SearchModelFactory.DocumentIntelligenceLayoutSkill Method

Definition

A skill that extracts content and layout information, via Azure AI Services, from files within the enrichment pipeline.

public static Azure.Search.Documents.Indexes.Models.DocumentIntelligenceLayoutSkill DocumentIntelligenceLayoutSkill(string name = default, string description = default, string context = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> inputs = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> outputs = default, Azure.Search.Documents.Indexes.Models.DocumentIntelligenceLayoutSkillOutputFormat? outputFormat = default, Azure.Search.Documents.Indexes.Models.DocumentIntelligenceLayoutSkillOutputMode? outputMode = default, Azure.Search.Documents.Indexes.Models.DocumentIntelligenceLayoutSkillMarkdownHeaderDepth? markdownHeaderDepth = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.DocumentIntelligenceLayoutSkillExtractionOptions> extractionOptions = default, Azure.Search.Documents.Indexes.Models.DocumentIntelligenceLayoutSkillChunkingProperties chunkingProperties = default);
static member DocumentIntelligenceLayoutSkill : string * string * string * seq<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> * seq<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> * Nullable<Azure.Search.Documents.Indexes.Models.DocumentIntelligenceLayoutSkillOutputFormat> * Nullable<Azure.Search.Documents.Indexes.Models.DocumentIntelligenceLayoutSkillOutputMode> * Nullable<Azure.Search.Documents.Indexes.Models.DocumentIntelligenceLayoutSkillMarkdownHeaderDepth> * seq<Azure.Search.Documents.Indexes.Models.DocumentIntelligenceLayoutSkillExtractionOptions> * Azure.Search.Documents.Indexes.Models.DocumentIntelligenceLayoutSkillChunkingProperties -> Azure.Search.Documents.Indexes.Models.DocumentIntelligenceLayoutSkill
Public Shared Function DocumentIntelligenceLayoutSkill (Optional name As String = Nothing, Optional description As String = Nothing, Optional context As String = Nothing, Optional inputs As IEnumerable(Of InputFieldMappingEntry) = Nothing, Optional outputs As IEnumerable(Of OutputFieldMappingEntry) = Nothing, Optional outputFormat As Nullable(Of DocumentIntelligenceLayoutSkillOutputFormat) = Nothing, Optional outputMode As Nullable(Of DocumentIntelligenceLayoutSkillOutputMode) = Nothing, Optional markdownHeaderDepth As Nullable(Of DocumentIntelligenceLayoutSkillMarkdownHeaderDepth) = Nothing, Optional extractionOptions As IEnumerable(Of DocumentIntelligenceLayoutSkillExtractionOptions) = Nothing, Optional chunkingProperties As DocumentIntelligenceLayoutSkillChunkingProperties = Nothing) As DocumentIntelligenceLayoutSkill

Parameters

name
String

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 '#'.

description
String

The description of the skill which describes the inputs, outputs, and usage of the skill.

context
String

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.

inputs
IEnumerable<InputFieldMappingEntry>

Inputs of the skills could be a column in the source data set, or the output of an upstream skill.

outputs
IEnumerable<OutputFieldMappingEntry>

The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill.

outputFormat
Nullable<DocumentIntelligenceLayoutSkillOutputFormat>

Controls the output format. Default is 'markdown'.

outputMode
Nullable<DocumentIntelligenceLayoutSkillOutputMode>

Controls the cardinality of the output produced by the skill. Default is 'oneToMany'.

markdownHeaderDepth
Nullable<DocumentIntelligenceLayoutSkillMarkdownHeaderDepth>

The depth of headers in the markdown output. Default is h6.

extractionOptions
IEnumerable<DocumentIntelligenceLayoutSkillExtractionOptions>

Controls the cardinality of the content extracted from the document by the skill.

chunkingProperties
DocumentIntelligenceLayoutSkillChunkingProperties

Controls the cardinality for chunking the content.

Returns

A new DocumentIntelligenceLayoutSkill instance for mocking.

Applies to