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ágina 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 gerar respostas a consultas extraídas do 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 de corpus.

A API Developer Knowledge permite pesquisar e recuperar páginas de documentação como conteúdo Markdown não estruturado.

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 usando o parâmetro de consulta key ou o cabeçalho X-Goog-Api-Key. Consulte o guia de início rápido do REST para ver um exemplo.
• 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.

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.