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 specificare anche 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 cui restituire i risultati. Se l'elenco non include una lingua supportata, Bing troverà la lingua e il mercato più vicini che supportano la richiesta e potrebbe 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, è necessario usare i parametri di query mkt e setLang. Una stringa dell'interfaccia utente è una stringa usata come etichetta in un'interfaccia utente. Negli oggetti risposta JSON sono presenti pochissime stringhe dell'interfaccia utente. Tutti i collegamenti negli oggetti risposta alle Bing.com proprietà applicheranno la lingua specificata.
answerCount	Numero di risposte da includere nella risposta. Le risposte restituite da Bing sono basate sulla classificazione. Ad esempio, se Bing restituisce pagine Web, immagini, video e ricerche correlate per una richiesta e si imposta questo parametro su due (2), la risposta include pagine Web e immagini. Se il parametro di query responseFilter è stato incluso nella stessa richiesta e impostato su pagine Web e notizie, la risposta includerà solo pagine Web.
clientId	Bing usa questa intestazione per fornire agli utenti un comportamento coerente tra le chiamate API Bing. Bing spesso esegue il volo di nuove funzionalità e miglioramenti e usa l'ID client come chiave per l'assegnazione del traffico su diversi voli. Se non si usa lo stesso ID client per un utente in più richieste, Bing può assegnare l'utente a più voli in conflitto. L'assegnazione a più voli in conflitto può comportare un'esperienza utente incoerente. Ad esempio, se la seconda richiesta ha un'assegnazione di anteprima diversa rispetto alla prima, l'esperienza potrebbe essere imprevista. Bing può anche usare l'ID client per personalizzare i risultati Web in base alla cronologia di ricerca dell'ID client, offrendo un'esperienza più completa per l'utente. Bing usa anche questa intestazione per migliorare le classificazioni dei risultati analizzando l'attività generata da un ID client. I miglioramenti della pertinenza aiutano a migliorare la qualità dei risultati forniti dalle API Bing e a loro volta abilitano tariffe click-through più elevate per il consumer di API. IMPORTANTE: anche se facoltativo, è consigliabile considerare questa intestazione obbligatoria. La persistenza dell'ID client tra più richieste per la stessa combinazione di utenti finali e dispositivo consente al consumer dell'API di ricevere un'esperienza utente coerente e 2) velocità di clic più elevate tramite una migliore qualità dei risultati delle API Bing. Ogni utente che usa l'applicazione nel dispositivo deve avere un ID client generato da Bing univoco. 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 che non devi includere questa intestazione in una richiesta è la prima volta che l'utente usa l'app nel dispositivo. Usare l'ID client per ogni richiesta API Bing eseguita dall'app per questo utente nel dispositivo. Rendere persistente l'ID client. Per rendere persistente l'ID in un'app browser, usare un cookie HTTP permanente per assicurarsi che l'ID venga usato in tutte le sessioni. Non usare un cookie di sessione. Per altre app come le app per dispositivi mobili, usare l'archiviazione permanente del dispositivo per rendere persistente l'ID. La volta successiva che l'utente usa l'app nel dispositivo, ottenere 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 nel dispositivo. Se si include X-MSEdge-ClientID, non è necessario 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 sicuro. Anche se facoltativo, è 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 dell'indirizzo comporta che la posizione non si trova in nessun punto vicino alla posizione effettiva del dispositivo, che può causare risultati errati in Bing.
count	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 count su 10 e offset su 0 per ottenere la prima pagina dei risultati. Per ogni pagina successiva, l'offset di incremento di 10 (ad esempio, 0, 10, 20). È possibile che più pagine includano alcune sovrapposizioni nei risultati.
countryCode	Codice paese a 2 caratteri del paese da cui provengono i risultati. Questa API supporta solo il mercato degli Stati Uniti. Se si specifica questo parametro di query, deve essere impostato su Microsoft. Se si imposta questo parametro, è necessario specificare anche l'intestazione Accept-Language. Bing usa la prima lingua supportata trovata dall'elenco delle lingue e combina tale lingua con il codice paese specificato per determinare il mercato per cui restituire i risultati. Se l'elenco delle lingue non include una lingua supportata, Bing trova la lingua e il mercato più vicini che supportano 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, è necessario 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 le pagine Web individuate da Bing nelle ultime 24 ore. Settimana: restituisce le pagine Web individuate da Bing negli ultimi 7 giorni. Mese: restituisce le 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 sicuro e per restituire il contenuto locale pertinente. Specificare la coppia chiave/valore come :. Di seguito sono riportate le chiavi usate per specificare la posizione dell'utente. lat (obbligatorio): latitudine della posizione del client, espressa in gradi. La latitudine deve essere maggiore o uguale a -90,0 e minore o uguale a +90,0. I valori negativi indicano le latitudine meridionali e i valori positivi indicano le latitudine settentrionali. long (obbligatorio): longitudine della posizione del client, espressa in gradi. La longitudine deve essere maggiore o uguale a -180,0 e minore o uguale a +180,0. I valori negativi indicano longitudini occidentali e valori positivi indicano longitudini orientali. re (obbligatorio): raggio, in metri, che specifica l'accuratezza orizzontale delle coordinate. Passare il valore restituito dal servizio di posizione del dispositivo. I valori tipici potrebbero essere 22m per GPS/Wi-Fi, 380m per la triangolazione della torre cellulare e 18.000m per la ricerca IP inversa. ts (facoltativo): timestamp UNIX UTC di quando il client si trovava nella posizione. Il timestamp UNIX è il numero di secondi dal 1° gennaio 1970. head (facoltativo): direzione o direzione di viaggio del cliente. Specificare la direzione di viaggio come gradi compreso tra 0 e 360, contando in senso orario rispetto a true 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): raggio, in metri, che specifica l'accuratezza verticale delle coordinate. Specificare questo tasto solo se si specifica il tasto ALT. Anche se molte delle chiavi sono facoltative, più informazioni vengono fornite, più accurati sono i risultati della posizione. Anche se facoltativo, è consigliabile specificare sempre la posizione geografica dell'utente. Fornire la posizione è particolarmente importante se l'indirizzo IP del client non riflette in modo accurato la posizione fisica dell'utente ( ad esempio, se il client usa VPN). Per ottenere risultati ottimali, è necessario includere questa intestazione e l'intestazione X-MSEdge-ClientIP, ma almeno è necessario includere questa intestazione.
market	Il mercato da cui provengono i risultati. In genere, mkt è il paese in cui l'utente effettua la richiesta. Tuttavia, potrebbe trattarsi di un paese diverso se l'utente non si trova in un paese in cui Bing fornisce risultati. Il mercato deve essere nel formato -. Ad esempio, en-US. La stringa non fa distinzione tra maiuscole e minuscole. Se noto, si consiglia di specificare sempre il mercato. Specificare il mercato consente a Bing di indirizzare la richiesta e 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 - count). 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 count su 10 e offset su 0 per ottenere la prima pagina dei risultati. Per ogni pagina successiva, l'offset di incremento di 10 (ad esempio, 0, 10, 20). è possibile che più pagine includano alcune sovrapposizioni nei risultati.
pragma	Per impostazione predefinita, Bing restituisce contenuto memorizzato nella cache, se disponibile. Per impedire a Bing di restituire 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 restituisca le prime due risposte classificate, ma si vuole anche che la risposta includa notizie, si imposta la promozione alle notizie. Se le risposte classificate più in alto sono pagine Web, immagini, video e ricerche correlate, 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 e restituirà pagine Web, immagini e video. Le risposte che si desidera promuovere non sono conteggiati rispetto al limite answerCount. Ad esempio, se le risposte classificate sono notizie, immagini e video e si imposta answerCount su 1 e promuovere le notizie, la risposta contiene notizie e immagini. In alternativa, se le risposte classificate sono video, immagini e notizie, la risposta contiene video e notizie. I valori possibili sono Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webpages. 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 le quali sono presenti dati pertinenti. I valori di filtro possibili sono Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webpages. 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 come l'API Ricerca immagini (solo l'API Ricerca Web le restituisce). Per includere risposte che altrimenti verrebbero escluse a causa della classificazione, vedere il parametro di promozione della query.
safeSearch	Filtro utilizzato per filtrare il contenuto per adulti. Off: restituisce pagine Web con testo, immagini o video per adulti. Moderate: restituisce pagine Web con testo per adulti, ma non immagini o video per adulti. Strict: non restituire pagine Web con testo, immagini o video per adulti. 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 site: query, è possibile che la risposta contenga contenuto per adulti indipendentemente dal parametro di query safeSearch impostato su. Usa 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 usando il codice di lingua ISO 639-1 a 2 lettere. Ad esempio, il codice della lingua per l'inglese è EN. Il valore predefinito è EN (inglese). Anche se facoltativo, è consigliabile specificare sempre la lingua. In genere, si imposta setLang sulla stessa lingua specificata da mkt, a meno che l'utente non voglia visualizzare le stringhe dell'interfaccia utente in una lingua diversa. Questo parametro e l'intestazione Accept-Language si escludono a vicenda; non specificare entrambi. Una stringa dell'interfaccia utente è una stringa usata come etichetta in un'interfaccia utente. Esistono poche stringhe dell'interfaccia utente negli oggetti risposta JSON. Inoltre, tutti i collegamenti alle proprietà Bing.com negli oggetti risposta applicano la lingua specificata.
textDecorations	Valore booleano che determina se le stringhe di visualizzazione devono contenere indicatori di decorazione, ad esempio i caratteri di evidenziazione dell'hit. Se true, le stringhe possono includere marcatori. Il valore predefinito è false. Per specificare se usare caratteri Unicode o 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 caratteri Unicode per contrassegnare il contenuto che richiede una formattazione speciale. I caratteri Unicode sono compresi nell'intervallo da E000 a E019. Ad esempio, Bing usa E000 e E001 per contrassegnare l'inizio e la fine dei termini di query per l'evidenziazione dei risultati. HTML: usare tag HTML per contrassegnare il contenuto che richiede una 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 per <. I valori possibili includono: 'Raw', 'Html'
userAgent	Agente utente che ha origine la richiesta. Bing usa l'agente utente per offrire agli utenti mobili un'esperienza ottimizzata. Anche se facoltativo, è consigliabile specificare sempre questa intestazione. L'agente utente deve essere la stessa stringa inviata da qualsiasi browser comunemente usato. 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 all'avanzamento del download.
onUploadProgress	Callback che viene attivato al momento dell'avanzamento del caricamento.
timeout	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 specificare anche 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 cui restituire i risultati. Se l'elenco non include una lingua supportata, Bing troverà la lingua e il mercato più vicini che supportano la richiesta e potrebbe 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, è necessario usare i parametri di query mkt e setLang. Una stringa dell'interfaccia utente è una stringa usata come etichetta in un'interfaccia utente. Negli oggetti risposta JSON sono presenti pochissime stringhe dell'interfaccia utente. Tutti i collegamenti negli oggetti risposta alle Bing.com proprietà applicheranno la lingua specificata.

acceptLanguage?: string

Valore della proprietà

string

answerCount

Numero di risposte da includere nella risposta. Le risposte restituite da Bing sono basate sulla classificazione. Ad esempio, se Bing restituisce pagine Web, immagini, video e ricerche correlate per una richiesta e si imposta questo parametro su due (2), la risposta include pagine Web e immagini. Se il parametro di query responseFilter è stato incluso nella stessa richiesta e impostato su pagine Web e notizie, la risposta includerà 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 esegue il volo di nuove funzionalità e miglioramenti e usa l'ID client come chiave per l'assegnazione del traffico su diversi voli. Se non si usa lo stesso ID client per un utente in più richieste, Bing può assegnare l'utente a più voli in conflitto. L'assegnazione a più voli in conflitto può comportare un'esperienza utente incoerente. Ad esempio, se la seconda richiesta ha un'assegnazione di anteprima diversa rispetto alla prima, l'esperienza potrebbe essere imprevista. Bing può anche usare l'ID client per personalizzare i risultati Web in base alla cronologia di ricerca dell'ID client, offrendo un'esperienza più completa per l'utente. Bing usa anche questa intestazione per migliorare le classificazioni dei risultati analizzando l'attività generata da un ID client. I miglioramenti della pertinenza aiutano a migliorare la qualità dei risultati forniti dalle API Bing e a loro volta abilitano tariffe click-through più elevate per il consumer di API. IMPORTANTE: anche se facoltativo, è consigliabile considerare questa intestazione obbligatoria. La persistenza dell'ID client tra più richieste per la stessa combinazione di utenti finali e dispositivo consente al consumer dell'API di ricevere un'esperienza utente coerente e 2) velocità di clic più elevate tramite una migliore qualità dei risultati delle API Bing. Ogni utente che usa l'applicazione nel dispositivo deve avere un ID client generato da Bing univoco. 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 che non devi includere questa intestazione in una richiesta è la prima volta che l'utente usa l'app nel dispositivo. Usare l'ID client per ogni richiesta API Bing eseguita dall'app per questo utente nel dispositivo. Rendere persistente l'ID client. Per rendere persistente l'ID in un'app browser, usare un cookie HTTP permanente per assicurarsi che l'ID venga usato in tutte le sessioni. Non usare un cookie di sessione. Per altre app come le app per dispositivi mobili, usare l'archiviazione permanente del dispositivo per rendere persistente l'ID. La volta successiva che l'utente usa l'app nel dispositivo, ottenere 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 nel dispositivo. Se si include X-MSEdge-ClientID, non è necessario 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 sicuro. Anche se facoltativo, è 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 dell'indirizzo comporta che la posizione non si trova in nessun punto vicino alla posizione effettiva del dispositivo, che può causare risultati errati in Bing.

clientIp?: string

Valore della proprietà

string

count

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 count su 10 e offset su 0 per ottenere la prima pagina dei risultati. Per ogni pagina successiva, l'offset di incremento di 10 (ad esempio, 0, 10, 20). È possibile che più pagine includano alcune sovrapposizioni nei risultati.

count?: number

Valore della proprietà

number

countryCode

Codice paese a 2 caratteri del paese da cui provengono i risultati. Questa API supporta solo il mercato degli Stati Uniti. Se si specifica questo parametro di query, deve essere impostato su Microsoft. Se si imposta questo parametro, è necessario specificare anche l'intestazione Accept-Language. Bing usa la prima lingua supportata trovata dall'elenco delle lingue e combina tale lingua con il codice paese specificato per determinare il mercato per cui restituire i risultati. Se l'elenco delle lingue non include una lingua supportata, Bing trova la lingua e il mercato più vicini che supportano 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, è necessario 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 le pagine Web individuate da Bing nelle ultime 24 ore. Settimana: restituisce le pagine Web individuate da Bing negli ultimi 7 giorni. Mese: restituisce le 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 sicuro e per restituire il contenuto locale pertinente. Specificare la coppia chiave/valore come :. Di seguito sono riportate le chiavi usate per specificare la posizione dell'utente. lat (obbligatorio): latitudine della posizione del client, espressa in gradi. La latitudine deve essere maggiore o uguale a -90,0 e minore o uguale a +90,0. I valori negativi indicano le latitudine meridionali e i valori positivi indicano le latitudine settentrionali. long (obbligatorio): longitudine della posizione del client, espressa in gradi. La longitudine deve essere maggiore o uguale a -180,0 e minore o uguale a +180,0. I valori negativi indicano longitudini occidentali e valori positivi indicano longitudini orientali. re (obbligatorio): raggio, in metri, che specifica l'accuratezza orizzontale delle coordinate. Passare il valore restituito dal servizio di posizione del dispositivo. I valori tipici potrebbero essere 22m per GPS/Wi-Fi, 380m per la triangolazione della torre cellulare e 18.000m per la ricerca IP inversa. ts (facoltativo): timestamp UNIX UTC di quando il client si trovava nella posizione. Il timestamp UNIX è il numero di secondi dal 1° gennaio 1970. head (facoltativo): direzione o direzione di viaggio del cliente. Specificare la direzione di viaggio come gradi compreso tra 0 e 360, contando in senso orario rispetto a true 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): raggio, in metri, che specifica l'accuratezza verticale delle coordinate. Specificare questo tasto solo se si specifica il tasto ALT. Anche se molte delle chiavi sono facoltative, più informazioni vengono fornite, più accurati sono i risultati della posizione. Anche se facoltativo, è consigliabile specificare sempre la posizione geografica dell'utente. Fornire la posizione è particolarmente importante se l'indirizzo IP del client non riflette in modo accurato la posizione fisica dell'utente ( ad esempio, se il client usa VPN). Per ottenere risultati ottimali, è necessario includere questa intestazione e l'intestazione X-MSEdge-ClientIP, ma almeno è necessario includere questa intestazione.

location?: string

Valore della proprietà

string

market

Il mercato da cui provengono i risultati. In genere, mkt è il paese in cui l'utente effettua la richiesta. Tuttavia, potrebbe trattarsi di un paese diverso se l'utente non si trova in un paese in cui Bing fornisce risultati. Il mercato deve essere nel formato -. Ad esempio, en-US. La stringa non fa distinzione tra maiuscole e minuscole. Se noto, si consiglia di specificare sempre il mercato. Specificare il mercato consente a Bing di indirizzare la richiesta e 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 - count). 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 count su 10 e offset su 0 per ottenere la prima pagina dei risultati. Per ogni pagina successiva, l'offset di incremento di 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 contenuto memorizzato nella cache, se disponibile. Per impedire a Bing di restituire 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 restituisca le prime due risposte classificate, ma si vuole anche che la risposta includa notizie, si imposta la promozione alle notizie. Se le risposte classificate più in alto sono pagine Web, immagini, video e ricerche correlate, 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 e restituirà pagine Web, immagini e video. Le risposte che si desidera promuovere non sono conteggiati rispetto al limite answerCount. Ad esempio, se le risposte classificate sono notizie, immagini e video e si imposta answerCount su 1 e promuovere le notizie, la risposta contiene notizie e immagini. In alternativa, se le risposte classificate sono video, immagini e notizie, la risposta contiene video e notizie. I valori possibili sono Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webpages. 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 le quali sono presenti dati pertinenti. I valori di filtro possibili sono Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webpages. 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 come l'API Ricerca immagini (solo l'API Ricerca Web le restituisce). Per includere risposte che altrimenti verrebbero escluse a causa della classificazione, vedere il parametro di promozione della query.

responseFilter?: AnswerType[]

Valore della proprietà

AnswerType[]

safeSearch

Filtro utilizzato per filtrare il contenuto per adulti. Off: restituisce pagine Web con testo, immagini o video per adulti. Moderate: restituisce pagine Web con testo per adulti, ma non immagini o video per adulti. Strict: non restituire pagine Web con testo, immagini o video per adulti. 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 site: query, è possibile che la risposta contenga contenuto per adulti indipendentemente dal parametro di query safeSearch impostato su. Usa 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 usando il codice di lingua ISO 639-1 a 2 lettere. Ad esempio, il codice della lingua per l'inglese è EN. Il valore predefinito è EN (inglese). Anche se facoltativo, è consigliabile specificare sempre la lingua. In genere, si imposta setLang sulla stessa lingua specificata da mkt, a meno che l'utente non voglia visualizzare le stringhe dell'interfaccia utente in una lingua diversa. Questo parametro e l'intestazione Accept-Language si escludono a vicenda; non specificare entrambi. Una stringa dell'interfaccia utente è una stringa usata come etichetta in un'interfaccia utente. Esistono poche stringhe dell'interfaccia utente negli oggetti risposta JSON. Inoltre, tutti i collegamenti alle proprietà Bing.com negli oggetti risposta applicano la lingua specificata.

setLang?: string

Valore della proprietà

string

textDecorations

Valore booleano che determina se le stringhe di visualizzazione devono contenere indicatori di decorazione, ad esempio i caratteri di evidenziazione dell'hit. Se true, le stringhe possono includere marcatori. Il valore predefinito è false. Per specificare se usare caratteri Unicode o 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 caratteri Unicode per contrassegnare il contenuto che richiede una formattazione speciale. I caratteri Unicode sono compresi nell'intervallo da E000 a E019. Ad esempio, Bing usa E000 e E001 per contrassegnare l'inizio e la fine dei termini di query per l'evidenziazione dei risultati. HTML: usare tag HTML per contrassegnare il contenuto che richiede una 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 per <. I valori possibili includono: 'Raw', 'Html'

textFormat?: TextFormat

Valore della proprietà

TextFormat

userAgent

Agente utente che ha origine la richiesta. Bing usa l'agente utente per offrire agli utenti mobili un'esperienza ottimizzata. Anche se facoltativo, è consigliabile specificare sempre questa intestazione. L'agente utente deve essere la stessa stringa inviata da qualsiasi browser comunemente usato. 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 all'avanzamento del download.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

Ereditato da msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Callback che viene attivato al momento dell'avanzamento del caricamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

Ereditato da msRest.RequestOptionsBase.onUploadProgress

timeout

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

timeout?: number

Valore della proprietà

number

ereditato da msRest.RequestOptionsBase.timeout