Быстрый старт: Начните работу с API знаний для разработчиков

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

Прежде чем начать

Прежде чем начать использовать API базы знаний для разработчиков, убедитесь, что вы выполнили следующие шаги.

Включить API

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

Создайте и защитите ключ API.

  1. В консоли Google Cloud для проекта, в котором вы включили API, перейдите на страницу «Учетные данные» .
  2. Нажмите «Создать учетные данные» , а затем выберите «Ключ API» в меню.
  3. В поле «Имя» укажите имя для ключа.
  4. Щелкните раскрывающийся список «Выбрать ограничения API» , затем введите «Developer Knowledge API» . Щелкните по результату и нажмите «ОК» .
    • Примечание: Если вы только что включили API базы знаний для разработчиков, может быть задержка перед его появлением в списке. Подождите несколько минут и попробуйте снова.
  5. Нажмите «Создать» .

Ответьте на вопрос, используя подход, основанный на принципах обоснованного поколения.

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

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

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

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

  2. Используйте curl для вызова конечной точки 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?"}'

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

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

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

Используйте 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.

Что дальше?