Эта страница переведена с помощью Cloud Translation API.

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

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

Обзор

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

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

Помимо прямого вызова REST API или клиентских библиотек, вы можете подключить Developer Knowledge к своему ИИ-помощнику в программировании, используя следующие инструменты:

Сервер Developer Knowledge MCP : позволяет вашему ИИ-помощнику в программировании искать и читать документацию Google, используя инструменты протокола Model Context Protocol (MCP) ( search_documents , get_documents и answer_query ).
Навык агента retrieving-developer-knowledge : предоставляет вашему ИИ-помощнику встроенные инструкции о том, когда использовать каждый инструмент сервера MCP для разработчиков, а также о том, как вызвать REST API с помощью curl , если MCP недоступен.

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

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

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

Включить API

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

Откройте страницу API для разработчиков в библиотеке API Google.
Убедитесь, что вы выбрали правильный проект, в котором планируете использовать API.
Нажмите «Включить» . Для включения или использования 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, не включен.