SearchIndexer Classe

Representa um indexador.

Todos os parâmetros necessários devem ser preenchidos para enviar ao 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 de apenas palavra-chave

Nome	Description
name	str o nome do indexador. Obrigatórios.
description	str A descrição do indexador.
data_source_name	str O nome da fonte de dados da qual esse indexador lê dados. Obrigatórios.
skillset_name	str O nome do conjunto de habilidades em execução com esse indexador.
target_index_name	str O nome do índice no qual esse indexador grava dados. Obrigatórios.
schedule	<xref:search_service_client.models.IndexingSchedule> O agendamento para esse indexador.
parameters	<xref:search_service_client.models.IndexingParameters> Parâmetros para execução do indexador.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] Define mapeamentos entre campos na fonte de dados e campos de destino correspondentes no índice.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] Os mapeamentos de campo de saída são aplicados após o enriquecimento e imediatamente antes da indexação.
is_disabled	bool Um valor que indica se o indexador está desabilitado. O padrão é false.
e_tag	str A ETag do indexador.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição do indexador (bem como a execução do indexador status) quando você deseja ter total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-los. Depois de criptografar a definição do indexador, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; A definição do indexador (e a status de execução do indexador) não serão afetadas. 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 a partir de 1º de janeiro de 2019.

Variáveis

Nome	Description
name	str o nome do indexador. Obrigatórios.
description	str A descrição do indexador.
data_source_name	str O nome da fonte de dados da qual esse indexador lê dados. Obrigatórios.
skillset_name	str O nome do conjunto de habilidades em execução com esse indexador.
target_index_name	str O nome do índice no qual esse indexador grava dados. Obrigatórios.
schedule	<xref:search_service_client.models.IndexingSchedule> O agendamento para esse indexador.
parameters	<xref:search_service_client.models.IndexingParameters> Parâmetros para execução do indexador.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] Define mapeamentos entre campos na fonte de dados e campos de destino correspondentes no índice.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] Os mapeamentos de campo de saída são aplicados após o enriquecimento e imediatamente antes da indexação.
is_disabled	bool Um valor que indica se o indexador está desabilitado. O padrão é false.
e_tag	str A ETag do indexador.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição do indexador (bem como a execução do indexador status) quando você deseja ter total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-los. Depois de criptografar a definição do indexador, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; A definição do indexador (e a status de execução do indexador) não serão afetadas. 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 a partir de 1º de janeiro de 2019.

Métodos

as_dict	Retornar um dict que pode ser serializado usando json.dump. Opcionalmente, o uso avançado pode usar um retorno de chamada como parâmetro: Key é o nome do atributo usado no Python. Attr_desc é um dict 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 dict que pode ser serializado usando json.dump.

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

Key é o nome do atributo usado no Python. Attr_desc é um dict 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 dict

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 dict