OcrSkill Класс

Навык, который извлекает текст из файлов изображений.

Для отправки в Azure необходимо заполнить все необходимые параметры.

Наследование

azure.search.documents.indexes._generated.models._models_py3.SearchIndexerSkill

OcrSkill

Конструктор

OcrSkill(*, inputs: List[_models.InputFieldMappingEntry], outputs: List[_models.OutputFieldMappingEntry], name: str | None = None, description: str | None = None, context: str | None = None, default_language_code: str | _models.OcrSkillLanguage | None = None, should_detect_orientation: bool = False, **kwargs: Any)

Параметры Keyword-Only

Имя	Описание
name	str Имя навыка, которое однозначно идентифицирует его в наборе навыков. Навыку без определенного имени будет присвоено имя по умолчанию его индекса на основе 1 в массиве навыков с префиксом символа #.
description	str Описание навыка, описывающее входные, выходные данные и использование навыка.
context	str Представляет уровень, на котором выполняются операции, такие как корень документа или содержимое документа (например, /document или /document/content). Значение по умолчанию — /document.
inputs	list[<xref:search_service_client.models.InputFieldMappingEntry>] Входные данные навыков могут быть столбцом в исходном наборе данных или выходными данными вышестоящий навыка. Обязательный.
outputs	list[<xref:search_service_client.models.OutputFieldMappingEntry>] Выходные данные навыка — это поле в индексе поиска или значение, которое может использоваться в качестве входных данных другим навыком. Обязательный.
default_language_code	str или <xref:search_service_client.models.OcrSkillLanguage> Значение , указывающее, какой код языка использовать. По умолчанию — en. Известные значения: "af", "sq", "anp", "ar", "ast", "awa", "az", "bfy", "eu", "be", "be-cyrl", "be-latn", "bho", "bi", "brx", "bs", "bra", "br", "bg", "bns", "bua", "ca", "ceb", "rab", "ch", "hne", "zh-Hans", "zh-Hant", "kw", "co", "crh", "hr", "cs", "da", "prs", "dhi", "doi", "nl", "en", "myv" ", "et", "fo", "fj", "fil", "fi", "fr", "fur", "gag", "gl", "de", "gil", "gon", "el", "kl", "gvr", "ht", "hlb", "hni", "bgc", "haw", "hi", "mww", "hoc", "hu", "is", "smn", "id", "ia", "iu", "ga", "it", "ja", "Jns", "jv", "kea", "kac", "xnr", "krc", "kaa-cyrl", "kaa", "csb", "kk-cyrl", "kk-latn", "klr", "kha", "quc", "ko", "kfq", "kpy", "kos", "kum", "ku-arab", "ku-latn", "kru", "ky"; "lkt", "la", "lt", "dsb", "smj", "lb", "bfz", "ms", "mt", "kmj", "gv", "mi", "mr", "mn", "cnr-cyrl", "cnr-latn", "nap", "ne", "niu", "nog", "sme", "nb", "no", "oc", "os", "ps", "fa", "pl", "pt", "pa", "ksh", "ro", "rm", "ru", "sck", "sm", "sa", "sat", "sco", "gd", "sr", "sr-Cyrl", "sr-Latn", "xsr", "srx", "sms", "sk", "sl", "so", "sma", "es", "sw", "sv", "tg", "tt", "tet", "thf", "to" "tr", "tk", "tyv", "hsb", "your", "ug", "uz-arab", "uz-cyrl", "uz", "vo", "wae", "cy", "fy", "yua", "za", "zu", "unk" и "is".
should_detect_orientation	bool Значение , указывающее, следует ли включить обнаружение ориентации. Значение по умолчанию — false.

Переменные

Имя	Описание
odata_type	str Фрагмент URI, указывающий тип навыка. Обязательный.
name	str Имя навыка, которое однозначно идентифицирует его в наборе навыков. Навыку без определенного имени будет присвоено имя по умолчанию его индекса на основе 1 в массиве навыков с префиксом символа #.
description	str Описание навыка, описывающее входные, выходные данные и использование навыка.
context	str Представляет уровень, на котором выполняются операции, такие как корень документа или содержимое документа (например, /document или /document/content). Значение по умолчанию — /document.
inputs	list[<xref:search_service_client.models.InputFieldMappingEntry>] Входные данные навыков могут быть столбцом в исходном наборе данных или выходными данными вышестоящий навыка. Обязательный.
outputs	list[<xref:search_service_client.models.OutputFieldMappingEntry>] Выходные данные навыка — это поле в индексе поиска или значение, которое может использоваться в качестве входных данных другим навыком. Обязательный.
default_language_code	str или <xref:search_service_client.models.OcrSkillLanguage> Значение , указывающее, какой код языка использовать. По умолчанию — en. Известные значения: "af", "sq", "anp", "ar", "ast", "awa", "az", "bfy", "eu", "be", "be-cyrl", "be-latn", "bho", "bi", "brx", "bs", "bra", "br", "bg", "bns", "bua", "ca", "ceb", "rab", "ch", "hne", "zh-Hans", "zh-Hant", "kw", "co", "crh", "hr", "cs", "da", "prs", "dhi", "doi", "nl", "en", "myv" ", "et", "fo", "fj", "fil", "fi", "fr", "fur", "gag", "gl", "de", "gil", "gon", "el", "kl", "gvr", "ht", "hlb", "hni", "bgc", "haw", "hi", "mww", "hoc", "hu", "is", "smn", "id", "ia", "iu", "ga", "it", "ja", "Jns", "jv", "kea", "kac", "xnr", "krc", "kaa-cyrl", "kaa", "csb", "kk-cyrl", "kk-latn", "klr", "kha", "quc", "ko", "kfq", "kpy", "kos", "kum", "ku-arab", "ku-latn", "kru", "ky"; "lkt", "la", "lt", "dsb", "smj", "lb", "bfz", "ms", "mt", "kmj", "gv", "mi", "mr", "mn", "cnr-cyrl", "cnr-latn", "nap", "ne", "niu", "nog", "sme", "nb", "no", "oc", "os", "ps", "fa", "pl", "pt", "pa", "ksh", "ro", "rm", "ru", "sck", "sm", "sa", "sat", "sco", "gd", "sr", "sr-Cyrl", "sr-Latn", "xsr", "srx", "sms", "sk", "sl", "so", "sma", "es", "sw", "sv", "tg", "tt", "tet", "thf", "to" "tr", "tk", "tyv", "hsb", "your", "ug", "uz-arab", "uz-cyrl", "uz", "vo", "wae", "cy", "fy", "yua", "za", "zu", "unk" и "is".
should_detect_orientation	bool Значение , указывающее, следует ли включить обнаружение ориентации. Значение по умолчанию — false.

Методы

as_dict	Возвращает дикт, который можно сериализовать с помощью json.dump. Дополнительное использование может использовать обратный вызов в качестве параметра: Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит "тип" с типом msrest и "key" с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте. Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом. См. три примера в этом файле: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Если требуется xml-сериализация, можно передать kwargs is_xml=True.
deserialize	Синтаксический анализ str с помощью синтаксиса RestAPI и возврат модели.
enable_additional_properties_sending
from_dict	Синтаксический анализ дикта с помощью заданного средства извлечения ключа возвращает модель. По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor).
is_xml_model
serialize	Возвращает json, который будет отправлен на сервер из этой модели. Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False). Если требуется xml-сериализация, можно передать kwargs is_xml=True.

as_dict

Возвращает дикт, который можно сериализовать с помощью json.dump.

Дополнительное использование может использовать обратный вызов в качестве параметра:

Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит "тип" с типом msrest и "key" с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.

Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом.

См. три примера в этом файле:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Если требуется xml-сериализация, можно передать kwargs is_xml=True.

as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

Параметры

Имя	Описание
key_transformer	<xref:function> Функция преобразователя ключей.
keep_readonly	значение по умолчанию: True

Возвращаемое значение

Тип	Описание
dict	Объект, совместимый с JSON для дикта

deserialize

Синтаксический анализ str с помощью синтаксиса RestAPI и возврат модели.

deserialize(data: Any, content_type: str | None = None) -> ModelType

Параметры

Имя	Описание
data Обязательно	str Строка, использующий структуру RestAPI. JSON по умолчанию.
content_type	str JSON по умолчанию задайте значение application/xml if XML. значение по умолчанию: None

Возвращаемое значение

Тип	Описание
	Экземпляр этой модели

Исключения

Тип	Описание
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Синтаксический анализ дикта с помощью заданного средства извлечения ключа возвращает модель.

По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor).

from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

Параметры

Имя	Описание
data Обязательно	dict Словарь, использующий структуру RestAPI
content_type	str JSON по умолчанию задайте значение application/xml if XML. значение по умолчанию: None
key_extractors	значение по умолчанию: None

Возвращаемое значение

Тип	Описание
	Экземпляр этой модели

Исключения

Тип	Описание
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Возвращает json, который будет отправлен на сервер из этой модели.

Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False).

Если требуется xml-сериализация, можно передать kwargs is_xml=True.

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

Параметры

Имя	Описание
keep_readonly	bool Если вы хотите сериализовать атрибуты только для чтения значение по умолчанию: False

Возвращаемое значение

Тип	Описание
dict	Объект, совместимый с JSON для дикта