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

Class VectorSearchVectorizer

java.lang.Object
com.azure.search.documents.indexes.models.VectorSearchVectorizer
All Implemented Interfaces:
com.azure.json.JsonSerializable<VectorSearchVectorizer>
Direct Known Subclasses:
AIServicesVisionVectorizer, AzureMachineLearningVectorizer, AzureOpenAIVectorizer, WebApiVectorizer
public class VectorSearchVectorizer extends Object implements com.azure.json.JsonSerializable<VectorSearchVectorizer>
Specifies the vectorization method to be used during query time.

  • Constructor Summary

    Constructors
    Constructor
    Description
    VectorSearchVectorizer(String vectorizerName)
    Creates an instance of VectorSearchVectorizer class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static VectorSearchVectorizer
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of VectorSearchVectorizer from the JsonReader.
    VectorSearchVectorizerKind
    getKind()
    Get the kind property: The name of the kind of vectorization method being configured for use with vector search.
    String
    getVectorizerName()
    Get the vectorizerName property: The name to associate with this particular vectorization method.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • VectorSearchVectorizer

      public VectorSearchVectorizer(String vectorizerName)
      Creates an instance of VectorSearchVectorizer 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.
      Returns:
      the kind value.

    • getVectorizerName

      public String getVectorizerName()
      Get the vectorizerName property: The name to associate with this particular vectorization method.
      Returns:
      the vectorizerName value.

    • toJson

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

    • fromJson

      public static VectorSearchVectorizer fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of VectorSearchVectorizer from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of VectorSearchVectorizer 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 VectorSearchVectorizer.