QueryCaptionResult Třída

Titulky jsou nejreprezentativnější pasáže z dokumentu relativně k vyhledávacímu dotazu. Často se používají jako souhrn dokumentů. Titulky se vrátí pouze pro dotazy typu semantic.

Proměnné jsou naplněné pouze serverem a při odesílání požadavku budou ignorovány.

Dědičnost

azure.search.documents._generated._serialization.Model

QueryCaptionResult

Konstruktor

QueryCaptionResult(*, additional_properties: Dict[str, Any] | None = None, **kwargs: Any)

Výhradně parametry klíčových slov

Name	Description
additional_properties	dict[str, any] Chybějící vlastnosti zprávy jsou deserializovány do této kolekce.

Proměnné

Name	Description
additional_properties	dict[str, any] Chybějící vlastnosti zprávy jsou deserializovány do této kolekce.
text	str Reprezentativní textová pasáž extrahovaná z dokumentu, který je pro vyhledávací dotaz nejrelevativnější.
highlights	str Stejný text jako ve vlastnosti Text se zvýrazněnými frázemi, které jsou pro dotaz nejrelevantní.

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: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer 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
dict	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 Str využívající strukturu RestAPI. Json ve výchozím nastavení.
content_type	str 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	dict A dict using RestAPI structure
content_type	str 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	bool Pokud chcete serializovat atributy readonly výchozí hodnota: False

Návraty

Typ	Description
dict	Objekt kompatibilní se dict JSON