DocumentIntelligenceLayoutSkill Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.8.1

• java.lang.Object
• • com.azure.search.documents.indexes.models.SearchIndexerSkill
  • • com.azure.search.documents.indexes.models.DocumentIntelligenceLayoutSkill

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 Summary

Constructor	Description
DocumentIntelligenceLayoutSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)	Creates an instance of DocumentIntelligenceLayoutSkill class.

Method Summary

Modifier and Type	Method and Description
static DocumentIntelligenceLayoutSkill	fromJson(JsonReader jsonReader) Reads an instance of DocumentIntelligenceLayoutSkill from the JsonReader.
DocumentIntelligenceLayoutSkillChunkingProperties	getChunkingProperties() Get the chunkingProperties property: Controls the cardinality for chunking the content.
List<DocumentIntelligenceLayoutSkillExtractionOptions>	getExtractionOptions() Get the extractionOptions property: Controls the cardinality of the content extracted from the document by the skill.
DocumentIntelligenceLayoutSkillMarkdownHeaderDepth	getMarkdownHeaderDepth() Get the markdownHeaderDepth property: The depth of headers in the markdown output.
String	getOdataType() Get the odataType property: A URI fragment specifying the type of skill.
DocumentIntelligenceLayoutSkillOutputFormat	getOutputFormat() Get the outputFormat property: Controls the cardinality of the output format.
DocumentIntelligenceLayoutSkillOutputMode	getOutputMode() Get the outputMode property: Controls the cardinality of the output produced by the skill.
DocumentIntelligenceLayoutSkill	setChunkingProperties(DocumentIntelligenceLayoutSkillChunkingProperties chunkingProperties) Set the chunkingProperties property: Controls the cardinality for chunking the content.
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).
DocumentIntelligenceLayoutSkill	setDescription(String description) Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
DocumentIntelligenceLayoutSkill	setExtractionOptions(List<DocumentIntelligenceLayoutSkillExtractionOptions> extractionOptions) Set the extractionOptions property: Controls the cardinality of the content extracted from the document by the skill.
DocumentIntelligenceLayoutSkill	setMarkdownHeaderDepth(DocumentIntelligenceLayoutSkillMarkdownHeaderDepth markdownHeaderDepth) Set the markdownHeaderDepth property: The depth of headers in the markdown output.
DocumentIntelligenceLayoutSkill	setName(String name) Set the name property: The name of the skill which uniquely identifies it within the skillset.
DocumentIntelligenceLayoutSkill	setOutputFormat(DocumentIntelligenceLayoutSkillOutputFormat outputFormat) Set the outputFormat property: Controls the cardinality of the output format.
DocumentIntelligenceLayoutSkill	setOutputMode(DocumentIntelligenceLayoutSkillOutputMode outputMode) Set the outputMode property: Controls the cardinality of the output produced by the skill.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from SearchIndexerSkill

fromJson getContext getDescription getInputs getName getOdataType getOutputs setContext setDescription setName toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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

fromJson

public static DocumentIntelligenceLayoutSkill fromJson(JsonReader jsonReader)

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:

IOException

- If the deserialized JSON object was missing any required properties.

getChunkingProperties

public DocumentIntelligenceLayoutSkillChunkingProperties getChunkingProperties()

Get the chunkingProperties property: Controls the cardinality for chunking the content.

Returns:

the chunkingProperties value.

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.

getMarkdownHeaderDepth

public DocumentIntelligenceLayoutSkillMarkdownHeaderDepth getMarkdownHeaderDepth()

Get the markdownHeaderDepth property: The depth of headers in the markdown output. Default is h6.

Returns:

the markdownHeaderDepth value.

getOdataType

public String getOdataType()

Get the odataType property: A URI fragment specifying the type of skill.

Overrides:

DocumentIntelligenceLayoutSkill.getOdataType()

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.

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.

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.

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:

DocumentIntelligenceLayoutSkill.setContext(String context)

Parameters:

context

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:

DocumentIntelligenceLayoutSkill.setDescription(String description)

Parameters:

description

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.

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.

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:

DocumentIntelligenceLayoutSkill.setName(String name)

Parameters:

name

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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

DocumentIntelligenceLayoutSkill.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException