Feedback Edit

DocumentExtractionSkill Class

  • Reference

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

All required parameters must be populated in order to send to Azure.

Inheritance
azure.search.documents.indexes._generated.models._models_py3.SearchIndexerSkill
DocumentExtractionSkill

Constructor

DocumentExtractionSkill(*, inputs: List[azure.search.documents.indexes._generated.models._models_py3.InputFieldMappingEntry], outputs: List[azure.search.documents.indexes._generated.models._models_py3.OutputFieldMappingEntry], name: Optional[str] = None, description: Optional[str] = None, context: Optional[str] = None, parsing_mode: Optional[str] = None, data_to_extract: Optional[str] = None, configuration: Optional[Dict[str, Any]] = None, **kwargs)

Parameters

odata_type
str
Required

Required. Identifies the concrete type of the skill.Constant filled by server.

name
str
Required

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
str
Required

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

context
str
Required

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
list[InputFieldMappingEntry]
Required

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

outputs
list[OutputFieldMappingEntry]
Required

Required. 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.

parsing_mode
str
Required

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

data_to_extract
str
Required

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

configuration
dict[str, any]
Required

A dictionary of configurations for the skill.