JS - AzureClientOptions

Author: diberry

articles/ai-services/openai/includes/language-overview/javascript.md

@@ -5,7 +5,7 @@ description: Azure OpenAI JavaScript support
 manager: nitinme
 ms.service: azure-ai-openai
 ms.topic: include
-ms.date: 11/18/2024
+ms.date: 02/06/2025
 ---
 
 [Source code](https://github.com/openai/openai-node) | [Package (npm)](https://www.npmjs.com/package/openai) | [Reference](../../reference.md) |
@@ -25,6 +25,33 @@ Feature availability in Azure OpenAI is dependent on what version of the REST AP
 npm install openai
 ```
 
+## Configuration
+
+The `AzureClientOptions` object is used to configure the API client for interfacing with the Azure OpenAI API. The configuration object extends the existing OpenAi `ClientOptions` object. Below are the Azure OpenAI specific properties, their default values, and descriptions:
+
+**Properties**:
+
+* azureADTokenProvider:
+    Type: (() => Promise<string>) | undefined
+    Default: undefined
+    Description: A function that returns an access token for Microsoft Entra (formerly known as Azure Active Directory), which will be invoked on every request.
+* apiKey:
+    Type: string | undefined
+    Default: process.env['AZURE_OPENAI_API_KEY']
+    Description: Your API key for authenticating requests.
+* apiVersion:
+    Type: string | undefined
+    Default: process.env['OPENAI_API_VERSION']
+    Description: Specifies the API version to use.
+* deployment:
+    Type: string | undefined
+    Default: undefined
+    Description: 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.    
+* endpoint:
+    Type: string | undefined
+    Default: undefined
+    Description: Your Azure endpoint, including the resource, e.g. https://example-resource.azure.openai.com/.
+
 ## Authentication
 
 # [Microsoft Entra ID](#tab/secure)
@@ -36,7 +63,7 @@ import { DefaultAzureCredential } from "@azure/identity";
 const credential = new DefaultAzureCredential();
 ```
 
-This object is then passed to the second argument of the `OpenAIClient` and `AssistantsClient` client constructors.
+This object is then passed as part of the [`AzureClientOptions`](#configuration) object to the `AzureOpenAI` and `AssistantsClient` client constructors.
 
 In order to authenticate the `AzureOpenAI` client, however, we need to use the `getBearerTokenProvider` function from the `@azure/identity` package. This function creates a token provider that `AzureOpenAI` uses internally to obtain tokens for each request. The token provider is created as follows:
 
@@ -49,7 +76,6 @@ const apiVersion = "2024-10-21"
 const scope = "https://cognitiveservices.azure.com/.default";
 const azureADTokenProvider = getBearerTokenProvider(credential, scope);
 
-
 const client = new AzureOpenAI({ 
     endpoint, 
     apiVersions,
@@ -78,6 +104,42 @@ const client = new AzureOpenAI({ apiKey, endpoint, apiVersion });
 
 ---
 
+### AzureClientOptions Properties
+
+| Property Name       | Default Value / Environment Variable | Purpose                                                                 |
+|---------------------|--------------------------------------|-------------------------------------------------------------------------|
+| `endpoint`          | `process.env.AZURE_COSMOS_DB_ENDPOINT` | The endpoint URL for the Azure Cosmos DB instance.                      |
+| `key`               | `process.env.AZURE_COSMOS_DB_KEY`      | The primary key for accessing the Azure Cosmos DB instance.             |
+| `databaseName`      | `process.env.AZURE_COSMOS_DB_DATABASE` | The name of the database to connect to within the Azure Cosmos DB.       |
+| `containerName`     | `process.env.AZURE_COSMOS_DB_CONTAINER`| The name of the container (collection) within the database.              |
+| `aadCredentials`    | `new DefaultAzureCredential()`         | Azure Active Directory credentials for authentication.                   |
+| `consistencyLevel`  | `Session`                              | The consistency level for read operations (e.g., Strong, BoundedStaleness, Session, Eventual). |
+| `connectionPolicy`  | `Default`                              | The connection policy for the Cosmos DB client, including retry options and preferred locations. |
+| `timeout`           | `60000` (60 seconds)                   | The timeout duration for requests to the Azure Cosmos DB instance.       |
+
+## Description
+
+The `AzureClientOptions` object is used to configure the connection and behavior of the Azure Cosmos DB client. It includes properties for specifying the endpoint, authentication credentials, database and container names, consistency level, connection policy, and request timeout.
+
+### Example Usage
+
+```typescript
+import { CosmosClient, AzureClientOptions } from "@azure/cosmos";
+
+const options: AzureClientOptions = {
+  endpoint: process.env.AZURE_COSMOS_DB_ENDPOINT,
+  key: process.env.AZURE_COSMOS_DB_KEY,
+  databaseName: process.env.AZURE_COSMOS_DB_DATABASE,
+  containerName: process.env.AZURE_COSMOS_DB_CONTAINER,
+  aadCredentials: new DefaultAzureCredential(),
+  consistencyLevel: "Session",
+  connectionPolicy: { retryOptions: { maxRetryAttempts: 3 } },
+  timeout: 60000,
+};
+
+const client = new CosmosClient(options);
+```
+
 ## Audio
 
 ### Transcription