Guida rapida: inizia a utilizzare l'API Developer Knowledge

Questa guida ti mostra come iniziare a utilizzare l'API Developer Knowledge. Scoprirai come abilitare l'API Developer Knowledge, ottenere una chiave API ed effettuare le prime chiamate API per cercare e recuperare la documentazione per gli sviluppatori.

Prima di iniziare

Prima di iniziare a utilizzare l'API Developer Knowledge, assicurati di completare i seguenti passaggi.

Abilita l'API

  1. Apri la pagina dell'API Developer Knowledge nella libreria delle API di Google.
  2. Verifica di aver selezionato il progetto corretto in cui intendi utilizzare l'API.
  3. Fai clic su Abilita. Non sono necessari ruoli IAM specifici per abilitare o utilizzare l' API.

Crea e proteggi la chiave API

  1. Nella console Google Cloud per il progetto in cui hai abilitato l'API, vai alla pagina Credenziali.
  2. Fai clic su Crea credenziali, quindi seleziona Chiave API dal menu.
  3. Nel campo Nome, fornisci un nome per la chiave.

  4. Fai clic sul menu a discesa Seleziona limitazioni dell'API, quindi digita API Developer Knowledge. Fai clic sul risultato, quindi su Ok.

    Note:

    • Se hai appena abilitato l'API Developer Knowledge, potrebbe esserci un ritardo prima che venga visualizzata nell'elenco. Attendi alcuni minuti e riprova.
    • Se prevedi di utilizzare la stessa chiave per le chiamate di modelli generali del client AI (ad esempio, GEMINI_API_KEY), devi selezionare anche API Generative Language. In caso contrario, queste chiamate verranno bloccate.
  5. Fai clic su Crea.

Rispondi a una query con la generazione basata su dati reali

Una volta ottenuta la chiave API Developer Knowledge, puoi iniziare a utilizzare l'API. L'esempio seguente mostra come porre una query e ottenere una risposta basata sulla documentazione:

  1. Salva la chiave API Developer Knowledge in una variabile di ambiente:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    Sostituisci YOUR_API_KEY con la chiave API che hai generato.

  2. Utilizza curl per chiamare l'endpoint AnswerQuery:

    curl -X POST "https://developerknowledge.googleapis.com/v1alpha:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

Questo comando restituisce una risposta alla query in base alla documentazione.

Cerca blocchi di documenti

Se vuoi trovare snippet di documentazione specifici anziché una risposta generata, puoi cercare direttamente i blocchi di documenti.

Utilizza curl per chiamare l'endpoint SearchDocumentChunks:

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

La risposta include blocchi di contenuti corrispondenti della documentazione e riferimenti ai documenti principali.

Recupera un documento

La risposta di searchDocumentChunks contiene un elenco di blocchi di documenti. Ogni blocco di documenti ha un campo parent contenente il nome della risorsa del documento, che puoi utilizzare con GetDocument per recuperare l'intero contenuto del documento.

Per recuperare un documento, copia il campo parent da uno dei blocchi restituiti da searchDocumentChunks, salvalo in una variabile di ambiente, quindi utilizza curl per chiamare l'endpoint GetDocument:

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

curl "https://developerknowledge.googleapis.com/v1/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

Viene restituito l'intero contenuto Markdown del documento specificato.

Passaggi successivi