WebOperations Klass

WebOperations-åtgärder.

Du bör inte instansiera direkt den här klassen, utan skapa en klientinstans som skapar den åt dig och bifogar den som attribut.

Arv
builtins.object
WebOperations

Konstruktor

WebOperations(client, config, serializer, deserializer)

Parametrar

client
Obligatorisk

Klient för tjänstbegäranden.

config
Obligatorisk

Konfiguration av tjänstklient.

serializer
Obligatorisk

En objektmodellserialiserare.

deserializer
Obligatorisk

En deserialiserare för objektmodell.

Variabler

x_bing_apis_sdk

Aktivera swagger-efterlevnad. Konstant värde: "true".

Metoder

search

Med API:et för webbsökning kan du skicka en sökfråga till Bing och få tillbaka sökresultat som innehåller länkar till webbsidor, bilder med mera.

Med API:et för webbsökning kan du skicka en sökfråga till Bing och få tillbaka sökresultat som innehåller länkar till webbsidor, bilder med mera.

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)

Parametrar

query
str
Obligatorisk

Användarens sökfrågeterm. Termen kanske inte är tom. Termen kan innehålla avancerade operatorer i Bing. Om du till exempel vill begränsa resultaten till en specifik domän använder du operatorn site: .

accept_language
str
standardvärde: None

En kommaavgränsad lista över ett eller flera språk som ska användas för användargränssnittssträngar. Listan är i fallande prioritetsordning. Mer information, inklusive förväntat format, finns i RFC2616. Den här rubriken och frågeparametern setLang utesluter varandra. ange inte båda. Om du anger huvudet måste du även ange frågeparametern cc. Bing använder det första språk som stöds i listan och kombinerar det språket med parametervärdet cc för att fastställa marknaden att returnera resultat för. Om listan inte innehåller ett språk som stöds hittar Bing det närmaste språket och marknaden som stöder begäran och kan använda en aggregerad marknad eller standardmarknad för resultaten i stället för en angiven marknad. Du bör endast använda det här huvudet och frågeparametern cc om du anger flera språk. Annars bör du använda frågeparametrarna mkt och setLang. En användargränssnittssträng är en sträng som används som en etikett i ett användargränssnitt. Det finns mycket få användargränssnittssträngar i JSON-svarsobjekten. Länkar i svarsobjekten till Bing.com egenskaper kommer att tillämpa det angivna språket.

pragma
str
standardvärde: None

Som standard returnerar Bing cachelagrat innehåll om det finns. Om du vill förhindra att Bing returnerar cachelagrat innehåll ska du ställa in huvudet Pragma på no-cache (till exempel Pragma: no-cache).

user_agent
str
standardvärde: None

Användaragenten som skapade begäran. Bing använder användaragenten för att ge mobila användare en optimerad upplevelse. Även om det är valfritt rekommenderar vi starkt att du alltid anger det här huvudet. Användaragenten ska vara samma sträng som alla vanliga webbläsare skickar. Information om användaragenter finns i RFC 2616.

client_id
str
standardvärde: None

Bing använder det här huvudet för att ge användarna konsekvent beteende i Bing API-anrop. Bing ger ofta förhandsversioner av nya funktioner och förbättringar och använder klient-ID som en nyckel för att tilldela trafik till olika förhandsversioner. Om du inte använder samma klient-ID för en användare vid flera förfrågningar kan sedan Bing tilldela användaren flera motstridiga förhandsversioner. Om du tilldelas flera motstridiga förhandsversioner kan det leda till en inkonsekvent användarupplevelse. Om till exempel den andra begäran har en annan förhandsversionstilldelning än den första kan upplevelsen vara oväntad. Bing kan också använda klient-ID:t för att skräddarsy webbresultat till det klient-ID:ts sökhistorik, vilket ger användaren en bättre upplevelse. Bing använder också det här huvudet för att förbättra resultatets rangordning genom att analysera aktiviteten som genererats av ett klient-ID. Relevansförbättringarna kan ge bättre resultat som levereras av Bing-API: er, vilka i sin tur möjliggör högre klickfrekvens för API-konsumenten. Viktigt! Även om det är valfritt bör du överväga att använda det här huvudet som krävs. Bestående klient-ID för flera förfrågningar för samma slutanvändare och enhetskombination gör det möjligt 1) för API-konsumenten att få en konsekvent användarupplevelse och 2) att få högre klickfrekvens via resultat av högre kvalitet från Bing-API: er. Varje användare som använder ditt program på enheten måste ha ett unikt, Bing-genererat klient-ID. Om du inte använder det här huvudet i begäran genererar Bing ett ID och returnerar det i svarshuvudet X-MSEdge-ClientID. Den enda gången som du inte får inkludera det här huvudet i en begäran är första gången du använder din app på enheten. Använd klient-ID för varje Bing API-begäran som din app gör för den här användaren på enheten. Spara klient-ID:t. Om du vill bevara ID:t i en webbläsarapp ska du använda en beständig HTTP-cookie i alla sessioner. Använd inte en sessionscookie. För andra appar, till exempel mobilappar, använder du enhetens beständiga lagring för att bevara ID. Nästa gång användaren använder appen på enheten ska du hämta klient-ID:t som du sparade. Bing-svar kan innehålla det här huvudet. Om svaret innehåller det här huvudet ska du avbilda klient-ID:t och använda det för alla efterföljande Bing-begäranden för användaren på enheten. Om du inkluderar X-MSEdge-ClientID får du inte inkludera cookies i begäran.

client_ip
str
standardvärde: None

Klientenhetens IPv4- eller IPv6-adress. IP-adressen används för att identifiera användarens plats. Bing använder platsinformationen för att fastställa SafeSearch-beteende. Även om det är valfritt rekommenderar vi att du alltid anger det här huvudet och rubriken X-Search-Location. Förvräng inte adressen (till exempel genom att ändra den sista oktetten till 0). Om adressresultatet förvillas på en plats som inte är i närheten av enhetens verkliga plats kan det leda till att Bing presenterar felaktiga resultat.

location
str
standardvärde: None

En semikolonavgränsad lista med nyckel/värde-par som beskriver klientens geografiska plats. Bing använder platsinformationen till att fastställa ett säkert sökbeteende och returnera relevant lokalt innehåll. Ange nyckel/värde-paret som :. Följande är de nycklar som används för att ange användarens plats. lat (obligatoriskt): Latitud för klientens plats, i grader. Latituden måste vara större än eller lika med -90.0 och vara mindre än eller lika med +90.0. Negativa värden anger sydliga latituder och positiva värden anger nordliga latituder. long (obligatoriskt): Longitud för klientens plats, i grader. Longituden måste vara större än eller lika med -180.0 och vara mindre än eller lika med +180.0. Negativa värden anger västliga longituder och positiva värden anger östliga longituder. re (obligatoriskt): Radien, i meter, som anger koordinaternas vågräta noggrannhet. Skicka värdet som returneras av enhetens platstjänst. Typiska värden kan vara 22 m för GPS/Wi-Fi, 380 m för mobiltornstriangulering och 18 000 m för omvänd IP-sökning. ts (valfritt): UTC UNIX-tidsstämpeln för när klienten var på platsen. (UNIX-tidsstämpeln är antalet sekunder sedan den 1 januari 1970.) huvud (valfritt): Klientens relativa färdriktning eller färdriktning. Ange färdriktningen som grader från 0 till 360 där du räknar medurs i förhållande till norr. Ange bara den här nyckeln om sp-nyckeln inte är noll. sp (valfritt): Den vågräta hastigheten (hastighet), i meter per sekund, som klientenheten färdas i. alt (valfritt): Klientenhetens höjd i meter. är (valfritt): Radien i meter som anger koordinaternas lodräta noggrannhet. Ange bara den här nyckeln om du anger alt-nyckeln. Även om många av nycklarna är valfria, desto mer information får du, desto mer exakt blir platsresultaten. Även om det är valfritt rekommenderar vi att du alltid anger användarens geografiska plats. Det är särskilt viktigt att ange plats om klientens IP-adress inte exakt avspeglar användarens fysiska plats (till exempel om klienten använder VPN). För bästa resultat bör du inkludera det här huvudet och huvudet X-MSEdge-ClientIP, men du bör minst inkludera det här huvudet.

answer_count
int
standardvärde: None

Antalet svar som du vill att svaret ska innehålla. Svaren som Bing returnerar baseras på rangordning. Om Bing till exempel returnerar webbsidor, bilder, videor och relatedSearches för en begäran och du anger den här parametern till två (2), innehåller svaret webbsidor och bilder. Om du inkluderade frågeparametern responseFilter i samma begäran och ställde in den på webbsidor och nyheter, skulle svaret bara innehålla webbsidor.

country_code
str
standardvärde: None

En landskod som består av två tecken för det land där resultatet kommer från. Det här API:et stöder endast USA marknaden. Om du anger den här frågeparametern måste den anges till oss. Om du anger parametern måste du även ange huvudet Accept-Language. Bing använder det första språk som stöds från språklistan och kombinerar det språket med den landskod som du anger för att fastställa vilken marknad som resultat ska returneras för. Om språklistan inte innehåller ett språk som stöds hittar Bing det närmaste språket och marknaden som stöder begäran, eller så kan Bing använda en aggregerad eller standardmarknad för resultaten i stället för en angiven marknad. Du bör endast använda den här frågeparametern och frågeparametern Accept-Language om du anger flera språk. Annars bör du använda frågeparametrarna mkt och setLang. Den här parametern och mkt-frågeparametern är ömsesidigt uteslutande – ange inte båda.

count
int
standardvärde: None

Antalet sökresultat som ska returneras i svaret. Standardvärdet är 10 och det maximala värdet är 50. Det faktiska levererade antalet kan vara mindre än begärt. Använd den här parametern tillsammans med förskjutningsparametern för att sidresultat. Om användargränssnittet till exempel visar 10 sökresultat per sida anger du antal till 10 och förskjuter till 0 för att få den första sidan med resultat. För varje efterföljande sida ökar du förskjutningen med 10 (till exempel 0, 10, 20). Det är möjligt för flera sidor att inkludera viss överlappning i resultaten.

freshness
str eller Freshness
standardvärde: None

Filtrera sökresultaten efter följande åldersvärden: Day – Returnera webbsidor som Bing har identifierat under de senaste 24 timmarna. Vecka – Returnera webbsidor som Bing har identifierat under de senaste 7 dagarna. Månad – Returnera webbsidor som identifierats under de senaste 30 dagarna. Det här filtret gäller endast för webbsidans resultat och inte för andra resultat, till exempel nyheter och bilder. Möjliga värden är: "Dag", "Vecka", "Månad"

market
str
standardvärde: en-us

Marknaden som resultatet kommer från. Vanligtvis är mkt det land där användaren gör begäran från. Det kan dock vara ett annat land om användaren inte finns i ett land där Bing levererar resultat. Marknaden måste vara i formatet -. Exempel: sv-SE. Strängen är skiftlägesokänslig. Om du är känd uppmuntras du att alltid ange marknaden. Om du anger marknaden gör det enklare för Bing att dirigera begäran och returnera ett lämpligt och optimalt svar. Om du anger en marknad som inte finns med i Marknadskoder använder Bing en marknadskod som passar bäst baserat på en intern mappning som kan komma att ändras. Den här parametern och frågeparametern cc utesluter varandra – ange inte båda.

offset
int
standardvärde: None

Den nollbaserade förskjutningen som anger antalet sökresultat som ska hoppa över innan resultatet returneras. Standardvärdet är 0. Förskjutningen ska vara mindre än (totalEstimatedMatches – antal). Använd den här parametern tillsammans med parametern count för att sidresultat. Om användargränssnittet till exempel visar 10 sökresultat per sida anger du antal till 10 och förskjuter till 0 för att få den första sidan med resultat. För varje efterföljande sida ökar du förskjutningen med 10 (till exempel 0, 10, 20). Det är möjligt för flera sidor att inkludera viss överlappning i resultaten.

promote
list[str eller AnswerType]
standardvärde: None

En kommaavgränsad lista med svar som du vill att svaret ska innehålla oavsett deras rangordning. Om du till exempel ställer in answerCount) på två (2) så att Bing returnerar de två främsta rankade svaren, men du också vill att svaret ska innehålla nyheter, skulle du ställa in upphöjt till nyheter. Om de högst rankade svaren är webbsidor, bilder, videor och relatedSearches innehåller svaret webbsidor och bilder eftersom nyheter inte är ett rangordnat svar. Men om du ställer in upphöjt till video höjer Bing videosvaret till svaret och returnerar webbsidor, bilder och videor. Svaren som du vill höja upp räknas inte mot answerCount-gränsen. Om de rankade svaren till exempel är nyheter, bilder och videor, och du anger answerCount till 1 och höjer till nyheter, innehåller svaret nyheter och bilder. Eller om de rankade svaren är videor, bilder och nyheter innehåller svaret videor och nyheter. Möjliga värden är Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webpages. Använd endast om du anger answerCount.

response_filter
list[str eller AnswerType]
standardvärde: None

En kommaavgränsad lista med svar som ska tas med i svaret. Om du inte anger den här parametern innehåller svaret alla söksvar där det finns relevanta data. Möjliga filtervärden är Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webpages. Även om du kan använda det här filtret för att få ett enda svar bör du i stället använda den svarsspecifika slutpunkten för att få bättre resultat. Om du till exempel bara vill ta emot bilder skickar du begäran till en av slutpunkterna för API:et för bildsökning. Svaren RelatedSearches och SpellSuggestions stöder inte en separat slutpunkt som API:et för bildsökning gör (endast API:et för webbsökning returnerar dem). Om du vill ta med svar som annars skulle uteslutas på grund av rangordning, se frågeparametern promote.

safe_search
str eller SafeSearch
standardvärde: None

Ett filter som används för att filtrera innehåll som är olämpligt för barn. Av: Returnera webbsidor med vuxentext, bilder eller videor. Måttlig: Returnera webbsidor med vuxentext, men inte vuxna bilder eller videor. Strikt: Returnera inte webbsidor med vuxentext, bilder eller videor. Standardinställningen är Måttlig. Om begäran kommer från en marknad där Bings vuxenpolicy kräver att safeSearch är inställt på Strict ignorerar Bing värdet safeSearch och använder Strict. Om du använder frågeoperatorn site: finns det en risk att svaret innehåller vuxet innehåll oavsett vad frågeparametern safeSearch är inställd på. Använd webbplats: endast om du är medveten om innehållet på webbplatsen och ditt scenario stöder möjligheten till vuxet innehåll. Möjliga värden är: "Av", "Måttlig", "Strikt"

set_lang
str
standardvärde: None

Språket som ska användas för användargränssnittssträngar. Ange språk med hjälp av den tvåstaviga språkkoden ISO 639-1. Språkkoden för engelska är till exempel EN. Standardvärdet är EN (engelska). Även om det är valfritt bör du alltid ange språket. Normalt anger du setLang till samma språk som anges av mkt om inte användaren vill att användargränssnittssträngarna ska visas på ett annat språk. Den här parametern och Accept-Language-huvudet utesluter varandra. ange inte båda. En användargränssnittssträng är en sträng som används som en etikett i ett användargränssnitt. Det finns några användargränssnittssträngar i JSON-svarsobjekt. Alla länkar till Bing.com-egenskaper i svarsobjekten använder det angivna språket.

text_decorations
bool
standardvärde: None

Ett booleskt värde som avgör om visningssträngar ska innehålla dekorationsmarkörer, till exempel träffmarkeringstecken. Om det är sant kan strängarna innehålla markörer. Standardvärdet är False. Om du vill ange om unicode-tecken eller HTML-taggar ska användas som markörer kan du läsa frågeparametern textFormat.

text_format
str eller TextFormat
standardvärde: None

Typ av markörer som ska användas för textdekorationer (se frågeparametern textDecorations). Möjliga värden är Raw – Använd Unicode-tecken för att markera innehåll som behöver särskild formatering. Unicode-tecknen finns i intervallet E000 till E019. Bing använder till exempel E000 och E001 för att markera början och slutet av frågetermerna för träffmarkering. HTML – Använd HTML-taggar för att markera innehåll som behöver särskild formatering. Du kan till exempel använda taggar för att markera frågetermer i visningssträngar. Standardvärdet är Raw. För visningssträngar som innehåller undantagsbara HTML-tecken som <, >och &, om textFormat är inställt på HTML, kommer Bing att undvika tecknen efter behov (till exempel < är undantaget till <). Möjliga värden är: Raw, Html

custom_headers
dict
standardvärde: None

rubriker som läggs till i begäran

raw
bool
standardvärde: False

returnerar det direkta svaret tillsammans med det avserialiserade svaret

operation_config
Obligatorisk

Åsidosättningar av åtgärdskonfiguration.

Returer

SearchResponse eller ClientRawResponse om raw=true

Returtyp

Undantag

Attribut

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'>