API Developer Knowledge

L'API Developer Knowledge fornisce accesso programmatico alla documentazione pubblica per sviluppatori di Google, consentendoti di integrare questa knowledge base nelle tue applicazioni e nei tuoi workflow.

Panoramica

L'API Developer Knowledge è progettata per essere la fonte canonica per l'accesso leggibile dalla macchina alla documentazione per sviluppatori di Google. Offre funzioni per cercare e recuperare documenti e rispondere alle query:

• SearchDocumentChunks per trovare URI di pagine e snippet di contenuti pertinenti in base a una query.
• GetDocument o BatchGetDocuments per recuperare l'intero contenuto dei risultati di ricerca.
• AnswerQuery per ottenere risposte alle query basate sul corpus della documentazione.

Per iniziare rapidamente, segui la guida rapida.

Il corpus di contenuti ricercabili è elencato in Riferimento al corpus.

L'API Developer Knowledge supporta la ricerca e il recupero delle pagine di documentazione come contenuti Markdown non strutturati.

Abilita l'API

Per utilizzare l'API Developer Knowledge, devi prima abilitarla per il tuo progetto Google Cloud.

**Suggerimento:** se non hai un progetto cloud Google, creane uno seguendo le istruzioni di Google Cloud o Firebase.

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.

Autenticazione

Per utilizzare l'API Developer Knowledge è necessaria una chiave API Developer Knowledge. Per crearne una:

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.
   • Nota: se hai appena abilitato l'API Developer Knowledge, potrebbe esserci un ritardo prima che venga visualizzata nell'elenco. Attendi qualche minuto e riprova.
5. Fai clic su Crea.

Includi questa chiave API Developer Knowledge nelle tue richieste. Ad esempio, le chiamate REST devono includerla utilizzando il parametro di query key. Per un esempio, consulta la guida rapida.

Documentazione inclusa

Consulta Riferimento al corpus per informazioni sui documenti ricercati dall'API.

Limitazioni note

• Qualità Markdown: il Markdown viene generato dall'HTML di origine. Potrebbero esserci alcune discrepanze o problemi di formattazione.
• Ambito dei contenuti: sono incluse solo le pagine pubbliche nel riferimento al corpus. I contenuti di altre fonti come GitHub, siti OSS, blog o YouTube non sono inclusi.