AzureOpenAIVectorizerParameters Class

Definition

Namespace:

Azure.Search.Documents.Indexes.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v12.0.0

Source:

AzureOpenAIVectorizerParameters.cs

Specifies the parameters for connecting to the Azure OpenAI resource.

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
    interface IJsonModel<AzureOpenAIVectorizerParameters>
    interface IPersistableModel<AzureOpenAIVectorizerParameters>

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

Inheritance

Object

AzureOpenAIVectorizerParameters

Implements

IJsonModel<AzureOpenAIVectorizerParameters> IPersistableModel<AzureOpenAIVectorizerParameters> IPersistableModel<T>

Constructors

Name	Description
AzureOpenAIVectorizerParameters()	Initializes a new instance of AzureOpenAIVectorizerParameters.

Properties

Name	Description
ApiKey	API key of the designated Azure OpenAI resource.
AuthenticationIdentity	The user-assigned managed identity used for outbound connections.
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

Name	Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name	Description
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.