Questa pagina mostra come visualizzare l'anteprima dei risultati di ricerca utilizzando la console Google Cloud e come ottenere i risultati di ricerca utilizzando l'API.
Inoltre, invece di creare un widget di ricerca da aggiungere alla tua pagina web, puoi effettuare chiamate API e integrarle nel server o nell'applicazione. Questa pagina include esempi di codice su come eseguire query di ricerca utilizzando le librerie client gRPC con un account di servizio.
Ottenere risultati di ricerca per un'app con dati di un sito web
Console
Per utilizzare la console Google Cloud per visualizzare l'anteprima dei risultati di ricerca per un'app con dati del sito web, segui questi passaggi:
Nella Google Cloud console, vai alla pagina AI Applications.
Fai clic sul nome dell'app da modificare.
Fai clic su Anteprima.
Apri la pagina Anteprima nella console.
(Facoltativo) Se hai collegato più datastore alla tua app, ma vuoi risultati solo da un datastore specifico, seleziona il datastore da cui ottenere i risultati.
Digita una query di ricerca.
Se hai attivato il completamento automatico, sotto la barra di ricerca viene visualizzato un elenco di suggerimenti per il completamento automatico mentre digiti.
Premi Invio per inviare la query.
- Sotto la barra di ricerca viene visualizzato un elenco di risultati di ricerca.
- Ogni risultato contiene un titolo, uno snippet e un URL.
- Se fai clic su un risultato, si apre l'URL.
- Se le funzionalità LLM avanzate sono abilitate per l'app, potrebbe essere visualizzata anche una risposta generata.
REST
Per utilizzare l'API per ottenere i risultati di ricerca per un'app con dati del sito web,
utilizza il metodo engines.servingConfigs.search
:
Trova l'ID app. Se hai già l'ID app, vai al passaggio successivo.
Nella Google Cloud console, vai alla pagina AI Applications.
Nella pagina App, trova il nome della tua app e recupera il relativo ID dalla colonna ID.
Ottenere i risultati di ricerca.
curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search:search" \ -d '{ "servingConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search", "query": "QUERY", "pageSize": "PAGE_SIZE", "offset": "OFFSET", "orderBy": "ORDER_BY", "params": {"user_country_code": "USER_COUNTRY_CODE", "searchType": "SEARCH_TYPE"}, "filter": "FILTER", "boostSpec": "BOOST_SPEC", "contentSearchSpec": { "searchResultMode": "RESULT_MODE" }, "dataStoreSpecs": [{"DATA_STORE_SPEC"}] }'
Sostituisci quanto segue:
PROJECT_ID
: l'ID del tuo Google Cloud progetto.APP_ID
: l'ID dell'app Vertex AI Search per cui vuoi eseguire query.QUERY
: il testo della query da cercare.PAGE_SIZE
: il numero di risultati restituiti dalla ricerca. La dimensione massima consentita della pagina dipende dal tipo di dati. Le dimensioni della pagina superiori al valore massimo vengono forzate al valore massimo.- Siti web con indicizzazione di base: predefinito
10
, massimo25
- Siti web con indicizzazione avanzata: predefinito
25
, massimo50
- Altro: predefinito
50
, massimo100
- Siti web con indicizzazione di base: predefinito
OFFSET
: l'indice iniziale dei risultati. Il valore predefinito è 0.Ad esempio, se l'offset è 2, la dimensione della pagina è 10 e ci sono 15 risultati da restituire, i risultati da 2 a 12 vengono restituiti nella prima pagina.
ORDER_BY
: l'ordine in cui sono disposti i risultati. L'attributo in base al quale ordinare deve avere un'interpretazione numerica, ad esempiodate
. Per saperne di più, consulta Ordinare i risultati della ricerca web.USER_COUNTRY_CODE
: la posizione dell'utente. Questa coppia chiave-valore è l'unica voce supportata per il campo della mappaparams
. Il valore predefinito è vuoto. Per i valori accettabili, consulta Codici paese nella documentazione di riferimento dell'API JSON del Programmable Search Engine.SEARCH_TYPE
: il tipo di ricerca da eseguire. Il valore predefinito è 0 per la ricerca di documenti. L'altro valore supportato è 1 per la ricerca immagini.FILTER
: un campo di testo per filtrare la ricerca utilizzando un'espressione di filtro. Il valore predefinito è una stringa vuota. Per ulteriori informazioni sull'utilizzo del campofilter
, vedi Filtrare la ricerca di siti web.BOOST_SPEC
: facoltativo. Una specifica per promuovere o nascondere i documenti. Valori:BOOST
: un numero in virgola mobile nell'intervallo [-1,1]. Quando il valore è negativo, i risultati vengono declassati (vengono visualizzati più in basso nei risultati). Quando il valore è positivo, i risultati vengono promossi (vengono visualizzati più in alto nei risultati).CONDITION
: un'espressione di filtro di testo per selezionare i documenti a cui viene applicato l'incremento. Il filtro deve restituire un valore booleano. Per scoprire di più sul boost per la ricerca strutturata, consulta Migliorare i risultati di ricerca.
RESULT_MODE
: determina se i risultati di ricerca vengono restituiti come documenti completi o in blocchi. Per ottenere i chunk, il datastore deve avere attivato il chunking dei documenti. I valori accettati sonodocuments
echunks
. Quando la suddivisione in blocchi è attivata per un datastore, il valore predefinito èchunks
. In caso contrario, il valore predefinito èdocuments
. Per informazioni sul chunking dei documenti, consulta Analizzare e dividere i documenti in blocchi. Questo campo è in anteprima pubblica. Per utilizzarlo, modificav1
inv1alpha
nel comando curl.DATA_STORE_SPEC
: filtri per un archivio dati specifico in cui eseguire la ricerca. UtilizzadataStoreSpecs
se la tua app di ricerca è collegata a più datastore, ma vuoi risultati da un datastore specifico. Per maggiori informazioni, consulta DataStoreSpec.
C#
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API AI Applications C#.
Per autenticarti in AI Applications, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Java
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API AI Applications Java.
Per autenticarti in AI Applications, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API AI Applications Node.js.
Per autenticarti in AI Applications, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
PHP
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API AI Applications PHP.
Per autenticarti in AI Applications, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Python
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API AI Applications Python.
Per autenticarti in AI Applications, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API AI Applications Ruby.
Per autenticarti in AI Applications, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Ottenere risultati di ricerca per un'app con dati del sito web (chiave API)
Se vuoi autenticare la chiamata al metodo di ricerca con una chiave API anziché
utilizzare OAuth 2.0 tramite unaccount di serviziot o un account utente, segui questa
procedura, che utilizza il metodo searchLite
.
Il metodo searchLite
ha le stesse funzionalità del metodo search
, tranne per il fatto che
può essere utilizzato solo per cercare siti web pubblici.
Il metodo searchLite
è particolarmente adatto nelle seguenti condizioni:
Hai un sito web statico per il quale la configurazione di OAuth 2.0 tramite un account di servizio o un account utente non è pratica.
Hai eseguito la migrazione a Vertex AI Search dall'API Custom Search Site Restricted JSON del Programmable Search Engine.
Non vuoi utilizzare il widget di ricerca.
Prima di iniziare
Prima di poter chiamare il metodo
servingConfigs.searchLite
, devi disporre di una chiave API. Se non hai una chiave API, completa il passaggio 1 di Deployment dell'app di ricerca (chiave API).
Procedura
REST
Per utilizzare l'API per ottenere i risultati di ricerca per un'app con dati di siti web pubblici autenticati con una chiave API, utilizza il metodo engines.servingConfigs.searchLite
:
Trova l'ID app. Se hai già l'ID app, vai al passaggio successivo.
Nella Google Cloud console, vai alla pagina AI Applications.
Nella pagina App, trova il nome della tua app e recupera il relativo ID dalla colonna ID.
Esegui questo comando curl per ottenere i risultati di ricerca:
curl -X POST -H "Content-Type: application/json" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search:searchLite?key=API_KEY" \ -d '{ "servingConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search", "query": "QUERY", }'
Sostituisci quanto segue:
PROJECT_ID
: l'ID del tuo Google Cloud progetto.API_KEY
: la stringa della chiave API.PROJECT_ID
: l'ID del tuo Google Cloud progetto.APP_ID
: l'ID dell'app Vertex AI Search per cui vuoi eseguire query.QUERY
: il testo della query da cercare.
Python
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API AI Applications Python.
Per autenticarti in AI Applications, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Visualizzare i risultati di ricerca per un'app con dati strutturati o non strutturati
Puoi visualizzare l'anteprima dei risultati di ricerca dalla console Google Cloud o ottenere i risultati di ricerca utilizzando l'API.
Console
Per utilizzare la console Google Cloud per visualizzare l'anteprima dei risultati di ricerca per un'app con dati strutturati o non strutturati, segui questi passaggi:
- Apri la pagina Anteprima nella console.
Digita una query di ricerca.
Se hai attivato il completamento automatico, sotto la barra di ricerca viene visualizzato un elenco di suggerimenti per il completamento automatico mentre digiti.
(Facoltativo) Se hai collegato più datastore alla tua app, ma vuoi risultati solo da un datastore specifico, seleziona il datastore da cui ottenere i risultati.
Premi Invio per inviare la query.
Sotto la barra di ricerca viene visualizzato un elenco di risultati di ricerca.
Per i dati strutturati, si applicano le seguenti condizioni:
Se i mapping degli attributi non sono definiti in Configurazioni > Configura campi nei risultati, i risultati di ricerca vengono visualizzati come un elenco di nomi e valori degli attributi non elaborati.
Se sono stati salvati mapping degli attributi in Configurazioni > Configura campi nei risultati, i risultati di ricerca vengono visualizzati nello stesso modo in cui li vedi nell'anteprima della pagina Configurazioni.
Se sono state specificate sfaccettature in Configurazioni > Impostazioni sfaccettature, vengono visualizzate nello stesso modo.
REST
Per utilizzare l'API per ottenere i risultati di ricerca per un'app con dati strutturati o non strutturati, utilizza il metodo engines.servingConfigs.search
:
Trova l'ID app. Se hai già l'ID app, vai al passaggio successivo.
Nella Google Cloud console, vai alla pagina AI Applications.
Nella pagina App, trova il nome della tua app e recupera il relativo ID dalla colonna ID.
Ottenere i risultati di ricerca.
curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search:search" \ -d '{ "query": "QUERY", "userPseudoId": "USER_PSEUDO_ID", "pageSize": "PAGE_SIZE", "offset": "OFFSET", "orderBy": "ORDER_BY", "filter": "FILTER", "boostSpec": "BOOST_SPEC", "facetSpec": "FACET_SPEC", "queryExpansionSpec": "QUERY_EXPANSION_SPEC", "spellCorrectionSpec": "SPELL_CORRECTION_SPEC", "contentSearchSpec": "CONTENT_SEARCH_SPEC", "dataStoreSpecs": [{"DATA_STORE_SPEC"}], }'
Sostituisci quanto segue:
PROJECT_ID
: l'ID del tuo Google Cloud progetto.PROJECT_ID
: l'ID del tuo Google Cloud progetto.APP_ID
: l'ID dell'app Vertex AI Search per cui vuoi eseguire query.QUERY
: il testo della query da cercare.USER_PSEUDO_ID
: facoltativo. Si tratta di un identificatore pseudonimizzato per il monitoraggio di un visitatore della ricerca. Google consiglia vivamente di utilizzare questo campo, che migliora il rendimento del modello e la qualità della personalizzazione. Puoi utilizzare un cookie HTTP per questo campo, che identifica in modo univoco un visitatore su un singolo dispositivo. Questo identificatore non cambia quando il visitatore esegue l'accesso o la disconnessione da un sito web. Non impostare questo campo sullo stesso identificatore per più utenti, in quanto ciò combinerebbe le loro cronologie degli eventi e peggiorerebbe la qualità del modello. Non includere informazioni che consentono l'identificazione personale (PII) in questo campo.PAGE_SIZE
: il numero di risultati restituiti dalla ricerca. La dimensione massima consentita della pagina dipende dal tipo di dati. Le dimensioni della pagina superiori al valore massimo vengono forzate al valore massimo.- Siti web con indicizzazione di base: predefinito
10
, massimo25
- Siti web con indicizzazione avanzata: predefinito
25
, massimo50
- Altro: predefinito
50
, massimo100
- Siti web con indicizzazione di base: predefinito
OFFSET
: facoltativo. L'indice iniziale dei risultati. Il valore predefinito è 0.Ad esempio, se l'offset è 2, la dimensione della pagina è 10 e ci sono 15 risultati da restituire, i risultati da 2 a 11 vengono restituiti nella prima pagina.
ORDER_BY
: facoltativo. L'ordine in cui vengono disposti i risultati.FILTER
: facoltativo. Un campo di testo per filtrare la ricerca utilizzando un'espressione di filtro. Il valore predefinito è una stringa vuota, il che significa che non viene applicato alcun filtro.Esempio:
color: ANY("red", "blue") AND score: IN(*, 100.0e)
Per maggiori informazioni, vedi Filtrare la ricerca di dati strutturati o non strutturati.
BOOST_SPEC
: facoltativo. Una specifica per aumentare o diminuire la visibilità dei documenti. Valori:BOOST
: un numero in virgola mobile nell'intervallo [-1,1]. Quando il valore è negativo, i risultati vengono declassati (vengono visualizzati più in basso nei risultati). Quando il valore è positivo, i risultati vengono promossi (vengono visualizzati più in alto nei risultati).CONDITION
: un'espressione di filtro di testo per selezionare i documenti a cui viene applicato l'incremento. Il filtro deve restituire un valore booleano.
Per scoprire di più sul boost per la ricerca strutturata, consulta Migliorare i risultati di ricerca.
FACET_SPEC
: facoltativo. Una specifica del facet per eseguire la ricerca con facet.QUERY_EXPANSION_SPEC
: facoltativo. Una specifica per determinare in quali condizioni deve verificarsi l'espansione della query. Il valore predefinito èDISABLED
.SPELL_CORRECTION_SPEC
: facoltativo. Una specifica per determinare in quali condizioni deve essere eseguita la correzione ortografica. Il valore predefinito èAUTO
.CONTENT_SEARCH_SPEC
: facoltativo. Per ottenere snippet, risposte estrattive, segmenti estrattivi e riepiloghi della ricerca. Solo per dati non strutturati. Per ulteriori informazioni, vedi:DATA_STORE_SPEC
: filtri per un datastore specifico in cui eseguire la ricerca. Può essere utilizzato se l'app di ricerca è collegata a più datastore.Visualizzazione dei risultati della ricerca guidata nella risposta di ricerca:
I risultati di ricerca guidata vengono restituiti con le risposte di ricerca per la ricerca strutturata e non strutturata. Il risultato della ricerca guidata contiene un elenco di coppie chiave-valore degli attributi estratte in base ai documenti dei risultati di ricerca. In questo modo, gli utenti possono perfezionare i risultati di ricerca utilizzando alcune chiavi e alcuni valori degli attributi come filtri.
In questa risposta di esempio, il colore verde è stato utilizzato per perfezionare i risultati di ricerca inviando una nuova richiesta di ricerca con il campo del filtro specificato come
_gs.color: ANY("green")
:{ "guidedSearchResult": { "refinementAttributes": [ { "attributeKey": "_gs.color", "attributeValue" : "green" }, { "attributeKey": "_gs.category", "attributeValue" : "shoe" } ] } }
C#
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API AI Applications C#.
Per autenticarti in AI Applications, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Java
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API AI Applications Java.
Per autenticarti in AI Applications, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API AI Applications Node.js.
Per autenticarti in AI Applications, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
PHP
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API AI Applications PHP.
Per autenticarti in AI Applications, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Python
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API AI Applications Python.
Per autenticarti in AI Applications, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API AI Applications Ruby.
Per autenticarti in AI Applications, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Ottenere i punteggi di pertinenza dei documenti con i risultati di ricerca
I punteggi di pertinenza dei documenti si basano sulla somiglianza della query con il documento. I punteggi vengono inseriti in 11 bucket nell'intervallo: 0, 0.1, 0.2, … a 1.0. Più alto è il punteggio, più pertinente è il documento.
Prendi in considerazione i punteggi di pertinenza dei documenti per questi casi d'uso:
Filtraggio post-ricerca in base al punteggio di pertinenza per rimuovere i risultati non pertinenti
Classifica post-ricerca o come input per altre applicazioni
Debug: i punteggi di pertinenza possono fornire informazioni sul motivo per cui vengono restituiti alcuni risultati di ricerca
Per ogni risultato di ricerca può essere restituito un punteggio di pertinenza:
"results": [ { "id": "DOCUMENT_ID", "document": { ... }, "modelScores": { "relevance_score": { "values": [ DOCUMENT-RELEVANCE-SCORE ] } } }, ...
Vedi anche il comando di esempio nella procedura riportata di seguito.
Prima di iniziare:assicurati che l'app di ricerca sia associata a un datastore strutturato o non strutturato. ovvero i punteggi di pertinenza dei documenti non possono essere restituiti per l'app di ricerca di siti web.
REST
Per richiedere che i punteggi di pertinenza dei documenti vengano restituiti con i risultati di ricerca, utilizza il metodo engines.servingConfigs.search
come segue:
Trova l'ID app. Se hai già l'ID app, vai al passaggio successivo.
Nella Google Cloud console, vai alla pagina AI Applications.
Nella pagina App, trova il nome della tua app e recupera il relativo ID dalla colonna ID.
Esegui il seguente comando curl per ottenere i punteggi restituiti con i risultati di ricerca.
curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search:search" \ -d '{ "servingConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search", "query": "QUERY", "relevanceScoreSpec": { "returnRelevanceScore": true } }'
PROJECT_ID
: l'ID del tuo Google Cloud progetto.APP_ID
: l'ID dell'app Vertex AI Search per cui vuoi eseguire query.QUERY
: il testo della query da cercare.
Il riepilogo delle ricerche varia in base al modello
Se generi riepiloghi della ricerca per le tue query, potresti notare che i riepiloghi differiscono tra i risultati della console e quelli dell'API. Se visualizzi questo messaggio, il motivo è probabilmente che la console utilizza un modello LLM diverso dall'API. Gli esempi di curl e codice in questa pagina utilizzano il modello LLM stabile.
Per modificare o visualizzare il modello LLM utilizzato nella pagina Anteprima della UI (supportato solo per applicazioni di ricerca avanzata e sanitarie).
- Vai alla pagina Configurazioni dell'app > scheda UI.
Seleziona un tipo di ricerca:
- Seleziona Cerca con una risposta per visualizzare un riepilogo generativo sopra i risultati di ricerca.
- Seleziona Ricerca con follow-up per attivare la ricerca conversazionale con riepiloghi generativi e domande aggiuntive.
Nella sezione Modelli linguistici di grandi dimensioni per i riassunti, seleziona un modello.
Per le chiamate di metodi, il modello stabile è quello predefinito. Per utilizzare un modello LLM diverso dal modello stabile, consulta Specificare il modello di riepilogo e Specificare il modello di risposta.
Passaggi successivi
Utilizza l'API di ricerca per sfogliare i dati nelle tue app di ricerca generiche.