Class ImageAnalysisSkill

java.lang.Object
com.azure.search.documents.indexes.models.SearchIndexerSkill
com.azure.search.documents.indexes.models.ImageAnalysisSkill
All Implemented Interfaces:
com.azure.json.JsonSerializable<SearchIndexerSkill>
public final class ImageAnalysisSkill extends SearchIndexerSkill
A skill that analyzes image files. It extracts a rich set of visual features based on the image content.

  • Constructor Details

  • 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.

    • getDefaultLanguageCode

      public ImageAnalysisSkillLanguage getDefaultLanguageCode()
      Get the defaultLanguageCode property: A value indicating which language code to use. Default is `en`.
      Returns:
      the defaultLanguageCode value.

    • setDefaultLanguageCode

      public ImageAnalysisSkill setDefaultLanguageCode(ImageAnalysisSkillLanguage defaultLanguageCode)
      Set the defaultLanguageCode property: A value indicating which language code to use. Default is `en`.
      Parameters:
      defaultLanguageCode - the defaultLanguageCode value to set.
      Returns:
      the ImageAnalysisSkill object itself.

    • getVisualFeatures

      public List<VisualFeature> getVisualFeatures()
      Get the visualFeatures property: A list of visual features.
      Returns:
      the visualFeatures value.

    • setVisualFeatures

      public ImageAnalysisSkill setVisualFeatures(List<VisualFeature> visualFeatures)
      Set the visualFeatures property: A list of visual features.
      Parameters:
      visualFeatures - the visualFeatures value to set.
      Returns:
      the ImageAnalysisSkill object itself.

    • getDetails

      public List<ImageDetail> getDetails()
      Get the details property: A string indicating which domain-specific details to return.
      Returns:
      the details value.

    • setDetails

      public ImageAnalysisSkill setDetails(List<ImageDetail> details)
      Set the details property: A string indicating which domain-specific details to return.
      Parameters:
      details - the details value to set.
      Returns:
      the ImageAnalysisSkill object itself.

    • setName

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

    • setVisualFeatures

      public ImageAnalysisSkill setVisualFeatures(VisualFeature... visualFeatures)
      Set the visualFeatures property: A list of visual features.
      Parameters:
      visualFeatures - the visualFeatures value to set.
      Returns:
      the ImageAnalysisSkill object itself.

    • setDetails

      public ImageAnalysisSkill setDetails(ImageDetail... details)
      Set the details property: A string indicating which domain-specific details to return.
      Parameters:
      details - the details value to set.
      Returns:
      the ImageAnalysisSkill object itself.