Class: AzureOpenAIApiConfiguration
Configuration for the Azure OpenAI API. This class is responsible for constructing URLs specific to the Azure OpenAI deployment.
It creates URLs of the form
https://[resourceName].openai.azure.com/openai/deployments/[deploymentId]/[path]?api-version=[apiVersion]
See
https://learn.microsoft.com/en-us/azure/ai-services/openai/reference
Hierarchy
-
AbstractApiConfiguration↳
AzureOpenAIApiConfiguration
Constructors
constructor
• new AzureOpenAIApiConfiguration(«destructured»): AzureOpenAIApiConfiguration
Parameters
| Name | Type |
|---|---|
«destructured» | AzureOpenAIApiConfigurationOptions |
Returns
Overrides
AbstractApiConfiguration.constructor
Defined in
packages/modelfusion/src/model-provider/openai/AzureOpenAIApiConfiguration.ts:29
Methods
assembleUrl
▸ assembleUrl(path): string
Parameters
| Name | Type |
|---|---|
path | string |
Returns
string
Overrides
AbstractApiConfiguration.assembleUrl
Defined in
packages/modelfusion/src/model-provider/openai/AzureOpenAIApiConfiguration.ts:52
fixedHeaders
▸ fixedHeaders(): Record<string, string>
Returns
Record<string, string>
Overrides
AbstractApiConfiguration.fixedHeaders
Defined in
packages/modelfusion/src/model-provider/openai/AzureOpenAIApiConfiguration.ts:56
headers
▸ headers(params): Record<string, string>
Parameters
| Name | Type |
|---|---|
params | HeaderParameters |
Returns
Record<string, string>
Inherited from
AbstractApiConfiguration.headers
Defined in
packages/modelfusion/src/core/api/AbstractApiConfiguration.ts:31
Properties
apiVersion
• Readonly apiVersion: string
Defined in
packages/modelfusion/src/model-provider/openai/AzureOpenAIApiConfiguration.ts:25
deploymentId
• Readonly deploymentId: string
Defined in
packages/modelfusion/src/model-provider/openai/AzureOpenAIApiConfiguration.ts:24
fixedHeaderValue
• Readonly fixedHeaderValue: Record<string, string>
Defined in
packages/modelfusion/src/model-provider/openai/AzureOpenAIApiConfiguration.ts:27
resourceName
• Readonly resourceName: string
Defined in
packages/modelfusion/src/model-provider/openai/AzureOpenAIApiConfiguration.ts:23
retry
• Optional Readonly retry: RetryFunction
Inherited from
AbstractApiConfiguration.retry
Defined in
packages/modelfusion/src/core/api/AbstractApiConfiguration.ts:7
throttle
• Optional Readonly throttle: ThrottleFunction
Inherited from
AbstractApiConfiguration.throttle
Defined in
packages/modelfusion/src/core/api/AbstractApiConfiguration.ts:8