WebSearchOptionalParams interface

Pakket:

@azure/cognitiveservices-websearch

Optionele parameters.

Extends

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 is in aflopende volgorde van voorkeur. Zie RFC2616 voor meer informatie, waaronder de verwachte indeling. Deze header en de queryparameter setLang sluiten elkaar uit; geef niet beide op. Als u deze header instelt, moet u ook de queryparameter cc opgeven. Bing gebruikt de eerste ondersteunde taal die wordt gevonden in de lijst en combineert die taal met de parameterwaarde cc om te bepalen voor welke markt resultaten moeten worden geretourneerd. Als de lijst geen ondersteunde taal bevat, vindt Bing de dichtstbijzijnde taal en markt die de aanvraag ondersteunt en kan een geaggregeerde of standaardmarkt voor de resultaten worden gebruikt in plaats van een opgegeven markt. Gebruik deze header en de queryparameter cc alleen als u meerdere talen opgeeft. Anders moet u de queryparameters mkt en setLang 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 naar Bing.com eigenschappen worden toegepast op de opgegeven taal.
answerCount	Het aantal antwoorden dat u in het antwoord wilt opnemen. 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 instelt op webpagina's en nieuws, bevat het antwoord alleen webpagina's.
clientId	Bing gebruikt deze header om gebruikers consistent gedrag te bieden bij Bing API-aanroepen. Bing introduceert nieuwe functies en verbeteringen vaak in flights, en gebruikt de client-ID als sleutel voor het toewijzen van verkeer aan verschillende flights. Als u niet dezelfde client-id gebruikt voor een gebruiker voor meerdere aanvragen, kan Bing de gebruiker toewijzen aan meerdere conflicterende flights. Toewijzing aan meerdere conflicterende flights kan leiden tot een inconsistente gebruikerservaring. Als de tweede aanvraag bijvoorbeeld een andere flighttoewijzing heeft dan de eerste, kan de ervaring onverwacht zijn. Bing kan de client-id ook gebruiken om webresultaten aan te passen aan de zoekgeschiedenis van die client-id, waardoor de gebruiker een rijkere ervaring krijgt. Bing gebruikt deze header ook om de rangschikking van resultaten te verbeteren door de activiteit te analyseren die wordt gegenereerd door een client-id. De relevantie-verbeteringen helpen de kwaliteit van de resultaten die door Bing-API's worden geleverd te verbeteren, en maken op hun beurt hogere doorklikpercentages mogelijk voor de API-consument. BELANGRIJK: Hoewel deze header optioneel is, dient u deze als verplicht te beschouwen. Door de client-id te behouden voor meerdere aanvragen voor dezelfde combinatie van eindgebruiker en apparaat, zorgt u voor 1) een consistente gebruikerservaring van de API-consument, en 2) hogere doorklikpercentages via een 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 in de aanvraag opneemt, 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 voor deze gebruiker op het apparaat doet. Maak de client-id persistent. Gebruik in een browser-app een persistent HTTP-cookie om ervoor te zorgen dat de id in alle sessies wordt gebruikt. Gebruik geen sessiecookie. Voor andere apps, zoals mobiele apps, gebruikt u de persistente opslag van het apparaat om de id persistent te maken. De volgende keer dat de gebruiker uw app op dat apparaat gebruikt, haalt u de client-id op die u persistent hebt gemaakt. Bing-antwoorden kunnen deze header al dan niet bevatten. Als het antwoord deze header bevat, registreert u de client-id 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 voor het detecteren van de locatie van de gebruiker. Bing gebruikt de locatie-informatie om het gedrag van Veilig Zoeken te bepalen. Hoewel dit optioneel is, wordt u aangeraden altijd deze koptekst en de X-Search-Location-header op te geven. Verdoezel het adres niet (bijvoorbeeld door het laatste octet te wijzigen in 0). Wanneer u het adres verdoezelt, is de locatie totaal niet in de buurt van de werkelijke locatie van het apparaat, wat ertoe kan leiden dat Bing onjuiste resultaten geeft.
count	Het aantal zoekresultaten dat in het antwoord moet worden geretourneerd. De standaardwaarde is 10 en de maximumwaarde is 50. Het werkelijk geleverde aantal kan kleiner zijn dan aangevraagd. Gebruik deze parameter samen met de offsetparameter om resultaten op te geven. Als uw gebruikersinterface bijvoorbeeld 10 zoekresultaten per pagina weergeeft, stelt u aantal in op 10 en offset op 0 om de eerste pagina met resultaten te krijgen. Verhoog voor elke volgende pagina de offset met 10 (bijvoorbeeld 0, 10, 20). Het is mogelijk dat meerdere pagina's elkaar overlappen in de resultaten.
countryCode	Een landcode van 2 tekens van het land waar de resultaten vandaan komen. Deze API ondersteunt alleen de Verenigde Staten markt. 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 lijst met talen en combineer die taal met de landcode die u opgeeft om te bepalen voor welke markt resultaten moeten worden geretourneerd. Als de lijst met talen geen ondersteunde taal bevat, vindt Bing de dichtstbijzijnde taal en markt die de aanvraag ondersteunt, of gebruikt het mogelijk een geaggregeerde of standaardmarkt voor de resultaten in plaats van een opgegeven markt. U moet deze queryparameter en de Accept-Language queryparameter alleen gebruiken als u meerdere talen opgeeft; Anders moet u de queryparameters mkt en setLang gebruiken. Deze parameter en de queryparameter mkt sluiten elkaar uit. Geef niet beide op.
freshness	Filter zoekresultaten op de volgende leeftijdswaarden: Dag: webpagina's retourneren die Bing in de afgelopen 24 uur heeft gedetecteerd. Week: webpagina's retourneren die Bing in de afgelopen 7 dagen heeft gedetecteerd. Maand: hiermee worden webpagina's geretourneerd die in de afgelopen 30 dagen zijn gedetecteerd. Dit filter is alleen van toepassing op resultaten van webpagina's en niet op de andere resultaten, zoals nieuws en afbeeldingen. Mogelijke waarden zijn: 'Dag', 'Week', 'Maand'
location	Een met puntkomma's gescheiden lijst met sleutel-waardeparen die de geografische locatie van de client beschrijven. Bing gebruikt de locatie-informatie om het gedrag van Veilig Zoeken te bepalen en relevante lokale inhoud te retourneren. Geef het sleutel-waardepaar op als :. 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 noordelijke. long (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 westelijke lengtegraden aan, en positieve waarden oostelijke. 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 zijn bijvoorbeeld 22 m voor GPS/Wi-Fi, 380 m voor triangulatie op basis van gsm-masten en 18.000 m voor reverse IP-lookup. ts (optioneel): het UTC UNIX-tijdstempel van wanneer 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 klant. Geef de reisrichting op als graden van 0 t/m 360, gerekend met de klok mee ten opzichte van het ware noorden. Geef deze sleutel alleen op als de sp-sleutel een andere is dan nul. sp (optioneel): de horizontale snelheid (snelheid), in meters per seconde, die het clientapparaat gebruikt. 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 opgeven van de locatie is vooral belangrijk als het IP-adres van de client de fysieke locatie van de gebruiker niet nauwkeurig weergeeft (bijvoorbeeld als de client VPN gebruikt). Voor optimale resultaten moet u zowel deze header als de X-MSEdge-ClientIP-header opnemen, maar neem minimaal deze header op.
market	De markt waaruit de resultaten afkomstig zijn. Meestal is mkt het land van waaruit 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. Bijvoorbeeld: nl-NL. De tekenreeks is niet hoofdlettergevoelig. Indien bekend, wordt u aangeraden altijd de markt op te geven. Het specificeren van de markt helpt Bing de aanvraag te routeren en een passend en optimaal antwoord te geven. Als u een markt opgeeft die niet wordt vermeld in Marktcodes, gebruikt Bing een best passende marktcode op basis van een interne toewijzing die kan worden gewijzigd. Deze parameter en de queryparameter CC sluiten elkaar uit. Geef beide niet op. Standaardwaarde: 'en-us'.
offset	De offset op basis van nul die het aantal zoekresultaten aangeeft dat moet worden overgeslagen voordat resultaten worden geretourneerd. De standaardwaarde is 0. De offset moet kleiner zijn dan (totalEstimatedMatches - count). Gebruik deze parameter samen met de parameter count om resultaten op de pagina te plaatsen. Als uw gebruikersinterface bijvoorbeeld 10 zoekresultaten per pagina weergeeft, stelt u het aantal in op 10 en offset op 0 om de eerste pagina met resultaten te krijgen. Verhoog voor elke volgende pagina offset met 10 (bijvoorbeeld 0, 10, 20). het is mogelijk dat meerdere pagina's wat overlappen in de resultaten.
pragma	Bing retourneert standaard cache-inhoud, indien beschikbaar. Om te voorkomen dat Bing inhoud uit 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 in het antwoord wilt opnemen, ongeacht de rangschikking. Als u bijvoorbeeld answerCount) instelt op twee (2), zodat Bing de twee beste gerangschikte antwoorden retourneert, maar u ook nieuws wilt opnemen in het antwoord, stelt u niveau verhogen in op nieuws. Als de meest gerangschikte antwoorden webpagina's, afbeeldingen, video's en relatedSearches zijn, bevat het antwoord webpagina's en afbeeldingen omdat nieuws geen gerangschikt antwoord is. Maar als u niveau verhogen instelt op video, promoveert Bing het videoantwoord in het antwoord en worden webpagina's, afbeeldingen en video's geretourneerd. De antwoorden die u wilt promoveren, tellen niet mee voor de limiet van answerCount. Als de gerangschikte antwoorden bijvoorbeeld nieuws, afbeeldingen en video's zijn en u answerCount instelt op 1 en promoveert naar 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 Berekening, Afbeeldingen, Nieuws, RelatedSearches, Spellingsuggesties, Tijdzone, Video's, Webpagina's. Gebruik alleen 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 rijkere resultaten te krijgen. Als u bijvoorbeeld alleen afbeeldingen wilt ontvangen, verzendt u de aanvraag naar een van de eindpunten van de Image Search-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 de classificatie, raadpleegt u de queryparameter niveau verhogen.
safeSearch	Een filter dat wordt gebruikt voor het filteren van inhoud voor volwassenen. Uit: webpagina's retourneren met tekst, afbeeldingen of video's voor volwassenen. Gemiddeld: webpagina's retourneren met tekst voor volwassenen, maar niet met afbeeldingen of video's voor volwassenen. Strikt: retourneer geen webpagina's 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 queryoperator site: gebruikt, bestaat de kans dat het antwoord inhoud voor volwassenen bevat, ongeacht waarop de queryparameter safeSearch is ingesteld. Site gebruiken: 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 gebruikersinterfacetekenreeksen. Geef de taal op met behulp van de tweeletterige ISO 639-1 taalcode. De taalcode voor Nederlands is bijvoorbeeld NL. De standaardwaarde is EN (Engels). Hoewel dit optioneel is, moet u altijd de taal opgeven. Normaal gesproken stelt u setLang in op dezelfde taal die is opgegeven door mkt, tenzij de gebruiker de tekenreeksen van de gebruikersinterface in een andere taal wil weergeven. Deze parameter en de Accept-Language-header sluiten elkaar uit; geef niet beide op. Een gebruikersinterfacetekenreeks is een tekenreeks die wordt gebruikt als label in een gebruikersinterface. Er zijn maar weinig gebruikersinterfacetekenreeksen in de JSON-antwoordobjecten. De opgegeven taal wordt ook toegepast op koppelingen naar Bing.com-eigenschappen in de antwoordobjecten.
textDecorations	Een Booleaanse waarde die bepaalt of weergavetekenreeksen decoratiemarkeringen moeten bevatten, zoals het markeren van treffers. Indien waar, kunnen de tekenreeksen markeringen bevatten. De standaardwaarde is false. Als u wilt opgeven of Unicode-tekens of HTML-tags als markeringen moeten worden gebruikt, 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 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 html-tekens bevatten die geschikt zijn, zoals <, en &, als textFormat is ingesteld op HTML, worden de tekens waar nodig door Bing escape-tekens gebruikt (bijvoorbeeld < is escaped naar <>). Mogelijke waarden zijn: 'Raw', 'HTML'
userAgent	De gebruikersagent waarvan de aanvraag afkomstig is. Bing gebruikt de user-agent om mobiele gebruikers een geoptimaliseerde ervaring te bieden. Hoewel dit optioneel is, wordt u sterk aangeraden deze header altijd op te geven. De user-agent moet dezelfde tekenreeks zijn die door een veelgebruikte browser wordt verzonden. Zie RFC 2616 voor 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 de voortgang van 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 is in aflopende volgorde van voorkeur. Zie RFC2616 voor meer informatie, waaronder de verwachte indeling. Deze header en de queryparameter setLang sluiten elkaar uit; geef niet beide op. Als u deze header instelt, moet u ook de queryparameter cc opgeven. Bing gebruikt de eerste ondersteunde taal die wordt gevonden in de lijst en combineert die taal met de parameterwaarde cc om te bepalen voor welke markt resultaten moeten worden geretourneerd. Als de lijst geen ondersteunde taal bevat, vindt Bing de dichtstbijzijnde taal en markt die de aanvraag ondersteunt en kan een geaggregeerde of standaardmarkt voor de resultaten worden gebruikt in plaats van een opgegeven markt. Gebruik deze header en de queryparameter cc alleen als u meerdere talen opgeeft. Anders moet u de queryparameters mkt en setLang 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 naar Bing.com eigenschappen worden toegepast op de opgegeven taal.

acceptLanguage?: string

Waarde van eigenschap

string

answerCount

Het aantal antwoorden dat u in het antwoord wilt opnemen. 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 instelt 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 bij Bing API-aanroepen. Bing introduceert nieuwe functies en verbeteringen vaak in flights, en gebruikt de client-ID als sleutel voor het toewijzen van verkeer aan verschillende flights. Als u niet dezelfde client-id gebruikt voor een gebruiker voor meerdere aanvragen, kan Bing de gebruiker toewijzen aan meerdere conflicterende flights. Toewijzing aan meerdere conflicterende flights kan leiden tot een inconsistente gebruikerservaring. Als de tweede aanvraag bijvoorbeeld een andere flighttoewijzing heeft dan de eerste, kan de ervaring onverwacht zijn. Bing kan de client-id ook gebruiken om webresultaten aan te passen aan de zoekgeschiedenis van die client-id, waardoor de gebruiker een rijkere ervaring krijgt. Bing gebruikt deze header ook om de rangschikking van resultaten te verbeteren door de activiteit te analyseren die wordt gegenereerd door een client-id. De relevantie-verbeteringen helpen de kwaliteit van de resultaten die door Bing-API's worden geleverd te verbeteren, en maken op hun beurt hogere doorklikpercentages mogelijk voor de API-consument. BELANGRIJK: Hoewel deze header optioneel is, dient u deze als verplicht te beschouwen. Door de client-id te behouden voor meerdere aanvragen voor dezelfde combinatie van eindgebruiker en apparaat, zorgt u voor 1) een consistente gebruikerservaring van de API-consument, en 2) hogere doorklikpercentages via een 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 in de aanvraag opneemt, 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 voor deze gebruiker op het apparaat doet. Maak de client-id persistent. Gebruik in een browser-app een persistent HTTP-cookie om ervoor te zorgen dat de id in alle sessies wordt gebruikt. Gebruik geen sessiecookie. Voor andere apps, zoals mobiele apps, gebruikt u de persistente opslag van het apparaat om de id persistent te maken. De volgende keer dat de gebruiker uw app op dat apparaat gebruikt, haalt u de client-id op die u persistent hebt gemaakt. Bing-antwoorden kunnen deze header al dan niet bevatten. Als het antwoord deze header bevat, registreert u de client-id 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 voor het detecteren van de locatie van de gebruiker. Bing gebruikt de locatie-informatie om het gedrag van Veilig Zoeken te bepalen. Hoewel dit optioneel is, wordt u aangeraden altijd deze koptekst en de X-Search-Location-header op te geven. Verdoezel het adres niet (bijvoorbeeld door het laatste octet te wijzigen in 0). Wanneer u het adres verdoezelt, is de locatie totaal niet in de buurt van de werkelijke locatie van het apparaat, wat ertoe kan leiden dat Bing onjuiste resultaten geeft.

clientIp?: string

Waarde van eigenschap

string

count

Het aantal zoekresultaten dat in het antwoord moet worden geretourneerd. De standaardwaarde is 10 en de maximumwaarde is 50. Het werkelijk geleverde aantal kan kleiner zijn dan aangevraagd. Gebruik deze parameter samen met de offsetparameter om resultaten op te geven. Als uw gebruikersinterface bijvoorbeeld 10 zoekresultaten per pagina weergeeft, stelt u aantal in op 10 en offset op 0 om de eerste pagina met resultaten te krijgen. Verhoog voor elke volgende pagina de offset met 10 (bijvoorbeeld 0, 10, 20). Het is mogelijk dat meerdere pagina's elkaar overlappen in de resultaten.

count?: number

Waarde van eigenschap

number

countryCode

Een landcode van 2 tekens van het land waar de resultaten vandaan komen. Deze API ondersteunt alleen de Verenigde Staten markt. 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 lijst met talen en combineer die taal met de landcode die u opgeeft om te bepalen voor welke markt resultaten moeten worden geretourneerd. Als de lijst met talen geen ondersteunde taal bevat, vindt Bing de dichtstbijzijnde taal en markt die de aanvraag ondersteunt, of gebruikt het mogelijk een geaggregeerde of standaardmarkt voor de resultaten in plaats van een opgegeven markt. U moet deze queryparameter en de Accept-Language queryparameter alleen gebruiken als u meerdere talen opgeeft; Anders moet u de queryparameters mkt en setLang gebruiken. Deze parameter en de queryparameter mkt sluiten elkaar uit. Geef niet beide op.

countryCode?: string

Waarde van eigenschap

string

freshness

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

freshness?: Freshness

Waarde van eigenschap

Freshness

location

Een met puntkomma's gescheiden lijst met sleutel-waardeparen die de geografische locatie van de client beschrijven. Bing gebruikt de locatie-informatie om het gedrag van Veilig Zoeken te bepalen en relevante lokale inhoud te retourneren. Geef het sleutel-waardepaar op als :. 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 noordelijke. long (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 westelijke lengtegraden aan, en positieve waarden oostelijke. 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 zijn bijvoorbeeld 22 m voor GPS/Wi-Fi, 380 m voor triangulatie op basis van gsm-masten en 18.000 m voor reverse IP-lookup. ts (optioneel): het UTC UNIX-tijdstempel van wanneer 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 klant. Geef de reisrichting op als graden van 0 t/m 360, gerekend met de klok mee ten opzichte van het ware noorden. Geef deze sleutel alleen op als de sp-sleutel een andere is dan nul. sp (optioneel): de horizontale snelheid (snelheid), in meters per seconde, die het clientapparaat gebruikt. 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 opgeven van de locatie is vooral belangrijk als het IP-adres van de client de fysieke locatie van de gebruiker niet nauwkeurig weergeeft (bijvoorbeeld als de client VPN gebruikt). Voor optimale resultaten moet u zowel deze header als de X-MSEdge-ClientIP-header opnemen, maar neem minimaal deze header op.

location?: string

Waarde van eigenschap

string

market

De markt waaruit de resultaten afkomstig zijn. Meestal is mkt het land van waaruit 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. Bijvoorbeeld: nl-NL. De tekenreeks is niet hoofdlettergevoelig. Indien bekend, wordt u aangeraden altijd de markt op te geven. Het specificeren van de markt helpt Bing de aanvraag te routeren en een passend en optimaal antwoord te geven. Als u een markt opgeeft die niet wordt vermeld in Marktcodes, gebruikt Bing een best passende marktcode op basis van een interne toewijzing die kan worden gewijzigd. Deze parameter en de queryparameter CC sluiten elkaar uit. Geef beide niet op. Standaardwaarde: 'en-us'.

market?: string

Waarde van eigenschap

string

offset

De offset op basis van nul die het aantal zoekresultaten aangeeft dat moet worden overgeslagen voordat resultaten worden geretourneerd. De standaardwaarde is 0. De offset moet kleiner zijn dan (totalEstimatedMatches - count). Gebruik deze parameter samen met de parameter count om resultaten op de pagina te plaatsen. Als uw gebruikersinterface bijvoorbeeld 10 zoekresultaten per pagina weergeeft, stelt u het aantal in op 10 en offset op 0 om de eerste pagina met resultaten te krijgen. Verhoog voor elke volgende pagina offset met 10 (bijvoorbeeld 0, 10, 20). het is mogelijk dat meerdere pagina's wat overlappen in de resultaten.

offset?: number

Waarde van eigenschap

number

pragma

Bing retourneert standaard cache-inhoud, indien beschikbaar. Om te voorkomen dat Bing inhoud uit 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 in het antwoord wilt opnemen, ongeacht de rangschikking. Als u bijvoorbeeld answerCount) instelt op twee (2), zodat Bing de twee beste gerangschikte antwoorden retourneert, maar u ook nieuws wilt opnemen in het antwoord, stelt u niveau verhogen in op nieuws. Als de meest gerangschikte antwoorden webpagina's, afbeeldingen, video's en relatedSearches zijn, bevat het antwoord webpagina's en afbeeldingen omdat nieuws geen gerangschikt antwoord is. Maar als u niveau verhogen instelt op video, promoveert Bing het videoantwoord in het antwoord en worden webpagina's, afbeeldingen en video's geretourneerd. De antwoorden die u wilt promoveren, tellen niet mee voor de limiet van answerCount. Als de gerangschikte antwoorden bijvoorbeeld nieuws, afbeeldingen en video's zijn en u answerCount instelt op 1 en promoveert naar 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 Berekening, Afbeeldingen, Nieuws, RelatedSearches, Spellingsuggesties, Tijdzone, Video's, Webpagina's. Gebruik alleen 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 rijkere resultaten te krijgen. Als u bijvoorbeeld alleen afbeeldingen wilt ontvangen, verzendt u de aanvraag naar een van de eindpunten van de Image Search-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 de classificatie, raadpleegt u de queryparameter niveau verhogen.

responseFilter?: AnswerType[]

Waarde van eigenschap

AnswerType[]

safeSearch

Een filter dat wordt gebruikt voor het filteren van inhoud voor volwassenen. Uit: webpagina's retourneren met tekst, afbeeldingen of video's voor volwassenen. Gemiddeld: webpagina's retourneren met tekst voor volwassenen, maar niet met afbeeldingen of video's voor volwassenen. Strikt: retourneer geen webpagina's 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 queryoperator site: gebruikt, bestaat de kans dat het antwoord inhoud voor volwassenen bevat, ongeacht waarop de queryparameter safeSearch is ingesteld. Site gebruiken: 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 gebruikersinterfacetekenreeksen. Geef de taal op met behulp van de tweeletterige ISO 639-1 taalcode. De taalcode voor Nederlands is bijvoorbeeld NL. De standaardwaarde is EN (Engels). Hoewel dit optioneel is, moet u altijd de taal opgeven. Normaal gesproken stelt u setLang in op dezelfde taal die is opgegeven door mkt, tenzij de gebruiker de tekenreeksen van de gebruikersinterface in een andere taal wil weergeven. Deze parameter en de Accept-Language-header sluiten elkaar uit; geef niet beide op. Een gebruikersinterfacetekenreeks is een tekenreeks die wordt gebruikt als label in een gebruikersinterface. Er zijn maar weinig gebruikersinterfacetekenreeksen in de JSON-antwoordobjecten. De opgegeven taal wordt ook toegepast op koppelingen naar Bing.com-eigenschappen in de antwoordobjecten.

setLang?: string

Waarde van eigenschap

string

textDecorations

Een Booleaanse waarde die bepaalt of weergavetekenreeksen decoratiemarkeringen moeten bevatten, zoals het markeren van treffers. Indien waar, kunnen de tekenreeksen markeringen bevatten. De standaardwaarde is false. Als u wilt opgeven of Unicode-tekens of HTML-tags als markeringen moeten worden gebruikt, 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 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 html-tekens bevatten die geschikt zijn, zoals <, en &, als textFormat is ingesteld op HTML, worden de tekens waar nodig door Bing escape-tekens gebruikt (bijvoorbeeld < is escaped naar <>). Mogelijke waarden zijn: 'Raw', 'HTML'

textFormat?: TextFormat

Waarde van eigenschap

TextFormat

userAgent

De gebruikersagent waarvan de aanvraag afkomstig is. Bing gebruikt de user-agent om mobiele gebruikers een geoptimaliseerde ervaring te bieden. Hoewel dit optioneel is, wordt u sterk aangeraden deze header altijd op te geven. De user-agent moet dezelfde tekenreeks zijn die door een veelgebruikte browser wordt verzonden. Zie RFC 2616 voor 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 de voortgang van 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