Package com.azure.search.documents.indexes.models

Class AzureMachineLearningVectorizer

java.lang.Object
com.azure.search.documents.indexes.models.VectorSearchVectorizer
com.azure.search.documents.indexes.models.AzureMachineLearningVectorizer
All Implemented Interfaces:
com.azure.json.JsonSerializable<VectorSearchVectorizer>
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 Details

    • AzureMachineLearningVectorizer

      public AzureMachineLearningVectorizer(String vectorizerName)
      Creates an instance of AzureMachineLearningVectorizer class.
      Parameters:
      vectorizerName - the vectorizerName value to set.

  • Method Details

    • getKind

      public VectorSearchVectorizerKind getKind()
      Get the kind property: The name of the kind of vectorization method being configured for use with vector search.
      Overrides:
      getKind in class VectorSearchVectorizer
      Returns:
      the kind value.

    • getAMLParameters

      public AzureMachineLearningParameters getAMLParameters()
      Get the aMLParameters property: Specifies the properties of the AML vectorizer.
      Returns:
      the aMLParameters value.

    • setAMLParameters

      public AzureMachineLearningVectorizer setAMLParameters(AzureMachineLearningParameters aMLParameters)
      Set the aMLParameters property: Specifies the properties of the AML vectorizer.
      Parameters:
      aMLParameters - the aMLParameters value to set.
      Returns:
      the AzureMachineLearningVectorizer object itself.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<VectorSearchVectorizer>
      Overrides:
      toJson in class VectorSearchVectorizer
      Throws:
      IOException

    • fromJson

      public static AzureMachineLearningVectorizer fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the AzureMachineLearningVectorizer.