Guia de início rápido: começar a usar a API Developer Knowledge

Este guia mostra como começar a usar a API Developer Knowledge. Você vai aprender a ativar a API Developer Knowledge, receber uma chave de API e fazer suas primeiras chamadas de API para pesquisar e recuperar a documentação do desenvolvedor.

Antes de começar

Antes de começar a usar a API Developer Knowledge, siga estas etapas.

Ativar a API

  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.

Criar e proteger a chave de API

  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çã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 novamente.
  5. Clique em Criar.

Responder a uma consulta com geração fundamentada

Depois de ter a chave da API Developer Knowledge, você pode começar a usar a API. O exemplo a seguir mostra como fazer uma consulta e receber uma resposta fundamentada na documentação:

  1. Salve a chave da API Developer Knowledge em uma variável de ambiente:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    Substitua YOUR_API_KEY pela chave de API que você gerou.

  2. Use curl para chamar o endpoint AnswerQuery:

    curl -X POST "https://developerknowledge.googleapis.com/v1alpha:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

Esse comando retorna uma resposta à consulta com base na documentação.

Pesquisar blocos de documentos

Se você quiser encontrar snippets de documentação específicos em vez de uma resposta gerada, poderá pesquisar diretamente blocos de documentos.

Use curl para chamar o endpoint SearchDocumentChunks:

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

A resposta inclui blocos de conteúdo correspondentes da documentação e referências aos documentos pai.

Recuperar um documento

A resposta de searchDocumentChunks contém uma lista de blocos de documentos. Cada bloco de documentos tem um campo parent que contém o nome do recurso do documento, que pode ser usado com GetDocument para recuperar o conteúdo completo do documento.

Para recuperar um documento, copie o campo parent de um dos blocos retornados por searchDocumentChunks e salve-o em uma variável de ambiente. Em seguida, use curl para chamar o endpoint GetDocument:

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

curl "https://developerknowledge.googleapis.com/v1/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

Isso retorna o conteúdo completo do Markdown do documento especificado.

A seguir