Crea un'interfaccia di ricerca con l'API Query

L'API Query fornisce metodi di ricerca e suggerimento per creare un'interfaccia di ricerca o incorporare i risultati di ricerca in un'applicazione.

Per le applicazioni web con requisiti minimi, valuta la possibilità di utilizzare il widget di ricerca. Per saperne di più, consulta Creare un'interfaccia di ricerca con il widget Ricerca

Creare un'interfaccia di ricerca

La creazione di un'interfaccia di ricerca minimale richiede diversi passaggi:

  1. Configurare un'applicazione di ricerca
  2. Generare le credenziali OAuth per l'applicazione
  3. Eseguire query sull'indice
  4. Visualizzare i risultati della query

Puoi migliorare ulteriormente l'interfaccia di ricerca con funzionalità come impaginazione, ordinamento, filtraggio, facet e suggerimenti automatici.

Configurare un'applicazione di ricerca

Devi creare almeno un'applicazione di ricerca da associare a ogni interfaccia di ricerca che crei. Un'applicazione di ricerca fornisce i parametri predefiniti per una query, ad esempio le origini dati da utilizzare, l'ordinamento, i filtri e i facet da richiedere. Se necessario, puoi ignorare questi parametri utilizzando l'API Query.

Per saperne di più sulle applicazioni di ricerca, consulta Personalizzare l'esperienza di ricerca in Cloud Search.

Generare le credenziali OAuth per l'applicazione

Oltre ai passaggi descritti in Configurare l'accesso all'API Google Cloud Search, devi anche generare le credenziali OAuth per l'applicazione web. Il tipo di credenziali che crei dipende dal contesto in cui viene utilizzata l'API.

Utilizza le credenziali per richiedere l'autorizzazione per conto dell'utente. Utilizza l'ambito https://www.googleapis.com/auth/cloud_search.query quando richiedi l'autorizzazione.

Per ulteriori informazioni sulle opzioni OAuth e sulle librerie client, vedi [Google Identity Platform](https://developers.google.com/identity/choose-auth{: .external target="_blank"}.

Eseguire query sull'indice

Utilizza il metodo search per eseguire ricerche nell'indice.

Ogni richiesta deve includere due informazioni: un testo query per confrontare gli elementi e un searchApplicationId che identifica l'ID dell'applicazione di ricerca da utilizzare.

Il seguente snippet mostra una query all'origine dati dei film per il film Titanic:

{
  "query": "titanic",
  "requestOptions": {
    "searchApplicationId": "searchapplications/<search_app_id>"
  },
}

Visualizzare i risultati delle query

Come minimo, le interfacce di ricerca devono visualizzare l'elemento title e un link all'elemento originale. Puoi migliorare ulteriormente la visualizzazione dei risultati di ricerca sfruttando le informazioni aggiuntive presenti nei risultati di ricerca, come lo snippet e i metadati.

Gestire i risultati supplementari

Per impostazione predefinita, Cloud Search restituisce risultati supplementari quando i risultati per la query dell'utente sono insufficienti. Il campo queryInterpretation nella risposta indica quando vengono restituiti i risultati supplementari. Se vengono restituiti solo risultati supplementari, InterpretationType è impostato su REPLACE. Se vengono restituiti alcuni risultati per la query originale insieme a risultati supplementari, InterpretationType è impostato su BLEND. In entrambi i casi QueryInterpretation.Reason = NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY.

Quando vengono restituiti alcuni risultati supplementari, valuta la possibilità di fornire un testo per indicare che sono stati restituiti risultati supplementari. Ad esempio, nel caso di un REPLACE, potresti visualizzare la stringa "La tua ricerca della query originale non ha restituito risultati. Visualizzazione dei risultati per query simili".

Nel caso di un BLEND, potresti visualizzare la stringa "La tua ricerca della tua query originale non ha trovato risultati sufficienti. Sono inclusi i risultati per query simili".

Gestire i risultati di ricerca di persone

Cloud Search restituisce due tipi di "risultati relativi alle persone": documenti correlati a una persona il cui nome viene utilizzato nella query e informazioni sui dipendenti per una persona il cui nome viene utilizzato in una query. Il secondo tipo di risultato è una funzione della funzionalità di ricerca di persone di Cloud Search e i risultati di una query di questo tipo si trovano nel campo structuredResults di una risposta dell'API Query:

{
  "results": [...],
  "structuredResults": [{
    "person": {...}
  }]
}

Corrispondenza dei subordinati diretti

Corrispondenza dei report diretti è una funzionalità di ricerca di persone di Cloud Search che consente agli utenti di visualizzare i report diretti di una persona nella loro organizzazione. Il risultato è disponibile nel campo structuredResults.

Per le query sul responsabile o sui dipendenti subordinati di una persona, la risposta contiene un assistCardProtoHolder all'interno di structuredResults. assistCardProtoHolder ha un campo chiamato cardType che sarà uguale a RELATED_PEOPLE_ANSWER_CARD. assistCardProtoHolder contiene una scheda chiamata relatedPeopleAnswerCard che contiene la risposta effettiva. Contiene subject (la persona inclusa nella query) e relatedPeople, ovvero l'insieme di persone correlate al soggetto. Il campo relationType restituisce il valore MANAGER o DIRECT_REPORTS.

Il seguente codice mostra un esempio di risposta per una query di corrispondenza dei report diretti:

{
  "results": [],
  "structuredResults": [{
    "assistCardProtoHolder": {
      "extensions": {
        "@type": "type.googleapis.com/enterprise.topaz.sidekick.AssistCardProto",
        "cardMetadata": {
          "cardCategory": "ANSWER"
        },
        "cardType": "RELATED_PEOPLE_ANSWER_CARD",
        "relatedPeopleAnswerCard": {
          "subject": {
            "email": "AdamStanford@psincs-test01.newjnj.com",
            "displayName": "Adam Stanford"
            "manager": {
              "email": "simonsais@psincs-test01.newjnj.com"
            }
          },
          "relatedPeople": [{
            "email": "EdgarMountainRamirez@psincs-test01.newjnj.com",
            "displayName": "Edgar Mountain Ramirez"
          }, {
            "email": "FranciscoJoseMartinez@psincs-test01.newjnj.com",
            "displayName": "Francisco Jose Martinez"
          }],
          "relationType": "DIRECT_REPORTS",
        }
      }
    }
  }]
}

Disattivare le ottimizzazioni, inclusi i risultati supplementari

Per impostazione predefinita, le ottimizzazioni, come i risultati supplementari, sono attivate. Tuttavia, puoi disattivare tutte le ottimizzazioni o solo i risultati supplementari sia a livello di applicazione di ricerca sia di query:

Snippet in evidenza

Per gli elementi restituiti contenenti testo o contenuti HTML indicizzati, viene restituito uno snippet dei contenuti. Questi contenuti aiutano gli utenti a determinare la pertinenza dell'articolo restituito.

Se nel snippet sono presenti termini di query, vengono restituiti anche uno o più intervalli di corrispondenza che identificano la posizione dei termini.

Utilizza matchRanges per evidenziare il testo corrispondente durante il rendering dei risultati. Il seguente esempio di JavaScript converte lo snippet in markup HTML con ogni intervallo corrispondente racchiuso in un tag <span>.

function highlightSnippet(snippet) {
  let text = snippet.snippet;
  let formattedText = text;
  if (snippet.matchRanges) {
    let parts = [];
    let index = 0;
    for (let match of snippet.matchRanges) {
      let start = match.start || 0; // Default to 0 if omitted
      let end = match.end;
      if (index < start) { // Include any leading text before/between ranges
        parts.push(text.slice(index, start));
      }
      parts.push('<span class="highlight">');
      parts.push(text.slice(start, end));
      parts.push('</span>');
      index = end;
    }
    parts.push(text.slice(index)); // Include any trailing text after last range
    formattedText = parts.join('');
  }
  return formattedText;
}

Dato lo snippet:

{
  "snippet": "This is an example snippet...",
  "matchRanges": [
    {
      "start": 11,
      "end": 18
    }
  ]
}

La stringa HTML risultante è:

This is an <span class="highlight">example</span> snippet...

Metadati visibili

Utilizza il campo metadata per visualizzare informazioni aggiuntive sull'articolo restituito che potrebbero essere pertinenti per gli utenti. Il campo metadata include createTime e updateTime dell'articolo, nonché tutti i dati strutturati restituibili associati all'articolo.

Per visualizzare i dati strutturati, utilizza il campo displayOptions. Il campo displayOptions contiene l'etichetta di visualizzazione per il tipo di oggetto e un insieme di metalines. Ogni metalinea è un array di etichette di visualizzazione e coppie di valori come configurato nello schema.

Recuperare risultati aggiuntivi

Per recuperare risultati aggiuntivi, imposta il campo start nella richiesta sull'offset desiderato. Puoi regolare le dimensioni di ogni pagina con il campo pageSize.

Per visualizzare il numero di elementi restituiti o i controlli di paginazione per scorrere gli elementi restituiti, utilizza il campo resultCount. A seconda delle dimensioni del set di risultati, viene fornito il valore effettivo o un valore stimato.

Ordina risultati

Utilizza il campo sortOptions per specificare l'ordine degli elementi restituiti. Il valore sortOptions è un oggetto con due campi:

  • operatorName: un operatore per la proprietà dei dati strutturati in base alla quale eseguire l'ordinamento. Per le proprietà con più operatori, puoi ordinare solo utilizzando l'operatore di uguaglianza principale.
  • sortOrder: la direzione dell'ordinamento, ASCENDING o DESCENDING.

La pertinenza viene utilizzata anche come chiave di ordinamento secondaria. Se in una query non viene specificato alcun ordinamento, i risultati vengono classificati solo in base alla pertinenza.

"sortOptions": {
  "operatorName": "priority",
  "sortOrder": "DESCENDING"
}

Aggiungi filtri

Oltre alle espressioni di query, puoi limitare ulteriormente i risultati applicando filtri. Puoi specificare i filtri sia nell'applicazione di ricerca sia nella richiesta di ricerca.

Per aggiungere filtri in una richiesta o in un'applicazione di ricerca, aggiungi il filtro nel campo dataSourceRestrictions.filterOptions[].

Esistono due modi principali per filtrare ulteriormente un'origine dati:

  • Filtri degli oggetti, tramite la proprietà filterOptions[].objectType: limita gli elementi corrispondenti al tipo specificato come definito in uno schema personalizzato.
  • Filtri per valori — limita gli elementi corrispondenti in base a un operatore di query e al valore fornito.

I filtri composti consentono di combinare più filtri di valori in espressioni logiche per query più complesse.

Nell'esempio di schema del film, potresti applicare un vincolo di età in base all'utente attuale e limitare i film disponibili in base alla classificazione MPAA.

{
  "query": "adventure",
  "requestOptions": {
    "searchApplicationId": "<search_app_id>"
  },
  "dataSourceRestrictions": [
    {
      "source": {
        "name": "datasources/<data_source_id>"
      },
      "filterOptions": [
        {
          "objectType": "movie",
          "filter": {
            "compositeFilter": {
              "logicOperator": "AND"
              "subFilters": [
                {
                  "compositeFilter": {
                  "logicOperator": "OR"
                  "subFilters": [
                    {
                      "valueFilter": {
                        "operatorName": "rated",
                        "value": {
                          "stringValue": "G"
                        }
                      }
                    },
                    {
                      "valueFilter": {
                        "operatorName": "rated",
                        "value": {
                          "stringValue": "PG"
                        }
                      }
                    }
                  ]
                }
              ]
            }
          }
        }
      ]
    }
  ]
}

Perfeziona i risultati con i facet

I facet sono proprietà indicizzate che rappresentano categorie per perfezionare i risultati di ricerca. Utilizza i filtri per aiutare gli utenti a perfezionare in modo interattivo le query e trovare più rapidamente gli articoli pertinenti.

Le sfaccettature possono essere definite nell'applicazione di ricerca e ignorate dalle impostazioni nella query.

Quando richiedi i facet, Cloud Search calcola i valori più frequenti per le proprietà richieste tra gli elementi corrispondenti. Questi valori vengono restituiti nella risposta. Utilizza questi valori per creare filtri che restringano i risultati nelle query successive.

Il pattern di interazione tipico con le sfaccettature è:

  1. Esegui una query iniziale specificando le proprietà da includere nei risultati delle sfaccettature.
  2. Esegui il rendering dei risultati di ricerca e dei facet.
  3. L'utente seleziona uno o più valori dei facet per perfezionare i risultati.
  4. Ripeti la query con un filtro basato sui valori selezionati.

Ad esempio, per attivare l'affinamento delle query sui film in base all'anno e alla classificazione MPAA, includi la proprietà facetOptions nella query.

"facetOptions": [
  {
    "sourceName": "datasources/<data_source_id>",
    "operatorName": "year"
  },
  {
    "sourceName": "datasources/<data_source_id>",
    "operatorName": "rated"
  }
]

Risultati dei facet con campi basati su numeri interi

Puoi anche suddividere i risultati delle richieste in base a campi basati su numeri interi. Ad esempio, potresti contrassegnare una proprietà intera chiamata book_pages come sfaccettabile per perfezionare i risultati di una ricerca di libri con "100-200" pagine.

Quando configuri lo schema del campo della proprietà intera, imposta isFacetable su true e aggiungi le opzioni di raggruppamento corrispondenti a integerPropertyOptions. In questo modo, per ogni proprietà con sfaccettature intere vengono definite opzioni di raggruppamento predefinite.

Quando definisci la logica delle opzioni di raggruppamento, fornisci un array di valori incrementali che indicano gli intervalli. Ad esempio, se l'utente finale specifica gli intervalli come 2, 5, 10, 100, vengono calcolate le sfaccettature per <2, [2-5), [5-10), [10-100), >=100.

Puoi ignorare i facet basati su numeri interi definendo le stesse opzioni di raggruppamento in facetOptions nella richiesta. Se necessario, Cloud Search utilizza le opzioni di raggruppamento definite nello schema quando non sono definite opzioni di sfaccettatura nell'applicazione di ricerca o nella richiesta di query. I facet definiti nella query hanno la precedenza su quelli definiti nell'applicazione di ricerca, mentre i facet definiti nell'applicazione di ricerca hanno la precedenza su quelli definiti nello schema.

Visualizzare i risultati per dimensione o data del documento

Puoi utilizzare operatori riservati per perfezionare i risultati di ricerca in base alle dimensioni del file del documento, misurate in byte, o in base alla data di creazione o modifica di un documento. Non è necessario definire uno schema personalizzato, ma devi specificare il valore operatorName in FacetOptions dell'applicazione di ricerca.

  • Per il faceting in base alle dimensioni del documento, utilizza itemsize e definisci le opzioni di raggruppamento.
  • Per la classificazione in base alla data di creazione del documento, utilizza createddatetimestamp.
  • Per la classificazione in base alla data di modifica del documento, utilizza lastmodified.

Interpretare i bucket di facet

La proprietà facetResults nella risposta alla query di ricerca include la richiesta di filtro esatta dell'utente nel campo filter per ogni bucket.

Per i facet non basati su numeri interi, facetResults include una voce per ogni proprietà richiesta. Per ogni proprietà viene fornito un elenco di valori o intervalli, chiamato buckets. I valori più frequenti vengono visualizzati per primi.

Quando un utente seleziona uno o più valori in base ai quali applicare il filtro, crea una nuova query con i filtri selezionati ed esegui di nuovo la query dell'API.

Aggiungere suggerimenti

Utilizza l'API suggest per fornire il completamento automatico delle query in base alla cronologia personale delle query dell'utente, nonché ai contatti e al corpus di documenti.

Ad esempio, la seguente chiamata fornisce suggerimenti per la frase parziale jo.

{
  "query": "jo",
  "requestOptions": {
    "searchApplicationId": "<search_app_id>",
    "peoplePhotoOptions": {
      "peoplePhotoUrlSizeInPx": 32
    },
    "timeZone": "America/Denver"
  }
}

Puoi quindi visualizzare i suggerimenti risultanti in base alle esigenze della tua applicazione.