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 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. Ela oferece funções para pesquisar e recuperar documentos e responder a consultas:

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

Para começar rapidamente, siga o guia de início rápido.

O corpus de conteúdo pesquisável está listado em Referência do corpus.

A API Developer Knowledge oferece suporte à pesquisa e recuperação de páginas de documentação como conteúdo Markdown não estruturado.

Ativar a API

Para usar a API Developer Knowledge, primeiro ative-a no seu projeto na nuvem do Google Cloud.

**Dica**: se você não tiver um projeto na nuvem do Google, 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

É necessária uma chave da API Developer Knowledge para usar a API Developer Knowledge. Para criar uma:

1. No console do Google Cloud do projeto em que você ativou a API, acesse a página "Credenciais".
2. Clique em Criar credenciais e selecione Chave de API no menu.
3. No campo Nome, forneça um nome para a chave.

4. Clique no menu suspenso Selecionar restrições de API e digite API Developer Knowledge. Clique no resultado e em OK.

   Observações:

   • Se você acabou de ativar a API Developer Knowledge, pode haver um atraso antes que ela apareça na lista. Aguarde alguns minutos e tente novamente.
   • Se você planeja usar essa mesma chave para as chamadas de modelo geral do cliente de IA (por exemplo, GEMINI_API_KEY), também selecione API Generative Language. Caso contrário, essas chamadas serão bloqueadas.
5. Clique em Criar.

Inclua essa chave da API Developer Knowledge nas suas solicitações. Por exemplo, as chamadas REST precisam incluí-la usando o parâmetro de consulta key. Consulte o guia de início rápido para ver um exemplo.

Documentação incluída

Consulte a 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 a partir do HTML de origem. Pode haver algumas discrepâncias ou problemas de formatação.
• Escopo do conteúdo:apenas páginas públicas na Referência do corpus são incluídas. O conteúdo de outras fontes, como GitHub, sites de OSS, blogs ou YouTube, não está incluído.