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

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

Обзор

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

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

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

Способы использования знаний разработчиков

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

• REST API и RPC API : вызовите конечные точки HTTP или gRPC напрямую. Для получения подробной информации о методах обратитесь к справочнику по REST и справочнику по RPC .
• Клиентские библиотеки : интегрируйте API знаний разработчиков в свои приложения, используя официальные клиентские библиотеки для Python, Node.js и TypeScript, Go, Java, PHP и Ruby.
• Google Cloud CLI ( gcloud ): запускайте команды gcloud developer-knowledge из терминала для поиска фрагментов документов, получения содержимого Markdown и генерации ответов.
• Сервер MCP для разработчиков : подключите своего помощника по программированию или агента ИИ к документации Google, используя инструменты протокола контекста модели (MCP) ( search_documents , get_documents и answer_query ). См. справочник MCP .

Совет: Если вы используете помощника по программированию на основе ИИ, установите навык агента retrieving-developer-knowledge выполнив npx skills add google/skills --skill retrieving-developer-knowledge . Этот навык предоставляет вашему помощнику встроенные инструкции о том, какой инструмент сервера Developer Knowledge MCP выбрать, как обрабатывать ошибки и как вызывать REST API с помощью curl , если сервер MCP недоступен. Чтобы узнать больше, ознакомьтесь с разделом «Использование навыка агента Developer Knowledge» .

Выберите между API и сервером MCP.

API базы знаний для разработчиков и сервер MCP базы знаний для разработчиков разработаны для различных задач интеграции:

• Используйте API базы знаний для разработчиков, клиентские библиотеки или интерфейс командной строки gcloud в следующих случаях:
  • В вашем проекте не используется агент искусственного интеллекта.
  • Вы хотите определить пользовательские инструменты или наборы инструментов для своего агента.
  • Вы хотите обработать или объединить результаты перед передачей их модели (например, проверить длину документа в байтах перед получением полного содержимого).
  • Необходимо отфильтровать результаты поиска (например, по data_source или update_time ) или применить маски полей .
• Используйте навыки сервера и агента Developer Knowledge MCP в следующих случаях:
  • Вы хотите подключить помощника или агента по программированию на основе ИИ, не создавая собственные определения и описания инструментов.
  • Вам нужны автоматические обновления по мере добавления новых возможностей на сервер Developer Knowledge MCP.
  • Фильтрация результатов поиска с помощью пользовательских метаданных не требуется.

Включить API

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

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

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

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

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

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

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

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

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

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

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