Delen via

WebSearchOptionalParams interface

Pakket:
@azure/cognitiveservices-websearch

Optionele parameters.

Uitbreiding
RequestOptionsBase

Eigenschappen

acceptLanguage

Een door komma's gescheiden lijst met een of meer talen die moeten worden gebruikt voor tekenreeksen van de gebruikersinterface. De lijst bevindt zich in aflopende volgorde van voorkeur. Zie RFC2616voor meer informatie, inclusief de verwachte indeling. Deze header en de setLang-queryparameter sluiten elkaar wederzijds uit; geef niet beide op. Als u deze header instelt, moet u ook de cc-queryparameter opgeven. Bing gebruikt de eerste ondersteunde taal die wordt gevonden in de lijst en combineert die taal met de cc-parameterwaarde om de markt te bepalen waarvoor resultaten moeten worden geretourneerd. Als de lijst geen ondersteunde taal bevat, vindt Bing de dichtstbijzijnde taal en markt die ondersteuning biedt voor de aanvraag en kan een geaggregeerde of standaardmarkt worden gebruikt voor de resultaten in plaats van een opgegeven. U moet deze header en de cc-queryparameter alleen gebruiken als u meerdere talen opgeeft; anders moet u de mkt en setLang-queryparameters gebruiken. Een gebruikersinterfacetekenreeks is een tekenreeks die wordt gebruikt als label in een gebruikersinterface. Er zijn zeer weinig tekenreeksen voor de gebruikersinterface in de JSON-antwoordobjecten. Alle koppelingen in de antwoordobjecten op Bing.com eigenschappen passen de opgegeven taal toe.
answerCount

Het aantal antwoorden dat u wilt opnemen in het antwoord. De antwoorden die Bing retourneert, zijn gebaseerd op classificatie. Als Bing bijvoorbeeld webpagina's, afbeeldingen, video's en relatedSearches retourneert voor een aanvraag en u deze parameter instelt op twee (2), bevat het antwoord webpagina's en afbeeldingen. Als u de queryparameter responseFilter in dezelfde aanvraag hebt opgenomen en deze hebt ingesteld op webpagina's en nieuws, bevat het antwoord alleen webpagina's.
clientId

Bing gebruikt deze header om gebruikers consistent gedrag te bieden in Bing API-aanroepen. Bing vlucht vaak nieuwe functies en verbeteringen en gebruikt de client-id als sleutel voor het toewijzen van verkeer op verschillende vluchten. Als u niet dezelfde client-id gebruikt voor een gebruiker voor meerdere aanvragen, kan Bing de gebruiker toewijzen aan meerdere conflicterende vluchten. Het toewijzen aan meerdere conflicterende vluchten kan leiden tot een inconsistente gebruikerservaring. Als de tweede aanvraag bijvoorbeeld een andere vluchttoewijzing heeft dan de eerste, kan de ervaring onverwacht zijn. Bing kan ook de client-id gebruiken om webresultaten aan te passen aan de zoekgeschiedenis van die client-id, waardoor de gebruiker een rijkere ervaring biedt. Bing gebruikt deze header ook om de resultatenclassificaties te verbeteren door de activiteit te analyseren die is gegenereerd door een client-id. De relevantieverbeteringen helpen bij betere kwaliteit van resultaten die door Bing-API's worden geleverd en maken op hun beurt hogere klikfrequenties mogelijk voor de API-consument. BELANGRIJK: Hoewel dit optioneel is, moet u rekening houden met deze header. Door de client-id bij meerdere aanvragen voor dezelfde combinatie van eindgebruikers en apparaten te behouden, kan de API-consument 1) een consistente gebruikerservaring ontvangen en 2) hogere klikfrequenties via betere kwaliteit van de resultaten van de Bing-API's. Elke gebruiker die uw toepassing op het apparaat gebruikt, moet een unieke, door Bing gegenereerde client-id hebben. Als u deze header niet opneemt in de aanvraag, genereert Bing een id en retourneert deze in de X-MSEdge-ClientID antwoordheader. De enige keer dat u deze header niet in een aanvraag moet opnemen, is de eerste keer dat de gebruiker uw app op dat apparaat gebruikt. Gebruik de client-id voor elke Bing API-aanvraag die uw app doet voor deze gebruiker op het apparaat. De client-id behouden. Als u de id in een browser-app wilt behouden, gebruikt u een permanente HTTP-cookie om ervoor te zorgen dat de id wordt gebruikt in alle sessies. Gebruik geen sessiecooky. Voor andere apps, zoals mobiele apps, gebruikt u de permanente opslag van het apparaat om de id te behouden. De volgende keer dat de gebruiker uw app op dat apparaat gebruikt, haalt u de client-id op die u hebt bewaard. Bing-antwoorden kunnen deze header wel of niet bevatten. Als het antwoord deze header bevat, legt u de client-id vast en gebruikt u deze voor alle volgende Bing-aanvragen voor de gebruiker op dat apparaat. Als u de X-MSEdge-ClientID opneemt, mag u geen cookies in de aanvraag opnemen.
clientIp

Het IPv4- of IPv6-adres van het clientapparaat. Het IP-adres wordt gebruikt om de locatie van de gebruiker te detecteren. Bing gebruikt de locatiegegevens om veilig zoekgedrag te bepalen. Hoewel dit optioneel is, wordt u aangeraden deze koptekst en de X-Search-Location-header altijd op te geven. Verdoezel het adres niet (bijvoorbeeld door de laatste octet te wijzigen in 0). Als u het adres verdoezelt, worden de resultaten van de locatie niet ergens in de buurt van de werkelijke locatie van het apparaat weergegeven. Dit kan ertoe leiden dat Bing onjuiste resultaten levert.
count

Het aantal zoekresultaten dat moet worden geretourneerd in het antwoord. De standaardwaarde is 10 en de maximumwaarde is 50. Het werkelijke aantal dat wordt geleverd, kan kleiner zijn dan aangevraagd. Gebruik deze parameter samen met de offsetparameter voor paginaresultaten. Als uw gebruikersinterface bijvoorbeeld 10 zoekresultaten per pagina weergeeft, stelt u het aantal in op 10 en verschoven naar 0 om de eerste pagina met resultaten op te halen. Voor elke volgende pagina wordt de incrementele verschuiving met 10 (bijvoorbeeld 0, 10, 20) verhoogd. Het is mogelijk dat meerdere pagina's enige overlapping in de resultaten bevatten.
countryCode

Een landcode van twee tekens van het land waar de resultaten vandaan komen. Deze API ondersteunt alleen de markt van de Verenigde Staten. Als u deze queryparameter opgeeft, moet deze worden ingesteld op ons. Als u deze parameter instelt, moet u ook de Accept-Language header opgeven. Bing gebruikt de eerste ondersteunde taal die wordt gevonden in de talenlijst en combineer die taal met de landcode die u opgeeft om de markt te bepalen waarvoor de resultaten moeten worden geretourneerd. Als de talenlijst geen ondersteunde taal bevat, vindt Bing de dichtstbijzijnde taal en markt die ondersteuning biedt voor de aanvraag, of kan er een geaggregeerde of standaardmarkt worden gebruikt voor de resultaten in plaats van een opgegeven. U moet deze queryparameter en de Accept-Language queryparameter alleen gebruiken als u meerdere talen opgeeft; anders moet u de mkt en setLang-queryparameters gebruiken. Deze parameter en de mkt-queryparameter sluiten elkaar wederzijds uit. Geef niet beide op.
freshness

Filter zoekresultaten op de volgende leeftijdswaarden: Dag: Retourneer webpagina's die Bing in de afgelopen 24 uur heeft gedetecteerd. Week: retourneer webpagina's die Bing in de afgelopen 7 dagen heeft gedetecteerd. Maand: retourneer webpagina's die in de afgelopen 30 dagen zijn gedetecteerd. Dit filter is alleen van toepassing op webpaginaresultaten en niet op de andere resultaten, zoals nieuws en afbeeldingen. Mogelijke waarden zijn: 'Dag', 'Week', 'Maand'
location

Een door puntkomma's gescheiden lijst met sleutel-/waardeparen die de geografische locatie van de client beschrijven. Bing gebruikt de locatiegegevens om veilig zoekgedrag te bepalen en relevante lokale inhoud te retourneren. Geef het sleutel-waardepaar op als <sleutel>:<waarde>. Hier volgen de sleutels die u gebruikt om de locatie van de gebruiker op te geven. lat (vereist): De breedtegraad van de locatie van de client, in graden. De breedtegraad moet groter dan of gelijk zijn aan -90,0 en kleiner dan of gelijk aan +90,0. Negatieve waarden geven zuidelijke breedtegraden aan en positieve waarden geven noordelijke breedtegraden aan. lang (vereist): de lengtegraad van de locatie van de client, in graden. De lengtegraad moet groter dan of gelijk zijn aan -180,0 en kleiner dan of gelijk aan +180,0. Negatieve waarden geven westerse lengtegraads aan en positieve waarden geven oostelijke lengtegraads aan. re (vereist): De straal, in meters, die de horizontale nauwkeurigheid van de coördinaten aangeeft. Geef de waarde door die wordt geretourneerd door de locatieservice van het apparaat. Typische waarden kunnen 22m zijn voor GPS/Wi-Fi, 380m voor triangulatie van de celtoren en 18.000m voor omgekeerde IP-zoekactie. ts (optioneel): de UTC UNIX-tijdstempel van toen de client zich op de locatie bevond. (De UNIX-tijdstempel is het aantal seconden sinds 1 januari 1970.) hoofd (optioneel): de relatieve koers of richting van de reis van de klant. Geef de richting van de reis op als graden van 0 tot en met 360, met de klok mee tellen ten opzichte van waar noorden. Geef deze sleutel alleen op als de sp-sleutel niet-nul is. sp (optioneel): de horizontale snelheid (snelheid), in meters per seconde, dat het clientapparaat onderweg is. alt (optioneel): De hoogte van het clientapparaat, in meters. zijn (optioneel): de straal, in meters, die de verticale nauwkeurigheid van de coördinaten aangeeft. Geef deze sleutel alleen op als u de alt-toets opgeeft. Hoewel veel van de sleutels optioneel zijn, hoe meer informatie u opgeeft, hoe nauwkeuriger de locatieresultaten zijn. Hoewel dit optioneel is, wordt u aangeraden altijd de geografische locatie van de gebruiker op te geven. Het instellen van de locatie is vooral belangrijk als het IP-adres van de client niet nauwkeurig overeenkomt met de fysieke locatie van de gebruiker (bijvoorbeeld als de client VPN gebruikt). Voor optimale resultaten moet u deze koptekst en de X-MSEdge-ClientIP-header opnemen, maar u moet deze header minimaal opnemen.
market

De markt waar de resultaten vandaan komen. Normaal gesproken is mkt het land waar de gebruiker de aanvraag indient. Het kan echter een ander land zijn als de gebruiker zich niet in een land bevindt waar Bing resultaten levert. De markt moet de vorm <hebben van de taalcode-landcode<>>. Bijvoorbeeld en-US. De tekenreeks is niet hoofdlettergevoelig. Indien bekend, wordt u aangemoedigd om altijd de markt op te geven. Door de markt op te geven, kan Bing de aanvraag routeren en een geschikt en optimaal antwoord retourneren. Als u een markt opgeeft die niet wordt vermeld in marktcodes, gebruikt Bing een best passende marktcode op basis van een interne toewijzing die onderhevig is aan wijzigingen. Deze parameter en de cc-queryparameter sluiten elkaar wederzijds uit. Geef beide niet op. Standaardwaarde: 'en-us'.
offset

De verschuiving op basis van nul die aangeeft hoeveel zoekresultaten moeten worden overgeslagen voordat er resultaten worden geretourneerd. De standaardwaarde is 0. De offset moet kleiner zijn dan (totalEstimatedMatches - count). Gebruik deze parameter samen met de tellingsparameter voor paginaresultaten. Als uw gebruikersinterface bijvoorbeeld 10 zoekresultaten per pagina weergeeft, stelt u het aantal in op 10 en verschoven naar 0 om de eerste pagina met resultaten op te halen. Voor elke volgende pagina wordt de incrementele verschuiving met 10 (bijvoorbeeld 0, 10, 20) verhoogd. het is mogelijk dat meerdere pagina's een aantal overlappingen in de resultaten opnemen.
pragma

Bing retourneert standaard inhoud in de cache, indien beschikbaar. Als u wilt voorkomen dat Bing inhoud in de cache retourneert, stelt u de Pragma-header in op no-cache (bijvoorbeeld Pragma: no-cache).
promote

Een door komma's gescheiden lijst met antwoorden die u wilt opnemen in het antwoord, ongeacht hun classificatie. Als u bijvoorbeeld answerCount instelt op twee (2), zodat Bing de twee beste gerangschikte antwoorden retourneert, maar u ook het antwoord op nieuws wilt opnemen, zou u het niveau verhogen naar nieuws. Als de meest gerangschikte antwoorden webpagina's, afbeeldingen, video's en relatedSearches zijn, bevat het antwoord webpagina's en afbeeldingen omdat nieuws geen geclassificeerd antwoord is. Maar als u het niveau verhogen naar video instelt, zou Bing het videoantwoord in het antwoord promoten en webpagina's, afbeeldingen en video's retourneren. De antwoorden die u wilt promoveren, tellen niet mee met de answerCount-limiet. Als de gerangschikte antwoorden bijvoorbeeld nieuws, afbeeldingen en video's zijn en u answerCount instelt op 1 en promoveert op nieuws, bevat het antwoord nieuws en afbeeldingen. Of als de gerangschikte antwoorden video's, afbeeldingen en nieuws zijn, bevat het antwoord video's en nieuws. Mogelijke waarden zijn Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webpagina's. Alleen gebruiken als u answerCount opgeeft.
responseFilter

Een door komma's gescheiden lijst met antwoorden die in het antwoord moeten worden opgenomen. Als u deze parameter niet opgeeft, bevat het antwoord alle zoekantwoorden waarvoor relevante gegevens zijn. Mogelijke filterwaarden zijn Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webpagina's. Hoewel u dit filter kunt gebruiken om één antwoord te krijgen, moet u in plaats daarvan het antwoordspecifieke eindpunt gebruiken om uitgebreidere resultaten te krijgen. Als u bijvoorbeeld alleen afbeeldingen wilt ontvangen, verzendt u de aanvraag naar een van de eindpunten van de Afbeeldingen zoeken-API. De antwoorden op RelatedSearches en SpellSuggestions bieden geen ondersteuning voor een afzonderlijk eindpunt, zoals de Afbeeldingen zoeken-API (alleen de Webzoekopdrachten-API retourneert ze). Als u antwoorden wilt opnemen die anders zouden worden uitgesloten vanwege classificatie, raadpleegt u de queryparameter promoveren.
safeSearch

Een filter dat wordt gebruikt om inhoud voor volwassenen te filteren. Uit: Retourneer webpagina's met tekst, afbeeldingen of video's voor volwassenen. Gemiddeld: retourneer webpagina's met tekst voor volwassenen, maar niet afbeeldingen of video's voor volwassenen. Strikt: Geen webpagina's retourneren met tekst, afbeeldingen of video's voor volwassenen. De standaardwaarde is Moderate. Als de aanvraag afkomstig is van een markt waarvoor het beleid voor volwassenen van Bing vereist dat SafeSearch is ingesteld op Strikt, negeert Bing de waarde safeSearch en gebruikt Strikt. Als u de site gebruikt: queryoperator, bestaat de kans dat het antwoord inhoud voor volwassenen kan bevatten, ongeacht waarop de safeSearch-queryparameter is ingesteld. Gebruik site: alleen als u op de hoogte bent van de inhoud op de site en uw scenario de mogelijkheid van inhoud voor volwassenen ondersteunt. Mogelijke waarden zijn: 'Uit', 'Gemiddeld', 'Strikt'
setLang

De taal die moet worden gebruikt voor tekenreeksen van de gebruikersinterface. Geef de taal op met behulp van de ISO 639-1 2-letter taalcode. De taalcode voor Engels is bijvoorbeeld EN. De standaardwaarde is EN (Engels). Hoewel dit optioneel is, moet u altijd de taal opgeven. Normaal gesproken stelt uLang in op dezelfde taal die is opgegeven door mkt, tenzij de gebruiker wil dat de tekenreeksen van de gebruikersinterface in een andere taal worden weergegeven. Deze parameter en de Accept-Language header sluiten elkaar wederzijds uit; geef niet beide op. Een gebruikersinterfacetekenreeks is een tekenreeks die wordt gebruikt als label in een gebruikersinterface. Er zijn enkele tekenreeksen voor de gebruikersinterface in de JSON-antwoordobjecten. Alle koppelingen naar Bing.com eigenschappen in de antwoordobjecten passen ook de opgegeven taal toe.
textDecorations

Een Booleaanse waarde die bepaalt of weergavetekenreeksen decoratiemarkeringen moeten bevatten, zoals het markeren van tekens. Indien waar, kunnen de tekenreeksen markeringen bevatten. De standaardwaarde is onwaar. Als u wilt opgeven of u Unicode-tekens of HTML-tags als markeringen wilt gebruiken, raadpleegt u de queryparameter textFormat.
textFormat

Het type markeringen dat moet worden gebruikt voor tekstdecoraties (zie de queryparameter textDecorations). Mogelijke waarden zijn Onbewerkt. Gebruik Unicode-tekens om inhoud te markeren die speciale opmaak nodig heeft. De Unicode-tekens bevinden zich in het bereik E000 tot en met E019. Bing gebruikt bijvoorbeeld E000 en E001 om het begin en einde van de querytermen te markeren voor het markeren van treffers. HTML: gebruik HTML-tags om inhoud te markeren die speciale opmaak nodig heeft. Gebruik bijvoorbeeld tags om querytermen in weergavetekenreeksen te markeren. De standaardwaarde is Raw. Voor weergavetekenreeksen die geschikte HTML-tekens bevatten, zoals <, >en &, als textFormat is ingesteld op HTML, escapet Bing de tekens naar wens (bijvoorbeeld < is ontsnapt aan <). Mogelijke waarden zijn: 'Raw', 'Html'
userAgent

De gebruikersagent die de aanvraag heeft ingediend. Bing gebruikt de gebruikersagent om mobiele gebruikers een geoptimaliseerde ervaring te bieden. Hoewel dit optioneel is, wordt u sterk aangeraden deze header altijd op te geven. De gebruikersagent moet dezelfde tekenreeks zijn die elke veelgebruikte browser zou verzenden. Zie RFC 2616voor meer informatie over gebruikersagenten.

Overgenomen eigenschappen

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.
customHeaders

Door de gebruiker gedefinieerde aangepaste aanvraagheaders die worden toegepast voordat de aanvraag wordt verzonden.
onDownloadProgress

Callback die wordt geactiveerd bij de voortgang van het downloaden.
onUploadProgress

Callback die wordt geactiveerd bij het uploaden.
timeout

Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beëindigd.

Eigenschapdetails

acceptLanguage

Een door komma's gescheiden lijst met een of meer talen die moeten worden gebruikt voor tekenreeksen van de gebruikersinterface. De lijst bevindt zich in aflopende volgorde van voorkeur. Zie RFC2616voor meer informatie, inclusief de verwachte indeling. Deze header en de setLang-queryparameter sluiten elkaar wederzijds uit; geef niet beide op. Als u deze header instelt, moet u ook de cc-queryparameter opgeven. Bing gebruikt de eerste ondersteunde taal die wordt gevonden in de lijst en combineert die taal met de cc-parameterwaarde om de markt te bepalen waarvoor resultaten moeten worden geretourneerd. Als de lijst geen ondersteunde taal bevat, vindt Bing de dichtstbijzijnde taal en markt die ondersteuning biedt voor de aanvraag en kan een geaggregeerde of standaardmarkt worden gebruikt voor de resultaten in plaats van een opgegeven. U moet deze header en de cc-queryparameter alleen gebruiken als u meerdere talen opgeeft; anders moet u de mkt en setLang-queryparameters gebruiken. Een gebruikersinterfacetekenreeks is een tekenreeks die wordt gebruikt als label in een gebruikersinterface. Er zijn zeer weinig tekenreeksen voor de gebruikersinterface in de JSON-antwoordobjecten. Alle koppelingen in de antwoordobjecten op Bing.com eigenschappen passen de opgegeven taal toe.

acceptLanguage?: string

Waarde van eigenschap

string

answerCount

Het aantal antwoorden dat u wilt opnemen in het antwoord. De antwoorden die Bing retourneert, zijn gebaseerd op classificatie. Als Bing bijvoorbeeld webpagina's, afbeeldingen, video's en relatedSearches retourneert voor een aanvraag en u deze parameter instelt op twee (2), bevat het antwoord webpagina's en afbeeldingen. Als u de queryparameter responseFilter in dezelfde aanvraag hebt opgenomen en deze hebt ingesteld op webpagina's en nieuws, bevat het antwoord alleen webpagina's.

answerCount?: number

Waarde van eigenschap

number

clientId

Bing gebruikt deze header om gebruikers consistent gedrag te bieden in Bing API-aanroepen. Bing vlucht vaak nieuwe functies en verbeteringen en gebruikt de client-id als sleutel voor het toewijzen van verkeer op verschillende vluchten. Als u niet dezelfde client-id gebruikt voor een gebruiker voor meerdere aanvragen, kan Bing de gebruiker toewijzen aan meerdere conflicterende vluchten. Het toewijzen aan meerdere conflicterende vluchten kan leiden tot een inconsistente gebruikerservaring. Als de tweede aanvraag bijvoorbeeld een andere vluchttoewijzing heeft dan de eerste, kan de ervaring onverwacht zijn. Bing kan ook de client-id gebruiken om webresultaten aan te passen aan de zoekgeschiedenis van die client-id, waardoor de gebruiker een rijkere ervaring biedt. Bing gebruikt deze header ook om de resultatenclassificaties te verbeteren door de activiteit te analyseren die is gegenereerd door een client-id. De relevantieverbeteringen helpen bij betere kwaliteit van resultaten die door Bing-API's worden geleverd en maken op hun beurt hogere klikfrequenties mogelijk voor de API-consument. BELANGRIJK: Hoewel dit optioneel is, moet u rekening houden met deze header. Door de client-id bij meerdere aanvragen voor dezelfde combinatie van eindgebruikers en apparaten te behouden, kan de API-consument 1) een consistente gebruikerservaring ontvangen en 2) hogere klikfrequenties via betere kwaliteit van de resultaten van de Bing-API's. Elke gebruiker die uw toepassing op het apparaat gebruikt, moet een unieke, door Bing gegenereerde client-id hebben. Als u deze header niet opneemt in de aanvraag, genereert Bing een id en retourneert deze in de X-MSEdge-ClientID antwoordheader. De enige keer dat u deze header niet in een aanvraag moet opnemen, is de eerste keer dat de gebruiker uw app op dat apparaat gebruikt. Gebruik de client-id voor elke Bing API-aanvraag die uw app doet voor deze gebruiker op het apparaat. De client-id behouden. Als u de id in een browser-app wilt behouden, gebruikt u een permanente HTTP-cookie om ervoor te zorgen dat de id wordt gebruikt in alle sessies. Gebruik geen sessiecooky. Voor andere apps, zoals mobiele apps, gebruikt u de permanente opslag van het apparaat om de id te behouden. De volgende keer dat de gebruiker uw app op dat apparaat gebruikt, haalt u de client-id op die u hebt bewaard. Bing-antwoorden kunnen deze header wel of niet bevatten. Als het antwoord deze header bevat, legt u de client-id vast en gebruikt u deze voor alle volgende Bing-aanvragen voor de gebruiker op dat apparaat. Als u de X-MSEdge-ClientID opneemt, mag u geen cookies in de aanvraag opnemen.

clientId?: string

Waarde van eigenschap

string

clientIp

Het IPv4- of IPv6-adres van het clientapparaat. Het IP-adres wordt gebruikt om de locatie van de gebruiker te detecteren. Bing gebruikt de locatiegegevens om veilig zoekgedrag te bepalen. Hoewel dit optioneel is, wordt u aangeraden deze koptekst en de X-Search-Location-header altijd op te geven. Verdoezel het adres niet (bijvoorbeeld door de laatste octet te wijzigen in 0). Als u het adres verdoezelt, worden de resultaten van de locatie niet ergens in de buurt van de werkelijke locatie van het apparaat weergegeven. Dit kan ertoe leiden dat Bing onjuiste resultaten levert.

clientIp?: string

Waarde van eigenschap

string

count

Het aantal zoekresultaten dat moet worden geretourneerd in het antwoord. De standaardwaarde is 10 en de maximumwaarde is 50. Het werkelijke aantal dat wordt geleverd, kan kleiner zijn dan aangevraagd. Gebruik deze parameter samen met de offsetparameter voor paginaresultaten. Als uw gebruikersinterface bijvoorbeeld 10 zoekresultaten per pagina weergeeft, stelt u het aantal in op 10 en verschoven naar 0 om de eerste pagina met resultaten op te halen. Voor elke volgende pagina wordt de incrementele verschuiving met 10 (bijvoorbeeld 0, 10, 20) verhoogd. Het is mogelijk dat meerdere pagina's enige overlapping in de resultaten bevatten.

count?: number

Waarde van eigenschap

number

countryCode

Een landcode van twee tekens van het land waar de resultaten vandaan komen. Deze API ondersteunt alleen de markt van de Verenigde Staten. Als u deze queryparameter opgeeft, moet deze worden ingesteld op ons. Als u deze parameter instelt, moet u ook de Accept-Language header opgeven. Bing gebruikt de eerste ondersteunde taal die wordt gevonden in de talenlijst en combineer die taal met de landcode die u opgeeft om de markt te bepalen waarvoor de resultaten moeten worden geretourneerd. Als de talenlijst geen ondersteunde taal bevat, vindt Bing de dichtstbijzijnde taal en markt die ondersteuning biedt voor de aanvraag, of kan er een geaggregeerde of standaardmarkt worden gebruikt voor de resultaten in plaats van een opgegeven. U moet deze queryparameter en de Accept-Language queryparameter alleen gebruiken als u meerdere talen opgeeft; anders moet u de mkt en setLang-queryparameters gebruiken. Deze parameter en de mkt-queryparameter sluiten elkaar wederzijds uit. Geef niet beide op.

countryCode?: string

Waarde van eigenschap

string

freshness

Filter zoekresultaten op de volgende leeftijdswaarden: Dag: Retourneer webpagina's die Bing in de afgelopen 24 uur heeft gedetecteerd. Week: retourneer webpagina's die Bing in de afgelopen 7 dagen heeft gedetecteerd. Maand: retourneer webpagina's die in de afgelopen 30 dagen zijn gedetecteerd. Dit filter is alleen van toepassing op webpaginaresultaten en niet op de andere resultaten, zoals nieuws en afbeeldingen. Mogelijke waarden zijn: 'Dag', 'Week', 'Maand'

freshness?: Freshness

Waarde van eigenschap

Freshness

location

Een door puntkomma's gescheiden lijst met sleutel-/waardeparen die de geografische locatie van de client beschrijven. Bing gebruikt de locatiegegevens om veilig zoekgedrag te bepalen en relevante lokale inhoud te retourneren. Geef het sleutel-waardepaar op als <sleutel>:<waarde>. Hier volgen de sleutels die u gebruikt om de locatie van de gebruiker op te geven. lat (vereist): De breedtegraad van de locatie van de client, in graden. De breedtegraad moet groter dan of gelijk zijn aan -90,0 en kleiner dan of gelijk aan +90,0. Negatieve waarden geven zuidelijke breedtegraden aan en positieve waarden geven noordelijke breedtegraden aan. lang (vereist): de lengtegraad van de locatie van de client, in graden. De lengtegraad moet groter dan of gelijk zijn aan -180,0 en kleiner dan of gelijk aan +180,0. Negatieve waarden geven westerse lengtegraads aan en positieve waarden geven oostelijke lengtegraads aan. re (vereist): De straal, in meters, die de horizontale nauwkeurigheid van de coördinaten aangeeft. Geef de waarde door die wordt geretourneerd door de locatieservice van het apparaat. Typische waarden kunnen 22m zijn voor GPS/Wi-Fi, 380m voor triangulatie van de celtoren en 18.000m voor omgekeerde IP-zoekactie. ts (optioneel): de UTC UNIX-tijdstempel van toen de client zich op de locatie bevond. (De UNIX-tijdstempel is het aantal seconden sinds 1 januari 1970.) hoofd (optioneel): de relatieve koers of richting van de reis van de klant. Geef de richting van de reis op als graden van 0 tot en met 360, met de klok mee tellen ten opzichte van waar noorden. Geef deze sleutel alleen op als de sp-sleutel niet-nul is. sp (optioneel): de horizontale snelheid (snelheid), in meters per seconde, dat het clientapparaat onderweg is. alt (optioneel): De hoogte van het clientapparaat, in meters. zijn (optioneel): de straal, in meters, die de verticale nauwkeurigheid van de coördinaten aangeeft. Geef deze sleutel alleen op als u de alt-toets opgeeft. Hoewel veel van de sleutels optioneel zijn, hoe meer informatie u opgeeft, hoe nauwkeuriger de locatieresultaten zijn. Hoewel dit optioneel is, wordt u aangeraden altijd de geografische locatie van de gebruiker op te geven. Het instellen van de locatie is vooral belangrijk als het IP-adres van de client niet nauwkeurig overeenkomt met de fysieke locatie van de gebruiker (bijvoorbeeld als de client VPN gebruikt). Voor optimale resultaten moet u deze koptekst en de X-MSEdge-ClientIP-header opnemen, maar u moet deze header minimaal opnemen.

location?: string

Waarde van eigenschap

string

market

De markt waar de resultaten vandaan komen. Normaal gesproken is mkt het land waar de gebruiker de aanvraag indient. Het kan echter een ander land zijn als de gebruiker zich niet in een land bevindt waar Bing resultaten levert. De markt moet de vorm <hebben van de taalcode-landcode<>>. Bijvoorbeeld en-US. De tekenreeks is niet hoofdlettergevoelig. Indien bekend, wordt u aangemoedigd om altijd de markt op te geven. Door de markt op te geven, kan Bing de aanvraag routeren en een geschikt en optimaal antwoord retourneren. Als u een markt opgeeft die niet wordt vermeld in marktcodes, gebruikt Bing een best passende marktcode op basis van een interne toewijzing die onderhevig is aan wijzigingen. Deze parameter en de cc-queryparameter sluiten elkaar wederzijds uit. Geef beide niet op. Standaardwaarde: 'en-us'.

market?: string

Waarde van eigenschap

string

offset

De verschuiving op basis van nul die aangeeft hoeveel zoekresultaten moeten worden overgeslagen voordat er resultaten worden geretourneerd. De standaardwaarde is 0. De offset moet kleiner zijn dan (totalEstimatedMatches - count). Gebruik deze parameter samen met de tellingsparameter voor paginaresultaten. Als uw gebruikersinterface bijvoorbeeld 10 zoekresultaten per pagina weergeeft, stelt u het aantal in op 10 en verschoven naar 0 om de eerste pagina met resultaten op te halen. Voor elke volgende pagina wordt de incrementele verschuiving met 10 (bijvoorbeeld 0, 10, 20) verhoogd. het is mogelijk dat meerdere pagina's een aantal overlappingen in de resultaten opnemen.

offset?: number

Waarde van eigenschap

number

pragma

Bing retourneert standaard inhoud in de cache, indien beschikbaar. Als u wilt voorkomen dat Bing inhoud in de cache retourneert, stelt u de Pragma-header in op no-cache (bijvoorbeeld Pragma: no-cache).

pragma?: string

Waarde van eigenschap

string

promote

Een door komma's gescheiden lijst met antwoorden die u wilt opnemen in het antwoord, ongeacht hun classificatie. Als u bijvoorbeeld answerCount instelt op twee (2), zodat Bing de twee beste gerangschikte antwoorden retourneert, maar u ook het antwoord op nieuws wilt opnemen, zou u het niveau verhogen naar nieuws. Als de meest gerangschikte antwoorden webpagina's, afbeeldingen, video's en relatedSearches zijn, bevat het antwoord webpagina's en afbeeldingen omdat nieuws geen geclassificeerd antwoord is. Maar als u het niveau verhogen naar video instelt, zou Bing het videoantwoord in het antwoord promoten en webpagina's, afbeeldingen en video's retourneren. De antwoorden die u wilt promoveren, tellen niet mee met de answerCount-limiet. Als de gerangschikte antwoorden bijvoorbeeld nieuws, afbeeldingen en video's zijn en u answerCount instelt op 1 en promoveert op nieuws, bevat het antwoord nieuws en afbeeldingen. Of als de gerangschikte antwoorden video's, afbeeldingen en nieuws zijn, bevat het antwoord video's en nieuws. Mogelijke waarden zijn Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webpagina's. Alleen gebruiken als u answerCount opgeeft.

promote?: AnswerType[]

Waarde van eigenschap

AnswerType[]

responseFilter

Een door komma's gescheiden lijst met antwoorden die in het antwoord moeten worden opgenomen. Als u deze parameter niet opgeeft, bevat het antwoord alle zoekantwoorden waarvoor relevante gegevens zijn. Mogelijke filterwaarden zijn Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webpagina's. Hoewel u dit filter kunt gebruiken om één antwoord te krijgen, moet u in plaats daarvan het antwoordspecifieke eindpunt gebruiken om uitgebreidere resultaten te krijgen. Als u bijvoorbeeld alleen afbeeldingen wilt ontvangen, verzendt u de aanvraag naar een van de eindpunten van de Afbeeldingen zoeken-API. De antwoorden op RelatedSearches en SpellSuggestions bieden geen ondersteuning voor een afzonderlijk eindpunt, zoals de Afbeeldingen zoeken-API (alleen de Webzoekopdrachten-API retourneert ze). Als u antwoorden wilt opnemen die anders zouden worden uitgesloten vanwege classificatie, raadpleegt u de queryparameter promoveren.

responseFilter?: AnswerType[]

Waarde van eigenschap

AnswerType[]

safeSearch

Een filter dat wordt gebruikt om inhoud voor volwassenen te filteren. Uit: Retourneer webpagina's met tekst, afbeeldingen of video's voor volwassenen. Gemiddeld: retourneer webpagina's met tekst voor volwassenen, maar niet afbeeldingen of video's voor volwassenen. Strikt: Geen webpagina's retourneren met tekst, afbeeldingen of video's voor volwassenen. De standaardwaarde is Moderate. Als de aanvraag afkomstig is van een markt waarvoor het beleid voor volwassenen van Bing vereist dat SafeSearch is ingesteld op Strikt, negeert Bing de waarde safeSearch en gebruikt Strikt. Als u de site gebruikt: queryoperator, bestaat de kans dat het antwoord inhoud voor volwassenen kan bevatten, ongeacht waarop de safeSearch-queryparameter is ingesteld. Gebruik site: alleen als u op de hoogte bent van de inhoud op de site en uw scenario de mogelijkheid van inhoud voor volwassenen ondersteunt. Mogelijke waarden zijn: 'Uit', 'Gemiddeld', 'Strikt'

safeSearch?: SafeSearch

Waarde van eigenschap

SafeSearch

setLang

De taal die moet worden gebruikt voor tekenreeksen van de gebruikersinterface. Geef de taal op met behulp van de ISO 639-1 2-letter taalcode. De taalcode voor Engels is bijvoorbeeld EN. De standaardwaarde is EN (Engels). Hoewel dit optioneel is, moet u altijd de taal opgeven. Normaal gesproken stelt uLang in op dezelfde taal die is opgegeven door mkt, tenzij de gebruiker wil dat de tekenreeksen van de gebruikersinterface in een andere taal worden weergegeven. Deze parameter en de Accept-Language header sluiten elkaar wederzijds uit; geef niet beide op. Een gebruikersinterfacetekenreeks is een tekenreeks die wordt gebruikt als label in een gebruikersinterface. Er zijn enkele tekenreeksen voor de gebruikersinterface in de JSON-antwoordobjecten. Alle koppelingen naar Bing.com eigenschappen in de antwoordobjecten passen ook de opgegeven taal toe.

setLang?: string

Waarde van eigenschap

string

textDecorations

Een Booleaanse waarde die bepaalt of weergavetekenreeksen decoratiemarkeringen moeten bevatten, zoals het markeren van tekens. Indien waar, kunnen de tekenreeksen markeringen bevatten. De standaardwaarde is onwaar. Als u wilt opgeven of u Unicode-tekens of HTML-tags als markeringen wilt gebruiken, raadpleegt u de queryparameter textFormat.

textDecorations?: boolean

Waarde van eigenschap

boolean

textFormat

Het type markeringen dat moet worden gebruikt voor tekstdecoraties (zie de queryparameter textDecorations). Mogelijke waarden zijn Onbewerkt. Gebruik Unicode-tekens om inhoud te markeren die speciale opmaak nodig heeft. De Unicode-tekens bevinden zich in het bereik E000 tot en met E019. Bing gebruikt bijvoorbeeld E000 en E001 om het begin en einde van de querytermen te markeren voor het markeren van treffers. HTML: gebruik HTML-tags om inhoud te markeren die speciale opmaak nodig heeft. Gebruik bijvoorbeeld tags om querytermen in weergavetekenreeksen te markeren. De standaardwaarde is Raw. Voor weergavetekenreeksen die geschikte HTML-tekens bevatten, zoals <, >en &, als textFormat is ingesteld op HTML, escapet Bing de tekens naar wens (bijvoorbeeld < is ontsnapt aan <). Mogelijke waarden zijn: 'Raw', 'Html'

textFormat?: TextFormat

Waarde van eigenschap

TextFormat

userAgent

De gebruikersagent die de aanvraag heeft ingediend. Bing gebruikt de gebruikersagent om mobiele gebruikers een geoptimaliseerde ervaring te bieden. Hoewel dit optioneel is, wordt u sterk aangeraden deze header altijd op te geven. De gebruikersagent moet dezelfde tekenreeks zijn die elke veelgebruikte browser zou verzenden. Zie RFC 2616voor meer informatie over gebruikersagenten.

userAgent?: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

overgenomen van msRest.RequestOptionsBase.abortSignal

customHeaders

Door de gebruiker gedefinieerde aangepaste aanvraagheaders die worden toegepast voordat de aanvraag wordt verzonden.

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

Waarde van eigenschap

{[key: string]: string}

overgenomen van msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Callback die wordt geactiveerd bij de voortgang van het downloaden.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

overgenomen van msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Callback die wordt geactiveerd bij het uploaden.

onUploadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

overgenomen van msRest.RequestOptionsBase.onUploadProgress

timeout

Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beëindigd.

timeout?: number

Waarde van eigenschap

number

overgenomen van msRest.RequestOptionsBase.timeout