API Developer Knowledge

L'API Developer Knowledge fornisce accesso programmatico alla documentazione per lo sviluppo pubblica 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 lo sviluppo 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 generare risposte alle query tratte dal corpus della documentazione.

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

Modalità di utilizzo di Developer Knowledge

Puoi accedere a Developer Knowledge tramite le seguenti interfacce a seconda del tuo workflow:

• API REST e API RPC: chiama direttamente gli endpoint HTTP o gRPC. Per le specifiche dei metodi, consulta il riferimento REST e riferimento RPC.
• Librerie client: integra l'API Developer Knowledge nelle tue applicazioni utilizzando le librerie client ufficiali per C#, Go, Java, Node.js e TypeScript, PHP, Python e Ruby.
• Google Cloud CLI (gcloud): esegui gcloud developer-knowledge comandi dal terminale per cercare blocchi di documenti, recuperare contenuti Markdown e generare risposte.
• Server MCP per Developer Knowledge: collega l'assistenza al coding o l'agente 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'assistenza al coding AI, installa la skill 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 saperne 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'assistenza al coding o un agente 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 di metadati personalizzati sui 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 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

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

• Chiave API: autentica le richieste REST dirette o il server MCP per Developer Knowledge utilizzando il parametro di query key o l'intestazione X-Goog-Api-Key.
• Credenziali predefinite dell'applicazione (ADC), OAuth 2.0 o account di servizio: autentica le richieste quando utilizzi le librerie client ufficiali o i workflow di produzione. Per saperne di più sulla configurazione delle credenziali, consulta la documentazione relativa alle credenziali predefinite dell'applicazione.
• Credenziali utente (gcloud CLI): autentica le richieste CLI accedendo al tuo account Google Cloud con gcloud auth login. Per le istruzioni di configurazione, consulta la guida rapida di gcloud CLI.

ambiti OAuth

Quando esegui l'autenticazione con OAuth 2.0 o account di servizio, l'API Developer Knowledge e il server MCP per Developer Knowledge accettano i seguenti ambiti OAuth:

• https://www.googleapis.com/auth/cloud-platform: ambito predefinito utilizzato dalle credenziali predefinite dell'applicazione (ADC), da gcloud CLI e dalle librerie client ufficiali di Google Cloud.
• https://www.googleapis.com/auth/devprofiles.full_control: ambito utilizzato per i flussi di consenso OAuth 2.0 utente e le integrazioni del server MCP.
• https://www.googleapis.com/auth/developerprofiles.readonly: ambito di sola lettura supportato per i service account e le credenziali che non richiedono una schermata per il consenso OAuth dell'utente finale.

Autorizzazione del token di connessione

Per autenticare le richieste REST dirette con un account di servizio o un token di accesso OAuth 2.0, passa il token nell'intestazione Authorization: Bearer e specifica il progetto di fatturazione in X-Goog-User-Project:

export ACCESS_TOKEN=$(gcloud auth print-access-token)
curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Goog-User-Project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

Sostituisci PROJECT_ID con l'ID del tuo progetto Google Cloud.

Per le applicazioni Python, Node.js, Go e Java, le librerie client ufficiali gestiscono automaticamente le credenziali predefinite dell'applicazione (ADC) e gli aggiornamenti dei token. Per esempi, consulta Utilizzare le librerie client con l'API Developer Knowledge.

Documentazione inclusa

Consulta il riferimento al corpus per informazioni sui documenti cercati dall'API.

L'API Developer Knowledge mira a fornire l'accesso alla documentazione per sviluppatori di Google più recente. 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 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.