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 da una 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 i contenuti completi dei risultati di ricerca.
• AnswerQuery per generare risposte alle query tratte dal 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 di 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. Per abilitare o utilizzare l'API non sono necessari ruoli IAM specifici.

Autenticazione

Puoi autenticare le richieste all'API Developer Knowledge utilizzando uno dei seguenti metodi:

• Chiave API: autentica le richieste REST dirette utilizzando il parametro di query key o l'intestazione X-Goog-Api-Key. Per un esempio, consulta la guida rapida REST.
• Credenziali predefinite dell'applicazione (ADC), OAuth 2.0 o service account: autentica le richieste quando utilizzi le librerie client ufficiali o i flussi di lavoro di produzione. Per scoprire di più sulla configurazione delle credenziali, consulta la documentazione sulle credenziali predefinite dell'applicazione.

Documentazione inclusa

Consulta il riferimento del corpus per informazioni sui documenti in cui viene eseguita la ricerca dall'API.

L'API Developer Knowledge mira a fornire l'accesso alla documentazione più recente per gli sviluppatori di Google. Il nostro obiettivo è reindicizzare i contenuti entro 48 ore dalla pubblicazione, in modo che la documentazione nuova o aggiornata sia disponibile entro 2 giorni lavorativi.

Limitazioni note

• Qualità del Markdown:il Markdown viene generato dal codice HTML di origine. Potrebbero verificarsi alcune discrepanze o problemi di formattazione.
• Ambito dei contenuti: sono incluse solo le pagine pubbliche del corpus di riferimento. I contenuti provenienti da altre fonti come GitHub, siti OSS, blog o YouTube non sono inclusi.