Class DocumentIntelligenceLayoutSkill

java.lang.Object
com.azure.search.documents.indexes.models.SearchIndexerSkill
com.azure.search.documents.indexes.models.DocumentIntelligenceLayoutSkill
All Implemented Interfaces:
com.azure.json.JsonSerializable<SearchIndexerSkill>
public final class DocumentIntelligenceLayoutSkill extends SearchIndexerSkill
A skill that extracts content and layout information, via Azure AI Services, from files within the enrichment pipeline.

  • Constructor Details

    • DocumentIntelligenceLayoutSkill

      public DocumentIntelligenceLayoutSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)
      Creates an instance of DocumentIntelligenceLayoutSkill 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.

    • getOutputFormat

      public DocumentIntelligenceLayoutSkillOutputFormat getOutputFormat()
      Get the outputFormat property: Controls the cardinality of the output format. Default is 'markdown'.
      Returns:
      the outputFormat value.

    • setOutputFormat

      public DocumentIntelligenceLayoutSkill setOutputFormat(DocumentIntelligenceLayoutSkillOutputFormat outputFormat)
      Set the outputFormat property: Controls the cardinality of the output format. Default is 'markdown'.
      Parameters:
      outputFormat - the outputFormat value to set.
      Returns:
      the DocumentIntelligenceLayoutSkill object itself.

    • getOutputMode

      public DocumentIntelligenceLayoutSkillOutputMode getOutputMode()
      Get the outputMode property: Controls the cardinality of the output produced by the skill. Default is 'oneToMany'.
      Returns:
      the outputMode value.

    • setOutputMode

      public DocumentIntelligenceLayoutSkill setOutputMode(DocumentIntelligenceLayoutSkillOutputMode outputMode)
      Set the outputMode property: Controls the cardinality of the output produced by the skill. Default is 'oneToMany'.
      Parameters:
      outputMode - the outputMode value to set.
      Returns:
      the DocumentIntelligenceLayoutSkill object itself.

    • getMarkdownHeaderDepth

      public DocumentIntelligenceLayoutSkillMarkdownHeaderDepth getMarkdownHeaderDepth()
      Get the markdownHeaderDepth property: The depth of headers in the markdown output. Default is h6.
      Returns:
      the markdownHeaderDepth value.

    • setMarkdownHeaderDepth

      public DocumentIntelligenceLayoutSkill setMarkdownHeaderDepth(DocumentIntelligenceLayoutSkillMarkdownHeaderDepth markdownHeaderDepth)
      Set the markdownHeaderDepth property: The depth of headers in the markdown output. Default is h6.
      Parameters:
      markdownHeaderDepth - the markdownHeaderDepth value to set.
      Returns:
      the DocumentIntelligenceLayoutSkill object itself.

    • getExtractionOptions

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

    • setExtractionOptions

      public DocumentIntelligenceLayoutSkill setExtractionOptions(List<DocumentIntelligenceLayoutSkillExtractionOptions> 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 DocumentIntelligenceLayoutSkill object itself.

    • getChunkingProperties

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

    • setChunkingProperties

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

    • setName

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