AzureMachineLearningVectorizer Class

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

public final class AzureMachineLearningVectorizer
extends VectorSearchVectorizer

Specifies an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog for generating the vector embedding of a query string.

Constructor Summary

Constructor Description
AzureMachineLearningVectorizer(String vectorizerName)

Creates an instance of AzureMachineLearningVectorizer class.

Method Summary

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

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

Get the kind property: Type of VectorSearchVectorizer.
AzureMachineLearningParameters getParameters()

Get the parameters property: Specifies the properties of the AML vectorizer.
AzureMachineLearningVectorizer setParameters(AzureMachineLearningParameters parameters)

Set the parameters property: Specifies the properties of the AML vectorizer.
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

AzureMachineLearningVectorizer

public AzureMachineLearningVectorizer(String vectorizerName)

Creates an instance of AzureMachineLearningVectorizer class.

Parameters:

vectorizerName - the vectorizerName value to set.

Method Details

fromJson

public static AzureMachineLearningVectorizer fromJson(JsonReader jsonReader)

Reads an instance of AzureMachineLearningVectorizer from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AzureMachineLearningVectorizer 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: Type of VectorSearchVectorizer.

Overrides:

AzureMachineLearningVectorizer.getKind()

Returns:

the kind value.

getParameters

public AzureMachineLearningParameters getParameters()

Get the parameters property: Specifies the properties of the AML vectorizer.

Returns:

the parameters value.

setParameters

public AzureMachineLearningVectorizer setParameters(AzureMachineLearningParameters parameters)

Set the parameters property: Specifies the properties of the AML vectorizer.

Parameters:

parameters - the parameters value to set.

Returns:

the AzureMachineLearningVectorizer object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AzureMachineLearningVectorizer.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to