225 строки
20 KiB
YAML
225 строки
20 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.indexes.models.OcrSkill"
|
|
fullName: "com.azure.search.documents.indexes.models.OcrSkill"
|
|
name: "OcrSkill"
|
|
nameWithType: "OcrSkill"
|
|
summary: "A skill that extracts text from image files."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill&text=SearchIndexerSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.fromJson(com.azure.json.JsonReader)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.fromJson&text=fromJson\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getContext()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getContext&text=getContext\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getDescription()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getDescription&text=getDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getInputs()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getInputs&text=getInputs\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getName()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getName&text=getName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getOdataType()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getOdataType&text=getOdataType\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getOutputs()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getOutputs&text=getOutputs\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.setContext(java.lang.String)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.setContext&text=setContext\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.setDescription(java.lang.String)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.setDescription&text=setDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.setName(java.lang.String)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.setName&text=setName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.toJson(com.azure.json.JsonWriter)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **OcrSkill**</br> extends <xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill&text=SearchIndexerSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.indexes.models.OcrSkill.OcrSkill(java.util.List<com.azure.search.documents.indexes.models.InputFieldMappingEntry>,java.util.List<com.azure.search.documents.indexes.models.OutputFieldMappingEntry>)"
|
|
fullName: "com.azure.search.documents.indexes.models.OcrSkill.OcrSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
|
|
name: "OcrSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
|
|
nameWithType: "OcrSkill.OcrSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
|
|
summary: "Creates an instance of Ocr<wbr>Skill class."
|
|
parameters:
|
|
- description: "the inputs value to set."
|
|
name: "inputs"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.search.documents.indexes.models.InputFieldMappingEntry?alt=com.azure.search.documents.indexes.models.InputFieldMappingEntry&text=InputFieldMappingEntry\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "the outputs value to set."
|
|
name: "outputs"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.search.documents.indexes.models.OutputFieldMappingEntry?alt=com.azure.search.documents.indexes.models.OutputFieldMappingEntry&text=OutputFieldMappingEntry\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public OcrSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
|
|
desc: "Creates an instance of OcrSkill class."
|
|
methods:
|
|
- uid: "com.azure.search.documents.indexes.models.OcrSkill.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.search.documents.indexes.models.OcrSkill.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "OcrSkill.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Ocr<wbr>Skill from the Json<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The JsonReader being read."
|
|
name: "jsonReader"
|
|
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static OcrSkill fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If the deserialized JSON object was missing any required properties."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of OcrSkill from the JsonReader."
|
|
returns:
|
|
description: "An instance of OcrSkill if the JsonReader was pointing to an instance of it, or null if it was pointing\n to JSON null."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.OcrSkill?alt=com.azure.search.documents.indexes.models.OcrSkill&text=OcrSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.OcrSkill.getDefaultLanguageCode()"
|
|
fullName: "com.azure.search.documents.indexes.models.OcrSkill.getDefaultLanguageCode()"
|
|
name: "getDefaultLanguageCode()"
|
|
nameWithType: "OcrSkill.getDefaultLanguageCode()"
|
|
summary: "Get the default<wbr>Language<wbr>Code property: A value indicating which language code to use."
|
|
syntax: "public OcrSkillLanguage getDefaultLanguageCode()"
|
|
desc: "Get the defaultLanguageCode property: A value indicating which language code to use. Default is \\`en\\`."
|
|
returns:
|
|
description: "the defaultLanguageCode value."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.OcrSkillLanguage?alt=com.azure.search.documents.indexes.models.OcrSkillLanguage&text=OcrSkillLanguage\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.OcrSkill.getLineEnding()"
|
|
fullName: "com.azure.search.documents.indexes.models.OcrSkill.getLineEnding()"
|
|
name: "getLineEnding()"
|
|
nameWithType: "OcrSkill.getLineEnding()"
|
|
summary: "Get the line<wbr>Ending property: Defines the sequence of characters to use between the lines of text recognized by the OCR skill."
|
|
syntax: "public OcrLineEnding getLineEnding()"
|
|
desc: "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:
|
|
description: "the lineEnding value."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.OcrLineEnding?alt=com.azure.search.documents.indexes.models.OcrLineEnding&text=OcrLineEnding\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.OcrSkill.getOdataType()"
|
|
fullName: "com.azure.search.documents.indexes.models.OcrSkill.getOdataType()"
|
|
name: "getOdataType()"
|
|
nameWithType: "OcrSkill.getOdataType()"
|
|
summary: "Get the odata<wbr>Type property: A URI fragment specifying the type of skill."
|
|
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.getOdataType()"
|
|
syntax: "public String getOdataType()"
|
|
desc: "Get the odataType property: A URI fragment specifying the type of skill."
|
|
returns:
|
|
description: "the odataType value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.OcrSkill.isShouldDetectOrientation()"
|
|
fullName: "com.azure.search.documents.indexes.models.OcrSkill.isShouldDetectOrientation()"
|
|
name: "isShouldDetectOrientation()"
|
|
nameWithType: "OcrSkill.isShouldDetectOrientation()"
|
|
summary: "Get the should<wbr>Detect<wbr>Orientation property: A value indicating to turn orientation detection on or not."
|
|
syntax: "public Boolean isShouldDetectOrientation()"
|
|
desc: "Get the shouldDetectOrientation property: A value indicating to turn orientation detection on or not. Default is false."
|
|
returns:
|
|
description: "the shouldDetectOrientation value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.OcrSkill.setContext(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.OcrSkill.setContext(String context)"
|
|
name: "setContext(String context)"
|
|
nameWithType: "OcrSkill.setContext(String context)"
|
|
summary: "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)."
|
|
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.setContext(java.lang.String)"
|
|
parameters:
|
|
- name: "context"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public OcrSkill setContext(String context)"
|
|
desc: "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."
|
|
returns:
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.OcrSkill?alt=com.azure.search.documents.indexes.models.OcrSkill&text=OcrSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.OcrSkill.setDefaultLanguageCode(com.azure.search.documents.indexes.models.OcrSkillLanguage)"
|
|
fullName: "com.azure.search.documents.indexes.models.OcrSkill.setDefaultLanguageCode(OcrSkillLanguage defaultLanguageCode)"
|
|
name: "setDefaultLanguageCode(OcrSkillLanguage defaultLanguageCode)"
|
|
nameWithType: "OcrSkill.setDefaultLanguageCode(OcrSkillLanguage defaultLanguageCode)"
|
|
summary: "Set the default<wbr>Language<wbr>Code property: A value indicating which language code to use."
|
|
parameters:
|
|
- description: "the defaultLanguageCode value to set."
|
|
name: "defaultLanguageCode"
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.OcrSkillLanguage?alt=com.azure.search.documents.indexes.models.OcrSkillLanguage&text=OcrSkillLanguage\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public OcrSkill setDefaultLanguageCode(OcrSkillLanguage defaultLanguageCode)"
|
|
desc: "Set the defaultLanguageCode property: A value indicating which language code to use. Default is \\`en\\`."
|
|
returns:
|
|
description: "the OcrSkill object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.OcrSkill?alt=com.azure.search.documents.indexes.models.OcrSkill&text=OcrSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.OcrSkill.setDescription(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.OcrSkill.setDescription(String description)"
|
|
name: "setDescription(String description)"
|
|
nameWithType: "OcrSkill.setDescription(String description)"
|
|
summary: "Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill."
|
|
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.setDescription(java.lang.String)"
|
|
parameters:
|
|
- name: "description"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public OcrSkill setDescription(String description)"
|
|
desc: "Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill."
|
|
returns:
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.OcrSkill?alt=com.azure.search.documents.indexes.models.OcrSkill&text=OcrSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.OcrSkill.setLineEnding(com.azure.search.documents.indexes.models.OcrLineEnding)"
|
|
fullName: "com.azure.search.documents.indexes.models.OcrSkill.setLineEnding(OcrLineEnding lineEnding)"
|
|
name: "setLineEnding(OcrLineEnding lineEnding)"
|
|
nameWithType: "OcrSkill.setLineEnding(OcrLineEnding lineEnding)"
|
|
summary: "Set the line<wbr>Ending property: Defines the sequence of characters to use between the lines of text recognized by the OCR skill."
|
|
parameters:
|
|
- description: "the lineEnding value to set."
|
|
name: "lineEnding"
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.OcrLineEnding?alt=com.azure.search.documents.indexes.models.OcrLineEnding&text=OcrLineEnding\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public OcrSkill setLineEnding(OcrLineEnding lineEnding)"
|
|
desc: "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\"."
|
|
returns:
|
|
description: "the OcrSkill object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.OcrSkill?alt=com.azure.search.documents.indexes.models.OcrSkill&text=OcrSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.OcrSkill.setName(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.OcrSkill.setName(String name)"
|
|
name: "setName(String name)"
|
|
nameWithType: "OcrSkill.setName(String name)"
|
|
summary: "Set the name property: The name of the skill which uniquely identifies it within the skillset."
|
|
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.setName(java.lang.String)"
|
|
parameters:
|
|
- name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public OcrSkill setName(String name)"
|
|
desc: "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 '\\#'."
|
|
returns:
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.OcrSkill?alt=com.azure.search.documents.indexes.models.OcrSkill&text=OcrSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.OcrSkill.setShouldDetectOrientation()"
|
|
fullName: "com.azure.search.documents.indexes.models.OcrSkill.setShouldDetectOrientation()"
|
|
name: "setShouldDetectOrientation()"
|
|
nameWithType: "OcrSkill.setShouldDetectOrientation()"
|
|
summary: "Get the should<wbr>Detect<wbr>Orientation property: A value indicating to turn orientation detection on or not."
|
|
deprecatedTag: "Use <xref uid=\"com.azure.search.documents.indexes.models.OcrSkill.isShouldDetectOrientation()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#isShouldDetectOrientation()\"></xref> instead."
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public Boolean setShouldDetectOrientation()"
|
|
desc: "Get the shouldDetectOrientation property: A value indicating to turn orientation detection on or not. Default is false."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "the shouldDetectOrientation value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.OcrSkill.setShouldDetectOrientation(java.lang.Boolean)"
|
|
fullName: "com.azure.search.documents.indexes.models.OcrSkill.setShouldDetectOrientation(Boolean shouldDetectOrientation)"
|
|
name: "setShouldDetectOrientation(Boolean shouldDetectOrientation)"
|
|
nameWithType: "OcrSkill.setShouldDetectOrientation(Boolean shouldDetectOrientation)"
|
|
summary: "Set the should<wbr>Detect<wbr>Orientation property: A value indicating to turn orientation detection on or not."
|
|
parameters:
|
|
- description: "the shouldDetectOrientation value to set."
|
|
name: "shouldDetectOrientation"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public OcrSkill setShouldDetectOrientation(Boolean shouldDetectOrientation)"
|
|
desc: "Set the shouldDetectOrientation property: A value indicating to turn orientation detection on or not. Default is false."
|
|
returns:
|
|
description: "the OcrSkill object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.OcrSkill?alt=com.azure.search.documents.indexes.models.OcrSkill&text=OcrSkill\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.OcrSkill.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.search.documents.indexes.models.OcrSkill.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "OcrSkill.toJson(JsonWriter jsonWriter)"
|
|
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.toJson(com.azure.json.JsonWriter)"
|
|
parameters:
|
|
- name: "jsonWriter"
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "A skill that extracts text from image files."
|
|
metadata: {}
|
|
package: "com.azure.search.documents.indexes.models"
|
|
artifact: com.azure:azure-search-documents:11.7.3
|