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. Ela oferece funções para pesquisar e recuperar documentos e responder a consultas:
SearchDocumentChunkspara encontrar URIs de página e snippets de conteúdo relevantes com base em uma consulta.GetDocumentouBatchGetDocumentspara buscar o conteúdo completo dos resultados da pesquisa.AnswerQuerypara receber respostas a consultas com base 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 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.
- Abra a página da API Developer Knowledge na biblioteca de APIs do Google.
- Verifique se você selecionou o projeto correto em que pretende usar a API.
- Clique em Ativar. Não é necessário ter papéis específicos do IAM para ativar ou usar a API.
Autenticação
É necessário ter uma chave de API do Developer Knowledge para usar a API Developer Knowledge. Para criar um:
- No console do Google Cloud para o projeto em que você ativou a API, acesse a página "Credenciais".
- Clique em Criar credenciais e selecione Chave de API no menu.
- No campo Nome, insira um nome para a chave.
-
Clique no menu suspenso Selecionar restrições de API e digite API Developer Knowledge. Clique no resultado e em OK.
- Observação: 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 de novo.
- Clique em Criar.
Inclua essa chave de API Developer Knowledge nas suas solicitações. Por exemplo, as chamadas REST precisam incluir esse parâmetro 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 de corpus para saber quais documentos são pesquisados pela API.
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:apenas 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 está incluído.