WebSearchOptionalParams interface

Paket:

@azure/cognitiveservices-websearch

Valfria parametrar.

Extends

RequestOptionsBase

Egenskaper

acceptLanguage	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 det här huvudet måste du också ange frågeparametern cc. Bing använder det första språk som stöds från 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 den här rubriken 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 använder det angivna språket.
answerCount	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 endast innehålla webbsidor.
clientId	Bing använder den här rubriken för att ge användare konsekvent beteende i Bing API-anrop. Bing flyger ofta nya funktioner och förbättringar och använder klient-ID:t som en nyckel för att tilldela trafik på olika flygningar. Om du inte använder samma klient-ID för en användare över flera begäranden kan Bing tilldela användaren till flera motstridiga flygningar. Att tilldelas till flera motstridiga flygningar kan leda till en inkonsekvent användarupplevelse. Om den andra begäran till exempel har en annan flygtilldelning än den första kan upplevelsen vara oväntad. Bing kan också använda klient-ID:t för att skräddarsy webbresultat till klient-ID:ts sökhistorik, vilket ger en bättre upplevelse för användaren. Bing använder också den här rubriken för att förbättra resultatrankningen genom att analysera aktiviteten som genereras av ett klient-ID. Relevansförbättringarna hjälper till med bättre resultatkvalitet som levereras av API:er i Bing och möjliggör i sin tur högre klickfrekvenser för API-konsumenten. VIKTIGT! Även om det är valfritt bör du överväga det här huvudet som krävs. Om klient-ID:t bevaras mellan flera begäranden för samma slutanvändare och enhetskombination kan 1) API-konsumenten få en konsekvent användarupplevelse och 2) högre klickfrekvenser via bättre resultatkvalitet från Bing-API:erna. Varje användare som använder ditt program på enheten måste ha ett unikt, Bing-genererat klient-ID. Om du inte tar med 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 ska inkludera det här huvudet i en begäran är första gången användaren använder din app på den enheten. Använd klient-ID:t 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 spara ID:t i en webbläsarapp använder du en beständig HTTP-cookie för att se till att ID:t används 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:t. Nästa gång användaren använder din app på den enheten hämtar du det klient-ID som du har sparat. Bing-svar kanske inte innehåller det här huvudet. Om svaret innehåller det här huvudet samlar du in klient-ID:t och använder det för alla efterföljande Bing-begäranden för användaren på den enheten. Om du inkluderar X-MSEdge-ClientID får du inte inkludera cookies i begäran.
clientIp	IPv4- eller IPv6-adressen för klientenheten. IP-adressen används för att identifiera användarens plats. Bing använder platsinformationen för att fastställa säkert sökbeteende. Även om det är valfritt rekommenderar vi att du alltid anger det här huvudet och X-Search-Location-huvudet. Dölj inte adressen (till exempel genom att ändra den sista oktetten till 0). Fördunkla adressen resulterar i att platsen inte är i närheten av enhetens faktiska plats, vilket kan leda till att Bing ger felaktiga resultat.
count	Antalet sökresultat som ska returneras i svaret. Standardvärdet är 10 och det maximala värdet är 50. Det faktiska antalet som levereras kan vara mindre än begärt. Använd den här parametern tillsammans med förskjutningsparametern för sidresultat. Om användargränssnittet till exempel visar 10 sökresultat per sida anger du antalet till 10 och förskjuter till 0 för att få den första resultatsidan. 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.
countryCode	En landskod på 2 tecken i det land där resultatet kommer från. Det här API:et stöder endast den amerikanska marknaden. Om du anger den här frågeparametern måste den vara inställd på oss. Om du anger den här parametern måste du också ange Accept-Language-huvudet. Bing använder det första språk som stöds från språklistan och kombinerar det språket med landskoden 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.
freshness	Filtrera sökresultaten efter följande åldersvärden: Dag – 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 har 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"
location	En semikolonavgränsad lista över nyckel/värde-par som beskriver klientens geografiska plats. Bing använder platsinformationen för att fastställa säkert sökbeteende och för att returnera relevant lokalt innehåll. Ange nyckel/värde-paret som :. Följande är de nycklar som du använder för att ange användarens plats. lat (krävs): Latitud för klientens plats, i grader. Latitud måste vara större än eller lika med -90,0 och mindre än eller lika med +90,0. Negativa värden anger sydliga latitud och positiva värden anger nordliga latitud. long (krävs): Longitud för klientens plats, i grader. Longitud måste vara större än eller lika med -180,0 och mindre än eller lika med +180,0. Negativa värden indikerar västerländska longituder och positiva värden indikerar östliga longituder. re (krävs): Radien, i meter, som anger koordinaternas vågräta noggrannhet. Skicka det värde som returneras av enhetens platstjänst. Typiska värden kan vara 22 m för GPS/Wi-Fi, 380 m för triangulering av celltorn 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 och räkna medsols i förhållande till sant norr. Ange endast den här nyckeln om sp-nyckeln inte är noll. sp (valfritt): Den horisontella hastighet (hastighet), i meter per sekund, som klientenheten färdas. alt (valfritt): Klientenhetens höjd i meter. är (valfritt): Radien i meter som anger koordinaternas lodräta noggrannhet. Ange endast den här nyckeln om du anger alt-nyckeln. Även om många av nycklarna är valfria, desto mer information som du anger, desto mer exakt är platsresultaten. Även om det är valfritt rekommenderar vi att du alltid anger användarens geografiska plats. Att ange platsen är särskilt viktigt om klientens IP-adress inte korrekt återspeglar användarens fysiska plats (till exempel om klienten använder VPN). För optimala resultat bör du inkludera det här huvudet och X-MSEdge-ClientIP-huvudet, men du bör åtminstone inkludera det här huvudet.
market	Marknaden där resultaten kommer ifrå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 form -. Till exempel en-US. Strängen är skiftlägesokänslig. Om det är känt uppmanas du att alltid ange marknaden. Att ange marknaden hjälper Bing att dirigera begäran och returnera ett lämpligt och optimalt svar. Om du anger en marknad som inte anges 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 cc-frågeparametern är ömsesidigt uteslutande – ange inte båda. Standardvärde: "en-us".
offset	Den nollbaserade förskjutningen som anger hur många sökresultat som ska hoppa över innan resultat returneras. Standardvärdet är 0. Förskjutningen bör vara mindre än (totalEstimatedMatches - count). 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 antalet till 10 och förskjuter till 0 för att få den första resultatsidan. 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 resultat.
pragma	Som standard returnerar Bing cachelagrat innehåll, om det är tillgängligt. Om du vill förhindra att Bing returnerar cachelagrat innehåll anger du Pragma-huvudet till no-cache (till exempel Pragma: no-cache).
promote	En kommaavgränsad lista med svar som du vill att svaret ska innehålla oavsett deras rangordning. Om du till exempel anger answerCount) till 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öjer 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 rankat svar. Men om du ställer in uppflyttad till video skulle Bing höja upp videosvaret till svaret och returnera 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 befordrar 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 Beräkning, Bilder, Nyheter, RelatedSearches, SpellSuggestions, TimeZone, Videor, Webbsidor. Använd endast om du anger answerCount.
responseFilter	En kommaavgränsad lista med svar som ska inkluderas i svaret. Om du inte anger den här parametern innehåller svaret alla söksvar som det finns relevanta data för. Möjliga filtervärden är Beräkning, Bilder, Nyheter, RelatedSearches, SpellSuggestions, TimeZone, Videor, Webbsidor. Ä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 API-slutpunkterna 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). Information om hur du tar med svar som annars skulle undantas på grund av rangordning finns i parametern för att höja upp frågan.
safeSearch	Ett filter som används för att filtrera innehåll för vuxna. 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. Standardvärdet är Måttlig. Om begäran kommer från en marknad där Bings vuxenpolicy kräver att safeSearch är inställt på Strikt ignorerar Bing värdet safeSearch och använder Strict. Om du använder webbplats: frågeoperator finns det en chans att svaret kan innehålla 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: "Off", "Moderate", "Strict"
setLang	Språket som ska användas för användargränssnittssträngar. Ange språket med hjälp av språkkoden ISO 639-1 med två bokstäver. 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. Vanligtvis 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 är ömsesidigt uteslutande. 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 få användargränssnittssträngar i JSON-svarsobjekten. Länkar till Bing.com egenskaper i svarsobjekten använder också det angivna språket.
textDecorations	Ett booleskt värde som avgör om visningssträngar ska innehålla dekorationsmarkörer som träffmarkeringstecken. Om det är sant kan strängarna innehålla markörer. Standardvärdet är falskt. Information om du vill ange om unicode-tecken eller HTML-taggar ska användas som markörer finns i frågeparametern textFormat.
textFormat	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 och med 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. Använd till exempel taggar för att markera frågetermer i visningssträngar. Standardvärdet är Raw. För visningssträngar som innehåller eskapbara HTML-tecken, till exempel <, >och &, om textFormat är inställt på HTML, kommer Bing att undvika tecknen efter behov (till exempel < är undantagen till <). Möjliga värden är: "Raw", "Html"
userAgent	Användaragenten som kommer från 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 skulle skicka. Information om användaragenter finns i RFC 2616.

Ärvda egenskaper

abortSignal	Den signal som kan användas för att avbryta begäranden.
customHeaders	Användardefinierade anpassade begärandehuvuden som ska tillämpas innan begäran skickas.
onDownloadProgress	Återanrop som utlöses när nedladdningen förlopp.
onUploadProgress	Återanrop som utlöses när uppladdningen förlopp.
timeout	Antalet millisekunder som en begäran kan ta innan den avslutas automatiskt.

Egenskapsinformation

acceptLanguage

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 det här huvudet måste du också ange frågeparametern cc. Bing använder det första språk som stöds från 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 den här rubriken 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 använder det angivna språket.

acceptLanguage?: string

Egenskapsvärde

string

answerCount

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 endast innehålla webbsidor.

answerCount?: number

Egenskapsvärde

number

clientId

Bing använder den här rubriken för att ge användare konsekvent beteende i Bing API-anrop. Bing flyger ofta nya funktioner och förbättringar och använder klient-ID:t som en nyckel för att tilldela trafik på olika flygningar. Om du inte använder samma klient-ID för en användare över flera begäranden kan Bing tilldela användaren till flera motstridiga flygningar. Att tilldelas till flera motstridiga flygningar kan leda till en inkonsekvent användarupplevelse. Om den andra begäran till exempel har en annan flygtilldelning än den första kan upplevelsen vara oväntad. Bing kan också använda klient-ID:t för att skräddarsy webbresultat till klient-ID:ts sökhistorik, vilket ger en bättre upplevelse för användaren. Bing använder också den här rubriken för att förbättra resultatrankningen genom att analysera aktiviteten som genereras av ett klient-ID. Relevansförbättringarna hjälper till med bättre resultatkvalitet som levereras av API:er i Bing och möjliggör i sin tur högre klickfrekvenser för API-konsumenten. VIKTIGT! Även om det är valfritt bör du överväga det här huvudet som krävs. Om klient-ID:t bevaras mellan flera begäranden för samma slutanvändare och enhetskombination kan 1) API-konsumenten få en konsekvent användarupplevelse och 2) högre klickfrekvenser via bättre resultatkvalitet från Bing-API:erna. Varje användare som använder ditt program på enheten måste ha ett unikt, Bing-genererat klient-ID. Om du inte tar med 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 ska inkludera det här huvudet i en begäran är första gången användaren använder din app på den enheten. Använd klient-ID:t 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 spara ID:t i en webbläsarapp använder du en beständig HTTP-cookie för att se till att ID:t används 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:t. Nästa gång användaren använder din app på den enheten hämtar du det klient-ID som du har sparat. Bing-svar kanske inte innehåller det här huvudet. Om svaret innehåller det här huvudet samlar du in klient-ID:t och använder det för alla efterföljande Bing-begäranden för användaren på den enheten. Om du inkluderar X-MSEdge-ClientID får du inte inkludera cookies i begäran.

clientId?: string

Egenskapsvärde

string

clientIp

IPv4- eller IPv6-adressen för klientenheten. IP-adressen används för att identifiera användarens plats. Bing använder platsinformationen för att fastställa säkert sökbeteende. Även om det är valfritt rekommenderar vi att du alltid anger det här huvudet och X-Search-Location-huvudet. Dölj inte adressen (till exempel genom att ändra den sista oktetten till 0). Fördunkla adressen resulterar i att platsen inte är i närheten av enhetens faktiska plats, vilket kan leda till att Bing ger felaktiga resultat.

clientIp?: string

Egenskapsvärde

string

count

Antalet sökresultat som ska returneras i svaret. Standardvärdet är 10 och det maximala värdet är 50. Det faktiska antalet som levereras kan vara mindre än begärt. Använd den här parametern tillsammans med förskjutningsparametern för sidresultat. Om användargränssnittet till exempel visar 10 sökresultat per sida anger du antalet till 10 och förskjuter till 0 för att få den första resultatsidan. 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.

count?: number

Egenskapsvärde

number

countryCode

En landskod på 2 tecken i det land där resultatet kommer från. Det här API:et stöder endast den amerikanska marknaden. Om du anger den här frågeparametern måste den vara inställd på oss. Om du anger den här parametern måste du också ange Accept-Language-huvudet. Bing använder det första språk som stöds från språklistan och kombinerar det språket med landskoden 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.

countryCode?: string

Egenskapsvärde

string

freshness

Filtrera sökresultaten efter följande åldersvärden: Dag – 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 har 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"

freshness?: Freshness

Egenskapsvärde

Freshness

location

En semikolonavgränsad lista över nyckel/värde-par som beskriver klientens geografiska plats. Bing använder platsinformationen för att fastställa säkert sökbeteende och för att returnera relevant lokalt innehåll. Ange nyckel/värde-paret som :. Följande är de nycklar som du använder för att ange användarens plats. lat (krävs): Latitud för klientens plats, i grader. Latitud måste vara större än eller lika med -90,0 och mindre än eller lika med +90,0. Negativa värden anger sydliga latitud och positiva värden anger nordliga latitud. long (krävs): Longitud för klientens plats, i grader. Longitud måste vara större än eller lika med -180,0 och mindre än eller lika med +180,0. Negativa värden indikerar västerländska longituder och positiva värden indikerar östliga longituder. re (krävs): Radien, i meter, som anger koordinaternas vågräta noggrannhet. Skicka det värde som returneras av enhetens platstjänst. Typiska värden kan vara 22 m för GPS/Wi-Fi, 380 m för triangulering av celltorn 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 och räkna medsols i förhållande till sant norr. Ange endast den här nyckeln om sp-nyckeln inte är noll. sp (valfritt): Den horisontella hastighet (hastighet), i meter per sekund, som klientenheten färdas. alt (valfritt): Klientenhetens höjd i meter. är (valfritt): Radien i meter som anger koordinaternas lodräta noggrannhet. Ange endast den här nyckeln om du anger alt-nyckeln. Även om många av nycklarna är valfria, desto mer information som du anger, desto mer exakt är platsresultaten. Även om det är valfritt rekommenderar vi att du alltid anger användarens geografiska plats. Att ange platsen är särskilt viktigt om klientens IP-adress inte korrekt återspeglar användarens fysiska plats (till exempel om klienten använder VPN). För optimala resultat bör du inkludera det här huvudet och X-MSEdge-ClientIP-huvudet, men du bör åtminstone inkludera det här huvudet.

location?: string

Egenskapsvärde

string

market

Marknaden där resultaten kommer ifrå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 form -. Till exempel en-US. Strängen är skiftlägesokänslig. Om det är känt uppmanas du att alltid ange marknaden. Att ange marknaden hjälper Bing att dirigera begäran och returnera ett lämpligt och optimalt svar. Om du anger en marknad som inte anges 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 cc-frågeparametern är ömsesidigt uteslutande – ange inte båda. Standardvärde: "en-us".

market?: string

Egenskapsvärde

string

offset

Den nollbaserade förskjutningen som anger hur många sökresultat som ska hoppa över innan resultat returneras. Standardvärdet är 0. Förskjutningen bör vara mindre än (totalEstimatedMatches - count). 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 antalet till 10 och förskjuter till 0 för att få den första resultatsidan. 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 resultat.

offset?: number

Egenskapsvärde

number

pragma

Som standard returnerar Bing cachelagrat innehåll, om det är tillgängligt. Om du vill förhindra att Bing returnerar cachelagrat innehåll anger du Pragma-huvudet till no-cache (till exempel Pragma: no-cache).

pragma?: string

Egenskapsvärde

string

promote

En kommaavgränsad lista med svar som du vill att svaret ska innehålla oavsett deras rangordning. Om du till exempel anger answerCount) till 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öjer 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 rankat svar. Men om du ställer in uppflyttad till video skulle Bing höja upp videosvaret till svaret och returnera 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 befordrar 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 Beräkning, Bilder, Nyheter, RelatedSearches, SpellSuggestions, TimeZone, Videor, Webbsidor. Använd endast om du anger answerCount.

promote?: AnswerType[]

Egenskapsvärde

AnswerType[]

responseFilter

En kommaavgränsad lista med svar som ska inkluderas i svaret. Om du inte anger den här parametern innehåller svaret alla söksvar som det finns relevanta data för. Möjliga filtervärden är Beräkning, Bilder, Nyheter, RelatedSearches, SpellSuggestions, TimeZone, Videor, Webbsidor. Ä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 API-slutpunkterna 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). Information om hur du tar med svar som annars skulle undantas på grund av rangordning finns i parametern för att höja upp frågan.

responseFilter?: AnswerType[]

Egenskapsvärde

AnswerType[]

safeSearch

Ett filter som används för att filtrera innehåll för vuxna. 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. Standardvärdet är Måttlig. Om begäran kommer från en marknad där Bings vuxenpolicy kräver att safeSearch är inställt på Strikt ignorerar Bing värdet safeSearch och använder Strict. Om du använder webbplats: frågeoperator finns det en chans att svaret kan innehålla 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: "Off", "Moderate", "Strict"

safeSearch?: SafeSearch

Egenskapsvärde

SafeSearch

setLang

Språket som ska användas för användargränssnittssträngar. Ange språket med hjälp av språkkoden ISO 639-1 med två bokstäver. 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. Vanligtvis 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 är ömsesidigt uteslutande. 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 få användargränssnittssträngar i JSON-svarsobjekten. Länkar till Bing.com egenskaper i svarsobjekten använder också det angivna språket.

setLang?: string

Egenskapsvärde

string

textDecorations

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

textDecorations?: boolean

Egenskapsvärde

boolean

textFormat

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 och med 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. Använd till exempel taggar för att markera frågetermer i visningssträngar. Standardvärdet är Raw. För visningssträngar som innehåller eskapbara HTML-tecken, till exempel <, >och &, om textFormat är inställt på HTML, kommer Bing att undvika tecknen efter behov (till exempel < är undantagen till <). Möjliga värden är: "Raw", "Html"

textFormat?: TextFormat

Egenskapsvärde

TextFormat

userAgent

Användaragenten som kommer från 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 skulle skicka. Information om användaragenter finns i RFC 2616.

userAgent?: string

Egenskapsvärde

string

Information om ärvda egenskaper

abortSignal

Den signal som kan användas för att avbryta begäranden.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

ärvd från msRest.RequestOptionsBase.abortSignal

customHeaders

Användardefinierade anpassade begärandehuvuden som ska tillämpas innan begäran skickas.

customHeaders?: {[key: string]: string}

Egenskapsvärde

{[key: string]: string}

ärvd från msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Återanrop som utlöses när nedladdningen förlopp.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

ärvd från msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Återanrop som utlöses när uppladdningen förlopp.

onUploadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

ärvd från msRest.RequestOptionsBase.onUploadProgress

timeout

Antalet millisekunder som en begäran kan ta innan den avslutas automatiskt.

timeout?: number

Egenskapsvärde

number

ärvs från msRest.RequestOptionsBase.timeout