SearchModelFactory.DocumentExtractionSkill Method

Definition

A skill that extracts content from a file within the enrichment pipeline.

public static Azure.Search.Documents.Indexes.Models.DocumentExtractionSkill DocumentExtractionSkill(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.BlobIndexerParsingMode? parsingMode = default, Azure.Search.Documents.Indexes.Models.BlobIndexerDataToExtract? dataToExtract = default, System.Collections.Generic.IDictionary<string,object> configuration = default);
static member DocumentExtractionSkill : string * string * string * seq<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> * seq<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> * Nullable<Azure.Search.Documents.Indexes.Models.BlobIndexerParsingMode> * Nullable<Azure.Search.Documents.Indexes.Models.BlobIndexerDataToExtract> * System.Collections.Generic.IDictionary<string, obj> -> Azure.Search.Documents.Indexes.Models.DocumentExtractionSkill
Public Shared Function DocumentExtractionSkill (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 parsingMode As Nullable(Of BlobIndexerParsingMode) = Nothing, Optional dataToExtract As Nullable(Of BlobIndexerDataToExtract) = Nothing, Optional configuration As IDictionary(Of String, Object) = Nothing) As DocumentExtractionSkill

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.

parsingMode
Nullable<BlobIndexerParsingMode>

The parsingMode for the skill. Will be set to 'default' if not defined.

dataToExtract
Nullable<BlobIndexerDataToExtract>

The type of data to be extracted for the skill. Will be set to 'contentAndMetadata' if not defined.

configuration
IDictionary<String,Object>

A dictionary of configurations for the skill.

Returns

A new DocumentExtractionSkill instance for mocking.

Applies to