Skip to main content
Module

x/openai/mod.ts>AzureClientOptions

Deno build of the official Typescript library for the OpenAI API.
Extremely Popular
Go to Latest
interface AzureClientOptions
implements ClientOptions
import { type AzureClientOptions } from "https://deno.land/x/openai@v4.47.1/mod.ts";

API Client for interfacing with the Azure OpenAI API.

Properties

optional
apiVersion: string | undefined

Defaults to process.env['OPENAI_API_VERSION'].

optional
endpoint: string | undefined

Your Azure endpoint, including the resource, e.g. https://example-resource.azure.openai.com/

optional
deployment: string | undefined

A model deployment, if given, sets the base client URL to include /deployments/{deployment}. Note: this means you won't be able to use non-deployment endpoints. Not supported with Assistants APIs.

optional
apiKey: string | undefined

Defaults to process.env['AZURE_OPENAI_API_KEY'].

optional
azureADTokenProvider: (() => Promise<string>) | undefined

A function that returns an access token for Microsoft Entra (formerly known as Azure Active Directory), which will be invoked on every request.