Package com.azure.search.documents.indexes.models

Class OcrSkill

java.lang.Object

com.azure.search.documents.indexes.models.SearchIndexerSkill

com.azure.search.documents.indexes.models.OcrSkill

public final class OcrSkill
extends SearchIndexerSkill

A skill that extracts text from image files.

Constructor Summary

Constructors

Constructor	Description
OcrSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)	Creates an instance of OcrSkill class.

Method Summary

Modifier and Type	Method	Description
OcrSkillLanguage	getDefaultLanguageCode()	Get the defaultLanguageCode property: A value indicating which language code to use.
LineEnding	getLineEnding()	Get the lineEnding property: Defines the sequence of characters to use between the lines of text recognized by the OCR skill.
Boolean	isShouldDetectOrientation()	Get the shouldDetectOrientation property: A value indicating to turn orientation detection on or not.
OcrSkill	setDefaultLanguageCode(OcrSkillLanguage defaultLanguageCode)	Set the defaultLanguageCode property: A value indicating which language code to use.
OcrSkill	setLineEnding(LineEnding lineEnding)	Set the lineEnding property: Defines the sequence of characters to use between the lines of text recognized by the OCR skill.
Boolean	setShouldDetectOrientation()	Deprecated. Use isShouldDetectOrientation() instead.
OcrSkill	setShouldDetectOrientation(Boolean shouldDetectOrientation)	Set the shouldDetectOrientation property: A value indicating to turn orientation detection on or not.

Methods inherited from class com.azure.search.documents.indexes.models.SearchIndexerSkill

getContext, getDescription, getInputs, getName, getOutputs, setContext, setDescription, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OcrSkill

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

Creates an instance of OcrSkill class.

Parameters:

inputs - the inputs value to set.

outputs - the outputs value to set.

Method Detail

getDefaultLanguageCode

public OcrSkillLanguage getDefaultLanguageCode()

Get the defaultLanguageCode property: A value indicating which language code to use. Default is en.

Returns:

the defaultLanguageCode value.

setDefaultLanguageCode

public OcrSkill setDefaultLanguageCode(OcrSkillLanguage defaultLanguageCode)

Set the defaultLanguageCode property: A value indicating which language code to use. Default is en.

Parameters:

defaultLanguageCode - the defaultLanguageCode value to set.

Returns:

the OcrSkill object itself.

isShouldDetectOrientation

public Boolean isShouldDetectOrientation()

Get the shouldDetectOrientation property: A value indicating to turn orientation detection on or not. Default is false.

Returns:

the shouldDetectOrientation value.

setShouldDetectOrientation

public OcrSkill setShouldDetectOrientation(Boolean shouldDetectOrientation)

Set the shouldDetectOrientation property: A value indicating to turn orientation detection on or not. Default is false.

Parameters:

shouldDetectOrientation - the shouldDetectOrientation value to set.

Returns:

the OcrSkill object itself.

getLineEnding

public LineEnding getLineEnding()

Get the lineEnding property: Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is "space".

Returns:

the lineEnding value.

setLineEnding

public OcrSkill setLineEnding(LineEnding lineEnding)

Set the lineEnding property: Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is "space".

Parameters:

lineEnding - the lineEnding value to set.

Returns:

the OcrSkill object itself.

setShouldDetectOrientation

@Deprecated
public Boolean setShouldDetectOrientation()

Deprecated.

Use isShouldDetectOrientation() instead.

Get the shouldDetectOrientation property: A value indicating to turn orientation detection on or not. Default is false.

Returns:

the shouldDetectOrientation value.