Share via

DocumentExtractionSkill Class

Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.8.1

public final class DocumentExtractionSkill
extends SearchIndexerSkill

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

Constructor Summary

Constructor Description
DocumentExtractionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)

Creates an instance of DocumentExtractionSkill class.

Method Summary

Modifier and Type Method and Description
static DocumentExtractionSkill fromJson(JsonReader jsonReader)

Reads an instance of DocumentExtractionSkill from the JsonReader.
Map<String,Object> getConfiguration()

Get the configuration property: A dictionary of configurations for the skill.
String getDataToExtract()

Get the dataToExtract property: The type of data to be extracted for the skill.
String getOdataType()

Get the odataType property: A URI fragment specifying the type of skill.
String getParsingMode()

Get the parsingMode property: The parsingMode for the skill.
DocumentExtractionSkill setConfiguration(Map<String,Object> configuration)

Set the configuration property: A dictionary of configurations for the skill.
DocumentExtractionSkill 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).
DocumentExtractionSkill setDataToExtract(String dataToExtract)

Set the dataToExtract property: The type of data to be extracted for the skill.
DocumentExtractionSkill setDescription(String description)

Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
DocumentExtractionSkill setName(String name)

Set the name property: The name of the skill which uniquely identifies it within the skillset.
DocumentExtractionSkill setParsingMode(String parsingMode)

Set the parsingMode property: The parsingMode for 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

DocumentExtractionSkill

public DocumentExtractionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)

Creates an instance of DocumentExtractionSkill class.

Parameters:

inputs - the inputs value to set.
outputs - the outputs value to set.

Method Details

fromJson

public static DocumentExtractionSkill fromJson(JsonReader jsonReader)

Reads an instance of DocumentExtractionSkill from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DocumentExtractionSkill 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.

getConfiguration

public Map<String,Object> getConfiguration()

Get the configuration property: A dictionary of configurations for the skill.

Returns:

the configuration value.

getDataToExtract

public String getDataToExtract()

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

Returns:

the dataToExtract value.

getOdataType

public String getOdataType()

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

Overrides:

DocumentExtractionSkill.getOdataType()

Returns:

the odataType value.

getParsingMode

public String getParsingMode()

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

Returns:

the parsingMode value.

setConfiguration

public DocumentExtractionSkill setConfiguration(Map<String,Object> configuration)

Set the configuration property: A dictionary of configurations for the skill.

Parameters:

configuration - the configuration value to set.

Returns:

the DocumentExtractionSkill object itself.

setContext

public DocumentExtractionSkill 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:

DocumentExtractionSkill.setContext(String context)

Parameters:

context

setDataToExtract

public DocumentExtractionSkill setDataToExtract(String dataToExtract)

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

Parameters:

dataToExtract - the dataToExtract value to set.

Returns:

the DocumentExtractionSkill object itself.

setDescription

public DocumentExtractionSkill setDescription(String description)

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

Overrides:

DocumentExtractionSkill.setDescription(String description)

Parameters:

description

setName

public DocumentExtractionSkill 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:

DocumentExtractionSkill.setName(String name)

Parameters:

name

setParsingMode

public DocumentExtractionSkill setParsingMode(String parsingMode)

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

Parameters:

parsingMode - the parsingMode value to set.

Returns:

the DocumentExtractionSkill object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

DocumentExtractionSkill.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to