SearchIndex Classe
Representa uma definição de índice de pesquisa, que descreve os campos e o comportamento de pesquisa de um índice.
Todos os parâmetros necessários têm de ser preenchidos para serem enviados para o Azure.
- Herança
-
azure.search.documents.indexes._generated._serialization.ModelSearchIndex
Construtor
SearchIndex(**kwargs)
Variáveis
Name | Description |
---|---|
name
|
Obrigatório. O nome do índice. |
fields
|
Obrigatório. Os campos do índice. |
scoring_profiles
|
Os perfis de classificação do índice. |
default_scoring_profile
|
O nome do perfil de classificação a utilizar se não for especificado nenhum na consulta. Se esta propriedade não estiver definida e não for especificado nenhum perfil de classificação na consulta, será utilizada a classificação predefinida (tf-idf). |
cors_options
|
Opções para controlar a Partilha de Recursos Entre Origens (CORS) para o índice. |
suggesters
|
Os sugestores do índice. |
analyzers
|
Os analisadores do índice. |
tokenizers
|
Os tokenizers do índice. |
token_filters
|
O token filtra o índice. |
char_filters
|
O caráter filtra para o índice. |
encryption_key
|
Uma descrição de uma chave de encriptação que cria no Azure Key Vault. Esta chave é utilizada para fornecer um nível adicional de encriptação inativa para os seus dados quando pretende garantir plenamente que ninguém, nem mesmo a Microsoft, pode desencriptar os seus dados no Azure Cognitive Search. Depois de encriptar os seus dados, estes permanecerão sempre encriptados. Azure Cognitive Search ignorará as tentativas de definir esta propriedade como nula. Pode alterar esta propriedade conforme necessário se quiser rodar a chave de encriptação; Os seus dados não serão afetados. A encriptação com chaves geridas pelo cliente não está disponível para serviços de pesquisa gratuita e só está disponível para serviços pagos criados em ou depois de 1 de janeiro de 2019. |
similarity
|
O tipo de algoritmo de semelhança a ser utilizado ao classificar e classificar os documentos correspondentes a uma consulta de pesquisa. O algoritmo de semelhança só pode ser definido no momento da criação do índice e não pode ser modificado em índices existentes. Se for nulo, é utilizado o algoritmo ClassicSimilarity. |
semantic_search
|
Define parâmetros para um índice de pesquisa que influencia as capacidades semânticas. |
vector_search
|
Define parâmetros para um índice de pesquisa que influencia a classificação num espaço de vetor. |
e_tag
|
O ETag do índice. |
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:
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 |
---|---|
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
|
Um str com a estrutura RestAPI. JSON por predefinição. |
content_type
|
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
|
Um ditado com a estrutura restAPI |
content_type
|
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
|
Se quiser serializar os atributos só de leitura valor predefinido: False
|
Devoluções
Tipo | Description |
---|---|
Um objeto compatível com JSON de dict |
Azure SDK for Python