Class WebApiVectorizer

java.lang.Object
com.azure.search.documents.indexes.models.VectorSearchVectorizer
com.azure.search.documents.indexes.models.WebApiVectorizer
All Implemented Interfaces:
com.azure.json.JsonSerializable<VectorSearchVectorizer>
public final class WebApiVectorizer extends VectorSearchVectorizer
Specifies a user-defined vectorizer for generating the vector embedding of a query string. Integration of an external vectorizer is achieved using the custom Web API interface of a skillset.

  • Constructor Details

    • WebApiVectorizer

      public WebApiVectorizer(String vectorizerName)
      Creates an instance of WebApiVectorizer 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.

    • getWebApiParameters

      public WebApiVectorizerParameters getWebApiParameters()
      Get the webApiParameters property: Specifies the properties of the user-defined vectorizer.
      Returns:
      the webApiParameters value.

    • setWebApiParameters

      public WebApiVectorizer setWebApiParameters(WebApiVectorizerParameters webApiParameters)
      Set the webApiParameters property: Specifies the properties of the user-defined vectorizer.
      Parameters:
      webApiParameters - the webApiParameters value to set.
      Returns:
      the WebApiVectorizer 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 WebApiVectorizer fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of WebApiVectorizer from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of WebApiVectorizer 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 WebApiVectorizer.