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

Class VisionVectorizeSkill

java.lang.Object
com.azure.search.documents.indexes.models.SearchIndexerSkill
com.azure.search.documents.indexes.models.VisionVectorizeSkill
All Implemented Interfaces:
com.azure.json.JsonSerializable<SearchIndexerSkill>
public final class VisionVectorizeSkill extends SearchIndexerSkill
Allows you to generate a vector embedding for a given image or text input using the Azure AI Services Vision Vectorize API.

  • Constructor Details

    • VisionVectorizeSkill

      public VisionVectorizeSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs, String modelVersion)
      Creates an instance of VisionVectorizeSkill class.
      Parameters:
      inputs - the inputs value to set.
      outputs - the outputs value to set.
      modelVersion - the modelVersion value to set.

  • Method Details

    • getOdataType

      public String getOdataType()
      Get the odataType property: A URI fragment specifying the type of skill.
      Overrides:
      getOdataType in class SearchIndexerSkill
      Returns:
      the odataType value.

    • getModelVersion

      public String getModelVersion()
      Get the modelVersion property: The version of the model to use when calling the AI Services Vision service. It will default to the latest available when not specified.
      Returns:
      the modelVersion value.

    • setName

      public VisionVectorizeSkill setName(String name)
      Set the name property: The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'.
      Overrides:
      setName in class SearchIndexerSkill
      Parameters:
      name - the name value to set.
      Returns:
      the SearchIndexerSkill object itself.

    • setDescription

      public VisionVectorizeSkill setDescription(String description)
      Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
      Overrides:
      setDescription in class SearchIndexerSkill
      Parameters:
      description - the description value to set.
      Returns:
      the SearchIndexerSkill object itself.

    • setContext

      public VisionVectorizeSkill setContext(String context)
      Set the context property: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document.
      Overrides:
      setContext in class SearchIndexerSkill
      Parameters:
      context - the context value to set.
      Returns:
      the SearchIndexerSkill 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<SearchIndexerSkill>
      Overrides:
      toJson in class SearchIndexerSkill
      Throws:
      IOException

    • fromJson

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