Partilhar via

CustomEntity Classe

  • Referência

Um objeto que contém informações sobre as correspondências encontradas e metadados relacionados.

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

Herança
azure.search.documents.indexes._generated._serialization.Model
CustomEntity

Construtor

CustomEntity(*, name: str, description: str | None = None, type: str | None = None, subtype: str | None = None, id: str | None = None, case_sensitive: bool | None = None, accent_sensitive: bool | None = None, fuzzy_edit_distance: int | None = None, default_case_sensitive: bool | None = None, default_accent_sensitive: bool | None = None, default_fuzzy_edit_distance: int | None = None, aliases: List[_models.CustomEntityAlias] | None = None, **kwargs: Any)

Parâmetros Só de Palavra-Chave

Name Description
name
str

O descritor de entidade de nível superior. As correspondências na saída de competências serão agrupadas por este nome e devem representar a forma "normalizada" do texto que está a ser encontrado. Obrigatório.
description
str

Este campo pode ser utilizado como pass-through para metadados personalizados sobre os textos correspondentes. O valor deste campo será apresentado com cada correspondência da respetiva entidade na saída de competências.
type
str

Este campo pode ser utilizado como pass-through para metadados personalizados sobre os textos correspondentes. O valor deste campo será apresentado com cada correspondência da respetiva entidade na saída de competências.
subtype
str

Este campo pode ser utilizado como pass-through para metadados personalizados sobre os textos correspondentes. O valor deste campo será apresentado com cada correspondência da respetiva entidade na saída de competências.
id
str

Este campo pode ser utilizado como pass-through para metadados personalizados sobre os textos correspondentes. O valor deste campo será apresentado com cada correspondência da respetiva entidade na saída de competências.
case_sensitive
bool

O valor predefinido é falso. Valor booleano que indica se as comparações com o nome da entidade devem ser sensíveis à caixa de carateres. As correspondências não sensíveis a maiúsculas e minúsculas de "Microsoft" podem ser: microsoft, microSoft, MICROSOFT.
accent_sensitive
bool

O valor predefinido é falso. Valor booleano que indica se as comparações com o nome da entidade devem ser sensíveis ao destaque.
fuzzy_edit_distance
int

A predefinição é 0. Valor máximo de 5. Indica o número aceitável de carateres divergentes que ainda constituem uma correspondência com o nome da entidade. O menor fuzziness possível para qualquer correspondência é devolvido. Por exemplo, se a distância de edição estiver definida como 3, "Windows10" continuará a corresponder a "Windows", "Windows10" e "Windows 7". Quando a sensibilidade a maiúsculas e minúsculas é definida como falsa, as diferenças de casos NÃO contam para tolerância difusa, mas de outra forma contam.
default_case_sensitive
bool

Altera o valor de sensibilidade a maiúsculas e minúsculas predefinido para esta entidade. É utilizado para alterar o valor predefinido de todos os valores caseSensitive de todos os aliases.
default_accent_sensitive
bool

Altera o valor de confidencialidade de destaque predefinido para esta entidade. É utilizado para alterar o valor predefinido de todos os aliases accent Valoressensíveis.
default_fuzzy_edit_distance
int

Altera o valor de distância de edição difusa predefinido para esta entidade. Pode ser utilizado para alterar o valor predefinido de todos os valores fuzzyEditDistance.
aliases
list[<xref:search_service_client.models.CustomEntityAlias>]

Uma matriz de objetos complexos que podem ser utilizados para especificar ortografias alternativas ou sinónimos para o nome da entidade raiz.

Variáveis

Name Description
name
str

O descritor de entidade de nível superior. As correspondências na saída de competências serão agrupadas por este nome e devem representar a forma "normalizada" do texto que está a ser encontrado. Obrigatório.
description
str

Este campo pode ser utilizado como pass-through para metadados personalizados sobre os textos correspondentes. O valor deste campo será apresentado com cada correspondência da respetiva entidade na saída de competências.
type
str

Este campo pode ser utilizado como pass-through para metadados personalizados sobre os textos correspondentes. O valor deste campo será apresentado com cada correspondência da respetiva entidade na saída de competências.
subtype
str

Este campo pode ser utilizado como pass-through para metadados personalizados sobre os textos correspondentes. O valor deste campo será apresentado com cada correspondência da respetiva entidade na saída de competências.
id
str

Este campo pode ser utilizado como pass-through para metadados personalizados sobre os textos correspondentes. O valor deste campo será apresentado com cada correspondência da respetiva entidade na saída de competências.
case_sensitive
bool

O valor predefinido é falso. Valor booleano que indica se as comparações com o nome da entidade devem ser sensíveis à caixa de carateres. As correspondências não sensíveis a maiúsculas e minúsculas de "Microsoft" podem ser: microsoft, microSoft, MICROSOFT.
accent_sensitive
bool

O valor predefinido é falso. Valor booleano que indica se as comparações com o nome da entidade devem ser sensíveis ao destaque.
fuzzy_edit_distance
int

A predefinição é 0. Valor máximo de 5. Indica o número aceitável de carateres divergentes que ainda constituem uma correspondência com o nome da entidade. O menor fuzziness possível para qualquer correspondência é devolvido. Por exemplo, se a distância de edição estiver definida como 3, "Windows10" continuará a corresponder a "Windows", "Windows10" e "Windows 7". Quando a sensibilidade a maiúsculas e minúsculas é definida como falsa, as diferenças de casos NÃO contam para tolerância difusa, mas de outra forma contam.
default_case_sensitive
bool

Altera o valor de sensibilidade a maiúsculas e minúsculas predefinido para esta entidade. É utilizado para alterar o valor predefinido de todos os valores caseSensitive de todos os aliases.
default_accent_sensitive
bool

Altera o valor de confidencialidade de destaque predefinido para esta entidade. É utilizado para alterar o valor predefinido de todos os aliases accent Valoressensíveis.
default_fuzzy_edit_distance
int

Altera o valor de distância de edição difusa predefinido para esta entidade. Pode ser utilizado para alterar o valor predefinido de todos os valores fuzzyEditDistance.
aliases
list[<xref:search_service_client.models.CustomEntityAlias>]

Uma matriz de objetos complexos que podem ser utilizados para especificar ortografias alternativas ou sinónimos para o nome da entidade raiz.

Métodos

as_dict

Devolver 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. O valor é o valor atual neste objeto.

A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, isto é considerado dict 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 transmitir 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

Devolver 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 transmitir os kwargs is_xml=True.

as_dict

Devolver 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. O valor é o valor atual neste objeto.

A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, isto é considerado dict 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 transmitir 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 ditado

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 application/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 application/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

Devolver 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 transmitir 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 ditado