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 and Description
OcrSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs) Constructor of OcrSkill.

Method Summary

Modifier and Type	Method and Description
OcrSkillLanguage	getDefaultLanguageCode() Get the defaultLanguageCode property: A value indicating which language code to use.
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.
Boolean	setShouldDetectOrientation() Deprecated. Use OcrSkill.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)

Constructor of OcrSkill.

Parameters:

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

outputs - The output of a skill is either a field in a search index, or a value

Method Detail

getDefaultLanguageCode

public OcrSkillLanguage getDefaultLanguageCode()

Get the defaultLanguageCode property: A value indicating which language code to use. Default is en. Possible values include: 'zh-Hans', 'zh-Hant', 'cs', 'da', 'nl', 'en', 'fi', 'fr', 'de', 'el', 'hu', 'it', 'ja', 'ko', 'nb', 'pl', 'pt', 'ru', 'es', 'sv', 'tr', 'ar', 'ro', 'sr-Cyrl', 'sr-Latn', 'sk'.

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. Possible values include: 'zh-Hans', 'zh-Hant', 'cs', 'da', 'nl', 'en', 'fi', 'fr', 'de', 'el', 'hu', 'it', 'ja', 'ko', 'nb', 'pl', 'pt', 'ru', 'es', 'sv', 'tr', 'ar', 'ro', 'sr-Cyrl', 'sr-Latn', 'sk'.

Parameters:

defaultLanguageCode - the defaultLanguageCode value to set.

Returns:

the OcrSkill object itself.

setShouldDetectOrientation

@Deprecated
public Boolean setShouldDetectOrientation()

Deprecated. Use OcrSkill.isShouldDetectOrientation() instead.

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

Returns:

the shouldDetectOrientation value.

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.