Package version:

Interface DocumentExtractionSkill

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

interface DocumentExtractionSkill {
    configuration?: {
        [propertyName: string]: any;
    };
    context?: string;
    dataToExtract?: string;
    description?: string;
    inputs: InputFieldMappingEntry[];
    name?: string;
    odatatype: "#Microsoft.Skills.Util.DocumentExtractionSkill";
    outputs: OutputFieldMappingEntry[];
    parsingMode?: string;
}

Hierarchy (view full)

Properties

configuration? context? dataToExtract? description? inputs name? odatatype outputs parsingMode?

Properties

Optionalconfiguration

configuration?: {
    [propertyName: string]: any;
}

A dictionary of configurations for the skill.

Optionalcontext

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.

OptionaldataToExtract

dataToExtract?: string

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

Optionaldescription

description?: string

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

inputs

inputs: InputFieldMappingEntry[]

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

Optionalname

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

odatatype

odatatype

Polymorphic discriminator, which specifies the different types this object can be

outputs

outputs: 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.

OptionalparsingMode

parsingMode?: string

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

Settings

Member Visibility