SearchIndexer Classe

Representa um indexador.

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.Model

SearchIndexer

Construtor

SearchIndexer(*, name: str, data_source_name: str, target_index_name: str, description: str | None = None, skillset_name: str | None = None, schedule: _models.IndexingSchedule | None = None, parameters: _models.IndexingParameters | None = None, field_mappings: List[_models.FieldMapping] | None = None, output_field_mappings: List[_models.FieldMapping] | None = None, is_disabled: bool = False, e_tag: str | None = None, encryption_key: _models.SearchResourceEncryptionKey | None = None, **kwargs: Any)

Parâmetros Só de Palavra-Chave

Name	Description
name	str O nome do indexador. Obrigatório.
description	str A descrição do indexador.
data_source_name	str O nome da origem de dados a partir da qual este indexador lê dados. Obrigatório.
skillset_name	str O nome do conjunto de competências executado com este indexador.
target_index_name	str O nome do índice ao qual este indexador escreve dados. Obrigatório.
schedule	<xref:search_service_client.models.IndexingSchedule> A agenda deste indexador.
parameters	<xref:search_service_client.models.IndexingParameters> Parâmetros para a execução do indexador.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] Define mapeamentos entre campos na origem de dados e campos de destino correspondentes no índice.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] Os mapeamentos de campos de saída são aplicados após o melhoramento e imediatamente antes da indexação.
is_disabled	bool Um valor que indica se o indexador está desativado. A predefinição é falso.
e_tag	str O ETag do indexador.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> 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 a definição do indexador (bem como o estado de execução do indexador) quando quiser ter a garantia total de que ninguém, nem mesmo a Microsoft, os pode desencriptar. Depois de encriptar a definição do indexador, esta permanecerá sempre encriptada. O serviço de pesquisa irá ignorar as tentativas de definir esta propriedade como nula. Pode alterar esta propriedade conforme necessário se quiser rodar a chave de encriptação; A definição do indexador (e o estado de execução do indexador) não serão afetadas. 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.

Variáveis

Name	Description
name	str O nome do indexador. Obrigatório.
description	str A descrição do indexador.
data_source_name	str O nome da origem de dados a partir da qual este indexador lê dados. Obrigatório.
skillset_name	str O nome do conjunto de competências executado com este indexador.
target_index_name	str O nome do índice ao qual este indexador escreve dados. Obrigatório.
schedule	<xref:search_service_client.models.IndexingSchedule> A agenda deste indexador.
parameters	<xref:search_service_client.models.IndexingParameters> Parâmetros para a execução do indexador.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] Define mapeamentos entre campos na origem de dados e campos de destino correspondentes no índice.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] Os mapeamentos de campos de saída são aplicados após o melhoramento e imediatamente antes da indexação.
is_disabled	bool Um valor que indica se o indexador está desativado. A predefinição é falso.
e_tag	str O ETag do indexador.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> 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 a definição do indexador (bem como o estado de execução do indexador) quando quiser ter a garantia total de que ninguém, nem mesmo a Microsoft, os pode desencriptar. Depois de encriptar a definição do indexador, esta permanecerá sempre encriptada. O serviço de pesquisa irá ignorar as tentativas de definir esta propriedade como nula. Pode alterar esta propriedade conforme necessário se quiser rodar a chave de encriptação; A definição do indexador (e o estado de execução do indexador) não serão afetadas. 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.

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