Краткое руководство по началу работы с Developer Knowledge API

В этом руководстве рассказывается, как начать работу с Developer Knowledge API. Вы узнаете, как включить Developer Knowledge API, получить ключ API и выполнить первые вызовы API для поиска и получения документации для разработчиков.

Подготовка

Прежде чем начать работу с Developer Knowledge API, выполните следующие действия:

Включение API

  1. Откройте страницу Developer Knowledge API в библиотеке API Google.
  2. Убедитесь, что вы выбрали проект, в котором хотите использовать API.
  3. Нажмите Включить. Для включения или использования API не требуются определенные роли IAM.

Как создать и защитить ключ API

  1. В консоли Google Cloud для проекта, в котором вы включили API, перейдите на страницу учетных данных.
  2. Нажмите Create credentials (Создать учетные данные) и выберите API key (Ключ API) в меню.
  3. В поле Название укажите название ключа.

  4. Нажмите на раскрывающийся список Select API restrictions (Выбрать ограничения API) и введите Developer Knowledge API. Нажмите на результат, а затем выберите ОК.

    Примечания

    • Если вы только что включили Developer Knowledge API, он может появиться в списке с задержкой. Подождите несколько минут и повторите попытку.
    • Если вы планируете использовать этот же ключ для вызовов общей модели ИИ-клиента (например, GEMINI_API_KEY), вам также нужно выбрать Generative Language API. В противном случае такие вызовы будут заблокированы.
  5. Нажмите Создать.

Генерируйте ответы на основе документации

Получив ключ API Developer Knowledge, вы можете начать использовать API. В следующем примере показано, как задать запрос и сгенерировать ответ на основе документации:

  1. Сохраните ключ API Developer Knowledge в переменной среды:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    Замените YOUR_API_KEY на сгенерированный ключ API.

  2. Используйте curl, чтобы вызвать конечную точку AnswerQuery:

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

Эта команда возвращает ответ на ваш запрос на основе документации.

Поиск фрагментов документов

Если вы хотите найти определенные фрагменты документации, а не сгенерированный ответ, вы можете выполнить поиск непосредственно по фрагментам документов.

Используйте curl, чтобы позвонить в конечную точку SearchDocumentChunks:

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

Ответ содержит подходящие фрагменты контента из документации и ссылки на родительские документы.

Как получить документ

Ответ от searchDocumentChunks содержит список фрагментов документов. У каждого фрагмента документа есть поле parent, содержащее название ресурса документа, которое можно использовать с GetDocument, чтобы получить полный контент документа.

Чтобы получить документ, скопируйте поле parent из одного из фрагментов, возвращенных searchDocumentChunks, и сохраните его в переменной среды, а затем используйте curl для вызова конечной точки GetDocument:

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

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

Возвращает полный контент указанного документа в формате Markdown.

Дальнейшие действия