SearchResponse Třída
Definuje objekt nejvyšší úrovně, který odpověď zahrnuje, když je požadavek úspěšný.
Proměnné jsou naplněny 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.cognitiveservices.search.websearch.models._models_py3.ResponseSearchResponse
Konstruktor
SearchResponse(**kwargs)
Parametry
Name | Description |
---|---|
_type
Vyžadováno
|
Povinná hodnota. Konstanta vyplněná serverem. |
Proměnné
Name | Description |
---|---|
id
|
Identifikátor řetězce. |
web_search_url
|
Výsledek hledání adresy URL bingu pro tuto položku. |
query_context
|
Objekt, který obsahuje řetězec dotazu, který Bing použil pro požadavek. Tento objekt obsahuje řetězec dotazu zadaný uživatelem. Může také obsahovat změněný řetězec dotazu, který bing použil pro dotaz, pokud řetězec dotazu obsahoval pravopisnou chybu. |
web_pages
|
Seznam webových stránek, které jsou relevantní pro vyhledávací dotaz. |
images
|
Seznam obrázků, které jsou relevantní pro vyhledávací dotaz. |
news
|
Seznam zpravodajských článků, které jsou relevantní pro vyhledávací dotaz. |
related_searches
|
Seznam souvisejících dotazů, které vytvořili jiní uživatelé. |
spell_suggestions
|
Řetězec dotazu, který pravděpodobně představuje záměr uživatele. |
time_zone
|
Datum a čas jednoho nebo více geografických míst. |
videos
|
Seznam videí, která jsou relevantní pro vyhledávací dotaz. |
computation
|
Odpověď na matematický výraz nebo převod jednotek. |
ranking_response
|
Pořadí, ve kterém Bing navrhuje, abyste zobrazili výsledky hledání. |
Metody
as_dict |
Vrátí dikt, který může být JSONify pomocí json.dump. Rozšířené využití může volitelně použít zpětné volání jako parametr: Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. V současné době obsahuje "type" s typem msrest a "key" s klíčem kódovaným restAPI. Hodnota 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 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 |
Analýza diktu 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ý se z tohoto modelu odešle do Azure. 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. |
validate |
Rekurzivně ověřte tento model a vraťte seznam ValidationError. |
as_dict
Vrátí dikt, který může být JSONify pomocí json.dump.
Rozšířené využití může volitelně použít zpětné volání jako parametr:
Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. V současné době obsahuje "type" s typem msrest a "key" s klíčem kódovaným restAPI. Hodnota 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 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=True, key_transformer=<function attribute_transformer>, **kwargs)
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í s diktem JSON |
deserialize
Parsujte str pomocí syntaxe RestAPI a vraťte model.
deserialize(data, content_type=None)
Parametry
Name | Description |
---|---|
data
Vyžadováno
|
Str používající strukturu RestAPI. Ve výchozím nastavení JSON. |
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()
from_dict
Analýza diktu 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, key_extractors=None, content_type=None)
Parametry
Name | Description |
---|---|
data
Vyžadováno
|
Diktování pomocí struktury RestAPI |
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()
serialize
Vrátí kód JSON, který se z tohoto modelu odešle do Azure.
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=False, **kwargs)
Parametry
Name | Description |
---|---|
keep_readonly
|
Pokud chcete serializovat atributy readonly výchozí hodnota: False
|
Návraty
Typ | Description |
---|---|
Objekt kompatibilní s diktem JSON |
validate
Rekurzivně ověřte tento model a vraťte seznam ValidationError.
validate()
Návraty
Typ | Description |
---|---|
Seznam chyb ověření |
Azure SDK for Python