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 documentação para desenvolvedores.

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 para o 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, digite 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 de novo.
  5. Clique em Criar.

Responder a uma consulta com geração embasada

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

  1. Salve sua chave de API do 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 à sua consulta com base na documentação.

Pesquisar partes de documentos

Se você quiser encontrar snippets de documentação específicos em vez de uma resposta gerada, pesquise diretamente os 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 trechos correspondentes de conteúdo da documentação e referências aos documentos principais.

Recuperar um documento

A resposta de searchDocumentChunks contém uma lista de partes do documento. Cada parte do documento 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 trechos 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 todo o conteúdo do Markdown do documento especificado.

A seguir