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

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

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

Включить API

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

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

  1. В консоли Google Cloud для проекта, в котором вы включили API, перейдите на страницу «Учетные данные» .
  2. Click Create credentials , and then select API key from the menu. The API key created dialog displays the string for your newly created key.
  3. Нажмите «Редактировать ключ API» .
  4. В поле «Имя» укажите имя для ключа.
  5. В разделе «Ограничения API» выберите «Ограничить ключ» .
  6. В списке «Выберите API» включите Developer Knowledge API и нажмите «ОК» .
    • Примечание: Если вы только что включили API базы знаний для разработчиков, может быть задержка, прежде чем он появится в списке выбранных API .
  7. Нажмите « Сохранить ».

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

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

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

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

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

  2. Используйте curl для вызова конечной точки searchDocumentChunks :

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

Эта команда возвращает список фрагментов документа, соответствующих запросу, включая фрагменты содержимого и parent для каждого документа.

Получить документ

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

Скопируйте parent одного из фрагментов документа, возвращаемых вызовом searchDocumentChunks (например, documents/developers.google.com/... ), сохраните его в переменную окружения и используйте curl для вызова конечной точки GetDocument :

export DOC_NAME="DOCUMENT_NAME"

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

Эта функция возвращает полное содержимое указанного документа в формате Markdown.

Что дальше?