IndexingResult Klass

Status för en indexeringsåtgärd för ett enskilt dokument.

Variabler fylls bara i av servern och ignoreras när en begäran skickas.

Alla obligatoriska parametrar måste fyllas i för att kunna skickas till Azure.

Arv

azure.search.documents._generated._serialization.Model

IndexingResult

Konstruktor

IndexingResult(**kwargs: Any)

Variabler

Name	Description
key	str Nyckeln för ett dokument som fanns i indexeringsbegäran. Krävs.
error_message	str Felmeddelandet som förklarar varför indexeringsåtgärden misslyckades för dokumentet som identifieras av nyckeln. null om indexeringen lyckades.
succeeded	bool Ett värde som anger om indexeringsåtgärden lyckades för dokumentet som identifieras av nyckeln. Krävs.
status_code	int Statuskoden för indexeringsåtgärden. Möjliga värden är: 200 för en lyckad uppdatering eller borttagning, 201 för lyckat dokumentskapande, 400 för ett felaktigt indatadokument, 404 för dokumentet hittades inte, 409 för en versionskonflikt, 422 när indexet är tillfälligt otillgängligt eller 503 för när tjänsten är för upptagen. Krävs.

Metoder

as_dict	Returnera en diktamen som kan serialiseras med json.dump. Avancerad användning kan också använda ett återanrop som parameter: Nyckeln är det attributnamn som används i Python. Attr_desc är en diktering av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med den RestAPI-kodade nyckeln. Värde är det aktuella värdet i det här objektet. Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt. Se de tre exemplen i den här filen: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.
deserialize	Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell.
enable_additional_properties_sending
from_dict	Parsa en diktamen med hjälp av den angivna nyckelextraktorn returnerar en modell. Som standard bör du överväga nyckelextraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Returnera den JSON som skulle skickas till servern från den här modellen. Det här är ett alias för as_dict(full_restapi_key_transformer, keep_readonly=False). Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

as_dict

Returnera en diktamen som kan serialiseras med json.dump.

Avancerad användning kan också använda ett återanrop som parameter:

Nyckeln är det attributnamn som används i Python. Attr_desc är en diktering av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med den RestAPI-kodade nyckeln. Värde är det aktuella värdet i det här objektet.

Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt.

Se de tre exemplen i den här filen:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Om du vill ha XML-serialisering kan du skicka 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]

Parametrar

Name	Description
key_transformer	<xref:function> En nyckeltransformatorfunktion.
keep_readonly	standardvärde: True

Returer

Typ	Description
dict	Ett dict JSON-kompatibelt objekt

deserialize

Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell.

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

Parametrar

Name	Description
data Obligatorisk	str En str som använder RestAPI-struktur. JSON som standard.
content_type	str JSON anger som standard application/xml om XML. standardvärde: None

Returer

Typ	Description
	En instans av den här modellen

Undantag

Typ	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Parsa en diktamen med hjälp av den angivna nyckelextraktorn returnerar en modell.

Som standard bör du överväga nyckelextraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och 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

Parametrar

Name	Description
data Obligatorisk	dict En diktamen som använder RestAPI-struktur
content_type	str JSON anger som standard application/xml om XML. standardvärde: None
key_extractors	standardvärde: None

Returer

Typ	Description
	En instans av den här modellen

Undantag

Typ	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Returnera den JSON som skulle skickas till servern från den här modellen.

Det här är ett alias för as_dict(full_restapi_key_transformer, keep_readonly=False).

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

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

Parametrar

Name	Description
keep_readonly	bool Om du vill serialisera skrivskyddade attribut standardvärde: False

Returer

Typ	Description
dict	Ett dict JSON-kompatibelt objekt