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 pertinenti e snippet di contenuti 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.

L'API Developer Knowledge supporta la ricerca e il recupero di pagine di documentazione come contenuti Markdown non strutturati. Il corpus di contenuti ricercabili è elencato nel documento Corpus di riferimento.

Modi per utilizzare le conoscenze per sviluppatori

Puoi accedere a Developer Knowledge tramite le seguenti piattaforme, a seconda del tuo flusso di lavoro:

• API REST e API RPC: chiama direttamente gli endpoint HTTP o gRPC. Per le specifiche del metodo, consulta il riferimento REST e il riferimento RPC.
• Librerie client: integra l'API Developer Knowledge nelle tue applicazioni utilizzando librerie client ufficiali per Python, Node.js e TypeScript, Go, Java, PHP e Ruby.
• Google Cloud CLI (gcloud): esegui i comandi gcloud developer-knowledge dal terminale per cercare blocchi di documenti, recuperare contenuti Markdown e generare risposte.
• Server MCP Developer Knowledge: collega l'assistente o l'agente di codifica AI alla documentazione di Google utilizzando gli strumenti Model Context Protocol (MCP) (search_documents, get_documents e answer_query). Consulta il riferimento MCP.

Suggerimento: se utilizzi un assistente di programmazione AI, installa l'abilità dell'agente retrieving-developer-knowledge eseguendo npx skills add google/skills --skill retrieving-developer-knowledge. Questa skill fornisce all'assistente istruzioni integrate su quale strumento del server MCP per Developer Knowledge scegliere, come gestire gli errori e come chiamare l'API REST con curl se il server MCP non è disponibile. Per scoprire di più, consulta Utilizzare la skill dell'agente Developer Knowledge.

Scegliere tra l'API e il server MCP

L'API Developer Knowledge e il server MCP per Developer Knowledge sono progettati per esigenze di integrazione diverse:

• Utilizza l'API Developer Knowledge, le librerie client o gcloud CLI quando:
  • Il tuo progetto non utilizza un agente AI.
  • Vuoi definire strumenti o set di strumenti personalizzati per il tuo agente.
  • Vuoi elaborare o combinare i risultati prima di passarli a un modello (ad esempio, controllare la lunghezza in byte del documento prima di recuperare l'intero contenuto).
  • Devi filtrare i risultati di ricerca (ad esempio per data_source o update_time) o applicare maschere di campo.
• Utilizza il server MCP per Developer Knowledge e la skill dell'agente quando:
  • Vuoi connettere un assistente o un agente di programmazione AI senza scrivere definizioni e descrizioni di strumenti personalizzati.
  • Vuoi aggiornamenti automatici man mano che il server MCP per Developer Knowledge aggiunge nuove funzionalità.
  • Non hai bisogno di filtri personalizzati dei metadati nei risultati di ricerca.

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 o il server MCP Developer Knowledge utilizzando il parametro di query key o l'intestazione X-Goog-Api-Key.
• 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.
• Credenziali utente (gcloud CLI): autentica le richieste CLI accedendo al tuo account Google Cloud con gcloud auth login. Consulta la guida rapida di gcloud CLI per le istruzioni di configurazione.

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