WebSearchOptionalParams interface

Pacchetto:

@azure/cognitiveservices-websearch

Parametri facoltativi.

Extends

RequestOptionsBase

Proprietà

acceptLanguage	Elenco delimitato da virgole di una o più lingue da usare per le stringhe dell'interfaccia utente. L'elenco è in ordine decrescente di preferenza. Per altre informazioni, incluso il formato previsto, vedere RFC2616. Questa intestazione e il parametro di query setLang si escludono a vicenda; non specificare entrambi. Se si imposta questa intestazione, è necessario inoltre specificare il parametro di query cc. Bing userà il primo linguaggio supportato trovato dall'elenco e combina tale lingua con il valore del parametro cc per determinare il mercato per restituire i risultati. Se l'elenco non include una lingua supportata, Bing troverà la lingua e il mercato più vicini che supporta la richiesta e può usare un mercato aggregato o predefinito per i risultati anziché uno specificato. È consigliabile usare questa intestazione e il parametro di query cc solo se si specificano più lingue; in caso contrario, è consigliabile usare i parametri di query mkt e setLang. Una stringa di interfaccia utente è una stringa usata come etichetta in un'interfaccia utente. Esistono poche stringhe dell'interfaccia utente negli oggetti di risposta JSON. Tutti i collegamenti negli oggetti di risposta alle proprietà Bing.com applicano la lingua specificata.
answerCount	Numero di risposte che si desidera includere la risposta. Le risposte restituite da Bing si basano sulla classificazione. Ad esempio, se Bing restituisce pagine Web, immagini, video e correlatiSearches per una richiesta e si imposta questo parametro su due (2), la risposta include pagine Web e immagini. Se è stato incluso il parametro di query responseFilter nella stessa richiesta e lo si imposta su pagine Web e notizie, la risposta include solo pagine Web.
clientId	Bing usa questa intestazione per fornire agli utenti un comportamento coerente tra le chiamate API Bing. Bing spesso invia in versione di anteprima i miglioramenti e le nuove funzionalità e usa l'ID client come chiave per l'assegnazione del traffico per le diverse versioni di anteprima. Se non si usa lo stesso ID client per un utente in più richieste, Bing può assegnare l'utente a più versioni di anteprima in conflitto. L'assegnazione a più versioni di anteprima in conflitto può generare un'esperienza utente incoerente. Ad esempio, se alla seconda richiesta viene assegnata una versione di anteprima diversa rispetto alla prima, è possibile che l'esperienza non sia quella prevista. Inoltre, Bing può usare l'ID client per adattare i risultati Web alla cronologia di ricerca dell'ID client, fornendo un'esperienza più completa per l'utente. Bing usa questa intestazione anche per migliorare le classifiche dei risultati analizzando l'attività generata da un ID client. I miglioramenti di pertinenza migliorano la qualità dei risultati forniti dalle API Bing consentendo, di conseguenza, percentuali di click-through più elevate per il consumer API. IMPORTANTE: sebbene sia facoltativa, è opportuno considerare obbligatoria questa intestazione. Salvare in modo permanente l'ID client in più richieste per la stessa combinazione di dispositivo e utente finale consente 1) al consumer API di ottenere un'esperienza utente coerente e 2) percentuali di click-through più elevate migliorando la qualità dei risultati dalle API Bing. Ogni utente che usa l'applicazione nel dispositivo deve avere un ID client univoco generato da Bing. Se non si include questa intestazione nella richiesta, Bing genera un ID e lo restituisce nell'intestazione della risposta X-MSEdge-ClientID. L'unica volta in cui NON è necessario includere questa intestazione in una richiesta è la prima volta l'utente usa l'app nel dispositivo. Usare l'ID client per ogni richiesta dell'API Bing che l'app effettua per questo utente nel dispositivo. Salvare l'ID client in modo permanente. Per salvare in modo permanente l'ID in un'app browser, usare un cookie HTTP permanente per far sì che l'ID venga usato in tutte le sessioni. Non usare un cookie di sessione. Per altre app, ad esempio le app per dispositivi mobili, usare l'archiviazione permanente del dispositivo per salvare in modo permanente l'ID. La volta successiva che l'utente usa l'app in questo dispositivo, ottiene l'ID client salvato in modo permanente. le risposte Bing possono includere o meno questa intestazione. Se la risposta include questa intestazione, acquisire l'ID client e usarlo per tutte le richieste Bing successive per l'utente in tale dispositivo. se si include X-MSEdge-ClientID, non includere i cookie nella richiesta.
clientIp	Indirizzo IPv4 o IPv6 del dispositivo client. L'indirizzo IP viene usato per individuare la posizione dell'utente. Bing usa le informazioni sulla posizione per determinare il comportamento di ricerca sicura. sebbene sia facoltativa, è consigliabile specificare sempre questa intestazione e l'intestazione X-Search-Location. Non offuscare l'indirizzo, ad esempio, modificando l'ultimo ottetto su 0. L'offuscamento dei risultati degli indirizzi nella posizione in un punto non vicino alla posizione effettiva del dispositivo può generare risultati errati in Bing.
count	Il numero di risultati della ricerca da restituire nella risposta. Il valore predefinito è 10 e il valore massimo è 50. Il numero effettivo recapitato può essere minore di quello richiesto. Usare questo parametro insieme al parametro offset per visualizzare i risultati della pagina. Ad esempio, se l'interfaccia utente visualizza 10 risultati della ricerca per pagina, impostare il conteggio su 10 e offset su 0 per ottenere la prima pagina dei risultati. Per ogni pagina successiva, l'offset di incremento per 10 (ad esempio, 0, 10, 20). È possibile che più pagine includano alcune sovrapposizioni nei risultati.
countryCode	Codice di 2 caratteri del paese da cui provengono i risultati. Questa API supporta solo il mercato Stati Uniti. Se si specifica questo parametro di query, deve essere impostato su di noi. Se si imposta questo parametro, è necessario specificare anche l'intestazione Accept-Language. Bing usa la prima lingua supportata che trova dall'elenco delle lingue e combina tale lingua con il codice paese specificato per determinare il mercato per restituire i risultati. Se l'elenco delle lingue non include una lingua supportata, Bing trova la lingua e il mercato più vicini che supporta la richiesta oppure può usare un mercato aggregato o predefinito per i risultati anziché uno specificato. È consigliabile usare questo parametro di query e il parametro di query Accept-Language solo se si specificano più lingue; in caso contrario, è consigliabile usare i parametri di query mkt e setLang. Questo parametro e il parametro di query mkt si escludono a vicenda, non specificano entrambi.
freshness	Filtrare i risultati della ricerca in base ai valori di età seguenti: Giorno: Restituire pagine Web individuate da Bing negli ultimi 24 ore. Settimana: restituisce pagine Web individuate da Bing negli ultimi 7 giorni. Mese: restituisce pagine Web individuate negli ultimi 30 giorni. Questo filtro si applica solo ai risultati della pagina Web e non agli altri risultati, ad esempio notizie e immagini. I valori possibili includono: 'Day', 'Week', 'Month'
location	Elenco delimitato da punto e virgola di coppie chiave/valore che descrivono la posizione geografica del client. Bing usa le informazioni sulla posizione per determinare il comportamento di ricerca sicura e per restituire il contenuto locale pertinente. Specificare la coppia chiave/valore come :. Di seguito sono indicate le chiavi usate per specificare la posizione dell'utente. lat (obbligatorio): latitudine della posizione del client, in gradi. La latitudine deve essere maggiore o uguale a -90,0 e minore o uguale a + 90,0. I valori negativi indicano le latitudini meridionali e i valori positivi indicano le latitudini settentrionali. long (obbligatorio): longitudine della posizione del client, in gradi. La longitudine deve essere maggiore o uguale a -180,0 e minore o uguale a +180,0. I valori negativi indicano le latitudini occidentali e i valori positivi indicano le latitudini orientali. re (obbligatorio): raggio, in metri, che specifica l'accuratezza orizzontale delle coordinate. Passare il valore restituito dal servizio che rileva la posizione del dispositivo. I valori tipici potrebbero essere 22 m per GPS/Wi-Fi, 380 m per la triangolazione dei ripetitori di rete e 18.000 m per la ricerca inversa degli indirizzi IP. ts (facoltativo): timestamp UNIX UTC di quando il client era nella posizione. Il timestamp UNIX è il numero di secondi dal 1° gennaio 1970. head (facoltativo): l'intestazione o la direzione relativa del client di viaggio. Specificare la direzione di viaggio come gradi da 0 a 360, partendo in senso orario rispetto al vero nord. Specificare questa chiave solo se la chiave sp è diversa da zero. sp (facoltativo): velocità orizzontale (velocità), in metri al secondo, che il dispositivo client sta viaggiando. alt (facoltativo): altitudine del dispositivo client, in metri. sono (facoltativo): il raggio, in metri, che specifica l'accuratezza verticale delle coordinate. Specificare questa chiave solo se si specifica la chiave alt. sebbene molte chiavi siano facoltative, più informazioni vengono specificate, più accurati sono i risultati relativi alle posizioni. anche se è facoltativa, è opportuno specificare sempre la posizione geografica dell'utente. Specificare la posizione è particolarmente importante se l'indirizzo IP del client non riflette accuratamente la posizione fisica dell'utente, ad esempio, se il client usa una VPN. Per ottenere risultati ottimali, è necessario includere questa intestazione e l'intestazione X-MSEdge-ClientIP ma, è necessario almeno includere questa intestazione.
market	Mercato dal quale provengono i risultati. In genere, mkt è il paese in cui l'utente effettua la richiesta. Tuttavia, potrebbe essere un paese diverso se l'utente non si trova in un paese in cui Bing offre risultati. Il mercato deve essere sotto forma -. ad esempio en-US. La stringa è senza distinzione tra maiuscole e minuscole. Se noto, si consiglia di specificare sempre il mercato. La specifica del mercato consente a Bing indirizzare la richiesta e di restituire una risposta appropriata e ottimale. Se si specifica un mercato non elencato in Codici di mercato, Bing usa un codice di mercato più adatto in base a un mapping interno soggetto a modifiche. Questo parametro e il parametro di query cc si escludono a vicenda, non specificano entrambi. Valore predefinito: 'en-us'.
offset	Offset in base zero che indica il numero di risultati della ricerca da ignorare prima di restituire i risultati. Il valore predefinito è 0. L'offset deve essere minore di (totalEstimatedMatches - conteggio). Usare questo parametro insieme al parametro count per visualizzare i risultati della pagina. Ad esempio, se l'interfaccia utente visualizza 10 risultati della ricerca per pagina, impostare il conteggio su 10 e offset su 0 per ottenere la prima pagina dei risultati. Per ogni pagina successiva, l'offset di incremento per 10 (ad esempio, 0, 10, 20). è possibile che più pagine includano alcune sovrapposizioni nei risultati.
pragma	Per impostazione predefinita, Bing restituisce il contenuto memorizzato nella cache, se disponibile. Per impedire a Bing di restituire il contenuto memorizzato nella cache, impostare l'intestazione Pragma su no-cache, ad esempio, Pragma: no-cache.
promote	Elenco delimitato da virgole di risposte che si desidera includere la risposta indipendentemente dalla classificazione. Ad esempio, se si imposta answerCount) su due (2) in modo che Bing restituisce le prime due risposte classificate, ma si vuole anche che la risposta includa notizie, si imposta la promozione su notizie. Se le risposte più classificate sono pagine Web, immagini, video e correlatiSearches, la risposta include pagine Web e immagini perché le notizie non sono una risposta classificata. Tuttavia, se si imposta la promozione al video, Bing promuoverà la risposta video nella risposta e restituirà pagine Web, immagini e video. Le risposte che si desidera promuovere non conteggiano il limite di answerCount. Ad esempio, se le risposte classificate sono notizie, immagini e video e si imposta rispostaCount su 1 e promuovere le notizie, la risposta contiene notizie e immagini. In alternativa, se i riscontri classificati sono video, immagini e notizie, la risposta contiene video e notizie. I valori possibili sono Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Video, Pagine Web. Usare solo se si specifica answerCount.
responseFilter	Elenco delimitato da virgole di risposte da includere nella risposta. Se non si specifica questo parametro, la risposta include tutte le risposte di ricerca per cui sono presenti dati pertinenti. I valori dei filtri possibili sono Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Video, Pagine Web. Anche se è possibile usare questo filtro per ottenere una singola risposta, è consigliabile usare invece l'endpoint specifico della risposta per ottenere risultati più avanzati. Ad esempio, per ricevere solo immagini, inviare la richiesta a uno degli endpoint dell'API Ricerca immagini. Le risposte RelatedSearches e SpellSuggestions non supportano un endpoint separato, ad esempio l'API Ricerca immagini ( solo l'API Ricerca Web li restituisce). Per includere risposte che altrimenti sarebbero escluse a causa della classificazione, vedere il parametro di promozione della query.
safeSearch	Filtro usato per filtrare il contenuto per adulti. Off: restituisce pagine Web con testo, immagini o video adulti. Moderata: restituisce pagine Web con testo adulto, ma non immagini adulte o video. Rigoroso: non restituire pagine Web con testo adulto, immagini o video. Il valore predefinito è Moderate. Se la richiesta proviene da un mercato che i criteri per adulti di Bing richiedono che SafeSearch sia impostato su Strict, Bing ignora il valore safeSearch e usa Strict. Se si usa l'operatore di query: query, è possibile che la risposta contenga contenuto adulto indipendentemente dal parametro di query safeSearch impostato su. Usare il sito: solo se si è a conoscenza del contenuto nel sito e lo scenario supporta la possibilità di contenuto per adulti. I valori possibili includono: 'Off', 'Moderate', 'Strict'
setLang	Lingua da usare per le stringhe dell'interfaccia utente. Specificare la lingua tramite il codice lingua a due lettere ISO 639-1. Ad esempio, il codice lingua per l'inglese è EN. L'impostazione predefinita è EN (inglese). Sebbene sia facoltativo, è opportuno specificare sempre la lingua. In genere, si impostaLang sulla stessa lingua specificata da mkt, a meno che l'utente non voglia che le stringhe dell'interfaccia utente vengano visualizzate in una lingua diversa. Questo parametro e l'intestazione Accept-Language si escludono a vicenda; non specificare entrambi. Una stringa di interfaccia utente è una stringa usata come etichetta in un'interfaccia utente. Gli oggetti di risposta JSON contengono poche stringhe di interfaccia utente. Eventuali collegamenti alle proprietà Bing.com negli oggetti risposta si applicano anche alla lingua specificata.
textDecorations	Valore booleano che determina se le stringhe di visualizzazione devono contenere marcatori di decorazione, ad esempio l'evidenziazione dei caratteri. Se true, le stringhe possono includere marcatori. Il valore predefinito è false. Per specificare se usare i caratteri Unicode o i tag HTML come marcatori, vedere il parametro di query textFormat.
textFormat	Tipo di marcatori da usare per le decorazioni di testo (vedere il parametro di query textDecorations). I valori possibili sono Raw: usare i caratteri Unicode per contrassegnare il contenuto che richiede una formattazione speciale. I caratteri Unicode si trovano nell'intervallo E000 a E019. Ad esempio, Bing usa E000 e E001 per contrassegnare l'inizio e la fine delle condizioni di query per l'evidenziazione. HTML: usare i tag HTML per contrassegnare il contenuto che necessita di formattazione speciale. Ad esempio, usare i tag per evidenziare i termini di query nelle stringhe di visualizzazione. Il valore predefinito è Raw. Per le stringhe di visualizzazione che contengono caratteri HTML non idonei, <ad esempio , >e &, se textFormat è impostato su HTML, Bing esegue l'escape dei caratteri in base alle esigenze, ad esempio < viene eseguito l'escape a <). I valori possibili includono: 'Raw', 'Html'
userAgent	L'agente utente di origine della richiesta. Bing usa l'agente utente per fornire agli utenti di dispositivi mobili un'esperienza ottimizzata. Anche se facoltativo, è consigliabile specificare sempre questa intestazione. L'agente utente deve essere la stessa stringa che qualsiasi browser comunemente usato invia. Per informazioni sugli agenti utente, vedere RFC 2616.

Proprietà ereditate

abortSignal	Segnale che può essere usato per interrompere le richieste.
customHeaders	Intestazioni di richiesta personalizzate definite dall'utente che verranno applicate prima dell'invio della richiesta.
onDownloadProgress	Callback che viene attivato al download dello stato di avanzamento.
onUploadProgress	Callback che viene attivato al caricamento dello stato di avanzamento.
timeout	Il numero di millisecondi che una richiesta può richiedere prima di essere terminata automaticamente.

Dettagli proprietà

acceptLanguage

Elenco delimitato da virgole di una o più lingue da usare per le stringhe dell'interfaccia utente. L'elenco è in ordine decrescente di preferenza. Per altre informazioni, incluso il formato previsto, vedere RFC2616. Questa intestazione e il parametro di query setLang si escludono a vicenda; non specificare entrambi. Se si imposta questa intestazione, è necessario inoltre specificare il parametro di query cc. Bing userà il primo linguaggio supportato trovato dall'elenco e combina tale lingua con il valore del parametro cc per determinare il mercato per restituire i risultati. Se l'elenco non include una lingua supportata, Bing troverà la lingua e il mercato più vicini che supporta la richiesta e può usare un mercato aggregato o predefinito per i risultati anziché uno specificato. È consigliabile usare questa intestazione e il parametro di query cc solo se si specificano più lingue; in caso contrario, è consigliabile usare i parametri di query mkt e setLang. Una stringa di interfaccia utente è una stringa usata come etichetta in un'interfaccia utente. Esistono poche stringhe dell'interfaccia utente negli oggetti di risposta JSON. Tutti i collegamenti negli oggetti di risposta alle proprietà Bing.com applicano la lingua specificata.

acceptLanguage?: string

Valore della proprietà

string

answerCount

Numero di risposte che si desidera includere la risposta. Le risposte restituite da Bing si basano sulla classificazione. Ad esempio, se Bing restituisce pagine Web, immagini, video e correlatiSearches per una richiesta e si imposta questo parametro su due (2), la risposta include pagine Web e immagini. Se è stato incluso il parametro di query responseFilter nella stessa richiesta e lo si imposta su pagine Web e notizie, la risposta include solo pagine Web.

answerCount?: number

Valore della proprietà

number

clientId

Bing usa questa intestazione per fornire agli utenti un comportamento coerente tra le chiamate API Bing. Bing spesso invia in versione di anteprima i miglioramenti e le nuove funzionalità e usa l'ID client come chiave per l'assegnazione del traffico per le diverse versioni di anteprima. Se non si usa lo stesso ID client per un utente in più richieste, Bing può assegnare l'utente a più versioni di anteprima in conflitto. L'assegnazione a più versioni di anteprima in conflitto può generare un'esperienza utente incoerente. Ad esempio, se alla seconda richiesta viene assegnata una versione di anteprima diversa rispetto alla prima, è possibile che l'esperienza non sia quella prevista. Inoltre, Bing può usare l'ID client per adattare i risultati Web alla cronologia di ricerca dell'ID client, fornendo un'esperienza più completa per l'utente. Bing usa questa intestazione anche per migliorare le classifiche dei risultati analizzando l'attività generata da un ID client. I miglioramenti di pertinenza migliorano la qualità dei risultati forniti dalle API Bing consentendo, di conseguenza, percentuali di click-through più elevate per il consumer API. IMPORTANTE: sebbene sia facoltativa, è opportuno considerare obbligatoria questa intestazione. Salvare in modo permanente l'ID client in più richieste per la stessa combinazione di dispositivo e utente finale consente 1) al consumer API di ottenere un'esperienza utente coerente e 2) percentuali di click-through più elevate migliorando la qualità dei risultati dalle API Bing. Ogni utente che usa l'applicazione nel dispositivo deve avere un ID client univoco generato da Bing. Se non si include questa intestazione nella richiesta, Bing genera un ID e lo restituisce nell'intestazione della risposta X-MSEdge-ClientID. L'unica volta in cui NON è necessario includere questa intestazione in una richiesta è la prima volta l'utente usa l'app nel dispositivo. Usare l'ID client per ogni richiesta dell'API Bing che l'app effettua per questo utente nel dispositivo. Salvare l'ID client in modo permanente. Per salvare in modo permanente l'ID in un'app browser, usare un cookie HTTP permanente per far sì che l'ID venga usato in tutte le sessioni. Non usare un cookie di sessione. Per altre app, ad esempio le app per dispositivi mobili, usare l'archiviazione permanente del dispositivo per salvare in modo permanente l'ID. La volta successiva che l'utente usa l'app in questo dispositivo, ottiene l'ID client salvato in modo permanente. le risposte Bing possono includere o meno questa intestazione. Se la risposta include questa intestazione, acquisire l'ID client e usarlo per tutte le richieste Bing successive per l'utente in tale dispositivo. se si include X-MSEdge-ClientID, non includere i cookie nella richiesta.

clientId?: string

Valore della proprietà

string

clientIp

Indirizzo IPv4 o IPv6 del dispositivo client. L'indirizzo IP viene usato per individuare la posizione dell'utente. Bing usa le informazioni sulla posizione per determinare il comportamento di ricerca sicura. sebbene sia facoltativa, è consigliabile specificare sempre questa intestazione e l'intestazione X-Search-Location. Non offuscare l'indirizzo, ad esempio, modificando l'ultimo ottetto su 0. L'offuscamento dei risultati degli indirizzi nella posizione in un punto non vicino alla posizione effettiva del dispositivo può generare risultati errati in Bing.

clientIp?: string

Valore della proprietà

string

count

Il numero di risultati della ricerca da restituire nella risposta. Il valore predefinito è 10 e il valore massimo è 50. Il numero effettivo recapitato può essere minore di quello richiesto. Usare questo parametro insieme al parametro offset per visualizzare i risultati della pagina. Ad esempio, se l'interfaccia utente visualizza 10 risultati della ricerca per pagina, impostare il conteggio su 10 e offset su 0 per ottenere la prima pagina dei risultati. Per ogni pagina successiva, l'offset di incremento per 10 (ad esempio, 0, 10, 20). È possibile che più pagine includano alcune sovrapposizioni nei risultati.

count?: number

Valore della proprietà

number

countryCode

Codice di 2 caratteri del paese da cui provengono i risultati. Questa API supporta solo il mercato Stati Uniti. Se si specifica questo parametro di query, deve essere impostato su di noi. Se si imposta questo parametro, è necessario specificare anche l'intestazione Accept-Language. Bing usa la prima lingua supportata che trova dall'elenco delle lingue e combina tale lingua con il codice paese specificato per determinare il mercato per restituire i risultati. Se l'elenco delle lingue non include una lingua supportata, Bing trova la lingua e il mercato più vicini che supporta la richiesta oppure può usare un mercato aggregato o predefinito per i risultati anziché uno specificato. È consigliabile usare questo parametro di query e il parametro di query Accept-Language solo se si specificano più lingue; in caso contrario, è consigliabile usare i parametri di query mkt e setLang. Questo parametro e il parametro di query mkt si escludono a vicenda, non specificano entrambi.

countryCode?: string

Valore della proprietà

string

freshness

Filtrare i risultati della ricerca in base ai valori di età seguenti: Giorno: Restituire pagine Web individuate da Bing negli ultimi 24 ore. Settimana: restituisce pagine Web individuate da Bing negli ultimi 7 giorni. Mese: restituisce pagine Web individuate negli ultimi 30 giorni. Questo filtro si applica solo ai risultati della pagina Web e non agli altri risultati, ad esempio notizie e immagini. I valori possibili includono: 'Day', 'Week', 'Month'

freshness?: Freshness

Valore della proprietà

Freshness

location

Elenco delimitato da punto e virgola di coppie chiave/valore che descrivono la posizione geografica del client. Bing usa le informazioni sulla posizione per determinare il comportamento di ricerca sicura e per restituire il contenuto locale pertinente. Specificare la coppia chiave/valore come :. Di seguito sono indicate le chiavi usate per specificare la posizione dell'utente. lat (obbligatorio): latitudine della posizione del client, in gradi. La latitudine deve essere maggiore o uguale a -90,0 e minore o uguale a + 90,0. I valori negativi indicano le latitudini meridionali e i valori positivi indicano le latitudini settentrionali. long (obbligatorio): longitudine della posizione del client, in gradi. La longitudine deve essere maggiore o uguale a -180,0 e minore o uguale a +180,0. I valori negativi indicano le latitudini occidentali e i valori positivi indicano le latitudini orientali. re (obbligatorio): raggio, in metri, che specifica l'accuratezza orizzontale delle coordinate. Passare il valore restituito dal servizio che rileva la posizione del dispositivo. I valori tipici potrebbero essere 22 m per GPS/Wi-Fi, 380 m per la triangolazione dei ripetitori di rete e 18.000 m per la ricerca inversa degli indirizzi IP. ts (facoltativo): timestamp UNIX UTC di quando il client era nella posizione. Il timestamp UNIX è il numero di secondi dal 1° gennaio 1970. head (facoltativo): l'intestazione o la direzione relativa del client di viaggio. Specificare la direzione di viaggio come gradi da 0 a 360, partendo in senso orario rispetto al vero nord. Specificare questa chiave solo se la chiave sp è diversa da zero. sp (facoltativo): velocità orizzontale (velocità), in metri al secondo, che il dispositivo client sta viaggiando. alt (facoltativo): altitudine del dispositivo client, in metri. sono (facoltativo): il raggio, in metri, che specifica l'accuratezza verticale delle coordinate. Specificare questa chiave solo se si specifica la chiave alt. sebbene molte chiavi siano facoltative, più informazioni vengono specificate, più accurati sono i risultati relativi alle posizioni. anche se è facoltativa, è opportuno specificare sempre la posizione geografica dell'utente. Specificare la posizione è particolarmente importante se l'indirizzo IP del client non riflette accuratamente la posizione fisica dell'utente, ad esempio, se il client usa una VPN. Per ottenere risultati ottimali, è necessario includere questa intestazione e l'intestazione X-MSEdge-ClientIP ma, è necessario almeno includere questa intestazione.

location?: string

Valore della proprietà

string

market

Mercato dal quale provengono i risultati. In genere, mkt è il paese in cui l'utente effettua la richiesta. Tuttavia, potrebbe essere un paese diverso se l'utente non si trova in un paese in cui Bing offre risultati. Il mercato deve essere sotto forma -. ad esempio en-US. La stringa è senza distinzione tra maiuscole e minuscole. Se noto, si consiglia di specificare sempre il mercato. La specifica del mercato consente a Bing indirizzare la richiesta e di restituire una risposta appropriata e ottimale. Se si specifica un mercato non elencato in Codici di mercato, Bing usa un codice di mercato più adatto in base a un mapping interno soggetto a modifiche. Questo parametro e il parametro di query cc si escludono a vicenda, non specificano entrambi. Valore predefinito: 'en-us'.

market?: string

Valore della proprietà

string

offset

Offset in base zero che indica il numero di risultati della ricerca da ignorare prima di restituire i risultati. Il valore predefinito è 0. L'offset deve essere minore di (totalEstimatedMatches - conteggio). Usare questo parametro insieme al parametro count per visualizzare i risultati della pagina. Ad esempio, se l'interfaccia utente visualizza 10 risultati della ricerca per pagina, impostare il conteggio su 10 e offset su 0 per ottenere la prima pagina dei risultati. Per ogni pagina successiva, l'offset di incremento per 10 (ad esempio, 0, 10, 20). è possibile che più pagine includano alcune sovrapposizioni nei risultati.

offset?: number

Valore della proprietà

number

pragma

Per impostazione predefinita, Bing restituisce il contenuto memorizzato nella cache, se disponibile. Per impedire a Bing di restituire il contenuto memorizzato nella cache, impostare l'intestazione Pragma su no-cache, ad esempio, Pragma: no-cache.

pragma?: string

Valore della proprietà

string

promote

Elenco delimitato da virgole di risposte che si desidera includere la risposta indipendentemente dalla classificazione. Ad esempio, se si imposta answerCount) su due (2) in modo che Bing restituisce le prime due risposte classificate, ma si vuole anche che la risposta includa notizie, si imposta la promozione su notizie. Se le risposte più classificate sono pagine Web, immagini, video e correlatiSearches, la risposta include pagine Web e immagini perché le notizie non sono una risposta classificata. Tuttavia, se si imposta la promozione al video, Bing promuoverà la risposta video nella risposta e restituirà pagine Web, immagini e video. Le risposte che si desidera promuovere non conteggiano il limite di answerCount. Ad esempio, se le risposte classificate sono notizie, immagini e video e si imposta rispostaCount su 1 e promuovere le notizie, la risposta contiene notizie e immagini. In alternativa, se i riscontri classificati sono video, immagini e notizie, la risposta contiene video e notizie. I valori possibili sono Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Video, Pagine Web. Usare solo se si specifica answerCount.

promote?: AnswerType[]

Valore della proprietà

AnswerType[]

responseFilter

Elenco delimitato da virgole di risposte da includere nella risposta. Se non si specifica questo parametro, la risposta include tutte le risposte di ricerca per cui sono presenti dati pertinenti. I valori dei filtri possibili sono Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Video, Pagine Web. Anche se è possibile usare questo filtro per ottenere una singola risposta, è consigliabile usare invece l'endpoint specifico della risposta per ottenere risultati più avanzati. Ad esempio, per ricevere solo immagini, inviare la richiesta a uno degli endpoint dell'API Ricerca immagini. Le risposte RelatedSearches e SpellSuggestions non supportano un endpoint separato, ad esempio l'API Ricerca immagini ( solo l'API Ricerca Web li restituisce). Per includere risposte che altrimenti sarebbero escluse a causa della classificazione, vedere il parametro di promozione della query.

responseFilter?: AnswerType[]

Valore della proprietà

AnswerType[]

safeSearch

Filtro usato per filtrare il contenuto per adulti. Off: restituisce pagine Web con testo, immagini o video adulti. Moderata: restituisce pagine Web con testo adulto, ma non immagini adulte o video. Rigoroso: non restituire pagine Web con testo adulto, immagini o video. Il valore predefinito è Moderate. Se la richiesta proviene da un mercato che i criteri per adulti di Bing richiedono che SafeSearch sia impostato su Strict, Bing ignora il valore safeSearch e usa Strict. Se si usa l'operatore di query: query, è possibile che la risposta contenga contenuto adulto indipendentemente dal parametro di query safeSearch impostato su. Usare il sito: solo se si è a conoscenza del contenuto nel sito e lo scenario supporta la possibilità di contenuto per adulti. I valori possibili includono: 'Off', 'Moderate', 'Strict'

safeSearch?: SafeSearch

Valore della proprietà

SafeSearch

setLang

Lingua da usare per le stringhe dell'interfaccia utente. Specificare la lingua tramite il codice lingua a due lettere ISO 639-1. Ad esempio, il codice lingua per l'inglese è EN. L'impostazione predefinita è EN (inglese). Sebbene sia facoltativo, è opportuno specificare sempre la lingua. In genere, si impostaLang sulla stessa lingua specificata da mkt, a meno che l'utente non voglia che le stringhe dell'interfaccia utente vengano visualizzate in una lingua diversa. Questo parametro e l'intestazione Accept-Language si escludono a vicenda; non specificare entrambi. Una stringa di interfaccia utente è una stringa usata come etichetta in un'interfaccia utente. Gli oggetti di risposta JSON contengono poche stringhe di interfaccia utente. Eventuali collegamenti alle proprietà Bing.com negli oggetti risposta si applicano anche alla lingua specificata.

setLang?: string

Valore della proprietà

string

textDecorations

Valore booleano che determina se le stringhe di visualizzazione devono contenere marcatori di decorazione, ad esempio l'evidenziazione dei caratteri. Se true, le stringhe possono includere marcatori. Il valore predefinito è false. Per specificare se usare i caratteri Unicode o i tag HTML come marcatori, vedere il parametro di query textFormat.

textDecorations?: boolean

Valore della proprietà

boolean

textFormat

Tipo di marcatori da usare per le decorazioni di testo (vedere il parametro di query textDecorations). I valori possibili sono Raw: usare i caratteri Unicode per contrassegnare il contenuto che richiede una formattazione speciale. I caratteri Unicode si trovano nell'intervallo E000 a E019. Ad esempio, Bing usa E000 e E001 per contrassegnare l'inizio e la fine delle condizioni di query per l'evidenziazione. HTML: usare i tag HTML per contrassegnare il contenuto che necessita di formattazione speciale. Ad esempio, usare i tag per evidenziare i termini di query nelle stringhe di visualizzazione. Il valore predefinito è Raw. Per le stringhe di visualizzazione che contengono caratteri HTML non idonei, <ad esempio , >e &, se textFormat è impostato su HTML, Bing esegue l'escape dei caratteri in base alle esigenze, ad esempio < viene eseguito l'escape a <). I valori possibili includono: 'Raw', 'Html'

textFormat?: TextFormat

Valore della proprietà

TextFormat

userAgent

L'agente utente di origine della richiesta. Bing usa l'agente utente per fornire agli utenti di dispositivi mobili un'esperienza ottimizzata. Anche se facoltativo, è consigliabile specificare sempre questa intestazione. L'agente utente deve essere la stessa stringa che qualsiasi browser comunemente usato invia. Per informazioni sugli agenti utente, vedere RFC 2616.

userAgent?: string

Valore della proprietà

string

Dettagli proprietà ereditate

abortSignal

Segnale che può essere usato per interrompere le richieste.

abortSignal?: AbortSignalLike

Valore della proprietà

AbortSignalLike

Ereditato da msRest.RequestOptionsBase.abortSignal

customHeaders

Intestazioni di richiesta personalizzate definite dall'utente che verranno applicate prima dell'invio della richiesta.

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

Valore della proprietà

{[key: string]: string}

Ereditato da msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Callback che viene attivato al download dello stato di avanzamento.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

Ereditato da msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Callback che viene attivato al caricamento dello stato di avanzamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

Ereditato da msRest.RequestOptionsBase.onUploadProgress

timeout

Il numero di millisecondi che una richiesta può richiedere prima di essere terminata automaticamente.

timeout?: number

Valore della proprietà

number

Ereditato da msRest.RequestOptionsBase.timeout