IndexingResult Classe
État d’une opération d’indexation pour un seul document.
Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.
Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.
- Héritage
-
azure.search.documents._generated._serialization.ModelIndexingResult
Constructeur
IndexingResult(**kwargs: Any)Variables
| Nom | Description |
|---|---|
|
key
|
Clé d’un document qui se trouvait dans la demande d’indexation. Obligatoire. |
|
error_message
|
Message d’erreur expliquant pourquoi l’opération d’indexation a échoué pour le document identifié par la clé ; Null si l’indexation a réussi. |
|
succeeded
|
Valeur indiquant si l’opération d’indexation a réussi pour le document identifié par la clé. Obligatoire. |
|
status_code
|
Code status de l’opération d’indexation. Les valeurs possibles sont les suivantes : 200 pour une mise à jour ou une suppression réussie, 201 pour une création de document réussie, 400 pour un document d’entrée mal formé, 404 pour un document introuvable, 409 pour un conflit de version, 422 lorsque l’index est temporairement indisponible ou 503 pour lorsque le service est trop occupé. Obligatoire. |
Méthodes
| as_dict |
Retourne un dict 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 une 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 de cet objet. La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, il est considéré comme un dict de résultat hiérarchique. Consultez les trois exemples de ce fichier :
Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True. |
| deserialize |
Analysez une str à l’aide de la syntaxe RestAPI et retournez un modèle. |
| enable_additional_properties_sending | |
| from_dict |
Analyser une 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 la sérialisation XML, vous pouvez passer les kwargs is_xml=True. |
as_dict
Retourne un dict 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 une 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 de cet objet.
La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, il 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 la 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 |
|---|---|
|
Objet compatible JSON dict |
deserialize
Analysez une str à l’aide de la syntaxe RestAPI et retournez un modèle.
deserialize(data: Any, content_type: str | None = None) -> ModelTypeParamètres
| Nom | Description |
|---|---|
|
data
Obligatoire
|
Str utilisant la structure RestAPI. JSON par défaut. |
|
content_type
|
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() -> Nonefrom_dict
Analyser une 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) -> ModelTypeParamètres
| Nom | Description |
|---|---|
|
data
Obligatoire
|
dict utilisant la structure RestAPI |
|
content_type
|
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() -> boolserialize
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 la 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
|
Si vous souhaitez sérialiser les attributs readonly valeur par défaut: False
|
Retours
| Type | Description |
|---|---|
|
Objet compatible JSON dict |
Azure SDK for Python