Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
AzureOpenAIParameters interface
- Package:
- @azure/search-documents
Specifies the parameters for connecting to the Azure OpenAI resource.
Properties
| apiKey | API key of the designated Azure OpenAI resource. |
| authIdentity | The user-assigned managed identity used for outbound connections. |
| deploymentId | ID of the Azure OpenAI model deployment on the designated resource. |
| modelName | The name of the embedding model that is deployed at the provided deploymentId path. |
| resourceUrl | The resource URI of the Azure OpenAI resource. |
Property Details
apiKey
API key of the designated Azure OpenAI resource.
apiKey?: stringProperty Value
string
authIdentity
The user-assigned managed identity used for outbound connections.
authIdentity?: SearchIndexerDataIdentityProperty Value
deploymentId
ID of the Azure OpenAI model deployment on the designated resource.
deploymentId?: stringProperty Value
string
modelName
The name of the embedding model that is deployed at the provided deploymentId path.
modelName?: stringProperty Value
string
resourceUrl
The resource URI of the Azure OpenAI resource.
resourceUrl?: stringProperty Value
string