AzureOpenAIVectorizerParameters Class

Definition

Namespace:: Azure.Search.Documents.Indexes.Models

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.6.1

Package:: Azure.Search.Documents v11.7.0-beta.6

Source:: AzureOpenAIVectorizerParameters.cs

Source:: AzureOpenAIVectorizerParameters.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Specifies the parameters for connecting to the Azure OpenAI resource.

public class AzureOpenAIVectorizerParameters

public class AzureOpenAIVectorizerParameters : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.AzureOpenAIVectorizerParameters>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.AzureOpenAIVectorizerParameters>

type AzureOpenAIVectorizerParameters = class

type AzureOpenAIVectorizerParameters = class
    interface IJsonModel<AzureOpenAIVectorizerParameters>
    interface IPersistableModel<AzureOpenAIVectorizerParameters>

Public Class AzureOpenAIVectorizerParameters

Public Class AzureOpenAIVectorizerParameters
Implements IJsonModel(Of AzureOpenAIVectorizerParameters), IPersistableModel(Of AzureOpenAIVectorizerParameters)

Inheritance: Object
AzureOpenAIVectorizerParameters

Implements: IJsonModel<AzureOpenAIVectorizerParameters> IPersistableModel<AzureOpenAIVectorizerParameters> IPersistableModel<T>

Constructors

AzureOpenAIVectorizerParameters()

Initializes a new instance of AzureOpenAIVectorizerParameters.

Properties

ApiKey	API key of the designated Azure OpenAI resource.
AuthenticationIdentity	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.
DeploymentName	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.
ResourceUri	The resource URI of the Azure OpenAI resource.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<AzureOpenAIVectorizerParameters>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<AzureOpenAIVectorizerParameters>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<AzureOpenAIVectorizerParameters>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<AzureOpenAIVectorizerParameters>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<AzureOpenAIVectorizerParameters>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to