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 devem ser preenchidos para enviar ao Azure.

Herança

azure.search.documents.indexes._generated._serialization.Model

SearchIndex

Construtor

SearchIndex(**kwargs)

Variáveis

Nome	Description
name	str Obrigatórios. O nome do índice.
fields	list[SearchField] Obrigatórios. Os campos do índice.
scoring_profiles	list[ScoringProfile] Os perfis de pontuação para o índice.
default_scoring_profile	str O nome do perfil de pontuação a ser usado se nenhum for especificado na consulta. Se essa propriedade não estiver definida e nenhum perfil de pontuação for especificado na consulta, a pontuação padrão (tf-idf) será usada.
cors_options	CorsOptions Opções para controlar o CORS (Compartilhamento de Recursos entre Origens) para o índice.
suggesters	list[SearchSuggester] Os sugestores para o índice.
analyzers	list[LexicalAnalyzer] Os analisadores do índice.
tokenizers	list[LexicalTokenizer] Os tokenizers para o índice.
token_filters	list[TokenFilter] O token filtra para o índice.
char_filters	list[CharFilter] O caractere filtra para o índice.
encryption_key	SearchResourceEncryptionKey Uma descrição de uma chave de criptografia criada no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para seus dados quando você quiser ter total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografar seus dados em Azure Cognitive Search. Depois de criptografar seus dados, eles sempre permanecerão criptografados. Azure Cognitive Search ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Seus dados não serão afetados. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em ou após 1º de janeiro de 2019.
similarity	SimilarityAlgorithm O tipo de algoritmo de similaridade a ser usado ao pontuar e classificar os documentos correspondentes a uma consulta de pesquisa. O algoritmo de similaridade só pode ser definido no momento da criação do índice e não pode ser modificado em índices existentes. Se for nulo, o algoritmo ClassicSimilarity será usado.
semantic_search	SemanticSearch Define parâmetros para um índice de pesquisa que influenciam as funcionalidades semânticas.
vector_search	VectorSearch Define parâmetros para um índice de pesquisa que influenciam a pontuação em um espaço vetor.
e_tag	str A ETag do índice.

Métodos

as_dict	Retornar um ditado que pode ser serializado usando json.dump. O uso avançado pode, opcionalmente, usar um retorno de chamada como parâmetro: Key é o nome do atributo usado no Python. Attr_desc é um ditado de metadados. Atualmente, contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto. A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico. Confira os três exemplos neste arquivo: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Se você quiser serialização XML, poderá passar os kwargs is_xml=True.
deserialize	Analise um str usando a sintaxe RestAPI e retorne um modelo.
enable_additional_properties_sending
from_dict	Analisar um ditado usando determinado extrator de chave retorna um modelo. Por padrão, considere extratores de chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Retorne o JSON que seria enviado para o servidor desse modelo. Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False). Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

as_dict

Retornar um ditado que pode ser serializado usando json.dump.

O uso avançado pode, opcionalmente, usar um retorno de chamada como parâmetro:

Key é o nome do atributo usado no Python. Attr_desc é um ditado de metadados. Atualmente, contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto.

A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico.

Confira os três exemplos neste arquivo:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Se você quiser serialização XML, poderá 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

Nome	Description
key_transformer	<xref:function> Uma função de transformador de chave.
keep_readonly	valor padrão: True

Retornos

Tipo	Description
dict	Um objeto compatível com JSON de ditado

deserialize

Analise um str usando a sintaxe RestAPI e retorne um modelo.

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

Parâmetros

Nome	Description
data Obrigatório	str Um str usando a estrutura RestAPI. JSON por padrão.
content_type	str JSON por padrão, defina application/xml se XML. valor padrão: None

Retornos

Tipo	Description
	Uma instância desse modelo

Exceções

Tipo	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Analisar um ditado usando determinado extrator de chave retorna um modelo.

Por padrão, considere extratores de 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

Nome	Description
data Obrigatório	dict Um ditado usando a estrutura RestAPI
content_type	str JSON por padrão, defina application/xml se XML. valor padrão: None
key_extractors	valor padrão: None

Retornos

Tipo	Description
	Uma instância desse modelo

Exceções

Tipo	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Retorne o JSON que seria enviado para o servidor desse modelo.

Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

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

Parâmetros

Nome	Description
keep_readonly	bool Se você quiser serializar os atributos somente leitura valor padrão: False

Retornos

Tipo	Description
dict	Um objeto compatível com JSON de ditado