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

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

Обзор

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

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

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

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

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

Включить API

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

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

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

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

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

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

    Примечания:

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

Include this Developer Knowledge API key in your requests. For example, REST calls should include it using the key query parameter. Refer to the Quickstart guide for an example.

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

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

API для разработчиков призван обеспечить доступ к самой актуальной документации Google для разработчиков. Наша цель — переиндексировать контент в течение 48 часов после публикации, чтобы новая или обновленная документация была доступна в течение 2 рабочих дней.

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

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