AzureOpenAIParameters Class

  • Reference

Definition

Namespace:
Azure.Search.Documents.Indexes.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.6.0-beta.3
Source:
AzureOpenAIParameters.cs

Specifies the parameters for connecting to the Azure OpenAI resource.

public class AzureOpenAIParameters
type AzureOpenAIParameters = class
Public Class AzureOpenAIParameters
Inheritance
Object
AzureOpenAIParameters

Constructors

AzureOpenAIParameters()

Initializes a new instance of AzureOpenAIParameters.

Properties

ApiKey

API key of the designated Azure OpenAI resource.
AuthIdentity

The user-assigned managed identity used for outbound connections. Please note SearchIndexerDataIdentity is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SearchIndexerDataNoneIdentity and SearchIndexerDataUserAssignedIdentity.
DeploymentId

ID of the Azure OpenAI model deployment on the designated resource.
ResourceUri

The resource URI of the Azure OpenAI resource.

Applies to