API Developer Knowledge

Anteprima

Questo prodotto è soggetto ai "Termini delle Offerte pre-GA" nella sezione Termini di servizio generali dei Termini specifici dei servizi. I prodotti pre-GA sono disponibili "così come sono" e potrebbero avere un supporto limitato. Per ulteriori informazioni, consulta le descrizioni della fase di lancio.

L'API Developer Knowledge fornisce accesso programmatico alla documentazione pubblica per gli 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 gli sviluppatori di Google. Offre due funzioni principali:

• 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.

Per iniziare rapidamente, segui la guida rapida.

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

Nota per l'anteprima: questa release di anteprima 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 Google Cloud, 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. La finestra di dialogo Chiave API creata mostra la stringa della chiave appena creata.
3. Fai clic su Modifica chiave API.
4. Nel campo Nome, fornisci un nome per la chiave.
5. In Restrizioni delle API, seleziona Limita chiave.
6. Nell'elenco Seleziona API, abilita API Developer Knowledge e fai clic su OK.
   • Nota: se hai appena abilitato l'API Developer Knowledge, potrebbe esserci un ritardo prima che venga visualizzata nell'elenco Seleziona API.
7. Fai clic su Salva.

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.