API знаний для разработчиков

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

Обзор

API Developer Knowledge предназначен для обеспечения канонического доступа к документации Google для разработчиков в машиночитаемом формате. Он предлагает две основные функции:

  • SearchDocumentChunks позволяет находить релевантные URI страниц и фрагменты контента на основе запроса.
  • GetDocument или BatchGetDocuments для получения полного содержимого результатов поиска.

Для быстрого начала работы следуйте инструкциям в руководстве по быстрому запуску .

Список доступных для поиска материалов представлен в разделе «Справочник по корпусу» .

Примечание для предварительной версии : В этой предварительной версии поддерживается поиск и извлечение страниц документации в виде неструктурированного контента Markdown.

Включить API

Для использования API базы знаний для разработчиков необходимо сначала включить его для вашего проекта в Google Cloud.

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

Аутентификация

Для использования API базы знаний разработчика требуется ключ. Чтобы его создать:

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

Включите этот ключ API базы знаний разработчика в свои запросы. Например, REST-запросы следует включать его с помощью параметра запроса key . Пример см. в руководстве по быстрому запуску .

Включенная документация

Для получения информации о том, какие документы используются для поиска с помощью API, обратитесь к справочнику Corpus .

Известные ограничения

  • Качество Markdown: Markdown генерируется из исходного HTML-кода. Могут быть некоторые несоответствия или проблемы с форматированием.
  • Содержание: Включены только общедоступные страницы из эталонного корпуса . Контент из других источников, таких как GitHub, сайты с открытым исходным кодом, блоги или YouTube, не включен.