Method: documents.searchDocumentChunks

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

HTTP-запрос

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

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

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

Параметры
query

string

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

pageSize

integer

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

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

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

pageToken

string

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

filter

string

Необязательный параметр. Применяет строгий фильтр к результатам поиска. Выражение поддерживает подмножество синтаксиса, описанного по адресу https://google.aip.dev/160 .

Хотя documents.searchDocumentChunks возвращает DocumentChunk , фильтр применяется к полям DocumentChunk.document .

Поддерживаемые поля для фильтрации:

  • dataSource (STRING): Источник документа, например, docs.cloud.google.com . Полный список источников данных в корпусе см. на странице https://developers.google.com/knowledge/reference/corpus-reference .
  • updateTime (TIMESTAMP): Отметка времени последнего значимого обновления документа. Значимое обновление — это обновление, изменяющее содержимое документа в формате Markdown или метаданные.
  • uri (STRING): URI документа, например, https://docs.cloud.google.com/bigquery/docs/tables .

Поля типа STRING поддерживают операторы = (равно) и != (не равно) для точного совпадения со всей строкой. Частичное совпадение, префиксное совпадение и совпадение по регулярному выражению не поддерживаются.

Поля TIMESTAMP поддерживают операторы = , < , <= , > и >= . Временные метки должны быть в формате RFC-3339, например, "2025-01-01T00:00:00Z" .

Выражения можно комбинировать с помощью логических операторов AND , OR и NOT (или - ). OR имеет более высокий приоритет, чем AND . Для явной группировки приоритетов используйте скобки.

Примеры:

  • dataSource = "docs.cloud.google.com" OR dataSource = "firebase.google.com"
  • dataSource != "firebase.google.com"
  • updateTime < "2024-01-01T00:00:00Z"
  • updateTime >= "2025-01-22T00:00:00Z" AND (dataSource = "developer.chrome.com" OR dataSource = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

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

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

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

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

Ответное сообщение для 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
  • https://www.googleapis.com/auth/cloud-platform

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

DocumentChunk

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

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

string

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

id

string

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

content

string

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

document

object ( Document )

Только для вывода. Представляет метаданные о Document из которого взят этот фрагмент. DocumentView для этого сообщения Document будет установлен в значение DOCUMENT_VIEW_BASIC . Он включен здесь для удобства, чтобы клиентам не нужно было вызывать DeveloperKnowledge.GetDocument или DeveloperKnowledge.BatchGetDocuments , если им нужны только поля метаданных. В противном случае клиентам следует использовать DeveloperKnowledge.GetDocument или DeveloperKnowledge.BatchGetDocuments для получения полного содержимого документа.