Skip to content

Commit 53a3a83

Browse files
committed
edits
1 parent 8896b90 commit 53a3a83

File tree

1 file changed

+7
-22
lines changed
  • articles/ai-services/openai/includes/language-overview

1 file changed

+7
-22
lines changed

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

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -29,28 +29,13 @@ npm install openai
2929

3030
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:
3131

32-
**Properties**:
33-
34-
* azureADTokenProvider:
35-
Type: `(() => Promise<string>) | undefined`
36-
Default: undefined
37-
Description: A function that returns an access token for Microsoft Entra (formerly known as Azure Active Directory), which will be invoked on every request.
38-
* apiKey:
39-
Type: `string | undefined`
40-
Default: process.env['AZURE_OPENAI_API_KEY']
41-
Description: Your API key for authenticating requests.
42-
* apiVersion:
43-
Type: `string | undefined`
44-
Default: process.env['OPENAI_API_VERSION']
45-
Description: Specifies the API version to use.
46-
* deployment:
47-
Type: `string | undefined`
48-
Default: undefined
49-
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.
50-
* endpoint:
51-
Type: `string | undefined`
52-
Default: undefined
53-
Description: Your Azure OpenAI endpoint.
32+
| Property | Details |
33+
|--|--|
34+
| azureADTokenProvider: `(() => Promise<string>) | A function that returns an access token for Microsoft Entra (formerly known as Azure Active Directory), invoked on every request. |
35+
| apiKey: `string | Your API key for authenticating requests. Default environment variable is `AZURE_OPENAI_API_KEY`.`|
36+
| apiVersion: `string | Specifies the API version to use. Default environment variable is `OPENAI_API_VERSION` |
37+
| deployment: `string | A model deployment. If provided, sets the base client URL to include `/deployments/{deployment}`. Non-deployment endpoints cannot be used (not supported with Assistants APIs).|
38+
| endpoint: `string | Your Azure OpenAI endpoint.|
5439

5540
## Authentication
5641

0 commit comments

Comments
 (0)