SearchIndexer Clase

Representa un indexador.

Todos los parámetros necesarios deben rellenarse para enviarlos a Azure.

Herencia

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

SearchIndexer

Constructor

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 solo palabra clave

Nombre	Description
name	str El nombre del indizador. Necesario.
description	str Descripción del indexador.
data_source_name	str Nombre del origen de datos del que este indexador lee los datos. Necesario.
skillset_name	str Nombre del conjunto de aptitudes que se ejecuta con este indexador.
target_index_name	str Nombre del índice en el que este indexador escribe datos. Necesario.
schedule	<xref:search_service_client.models.IndexingSchedule> La programación de este indexador.
parameters	<xref:search_service_client.models.IndexingParameters> Parámetros para la ejecución del indexador.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] Define las asignaciones entre los campos del origen de datos y los campos de destino correspondientes del índice.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] Las asignaciones de campos de salida se aplican después del enriquecimiento e inmediatamente antes de la indexación.
is_disabled	bool Valor que indica si el indexador está deshabilitado. El valor predeterminado es False.
e_tag	str ETag del indexador.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se usa para proporcionar un nivel adicional de cifrado en reposo para la definición del indizador (así como el estado de ejecución del indexador) cuando desea asegurarse de que nadie, ni siquiera Microsoft, puede descifrarlos. Una vez que haya cifrado la definición del indexador, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puede cambiar esta propiedad según sea necesario si desea rotar la clave de cifrado; La definición del indexador (y el estado de ejecución del indexador) no se verán afectadas. El cifrado con claves administradas por el cliente no está disponible para los servicios de búsqueda gratuitos y solo está disponible para los servicios de pago creados el 1 de enero de 2019 o después.

Variables

Nombre	Description
name	str El nombre del indizador. Necesario.
description	str Descripción del indexador.
data_source_name	str Nombre del origen de datos del que este indexador lee los datos. Necesario.
skillset_name	str Nombre del conjunto de aptitudes que se ejecuta con este indexador.
target_index_name	str Nombre del índice en el que este indexador escribe datos. Necesario.
schedule	<xref:search_service_client.models.IndexingSchedule> La programación de este indexador.
parameters	<xref:search_service_client.models.IndexingParameters> Parámetros para la ejecución del indexador.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] Define las asignaciones entre los campos del origen de datos y los campos de destino correspondientes del índice.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] Las asignaciones de campos de salida se aplican después del enriquecimiento e inmediatamente antes de la indexación.
is_disabled	bool Valor que indica si el indexador está deshabilitado. El valor predeterminado es False.
e_tag	str ETag del indexador.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se usa para proporcionar un nivel adicional de cifrado en reposo para la definición del indizador (así como el estado de ejecución del indexador) cuando desea asegurarse de que nadie, ni siquiera Microsoft, puede descifrarlos. Una vez que haya cifrado la definición del indexador, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puede cambiar esta propiedad según sea necesario si desea rotar la clave de cifrado; La definición del indexador (y el estado de ejecución del indexador) no se verán afectadas. El cifrado con claves administradas por el cliente no está disponible para los servicios de búsqueda gratuitos y solo está disponible para los servicios de pago creados el 1 de enero de 2019 o después.

Métodos

as_dict	Devuelve un dict que se puede serializar mediante json.dump. El uso avanzado podría usar opcionalmente una devolución de llamada como parámetro: Key es el nombre de atributo que se usa en Python. Attr_desc es un dict de metadatos. Actualmente contiene 'type' con el tipo msrest y 'key' con la clave codificada restAPI. Value es el valor actual de este objeto. La cadena devuelta se usará para serializar la clave. Si el tipo de valor devuelto es una lista, se considera dict de resultados jerárquicos. Consulte los tres ejemplos de este archivo: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Si desea serialización XML, puede pasar los kwargs is_xml=True.
deserialize	Analice una cadena mediante la sintaxis restAPI y devuelva un modelo.
enable_additional_properties_sending
from_dict	Analizar un dict mediante un extractor de claves dado devuelve un modelo. De forma predeterminada, considere la posibilidad de extractores de claves (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor y last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Devuelve el JSON que se enviaría al servidor desde este modelo. Se trata de un alias para as_dict(full_restapi_key_transformer, keep_readonly=False). Si desea serialización XML, puede pasar los kwargs is_xml=True.

as_dict

Devuelve un dict que se puede serializar mediante json.dump.

El uso avanzado podría usar opcionalmente una devolución de llamada como parámetro:

Key es el nombre de atributo que se usa en Python. Attr_desc es un dict de metadatos. Actualmente contiene 'type' con el tipo msrest y 'key' con la clave codificada restAPI. Value es el valor actual de este objeto.

La cadena devuelta se usará para serializar la clave. Si el tipo de valor devuelto es una lista, se considera dict de resultados jerárquicos.

Consulte los tres ejemplos de este archivo:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Si desea serialización XML, puede pasar los 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

Nombre	Description
key_transformer	<xref:function> Una función de transformador de teclas.
keep_readonly	valor predeterminado: True

Devoluciones

Tipo	Description
dict	Un objeto compatible con JSON dict

deserialize

Analice una cadena mediante la sintaxis restAPI y devuelva un modelo.

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

Parámetros

Nombre	Description
data Requerido	str Una cadena de datos mediante la estructura restAPI. JSON de forma predeterminada.
content_type	str JSON de forma predeterminada, establezca application/xml si XML. valor predeterminado: None

Devoluciones

Tipo	Description
	Una instancia de este modelo

Excepciones

Tipo	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Analizar un dict mediante un extractor de claves dado devuelve un modelo.

De forma predeterminada, considere la posibilidad de extractores de claves (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor y 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

Nombre	Description
data Requerido	dict Un dict mediante la estructura restAPI
content_type	str JSON de forma predeterminada, establezca application/xml si XML. valor predeterminado: None
key_extractors	valor predeterminado: None

Devoluciones

Tipo	Description
	Una instancia de este modelo

Excepciones

Tipo	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Devuelve el JSON que se enviaría al servidor desde este modelo.

Se trata de un alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Si desea serialización XML, puede pasar los kwargs is_xml=True.

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

Parámetros

Nombre	Description
keep_readonly	bool Si desea serializar los atributos de solo lectura valor predeterminado: False

Devoluciones

Tipo	Description
dict	Un objeto compatible con JSON dict