IndexingResult Třída
Stav operace indexování pro jeden dokument
Proměnné jsou naplněné pouze serverem a při odesílání požadavku budou ignorovány.
Aby bylo možné odesílat do Azure, musí být vyplněny všechny požadované parametry.
- Dědičnost
-
azure.search.documents._generated._serialization.ModelIndexingResult
Konstruktor
IndexingResult(**kwargs: Any)
Proměnné
Name | Description |
---|---|
key
|
Klíč dokumentu, který byl v požadavku na indexování. Povinná hodnota. |
error_message
|
Chybová zpráva vysvětlující, proč operace indexování selhala pro dokument identifikovaný klíčem; null, pokud bylo indexování úspěšné. |
succeeded
|
Hodnota označující, jestli byla operace indexování pro dokument identifikovaný klíčem úspěšná. Povinná hodnota. |
status_code
|
Stavový kód operace indexování. Mezi možné hodnoty patří: 200 pro úspěšnou aktualizaci nebo odstranění, 201 pro úspěšné vytvoření dokumentu, 400 pro poškozený vstupní dokument, 404 pro dokument nebyl nalezen, 409 pro konflikt verze, 422, pokud je index dočasně nedostupný nebo 503 pro případě, že je služba příliš zaneprázdněná. Povinná hodnota. |
Metody
as_dict |
Vrátí dikt, který je možné serializovat pomocí json.dump. Rozšířené použití může jako parametr volitelně použít zpětné volání: Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. Aktuálně obsahuje 'type' s typem msrest a 'key' s klíčem kódovaným RestAPI. Value je aktuální hodnota v tomto objektu. Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se to za hierarchický dikt výsledku. Podívejte se na tři příklady v tomto souboru:
Pokud chcete serializaci XML, můžete předat kwargs is_xml=True. |
deserialize |
Parsujte str pomocí syntaxe RestAPI a vraťte model. |
enable_additional_properties_sending | |
from_dict |
Parsování diktování pomocí daného extraktoru klíčů vrátí model. Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a last_rest_key_case_insensitive_extractor). |
is_xml_model | |
serialize |
Vrátí kód JSON, který by se z tohoto modelu odeslal na server. Toto je alias pro as_dict(full_restapi_key_transformer, keep_readonly=False). Pokud chcete serializaci XML, můžete předat kwargs is_xml=True. |
as_dict
Vrátí dikt, který je možné serializovat pomocí json.dump.
Rozšířené použití může jako parametr volitelně použít zpětné volání:
Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. Aktuálně obsahuje 'type' s typem msrest a 'key' s klíčem kódovaným RestAPI. Value je aktuální hodnota v tomto objektu.
Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se to za hierarchický dikt výsledku.
Podívejte se na tři příklady v tomto souboru:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Pokud chcete serializaci XML, můžete předat 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]
Parametry
Name | Description |
---|---|
key_transformer
|
<xref:function>
Funkce klíčového transformátoru. |
keep_readonly
|
výchozí hodnota: True
|
Návraty
Typ | Description |
---|---|
Objekt kompatibilní se dict JSON |
deserialize
Parsujte str pomocí syntaxe RestAPI a vraťte model.
deserialize(data: Any, content_type: str | None = None) -> ModelType
Parametry
Name | Description |
---|---|
data
Vyžadováno
|
Str využívající strukturu RestAPI. Json ve výchozím nastavení. |
content_type
|
Ve výchozím nastavení JSON nastavte application/xml, pokud XML. výchozí hodnota: None
|
Návraty
Typ | Description |
---|---|
Instance tohoto modelu |
Výjimky
Typ | Description |
---|---|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> None
from_dict
Parsování diktování pomocí daného extraktoru klíčů vrátí model.
Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a 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
Parametry
Name | Description |
---|---|
data
Vyžadováno
|
A dict using RestAPI structure |
content_type
|
Ve výchozím nastavení JSON nastavte application/xml, pokud XML. výchozí hodnota: None
|
key_extractors
|
výchozí hodnota: None
|
Návraty
Typ | Description |
---|---|
Instance tohoto modelu |
Výjimky
Typ | Description |
---|---|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> bool
serialize
Vrátí kód JSON, který by se z tohoto modelu odeslal na server.
Toto je alias pro as_dict(full_restapi_key_transformer, keep_readonly=False).
Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]
Parametry
Name | Description |
---|---|
keep_readonly
|
Pokud chcete serializovat atributy readonly výchozí hodnota: False
|
Návraty
Typ | Description |
---|---|
Objekt kompatibilní se dict JSON |
Azure SDK for Python