API Developer Knowledge

A API Developer Knowledge oferece acesso programático à documentação pública para desenvolvedores do Google, permitindo que você integre essa base de conhecimento aos seus próprios aplicativos e fluxos de trabalho.

Visão geral

A API Developer Knowledge foi projetada para ser a fonte canônica de acesso legível por máquina à documentação para desenvolvedores do Google. Ele oferece funções para pesquisar e recuperar documentos e responder a consultas:

• SearchDocumentChunks para encontrar URIs de páginas relevantes e trechos de conteúdo com base em uma consulta.
• GetDocument ou BatchGetDocuments para buscar o conteúdo completo dos resultados da pesquisa.
• AnswerQuery para gerar respostas a consultas extraídas do corpus de documentação.

A API Developer Knowledge permite pesquisar e recuperar páginas de documentação como conteúdo Markdown não estruturado. O corpus de conteúdo pesquisável está listado na Referência do corpus.

Maneiras de usar o Developer Knowledge

Você pode acessar o Developer Knowledge nas seguintes plataformas, dependendo do seu fluxo de trabalho:

• API REST e API RPC: chame os endpoints HTTP ou gRPC diretamente. Consulte a referência REST e a referência RPC para especificações de métodos.
• Bibliotecas de cliente: integre a API Developer Knowledge aos seus aplicativos usando bibliotecas de cliente oficiais para Python, Node.js e TypeScript, Go, Java, PHP e Ruby.
• CLI do Google Cloud (gcloud): execute comandos gcloud developer-knowledge no terminal para pesquisar pedaços de documentos, buscar conteúdo em Markdown e gerar respostas.
• Servidor MCP do Developer Knowledge: conecte seu assistente ou agente de programação de IA à documentação do Google usando as ferramentas do Protocolo de contexto de modelo (MCP) (search_documents, get_documents e answer_query). Consulte a referência do MCP.

Dica: se você estiver usando um assistente de programação de IA, instale a habilidade do agente retrieving-developer-knowledge executando npx skills add google/skills --skill retrieving-developer-knowledge. Essa skill oferece ao seu assistente instruções integradas sobre qual ferramenta do servidor MCP do Developer Knowledge escolher, como lidar com erros e como chamar a API REST com curl se o servidor MCP não estiver disponível. Para saber mais, confira Usar a habilidade do agente Developer Knowledge.

Escolher entre a API e o servidor MCP

A API Developer Knowledge e o servidor MCP Developer Knowledge foram projetados para diferentes necessidades de integração:

• Use a API Developer Knowledge, as bibliotecas de cliente ou a CLI gcloud quando:
  • Seu projeto não usa um agente de IA.
  • Você quer definir ferramentas ou conjuntos de ferramentas personalizados para seu agente.
  • Você quer processar ou combinar resultados antes de transmiti-los a um modelo (por exemplo, verificar o comprimento em bytes do documento antes de buscar o conteúdo completo).
  • É necessário filtrar os resultados da pesquisa (por exemplo, por data_source ou update_time) ou aplicar máscaras de campo.
• Use o servidor MCP de conhecimento do desenvolvedor e a habilidade do agente quando:
  • Você quer conectar um assistente ou agente de programação de IA sem escrever definições e descrições de ferramentas personalizadas.
  • Você quer atualizações automáticas à medida que o servidor MCP de conhecimento do desenvolvedor adiciona novos recursos.
  • Não é necessário filtrar metadados personalizados nos resultados da pesquisa.

Ativar a API

Para usar a API Developer Knowledge, primeiro é necessário ativá-la no seu projeto na nuvem do Google Cloud.

Dica: se você não tiver um projeto na nuvem do Google Cloud, crie um usando as instruções do Google Cloud ou do Firebase.

1. Abra a página da API Developer Knowledge na biblioteca de APIs do Google.
2. Verifique se você selecionou o projeto correto em que pretende usar a API.
3. Clique em Ativar. Não é necessário ter papéis específicos do IAM para ativar ou usar a API.

Autenticação

É possível autenticar solicitações para a API Developer Knowledge usando um dos seguintes métodos:

• Chave de API: autentique solicitações REST diretas ou o servidor MCP de conhecimento do desenvolvedor usando o parâmetro de consulta key ou o cabeçalho X-Goog-Api-Key.
• Application Default Credentials (ADC), OAuth 2.0 ou contas de serviço: autentique solicitações ao usar as bibliotecas de cliente oficiais ou fluxos de trabalho de produção. Para saber mais sobre como configurar credenciais, consulte a documentação do Application Default Credentials.
• Credenciais do usuário (CLI gcloud): autentique solicitações da CLI fazendo login na sua conta do Google Cloud com gcloud auth login. Consulte o guia de início rápido da CLI gcloud para instruções de configuração.

Documentação incluída

Consulte Referência do corpus para saber quais documentos são pesquisados pela API.

A API Developer Knowledge tem como objetivo fornecer acesso à documentação mais recente para desenvolvedores do Google. Nosso objetivo é reindexar o conteúdo em até 48 horas após a publicação para que a documentação nova ou atualizada esteja disponível em até dois dias úteis.

Limitações conhecidas

• Qualidade do Markdown:o Markdown é gerado com base no HTML de origem. Pode haver algumas discrepâncias ou problemas de formatação.
• Escopo do conteúdo:somente páginas públicas na referência do corpus são incluídas. Conteúdo de outras fontes, como GitHub, sites de OSS, blogs ou YouTube, não é incluído.