WebOperations Classe
Operazioni WebOperations.
Non è consigliabile creare un'istanza diretta di questa classe, ma creare un'istanza client che lo creerà automaticamente e associarlo come attributo.
- Ereditarietà
-
builtins.objectWebOperations
Costruttore
WebOperations(client, config, serializer, deserializer)Parametri
- client
Client per le richieste di servizio.
- config
Configurazione del client del servizio.
- serializer
Serializzatore del modello a oggetti.
- deserializer
Deserializzatore del modello a oggetti.
Variabili
- x_bing_apis_sdk
Attivare la conformità swagger. Valore costante: "true".
Metodi
| search |
L'API Ricerca Web consente di inviare una query di ricerca a Bing e di recuperare i risultati della ricerca che includono collegamenti a pagine Web, immagini e altro ancora. |
search
L'API Ricerca Web consente di inviare una query di ricerca a Bing e di recuperare i risultati della ricerca che includono collegamenti a pagine Web, immagini e altro ancora.
search(query, accept_language=None, pragma=None, user_agent=None, client_id=None, client_ip=None, location=None, answer_count=None, country_code=None, count=None, freshness=None, market='en-us', offset=None, promote=None, response_filter=None, safe_search=None, set_lang=None, text_decorations=None, text_format=None, custom_headers=None, raw=False, **operation_config)Parametri
- query
- str
Termine della query di ricerca dell'utente. Il termine non può essere vuoto. Il termine può contenere operatori avanzati Bing. Ad esempio, per limitare i risultati a un dominio specifico, usare l'operatore site: .
- accept_language
- str
Elenco delimitato da virgole di uno o più linguaggi 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à la prima lingua supportata trovata 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 potrebbero 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 di 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 a Bing.com proprietà applicheranno la lingua specificata.
- pragma
- str
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.
- user_agent
- str
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 inviata da qualsiasi browser comunemente usato. Per informazioni sugli agenti utente, vedere RFC 2616.
- client_id
- str
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. 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 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.
- client_ip
- str
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.
- location
- str
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, 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 latitudini meridionali e i valori positivi indicano le latitudini 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 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 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 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): raggio, in metri, che specifica l'accuratezza verticale delle coordinate. Specificare questo tasto solo se si specifica il tasto 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.
- answer_count
- int
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 relatedSearches 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.
- country_code
- str
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, è necessario impostarlo 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 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, è necessario usare i parametri di query mkt e setLang. Questo parametro e il parametro di query mkt si escludono a vicenda, non specificano entrambi.
- count
- int
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 count su 10 e offset su 0 per ottenere la prima pagina dei risultati. Per ogni pagina successiva, offset di incremento di 10 (ad esempio, 0, 10, 20). È possibile che più pagine includano alcune sovrapposizioni nei risultati.
Filtrare i risultati della ricerca in base ai valori di età seguenti: Giorno: restituisce 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'
- market
- str
Mercato dal quale 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 i 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. 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.
- offset
- int
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, offset di incremento di 10 (ad esempio, 0, 10, 20). è possibile che più pagine includano alcune sovrapposizioni nei risultati.
- promote
- list[str oppure AnswerType]
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 sulle notizie. Se le risposte più classificate 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 l'alza di livello al video, Bing promuoverà la risposta e restituirà pagine Web, immagini e video. Le risposte da alzare di livello non corrispondono al limite answerCount. Ad esempio, se le risposte classificate sono notizie, immagini e video e si imposta answerCount su 1 e alza di livello 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 Calcolo, Immagini, Notizie, RelatedSearches, SpellSuggestions, TimeZone, Video, Pagine Web. Usare solo se si specifica answerCount.
- response_filter
- list[str oppure AnswerType]
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 Calcolo, Immagini, Notizie, 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 come l'API Ricerca immagini (solo l'API Ricerca Web li restituisce). Per includere risposte che altrimenti verrebbero escluse a causa della classificazione, vedere il parametro di query promote.
- safe_search
- str oppure SafeSearch
Filtro usato per filtrare il contenuto per adulti. Disattivato: restituisce pagine Web con testo per adulti, immagini o video. Moderate: restituisce pagine Web con testo per adulti, ma non immagini o video per adulti. Strict: non restituire pagine Web con testo per adulti, immagini o video. Il valore predefinito è Moderate. Se la richiesta proviene da un mercato per cui 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. 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'
- set_lang
- str
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, impostareLang 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 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.
- text_decorations
- bool
Valore booleano che determina se le stringhe di visualizzazione devono contenere indicatori di decorazione, ad esempio i caratteri di evidenziazione dei risultati. 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.
- text_format
- str oppure 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 ed 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 preceduto da un carattere di escape a <). I valori possibili includono: 'Raw', 'Html'
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
Override della configurazione dell'operazione.
Restituisce
SearchResponse o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
Attributi
models
models = <module 'azure.cognitiveservices.search.websearch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\cognitiveservices\\search\\websearch\\models\\__init__.py'>
Azure SDK for Python