Class DocumentExtractionSkill

java.lang.Object
com.azure.search.documents.indexes.models.SearchIndexerSkill
com.azure.search.documents.indexes.models.DocumentExtractionSkill
All Implemented Interfaces:
com.azure.json.JsonSerializable<SearchIndexerSkill>
public final class DocumentExtractionSkill extends SearchIndexerSkill
A skill that extracts content from a file within the enrichment pipeline.

  • Constructor Details

    • DocumentExtractionSkill

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

    • getParsingMode

      public String getParsingMode()
      Get the parsingMode property: The parsingMode for the skill. Will be set to 'default' if not defined.
      Returns:
      the parsingMode value.

    • setParsingMode

      public DocumentExtractionSkill setParsingMode(String parsingMode)
      Set the parsingMode property: The parsingMode for the skill. Will be set to 'default' if not defined.
      Parameters:
      parsingMode - the parsingMode value to set.
      Returns:
      the DocumentExtractionSkill object itself.

    • getDataToExtract

      public String getDataToExtract()
      Get the dataToExtract property: The type of data to be extracted for the skill. Will be set to 'contentAndMetadata' if not defined.
      Returns:
      the dataToExtract value.

    • setDataToExtract

      public DocumentExtractionSkill setDataToExtract(String dataToExtract)
      Set the dataToExtract property: The type of data to be extracted for the skill. Will be set to 'contentAndMetadata' if not defined.
      Parameters:
      dataToExtract - the dataToExtract value to set.
      Returns:
      the DocumentExtractionSkill object itself.

    • getConfiguration

      public Map<String,Object> getConfiguration()
      Get the configuration property: A dictionary of configurations for the skill.
      Returns:
      the configuration value.

    • setConfiguration

      public DocumentExtractionSkill setConfiguration(Map<String,Object> configuration)
      Set the configuration property: A dictionary of configurations for the skill.
      Parameters:
      configuration - the configuration value to set.
      Returns:
      the DocumentExtractionSkill object itself.

    • setName

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