Class ContentUnderstandingSkill

java.lang.Object
com.azure.search.documents.indexes.models.SearchIndexerSkill
com.azure.search.documents.indexes.models.ContentUnderstandingSkill
All Implemented Interfaces:
com.azure.json.JsonSerializable<SearchIndexerSkill>
public final class ContentUnderstandingSkill extends SearchIndexerSkill
A skill that leverages Azure AI Content Understanding to process and extract structured insights from documents, enabling enriched, searchable content for enhanced document indexing and retrieval.

  • Constructor Details

    • ContentUnderstandingSkill

      public ContentUnderstandingSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)
      Creates an instance of ContentUnderstandingSkill class.
      Parameters:
      inputs - the inputs value to set.
      outputs - the outputs 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.

    • getExtractionOptions

      public List<ContentUnderstandingSkillExtractionOptions> getExtractionOptions()
      Get the extractionOptions property: Controls the cardinality of the content extracted from the document by the skill.
      Returns:
      the extractionOptions value.

    • setExtractionOptions

      public ContentUnderstandingSkill setExtractionOptions(List<ContentUnderstandingSkillExtractionOptions> extractionOptions)
      Set the extractionOptions property: Controls the cardinality of the content extracted from the document by the skill.
      Parameters:
      extractionOptions - the extractionOptions value to set.
      Returns:
      the ContentUnderstandingSkill object itself.

    • getChunkingProperties

      public ContentUnderstandingSkillChunkingProperties getChunkingProperties()
      Get the chunkingProperties property: Controls the cardinality for chunking the content.
      Returns:
      the chunkingProperties value.

    • setChunkingProperties

      public ContentUnderstandingSkill setChunkingProperties(ContentUnderstandingSkillChunkingProperties chunkingProperties)
      Set the chunkingProperties property: Controls the cardinality for chunking the content.
      Parameters:
      chunkingProperties - the chunkingProperties value to set.
      Returns:
      the ContentUnderstandingSkill object itself.

    • setName

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