Partilhar via

OcrSkill Classe

  • Referência

Uma competência que extrai texto de ficheiros de imagem.

Todos os parâmetros necessários têm de ser preenchidos para serem enviados para o Azure.

Herança
azure.search.documents.indexes._generated.models._models_py3.SearchIndexerSkill
OcrSkill

Construtor

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)

Parâmetros Só de Palavra-Chave

Name Description
name
str

O nome da competência que a identifica exclusivamente no conjunto de competências. Uma competência sem nome definido receberá um nome predefinido do respetivo índice baseado em 1 na matriz de competências, com o prefixo com o caráter #.
description
str

A descrição da competência que descreve as entradas, saídas e utilização da competência.
context
str

Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /documento ou /documento/conteúdo). A predefinição é /document.
inputs
list[<xref:search_service_client.models.InputFieldMappingEntry>]

As entradas das competências podem ser uma coluna no conjunto de dados de origem ou a saída de uma competência a montante. Obrigatório.
outputs
list[<xref:search_service_client.models.OutputFieldMappingEntry>]

A saída de uma competência é um campo num índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra competência. Obrigatório.
default_language_code
str ou <xref:search_service_client.models.OcrSkillLanguage>

Um valor que indica o código de idioma a utilizar. A predefinição é en. Os valores conhecidos são: "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", "h" "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", "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", "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", "th"f", "to", "tr", "tk", "tyv", "hsb", "your", "ug", "uz-arab", "uz-cyrl", "uz", "vo", "wae", "cy", "fy", "yua", "za", "zu", "unk" e "is".
should_detect_orientation
bool

Um valor que indica para ativar ou não a deteção de orientação. A predefinição é falso.

Variáveis

Name Description
odata_type
str

Um fragmento de URI que especifica o tipo de competência. Obrigatório.
name
str

O nome da competência que a identifica exclusivamente no conjunto de competências. Uma competência sem nome definido receberá um nome predefinido do respetivo índice baseado em 1 na matriz de competências, com o prefixo com o caráter #.
description
str

A descrição da competência que descreve as entradas, saídas e utilização da competência.
context
str

Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /documento ou /documento/conteúdo). A predefinição é /document.
inputs
list[<xref:search_service_client.models.InputFieldMappingEntry>]

As entradas das competências podem ser uma coluna no conjunto de dados de origem ou a saída de uma competência a montante. Obrigatório.
outputs
list[<xref:search_service_client.models.OutputFieldMappingEntry>]

A saída de uma competência é um campo num índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra competência. Obrigatório.
default_language_code
str ou <xref:search_service_client.models.OcrSkillLanguage>

Um valor que indica o código de idioma a utilizar. A predefinição é en. Os valores conhecidos são: "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", "h" "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", "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", "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", "th"f", "to", "tr", "tk", "tyv", "hsb", "your", "ug", "uz-arab", "uz-cyrl", "uz", "vo", "wae", "cy", "fy", "yua", "za", "zu", "unk" e "is".
should_detect_orientation
bool

Um valor que indica para ativar ou não a deteção de orientação. A predefinição é falso.

Métodos

as_dict

Devolva um ditado que pode ser serializado com json.dump.

Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro:

A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. Valor é o valor atual neste objeto.

A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, este é considerado ditado de resultado hierárquico.

Veja os três exemplos neste ficheiro:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se quiser serialização XML, pode passar os kwargs is_xml=True.
deserialize

Analise um str com a sintaxe RestAPI e devolva um modelo.
enable_additional_properties_sending
from_dict

Analisar um ditado com um determinado extrator de chaves devolve um modelo.

Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize

Devolva o JSON que seria enviado para o servidor a partir deste modelo.

Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso).

Se quiser serialização XML, pode passar os kwargs is_xml=True.

as_dict

Devolva um ditado que pode ser serializado com json.dump.

Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro:

A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. Valor é o valor atual neste objeto.

A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, este é considerado ditado de resultado hierárquico.

Veja os três exemplos neste ficheiro:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se quiser serialização XML, pode passar os 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]

Parâmetros

Name Description
key_transformer
<xref:function>

Uma função de transformador de chaves.
keep_readonly
valor predefinido: True

Devoluções

Tipo Description
dict

Um objeto compatível com JSON de dict

deserialize

Analise um str com a sintaxe RestAPI e devolva um modelo.

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

Parâmetros

Name Description
data
Necessário
str

Um str com a estrutura RestAPI. JSON por predefinição.
content_type
str

JSON por predefinição, defina aplicação/xml se XML.

valor predefinido: None

Devoluções

Tipo Description

Uma instância deste modelo

Exceções

Tipo Description
DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending() -> None

from_dict

Analisar um ditado com um determinado extrator de chaves devolve um modelo.

Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e 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

Parâmetros

Name Description
data
Necessário
dict

Um ditado com a estrutura restAPI
content_type
str

JSON por predefinição, defina aplicação/xml se XML.

valor predefinido: None
key_extractors
valor predefinido: None

Devoluções

Tipo Description

Uma instância deste modelo

Exceções

Tipo Description
DeserializationError if something went wrong

is_xml_model 

is_xml_model() -> bool

serialize

Devolva o JSON que seria enviado para o servidor a partir deste modelo.

Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso).

Se quiser serialização XML, pode passar os kwargs is_xml=True.

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

Parâmetros

Name Description
keep_readonly
bool

Se quiser serializar os atributos só de leitura

valor predefinido: False

Devoluções

Tipo Description
dict

Um objeto compatível com JSON de dict