SearchIndexer Classe

Représente un indexeur.

Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.

Héritage

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

SearchIndexer

Constructeur

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)

Paramètres de mots-clés uniquement

Nom	Description
name	str Nom de l'indexeur. Obligatoire.
description	str Description de l’indexeur.
data_source_name	str Nom de la source de données à partir de laquelle cet indexeur lit les données. Obligatoire.
skillset_name	str Nom de l’ensemble de compétences s’exécutant avec cet indexeur.
target_index_name	str Nom de l’index dans lequel cet indexeur écrit les données. Obligatoire.
schedule	<xref:search_service_client.models.IndexingSchedule> Planification de cet indexeur.
parameters	<xref:search_service_client.models.IndexingParameters> Paramètres pour l’exécution de l’indexeur.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] Définit des mappages entre les champs de la source de données et les champs cibles correspondants dans l’index.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] Les mappages de champs de sortie sont appliqués après l’enrichissement et immédiatement avant l’indexation.
is_disabled	bool Valeur indiquant si l’indexeur est désactivé. La valeur par défaut est false.
e_tag	str ETag de l’indexeur.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé est utilisée pour fournir un niveau supplémentaire de chiffrement au repos pour votre définition d’indexeur (ainsi que l’exécution de l’indexeur status) lorsque vous souhaitez avoir l’assurance complète que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré votre définition d’indexeur, elle reste toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si nécessaire si vous souhaitez faire pivoter votre clé de chiffrement ; Votre définition de l’indexeur (et l’exécution de l’indexeur status) ne seront pas affectées. Le chiffrement avec des clés gérées par le client n’est pas disponible pour les services de recherche gratuits et est uniquement disponible pour les services payants créés à partir du 1er janvier 2019.

Variables

Nom	Description
name	str Nom de l'indexeur. Obligatoire.
description	str Description de l’indexeur.
data_source_name	str Nom de la source de données à partir de laquelle cet indexeur lit les données. Obligatoire.
skillset_name	str Nom de l’ensemble de compétences s’exécutant avec cet indexeur.
target_index_name	str Nom de l’index dans lequel cet indexeur écrit les données. Obligatoire.
schedule	<xref:search_service_client.models.IndexingSchedule> Planification de cet indexeur.
parameters	<xref:search_service_client.models.IndexingParameters> Paramètres pour l’exécution de l’indexeur.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] Définit des mappages entre les champs de la source de données et les champs cibles correspondants dans l’index.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] Les mappages de champs de sortie sont appliqués après l’enrichissement et immédiatement avant l’indexation.
is_disabled	bool Valeur indiquant si l’indexeur est désactivé. La valeur par défaut est false.
e_tag	str ETag de l’indexeur.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé est utilisée pour fournir un niveau supplémentaire de chiffrement au repos pour votre définition d’indexeur (ainsi que l’exécution de l’indexeur status) lorsque vous souhaitez avoir l’assurance complète que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré votre définition d’indexeur, elle reste toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si nécessaire si vous souhaitez faire pivoter votre clé de chiffrement ; Votre définition de l’indexeur (et l’exécution de l’indexeur status) ne seront pas affectées. Le chiffrement avec des clés gérées par le client n’est pas disponible pour les services de recherche gratuits et est uniquement disponible pour les services payants créés à partir du 1er janvier 2019.

Méthodes

as_dict	Retourne un dictée qui peut être sérialisé à l’aide de json.dump. L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre : La clé est le nom d’attribut utilisé dans Python. Attr_desc est un dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle dans cet objet. La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, cela est considéré comme un dicté de résultat hiérarchique. Consultez les trois exemples de ce fichier : attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Si vous souhaitez une sérialisation XML, vous pouvez passer les kwargs is_xml=True.
deserialize	Analysez un str à l’aide de la syntaxe RestAPI et retournez un modèle.
enable_additional_properties_sending
from_dict	L’analyse d’un dicté à l’aide de l’extracteur de clé donné retourne un modèle. Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Retourne le json qui serait envoyé au serveur à partir de ce modèle. Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False). Si vous souhaitez une sérialisation XML, vous pouvez passer les kwargs is_xml=True.

as_dict

Retourne un dictée qui peut être sérialisé à l’aide de json.dump.

L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre :

La clé est le nom d’attribut utilisé dans Python. Attr_desc est un dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle dans cet objet.

La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, cela est considéré comme un dicté de résultat hiérarchique.

Consultez les trois exemples de ce fichier :

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Si vous souhaitez une sérialisation XML, vous pouvez passer les 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]

Paramètres

Nom	Description
key_transformer	<xref:function> Fonction de transformateur de clé.
keep_readonly	valeur par défaut: True

Retours

Type	Description
dict	Objet compatible JSON de dict

deserialize

Analysez un str à l’aide de la syntaxe RestAPI et retournez un modèle.

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

Paramètres

Nom	Description
data Obligatoire	str Str utilisant la structure RestAPI. JSON par défaut.
content_type	str JSON par défaut, définissez application/xml si XML. valeur par défaut: None

Retours

Type	Description
	Une instance de ce modèle

Exceptions

Type	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

L’analyse d’un dicté à l’aide de l’extracteur de clé donné retourne un modèle.

Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et 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

Paramètres

Nom	Description
data Obligatoire	dict Dict utilisant la structure RestAPI
content_type	str JSON par défaut, définissez application/xml si XML. valeur par défaut: None
key_extractors	valeur par défaut: None

Retours

Type	Description
	Une instance de ce modèle

Exceptions

Type	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Retourne le json qui serait envoyé au serveur à partir de ce modèle.

Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False).

Si vous souhaitez une sérialisation XML, vous pouvez passer les kwargs is_xml=True.

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

Paramètres

Nom	Description
keep_readonly	bool Si vous souhaitez sérialiser les attributs readonly valeur par défaut: False

Retours

Type	Description
dict	Objet compatible JSON de dict