Method: documents.searchDocumentChunks

Выполняет поиск информации для разработчиков в документации Google. Этот метод возвращает фрагменты документа на основе запроса пользователя. Фрагментов одного и того же документа может быть несколько. Для получения полных документов используйте DeveloperKnowledge.GetDocument или DeveloperKnowledge.BatchGetDocuments с DocumentChunk.parent , возвращаемым в SearchDocumentChunksResponse.results .

HTTP-запрос

GET https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks

В URL-адресе используется синтаксис транскодирования gRPC .

Параметры запроса

Параметры
query

string

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

pageSize

integer

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

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

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

pageToken

string

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

Текст запроса

Тело запроса должно быть пустым.

Ответный текст

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

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "results": [
    {
      object (DocumentChunk)
    }
  ],
  "nextPageToken": string
}
Поля
results[]

object ( DocumentChunk )

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

nextPageToken

string

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

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

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

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

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

DocumentChunk

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

JSON-представление 
{
  "parent": string,
  "id": string,
  "content": string
}
Поля
parent

string

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

id

string

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

content

string

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