WebOperations Třída
Operace WebOperations.
Neměli byste vytvořit instanci přímo této třídy, ale vytvořit instanci klienta, která ji vytvoří pro vás a připojí ji jako atribut.
- Dědičnost
-
builtins.objectWebOperations
Konstruktor
WebOperations(client, config, serializer, deserializer)Parametry
- client
Klient pro žádosti o služby.
- config
Konfigurace klienta služby.
- serializer
Serializátor objektového modelu.
- deserializer
Deserializátor objektového modelu.
Proměnné
- x_bing_apis_sdk
Aktivace dodržování předpisů swaggerem Konstantní hodnota: "true".
Metody
| search |
Rozhraní API pro vyhledávání na webu umožňuje odeslat vyhledávací dotaz do Bingu a získat zpět výsledky hledání, které obsahují odkazy na webové stránky, obrázky a další. |
search
Rozhraní API pro vyhledávání na webu umožňuje odeslat vyhledávací dotaz do Bingu a získat zpět výsledky hledání, které obsahují odkazy na webové stránky, obrázky a další.
search(query, accept_language=None, pragma=None, user_agent=None, client_id=None, client_ip=None, location=None, answer_count=None, country_code=None, count=None, freshness=None, market='en-us', offset=None, promote=None, response_filter=None, safe_search=None, set_lang=None, text_decorations=None, text_format=None, custom_headers=None, raw=False, **operation_config)Parametry
- query
- str
Termín hledaného dotazu uživatele. Termín nemusí být prázdný. Termín může obsahovat Rozšířené operátory Bingu. Pokud například chcete omezit výsledky na určitou doménu, použijte operátor site:.
- accept_language
- str
Seznam jednoho nebo více jazyků oddělených čárkami, které se mají použít pro řetězce uživatelského rozhraní. Seznam je v sestupném pořadí podle priority. Další informace, včetně očekávaného formátu, najdete v tématu RFC2616. Tato hlavička a parametr dotazu setLang se vzájemně vylučují; nezadávejte obojí. Pokud tuto hlavičku nastavíte, musíte zadat také parametr dotazu cc. Bing použije první podporovaný jazyk, který najde v seznamu, a zkombinuje tento jazyk s hodnotou parametru cc, aby určil trh, pro který se mají vracet výsledky. Pokud seznam neobsahuje podporovaný jazyk, Bing najde nejbližší jazyk a trh, který požadavek podporuje, a může pro výsledky místo zadaného trhu použít agregovaný nebo výchozí trh. Tuto hlavičku a parametr dotazu cc byste měli použít pouze v případě, že zadáte více jazyků; jinak byste měli použít parametry dotazu mkt a setLang. Řetězec uživatelského rozhraní je řetězec, který se používá jako popisek v uživatelském rozhraní. V objektech odpovědi JSON je velmi málo řetězců uživatelského rozhraní. Všechny odkazy v objektech odpovědi na Bing.com vlastnosti použijí zadaný jazyk.
- pragma
- str
Ve výchozím nastavení Bing vrátí obsah uložený v mezipaměti, pokud je k dispozici. Abyste Bingu zabránili ve vrácení obsahu uloženého v mezipaměti, hlavičku Pragma nastavte na hodnotu no-cache (například Pragma: no-cache).
- user_agent
- str
Uživatelský agent, ze kterého požadavek pochází. Bing používá uživatelského agenta k poskytnutí optimalizovaného prostředí pro mobilní uživatele. I když je tato hlavička volitelná, důrazně doporučujeme tuto hlavičku zadat vždy. Uživatelský agent by měl být stejný řetězec, který by odeslal jakýkoli běžně používaný prohlížeč. Informace o uživatelských agentech najdete v RFC 2616.
- client_id
- str
Bing tuto hlavičku používá k tomu, aby uživatelům poskytoval konzistentní chování napříč voláními rozhraní API Bingu. Bing často testuje nové funkce a vylepšení a ID klienta používá jako klíč pro přiřazení provozu v různých testovacích verzích. Pokud nepoužíváte stejné ID klienta pro uživatele napříč více požadavky, pak může Bing uživatele přiřadit k více konfliktním testovacím verzím. Přiřazení k více konfliktním testovacím verzím může vést k nekonzistentnímu prostředí pro uživatele. Pokud třeba druhý požadavek má jiné přiřazení k testovací verzi než prví, může být prostředí neočekávané. Bing může také použít ID klienta k přizpůsobení webových výsledků historii hledání daného ID klienta, což uživateli poskytuje bohatší prostředí. Bing také tuto hlavičku používá ke zlepšování hodnocení výsledků díky analýze aktivity generované tímto ID klienta. Zlepšení relevance pomáhá zlepšit kvalitu výsledků poskytovaných rozhraním API Bingu a stejně tak umožňuje vyšší míru prokliků uživatele rozhraní API. DŮLEŽITÉ: I když je tato hlavička nepovinná, měli byste ji považovat za povinnou. Zachování ID klienta mezi více požadavky pro stejnou kombinaci koncového uživatele a zařízení umožňuje 1) aby uživatel rozhraní API získával konzistentní uživatelské prostředí a 2) vyšší míry prokliků díky kvalitnějším výsledkům z rozhraní API Bingu. Každý uživatel, který používá vaši aplikaci na zařízení, musí mít jedinečné ID klienta vygenerované Bingem. Pokud tuto hlavičku do požadavku nezahrnete, Bing vygeneruje ID a vrátí ho v hlavičce odpovědi X-MSEdge ClientID. Tuto hlavičku byste v požadavku zahrnout NEMĚLI jenom v případě, kdy uživatel aplikaci na zařízení používá poprvé. Použijte ID klienta pro každý požadavek rozhraní API Bingu, který vaše aplikace provede pro tohoto uživatele na zařízení. ID klienta zachovejte. Pokud chcete zachovat ID v aplikaci prohlížeče, použijte trvalý soubor cookie HTTP, aby se zaručilo, že se ID použije ve všech relacích. Nepoužívejte soubor cookie relace. Pro jiné aplikace, jako jsou mobilní aplikace, použijte k zachování ID trvalé úložiště zařízení. Když uživatel aplikaci na zařízení příště použije, získejte ID klienta, které jste zachovali. Odpovědi Bingu můžou nebo nemusí obsahovat tuto hlavičku. Pokud odpověď tuto hlavičku obsahuje, ID klienta zachyťte a použijte pro všechny následné požadavky Bingu pro uživatele na tomto zařízení. Pokud zahrnete X-MSEdge-ClientID, nesmíte do žádosti zahrnout soubory cookie.
- client_ip
- str
Adresa IPv4 nebo IPv6 klientského zařízení. IP adresa se používá ke zjištění polohy uživatele. Bing informace o poloze používá k určení chování bezpečného hledání. I když je to volitelné, doporučujeme vždy zadat tuto hlavičku a hlavičku X-Search-Location. Neprovádějte obfuskaci adresy (například změnou posledního oktetu na 0). Obfuskace adresy vede k tomu, že poloha nebude blízko skutečné polohy zařízení. Bing pak může dodávat chybné výsledky.
- location
- str
Středníky oddělený seznam párů klíč/hodnota, které popisují zeměpisnou polohu klienta. Bing informace o poloze používá k určení chování bezpečného hledání a vracení relevantního místního obsahu. Zadejte dvojici klíč/hodnota jako :. Následují klíče, které se používají k určení polohy uživatele. lat (povinné): zeměpisná šířka umístění klienta ve stupních. Zeměpisná šířka musí být větší nebo rovná -90,0 a menší nebo rovná +90,0. Záporné hodnoty značí jižní šířku a kladné hodnoty značí severní šířku. long (povinné): Zeměpisná délka umístění klienta ve stupních. Zeměpisná délka musí být větší nebo rovná -180,0 a menší nebo rovná +180,0. Záporné hodnoty značí západní délku a kladné hodnoty značí východní délku. re (povinné): Poloměr v metrech, který určuje vodorovnou přesnost souřadnic. Předejte hodnotu vrácenou službou zjišťování polohy zařízení. Typické hodnoty můžou být 22 m pro GPS/Wi-Fi, 380 m pro triangulaci mobilních vysílačů a 18 000 m pro reverzní vyhledávání IP adresy. ts (volitelné): Časové razítko UTC unix, kdy byl klient v umístění. (Časové razítko systému UNIX je počet sekund od 1. ledna 1970.) head (volitelné): Relativní nadpis nebo směr jízdy klienta. Zadejte směr pohybu ve stupních od 0 do 360 ve směru hodinových ručiček vzhledem k severu. Tento klíč zadejte pouze v případě, že je klíč sp nenulový. sp (volitelné): Horizontální rychlost (rychlost) v metrech za sekundu, kterou klientské zařízení cestuje. alt (volitelné): Nadmořská výška klientského zařízení v metrech. are (volitelné): Poloměr v metrech, který určuje svislou přesnost souřadnic. Tento klíč zadejte pouze v případě, že zadáte klávesu Alt. I když je mnoho klíčů volitelných, čím více informací zadáte, tím přesnější jsou výsledky umístění. I když je to volitelné, doporučujeme vždy zadat zeměpisnou polohu uživatele. Poskytnutí polohy je zvlášť důležité, pokud IP adresa klienta přesně neodráží fyzickou polohu uživatele (třeba pokud klient používá síť VPN). Pro dosažení optimálních výsledků byste měli zahrnout tuto hlavičku i hlavičku X-MSEdge ClientIP, minimálně ale aspoň tuto hlavičku.
- answer_count
- int
Počet odpovědí, které má odpověď obsahovat. Odpovědi, které Bing vrátí, jsou založené na hodnocení. Pokud například Bing pro požadavek vrátí webové stránky, obrázky, videa a související hledání a vy nastavíte tento parametr na hodnotu dva (2), odpověď bude zahrnovat webové stránky a obrázky. Pokud jste do stejného požadavku zahrnuli parametr dotazu responseFilter a nastavili ho na webové stránky a zprávy, odpověď by obsahovala jenom webové stránky.
- country_code
- str
Dva znaky kódu země, odkud výsledky pochází. Toto rozhraní API podporuje pouze USA trh. Pokud zadáte tento parametr dotazu, musí být nastaven na nás. Pokud tento parametr nastavíte, musíte zadat také hlavičku Accept-Language. Bing použije první podporovaný jazyk, který najde ze seznamu jazyků, a zkombinuje ho s kódem země, který zadáte, aby určil trh, pro který se mají vracet výsledky. Pokud seznam jazyků neobsahuje podporovaný jazyk, Bing najde nejbližší jazyk a trh, který požadavek podporuje, nebo může pro výsledky místo zadaného trhu použít agregovaný nebo výchozí trh. Měli byste použít tento parametr dotazu a Accept-Language parametr dotazu pouze v případě, že zadáte více jazyků; jinak byste měli použít parametry dotazu mkt a setLang. Tento parametr a parametr dotazu mkt se vzájemně vylučují – nezadávejte obojí.
- count
- int
Počet výsledků hledání, které se mají vrátit v odpovědi. Výchozí hodnota je 10 a maximální hodnota je 50. Skutečné doručované číslo může být menší, než je požadováno. Tento parametr použijte společně s parametrem posunu k stránkovým výsledkům. Pokud například uživatelské rozhraní zobrazí 10 výsledků hledání na stránku, nastavte počet na 10 a posun na 0, aby se získala první stránka výsledků. Pro každou další stránku se posune o 10 (například 0, 10, 20). Je možné, že více stránek obsahuje určité překrývání výsledků.
Výsledky hledání můžete filtrovat podle následujících hodnot věku: Den – vrátí webové stránky, které Bing zjistil během posledních 24 hodin. Týden – vrátí webové stránky, které Bing zjistil během posledních 7 dnů. Měsíc – vrátí webové stránky zjištěné za posledních 30 dnů. Tento filtr se vztahuje pouze na výsledky webové stránky, a ne na ostatní výsledky, jako jsou zprávy a obrázky. Mezi možné hodnoty patří: "Day", 'Week', 'Month'
- market
- str
Trh, odkud pochází výsledky. Mkt je obvykle země, ze které uživatel vytváří požadavek. Může se ale jednat o jinou zemi, pokud uživatel není umístěn v zemi, kde Bing poskytuje výsledky. Trh musí být ve tvaru -. Například cs-CZ. V řetězci se nerozlišují malá a velká písmena. Pokud ho znáte, doporučujeme vždy specifikovat trh. Určení trhu pomáhá Bingu směrovat požadavek a vrátit odpovídající a optimální odpověď. Pokud zadáte trh, který není uvedený v kódech trhu, Bing použije kód trhu, který nejlépe vyhovuje, na základě interního mapování, které se může změnit. Tento parametr a parametr dotazu cc se vzájemně vylučují – nezadávejte oba.
- offset
- int
Posun od nuly, který označuje počet výsledků hledání, které se mají přeskočit před vrácením výsledků. Výchozí hodnota je 0. Posun by měl být menší než (totalEstimatedMatches – count). Tento parametr použijte spolu s parametrem count k zobrazení výsledků stránky. Pokud například uživatelské rozhraní zobrazí 10 výsledků hledání na stránku, nastavte počet na 10 a posun na 0, aby se získala první stránka výsledků. Pro každou další stránku se posune o 10 (například 0, 10, 20). je možné, že více stránek obsahuje určité překrývání výsledků.
- promote
- list[str nebo AnswerType]
Seznam odpovědí oddělených čárkami, které má odpověď obsahovat, bez ohledu na jejich pořadí. Pokud například nastavíte answerCount) na dvě (2), aby Bing vrátil dvě seřazené odpovědi, ale vy chcete, aby odpověď obsahovala i novinky, nastavíte možnost zvýšit úroveň na zprávy. Pokud jsou odpovědi s nejvyšším hodnocením webové stránky, obrázky, videa a související hledání, zahrnuje odpověď webové stránky a obrázky, protože zprávy nejsou seřazenou odpovědí. Pokud ale nastavíte zvýšení úrovně na video, Bing zvýší úroveň odpovědi na video a vrátí webové stránky, obrázky a videa. Odpovědi, které chcete zvýšit, se nezapočítávají do limitu answerCount. Pokud jsou seřazené odpovědi například zprávy, obrázky a videa a vy nastavíte answerCount na 1 a povyšte na zprávy, odpověď bude obsahovat zprávy a obrázky. Nebo pokud jsou seřazené odpovědi videa, obrázky a zprávy, odpověď obsahuje videa a zprávy. Možné hodnoty jsou Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webové stránky. Použijte pouze v případě, že zadáte answerCount.
- response_filter
- list[str nebo AnswerType]
Seznam odpovědí oddělených čárkami, které se mají zahrnout do odpovědi. Pokud tento parametr nezadáte, odpověď bude obsahovat všechny odpovědi hledání, pro které jsou k dispozici relevantní data. Možné hodnoty filtru jsou Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webové stránky. I když můžete tento filtr použít k získání jedné odpovědi, měli byste místo toho použít koncový bod pro konkrétní odpověď, abyste získali bohatší výsledky. Pokud například chcete přijímat jenom obrázky, odešlete požadavek do jednoho z koncových bodů rozhraní API pro vyhledávání obrázků. Odpovědi RelatedSearches a SpellSuggestions nepodporují samostatný koncový bod jako rozhraní API pro vyhledávání obrázků (vrací je jenom rozhraní API pro vyhledávání na webu). Pokud chcete zahrnout odpovědi, které by jinak byly vyloučeny z důvodu řazení, projděte si parametr dotazu zvýšení úrovně.
- safe_search
- str nebo SafeSearch
Filtr, který slouží k filtrování obsahu pro dospělé. Vypnuto: Vrátí webové stránky s textem, obrázky nebo videi pro dospělé. Moderovat: Vrátí webové stránky s textem pro dospělé, ale ne obrázky nebo videa pro dospělé. Striktní: Nevracejte webové stránky s textem, obrázky nebo videi pro dospělé. Výchozí hodnota je Moderate. Pokud žádost pochází z trhu, který zásady Bingu pro dospělé vyžadují, aby bezpečné hledání bylo nastaveno na Strict, Bing hodnotu safeSearch ignoruje a použije Strict. Pokud použijete operátor dotazu site:, je možné, že odpověď může obsahovat obsah pro dospělé bez ohledu na to, na co je nastavený parametr dotazu safeSearch. Použít web: Pouze v případě, že znáte obsah webu a váš scénář podporuje možnost obsahu pro dospělé. Mezi možné hodnoty patří: Vypnuto, Střední, Striktní.
- set_lang
- str
Jazyk, který se má použít pro řetězce uživatelského rozhraní. Jazyk zadejte pomocí dvoupísmenného kódu jazyka ISO 639-1. Například kód jazyka pro češtinu je CS. Výchozí hodnota je EN (angličtina). I když je jazyk volitelný, měli byste ho vždy zadat. Obvykle nastavíte setLang na stejný jazyk určený mkt, pokud uživatel nechce zobrazovat řetězce uživatelského rozhraní v jiném jazyce. Tento parametr a hlavička Accept-Language se vzájemně vylučují; nezadávejte obojí. Řetězec uživatelského rozhraní je řetězec, který se používá jako popisek v uživatelském rozhraní. V objektech odpovědí JSON je několik řetězců uživatelského rozhraní. Zadaný jazyk použijí také všechny odkazy na vlastnosti Bing.com v objektech odpovědi.
- text_decorations
- bool
Logická hodnota, která určuje, jestli mají zobrazované řetězce obsahovat dekorační značky, jako jsou znaky zvýraznění shod. Pokud je true, řetězce mohou obsahovat značky. Výchozí hodnotou je hodnota false. Pokud chcete určit, jestli se mají jako značky použít znaky Unicode nebo značky HTML, podívejte se na parametr dotazu textFormat.
- text_format
- str nebo TextFormat
Typ značek, které se mají použít pro dekoraci textu (viz parametr dotazu textDecorations). Možné hodnoty jsou Raw – Pomocí znaků Unicode označte obsah, který vyžaduje speciální formátování. Znaky Unicode jsou v rozsahu E000 až E019. Bing například používá E000 a E001 k označení začátku a konce termínů dotazu pro zvýraznění přístupů. HTML – značky HTML slouží k označení obsahu, který vyžaduje speciální formátování. Značky můžete například použít ke zvýraznění výrazů dotazu v zobrazovaných řetězcích. Výchozí hodnota je Raw. U zobrazovaných řetězců, které obsahují znaky HTML, jako <jsou , >a &, pokud je textFormat nastavený na HTML, Bing tyto znaky podle potřeby uvozuje (například < je uvozovaný do <). Mezi možné hodnoty patří: Raw, Html.
- operation_config
Přepsání konfigurace operace
Návraty
SearchResponse nebo ClientRawResponse, pokud raw=true
Návratový typ
Výjimky
Atributy
models
models = <module 'azure.cognitiveservices.search.websearch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\cognitiveservices\\search\\websearch\\models\\__init__.py'>
Azure SDK for Python
Váš názor
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu: https://aka.ms/ContentUserFeedback.
Odeslat a zobrazit názory pro