IndexingResult Classe

Stato di un'operazione di indicizzazione per un singolo documento.

Le variabili vengono popolate solo dal server e verranno ignorate durante l'invio di una richiesta.

Tutti i parametri obbligatori devono essere popolati per l'invio ad Azure.

Ereditarietà

azure.search.documents._generated._serialization.Model

IndexingResult

Costruttore

IndexingResult(**kwargs: Any)

Variabili

Nome	Descrizione
key	str Chiave di un documento incluso nella richiesta di indicizzazione. Obbligatorio.
error_message	str Messaggio di errore che spiega perché l'operazione di indicizzazione non è riuscita per il documento identificato dalla chiave; Null se l'indicizzazione è riuscita.
succeeded	bool Valore che indica se l'operazione di indicizzazione è riuscita per il documento identificato dalla chiave. Obbligatorio.
status_code	int Codice di stato dell'operazione di indicizzazione. I valori possibili includono: 200 per un aggiornamento o un'eliminazione corretta, 201 per la creazione corretta del documento, 400 per un documento di input in formato non valido, 404 per il documento non trovato, 409 per un conflitto di versione, 422 quando l'indice non è temporaneamente disponibile o 503 per quando il servizio è troppo occupato. Obbligatorio.

Metodi

as_dict	Restituisce un dict che può essere serializzato usando json.dump. L'utilizzo avanzato può facoltativamente usare un callback come parametro: Key è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Value è il valore corrente in questo oggetto. La stringa restituita verrà utilizzata per serializzare la chiave. Se il tipo restituito è un elenco, si tratta di un risultato gerarchico dict. Vedere i tre esempi in questo file: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True.
deserialize	Analizzare uno str usando la sintassi RestAPI e restituire un modello.
enable_additional_properties_sending
from_dict	Analizzare un dict usando un estrattore di chiave specificato restituisce un modello. Per impostazione predefinita, considerare gli estrattori di chiave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Restituisce il codice JSON che verrebbe inviato al server da questo modello. Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False). Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True.

as_dict

Restituisce un dict che può essere serializzato usando json.dump.

L'utilizzo avanzato può facoltativamente usare un callback come parametro:

Key è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Value è il valore corrente in questo oggetto.

La stringa restituita verrà utilizzata per serializzare la chiave. Se il tipo restituito è un elenco, si tratta di un risultato gerarchico dict.

Vedere i tre esempi in questo file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Se si desidera la serializzazione XML, è possibile passare i 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]

Parametri

Nome	Descrizione
key_transformer	<xref:function> Funzione di trasformatore di tasti.
keep_readonly	valore predefinito: True

Restituisce

Tipo	Descrizione
dict	Oggetto compatibile con JSON dict

deserialize

Analizzare uno str usando la sintassi RestAPI e restituire un modello.

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

Parametri

Nome	Descrizione
data Necessario	str Str che usa la struttura RestAPI. JSON per impostazione predefinita.
content_type	str JSON per impostazione predefinita, impostare application/xml se XML. valore predefinito: None

Restituisce

Tipo	Descrizione
	Istanza di questo modello

Eccezioni

Tipo	Descrizione
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Analizzare un dict usando un estrattore di chiave specificato restituisce un modello.

Per impostazione predefinita, considerare gli estrattori di chiave (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

Parametri

Nome	Descrizione
data Necessario	dict Oggetto dict using RestAPI structure (Struttura RESTAPI)
content_type	str JSON per impostazione predefinita, impostare application/xml se XML. valore predefinito: None
key_extractors	valore predefinito: None

Restituisce

Tipo	Descrizione
	Istanza di questo modello

Eccezioni

Tipo	Descrizione
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Restituisce il codice JSON che verrebbe inviato al server da questo modello.

Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False).

Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True.

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

Parametri

Nome	Descrizione
keep_readonly	bool Se si desidera serializzare gli attributi readonly valore predefinito: False

Restituisce

Tipo	Descrizione
dict	Oggetto compatibile con JSON dict