API di ricerca e filtro

Questa pagina si applica ad Apigee e Apigee hybrid.

Questo argomento descrive come utilizzare la Ricerca intelligente basata su Vertex AI e le opzioni di ricerca basate su filtri per cercare risorse specifiche nell'hub API.

Puoi trovare e visualizzare facilmente le risorse API registrate nell'hub API utilizzando la ricerca intelligente. La ricerca intelligente ti consente di cercare tutte le risorse API disponibili nella tua istanza utilizzando una query di ricerca a testo libero. Puoi cercare in tutti i tipi di entità (API, operazioni API, specifiche e così via), oppure specifica il tipo di entità su cui eseguire la query.

Con il motore di ricerca Vertex AI, la ricerca intelligente può andare oltre la "corrispondenza" dei termini. La ricerca intelligente restituisce risultati contenenti termini trovati in qualsiasi punto delle voci delle risorse dell'API dettagliate che sono semanticamente simili alle query di ricerca a testo libero inserite.

La ricerca a testo libero restituisce un elenco impaginato di risultati di ricerca che includono i seguenti dettagli:

  • Nome risorsa: il nome dell'API, dell'operazione API o del file di specifica.
  • Descrizione della risorsa: una breve descrizione della risorsa.
  • Proprietario della risorsa: il nome e l'indirizzo email del proprietario della risorsa.
  • Link ai dettagli della risorsa: un link alla pagina delle informazioni dettagliate sulla risorsa.

Per cercare API contenenti un termine specifico:

  1. Nella console Google Cloud, vai alla pagina Scopri dell'hub API.

    Vai all'hub API Discover

  2. Digita una query di ricerca nella casella di ricerca.

    Ad esempio, puoi inserire "API di gestione degli ordini" o "File delle specifiche per le impostazioni dell'operatore wireless".

    Puoi perfezionare la ricerca utilizzando gli attributi di sistema nella richiesta di query di ricerca. Se hai creato attributi utente durante la registrazione delle API nell'hub API, puoi anche incorporare questi attributi nei prompt delle query di ricerca.

  3. L'elenco Risultati di ricerca mostrerà un elenco di risorse API contenenti termini semanticamente simili alla query di ricerca che hai inserito.
  4. Fai clic sul nome della risorsa API per visualizzare la relativa pagina dei dettagli.
  5. Per cancellare la query corrente, fai clic su Cancella risultati.

Puoi anche cercare le risorse dell'hub API utilizzando l'API dell'hub API. Il metodo searchResources consente di eseguire query sulle risorse dell'hub API utilizzando filtri e query a testo libero.

Puoi utilizzare la seguente chiamata API per eseguire ricerche nelle risorse dell'hub API: 

curl -X POST https://apihub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:searchResources \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" \
  -d '{
    "query":"QUERY",
    "filter":"resource_type = RESOURCE_TYPE"
   }'

Dove:

  • PROJECT_ID è l'ID del progetto host per l'istanza dell'hub API.
  • LOCATION è la località in cui è ospitata l'istanza dell'hub API.
  • QUERY è la query di testo libero da utilizzare nella ricerca. La query può contenere parole chiave relative a qualsiasi dettaglio della risorsa hub API, tra cui nomi visualizzati, descrizioni o altri metadati.
  • RESOURCE_TYPE è il filtro facoltativo specificato per la ricerca. Puoi specificare come filtro uno dei seguenti tipi di risorse dell'hub API:
    • Api
    • ApiOperation
    • Deployment
    • Definition
    • Spec
    • Version

Ad esempio: 

curl -X POST https://apihub.googleapis.com/v1/projects/{project-id}/locations/{location}:searchResources \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" \
  -d '{
    "query":"dog status in the store",
    "filter":"resource_type = SPEC"
    }'

Questa chiamata restituisce un elenco impaginato di risorse hub API, tra cui:

  • Il nome visualizzato della risorsa.
  • Una descrizione della risorsa.
  • Un link alla documentazione sulle risorse.
  • Il proprietario della risorsa.

Se vengono configurati attributi utente o di sistema aggiuntivi per la risorsa, vengono restituiti anche i metadati associati agli attributi.

Per maggiori informazioni sulla ricerca a testo libero con l'API dell'hub API, consulta la documentazione di riferimento dell'API per Method:project.locations.searchResources.

Opzioni di ricerca basate su filtri

Puoi perfezionare l'elenco delle API visualizzato nella pagina API utilizzando gli attributi di sistema come parametri di ricerca. Se hai creato attributi utente durante la registrazione delle API nell'hub delle API, puoi anche incorporare questi attributi nelle query di ricerca. Personalizza l'elenco di risorse API visualizzato utilizzando uno dei seguenti metodi:

Filtro

Utilizzando la ricerca elenco basata sui filtri, puoi semplificare l'elenco delle API in base a una serie di parametri predefiniti e attributi di sistema associati alla risorsa. Puoi utilizzare le opzioni Match ALL o Match ANY per personalizzare la visualizzazione filtrata.

Per specificare le opzioni di filtro:

  1. Nella console Google Cloud, vai alla pagina API dell'hub API.

    Vai alle API dell'hub API

  2. Fai clic sul campo Filtra tabella per filtrare la tabella. Viene visualizzato il riquadro Filtro.
  3. Specifica o seleziona le opzioni di filtro tra quelle riportate di seguito:
    • Nome API: il nome visualizzato dell'API
    • Documentazione: un breve link alla documentazione dell'API.
  4. Dopo aver selezionato un'opzione di filtro, seleziona un valore dall'elenco Valori. In alternativa, puoi inserire un valore per l'attributo di filtro selezionato.
  5. Per aggiungere un altro filtro, fai clic nel campo Filtra tabella per scegliere tra gli Operatori disponibili, quindi seleziona un altro attributo e un valore del filtro.

  6. Le proprietà di filtro selezionate mostrano la logica condizionale utilizzata dalla query di filtro. Puoi selezionare OR come operatore. Se non è selezionato alcun operatore, il valore predefinito è AND.

  7. Per cancellare un singolo filtro, fai clic sulla X in corrispondenza del filtro. Per cancellare tutti i filtri, fai clic su Cancella tutto nel riquadro Filtro.

Ordinamento

Per riordinare l'elenco delle API visualizzate:

  1. Nella console Google Cloud, vai alla pagina API dell'hub API.

    Vai alle API dell'hub API

    Per impostazione predefinita, viene visualizzata la pagina di elenco API.

  2. Nella pagina dell'elenco delle API, individua l'intestazione della colonna Nome API.
  3. La freccia indica la priorità di ordinamento corrente. Una freccia verso il basso indica in ordine alfabetico decrescente. Una freccia verso l'alto indica l'ordine alfabetico crescente.
  4. Fai clic su Nome API per ordinare l'elenco per nome.

Impaginazione

Se sono presenti più risorse dell'API, potrebbero essere visualizzate su più pagine.

Per personalizzare la visualizzazione dell'elenco e passare da una pagina all'altra:

  1. Nella console Google Cloud, vai alla pagina API dell'hub API.

    Vai alle API dell'hub API

    Per impostazione predefinita, viene visualizzata la pagina di elenco API.

  2. Dall'elenco delle API, individua gli strumenti di impaginazione come mostrato di seguito:

  3. Seleziona il numero di API da visualizzare per pagina.
  4. Fai clic su > Avanti per passare alla pagina successiva.
  5. Fai clic su < Indietro per tornare alla pagina precedente.

Che cosa succede dopo?