Package google.developers.knowledge.v1alpha

Индекс

Знания разработчика

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

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

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

Все содержимое документа представлено в формате Markdown.

Пакетное получение документов

rpc BatchGetDocuments( BatchGetDocumentsRequest ) returns ( BatchGetDocumentsResponse )

Извлекает несколько документов, каждый из которых содержит полный текст в формате Markdown.

Области полномочий

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/devprofiles.full_control

Для получения более подробной информации см.OAuth 2.0 Overview .

GetDocument

rpc GetDocument( GetDocumentRequest ) returns ( Document )

Извлекает отдельный документ со всем его содержимым в формате Markdown.

Области полномочий

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/devprofiles.full_control

Для получения более подробной информации см.OAuth 2.0 Overview .

ПоискПотокДокументов

rpc SearchDocumentChunks( SearchDocumentChunksRequest ) returns ( SearchDocumentChunksResponse )

Searches for developer knowledge across Google's developer documentation. This method returns document chunks based on the user's query. There can be many chunks of the same Document. To retrieve full documents, use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments with the DocumentChunk.parent returned in the SearchDocumentChunksResponse.results .

Области полномочий

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/devprofiles.full_control

Для получения более подробной информации см.OAuth 2.0 Overview .

BatchGetDocumentsRequest

Сообщение запроса для DeveloperKnowledge.BatchGetDocuments .

Поля
names[]

string

Обязательно. Названия документов для получения. В одном пакете можно получить максимум 20 документов. Документы возвращаются в том же порядке, что и names в запросе.

Формат: documents/{uri_without_scheme} Пример: documents/docs.cloud.google.com/storage/docs/creating-buckets

BatchGetDocumentsResponse

Ответное сообщение для DeveloperKnowledge.BatchGetDocuments .

Поля
documents[]

Document

Запрошенные документы.

Документ

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

Поля
name

string

Идентификатор. Имя ресурса документа. Формат: documents/{uri_without_scheme} Пример: documents/docs.cloud.google.com/storage/docs/creating-buckets

uri

string

Только вывод. URI контента, например, docs.cloud.google.com/storage/docs/creating-buckets .

content

string

Только вывод. Полное содержимое документа в формате Markdown.

description

string

Только вывод. Описание документа.

DocumentChunk

Объект DocumentChunk представляет собой фрагмент содержимого документа из корпуса DeveloperKnowledge. Чтобы получить все содержимое документа, передайте parent в методы DeveloperKnowledge.GetDocument или DeveloperKnowledge.BatchGetDocuments .

Поля
parent

string

Только вывод. Имя ресурса документа, из которого взят этот фрагмент. Формат: documents/{uri_without_scheme} Пример: documents/docs.cloud.google.com/storage/docs/creating-buckets

id

string

Только для вывода. Идентификатор этого фрагмента в документе. Идентификатор фрагмента уникален в пределах одного документа, но не является уникальным для всех документов. Идентификатор фрагмента нестабилен и может меняться со временем.

content

string

Только вывод. Содержимое фрагмента документа.

GetDocumentRequest

Сообщение запроса для DeveloperKnowledge.GetDocument .

Поля
name

string

Обязательно. Название документа для получения. Формат: documents/{uri_without_scheme} Пример: documents/docs.cloud.google.com/storage/docs/creating-buckets

SearchDocumentChunksRequest

Сообщение запроса для DeveloperKnowledge.SearchDocumentChunks .

Поля
query

string

Обязательно. Исходная строка запроса, предоставленная пользователем, например: "Как создать корзину в Cloud Storage?".

page_size

int32

Необязательный параметр. Максимальное количество возвращаемых результатов. Сервис может вернуть меньшее количество результатов.

Если параметр не указан, будет возвращено не более 5 результатов.

Максимальное значение равно 20; значения выше 20 приведут к ошибке INVALID_ARGUMENT.

page_token

string

Необязательный параметр. Токен страницы, полученный из предыдущего вызова SearchDocumentChunks . Укажите его, чтобы получить следующую страницу.

SearchDocumentChunksResponse

Ответное сообщение для DeveloperKnowledge.SearchDocumentChunks .

Поля
results[]

DocumentChunk

Результаты поиска по заданному запросу. Каждый DocumentChunk в этом списке содержит фрагмент контента, относящийся к поисковому запросу. Используйте поле DocumentChunk.parent каждого результата с помощью DeveloperKnowledge.GetDocument или DeveloperKnowledge.BatchGetDocuments , чтобы получить полное содержимое документа.

next_page_token

string

Необязательный параметр. Токен, который можно отправить в качестве page_token для получения следующей страницы. Если это поле опущено, последующих страниц не будет.