OcrSkill Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.8.1

• 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

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

Method Summary

Modifier and Type	Method and Description
static OcrSkill	fromJson(JsonReader jsonReader) Reads an instance of OcrSkill from the JsonReader.
OcrSkillLanguage	getDefaultLanguageCode() Get the defaultLanguageCode property: A value indicating which language code to use.
OcrLineEnding	getLineEnding() Get the lineEnding property: Defines the sequence of characters to use between the lines of text recognized by the OCR skill.
String	getOdataType() Get the odataType property: A URI fragment specifying the type of skill.
Boolean	isShouldDetectOrientation() Get the shouldDetectOrientation property: A value indicating to turn orientation detection on or not.
OcrSkill	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).
OcrSkill	setDefaultLanguageCode(OcrSkillLanguage defaultLanguageCode) Set the defaultLanguageCode property: A value indicating which language code to use.
OcrSkill	setDescription(String description) Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
OcrSkill	setLineEnding(OcrLineEnding lineEnding) Set the lineEnding property: Defines the sequence of characters to use between the lines of text recognized by the OCR skill.
OcrSkill	setName(String name) Set the name property: The name of the skill which uniquely identifies it within the skillset.
Boolean	setShouldDetectOrientation() Deprecated Use isShouldDetectOrientation() instead. Get the shouldDetectOrientation property: A value indicating to turn orientation detection on or not.
OcrSkill	setShouldDetectOrientation(Boolean shouldDetectOrientation) Set the shouldDetectOrientation property: A value indicating to turn orientation detection on or not.
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

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 Details

fromJson

public static OcrSkill fromJson(JsonReader jsonReader)

Reads an instance of OcrSkill from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getDefaultLanguageCode

public OcrSkillLanguage getDefaultLanguageCode()

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

Returns:

the defaultLanguageCode value.

getLineEnding

public OcrLineEnding 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.

getOdataType

public String getOdataType()

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

Overrides:

OcrSkill.getOdataType()

Returns:

the odataType 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.

setContext

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

OcrSkill.setContext(String context)

Parameters:

context

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.

setDescription

public OcrSkill setDescription(String description)

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

Overrides:

OcrSkill.setDescription(String description)

Parameters:

description

setLineEnding

public OcrSkill setLineEnding(OcrLineEnding 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.

setName

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

OcrSkill.setName(String name)

Parameters:

name

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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

OcrSkill.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException