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

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

Обзор

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

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

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

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

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

Включить API

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

Совет: Если у вас нет проекта в Google Cloud, создайте его, следуя инструкциям для Google Cloud или Firebase .

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

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

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

• Ключ API : для аутентификации прямых REST-запросов используйте параметр запроса key или заголовок X-Goog-Api-Key . Пример см. в кратком руководстве по REST .
• Учетные данные по умолчанию для приложений (ADC), OAuth 2.0 или учетные записи служб : аутентифицируйте запросы при использовании официальных клиентских библиотек или рабочих процессов в производственной среде. Для получения дополнительной информации о настройке учетных данных обратитесь к документации по учетным данным по умолчанию для приложений .

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

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

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

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

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