AzureOpenAIVectorizer Class

Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.8.1

public final class AzureOpenAIVectorizer
extends VectorSearchVectorizer

Specifies the Azure OpenAI resource used to vectorize a query string.

Constructor Summary

Constructor Description
AzureOpenAIVectorizer(String vectorizerName)

Creates an instance of AzureOpenAIVectorizer class.

Method Summary

Modifier and Type Method and Description
static AzureOpenAIVectorizer fromJson(JsonReader jsonReader)

Reads an instance of AzureOpenAIVectorizer from the JsonReader.
VectorSearchVectorizerKind getKind()

Get the kind property: The name of the kind of vectorization method being configured for use with vector search.
AzureOpenAIVectorizerParameters getParameters()

Get the parameters property: Contains the parameters specific to Azure OpenAI embedding vectorization.
AzureOpenAIVectorizer setParameters(AzureOpenAIVectorizerParameters parameters)

Set the parameters property: Contains the parameters specific to Azure OpenAI embedding vectorization.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from VectorSearchVectorizer

fromJson getKind getVectorizerName toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AzureOpenAIVectorizer

public AzureOpenAIVectorizer(String vectorizerName)

Creates an instance of AzureOpenAIVectorizer class.

Parameters:

vectorizerName - the vectorizerName value to set.

Method Details

fromJson

public static AzureOpenAIVectorizer fromJson(JsonReader jsonReader)

Reads an instance of AzureOpenAIVectorizer from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AzureOpenAIVectorizer if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getKind

public VectorSearchVectorizerKind getKind()

Get the kind property: The name of the kind of vectorization method being configured for use with vector search.

Overrides:

AzureOpenAIVectorizer.getKind()

Returns:

the kind value.

getParameters

public AzureOpenAIVectorizerParameters getParameters()

Get the parameters property: Contains the parameters specific to Azure OpenAI embedding vectorization.

Returns:

the parameters value.

setParameters

public AzureOpenAIVectorizer setParameters(AzureOpenAIVectorizerParameters parameters)

Set the parameters property: Contains the parameters specific to Azure OpenAI embedding vectorization.

Parameters:

parameters - the parameters value to set.

Returns:

the AzureOpenAIVectorizer object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AzureOpenAIVectorizer.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to