Method: documents.searchDocumentChunks

Tìm kiếm kiến thức dành cho nhà phát triển trong tài liệu dành cho nhà phát triển của Google. Trả về DocumentChunk dựa trên cụm từ tìm kiếm của người dùng. Có thể có nhiều đoạn từ cùng một Document. Để truy xuất toàn bộ tài liệu, hãy sử dụng DeveloperKnowledge.GetDocument hoặc DeveloperKnowledge.BatchGetDocuments với DocumentChunk.parent được trả về trong SearchDocumentChunksResponse.results.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Tham số
query

string

Bắt buộc. Cung cấp chuỗi truy vấn thô do người dùng cung cấp, chẳng hạn như "Cách tạo một vùng lưu trữ Cloud Storage".
pageSize

integer

Không bắt buộc. Chỉ định số lượng kết quả tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này.

Nếu không chỉ định, tối đa 5 kết quả sẽ được trả về.

Giá trị tối đa là 20; các giá trị lớn hơn 20 sẽ dẫn đến lỗi INVALID_ARGUMENT.
pageToken

string

Không bắt buộc. Chứa một mã thông báo trang, nhận được từ lệnh gọi documents.searchDocumentChunks trước đó. Cung cấp thông tin này để truy xuất trang tiếp theo.
filter

string

Không bắt buộc. Áp dụng bộ lọc nghiêm ngặt cho kết quả tìm kiếm. Biểu thức này hỗ trợ một tập hợp con của cú pháp được mô tả tại https://google.aip.dev/160.

Mặc dù documents.searchDocumentChunks trả về DocumentChunk, nhưng bộ lọc được áp dụng cho các trường DocumentChunk.document.

Các trường được hỗ trợ để lọc:

  • dataSource (STRING): Nguồn của tài liệu, ví dụ: docs.cloud.google.com. Hãy xem https://developers.google.com/knowledge/reference/corpus-reference để biết danh sách đầy đủ các nguồn dữ liệu trong kho ngữ liệu.
  • updateTime (DẤU THỜI GIAN): Dấu thời gian cho biết lần cập nhật có ý nghĩa gần đây nhất của tài liệu. Bản cập nhật có ý nghĩa là bản cập nhật làm thay đổi nội dung markdown hoặc siêu dữ liệu của tài liệu.
  • uri (STRING): URI của tài liệu, ví dụ: https://docs.cloud.google.com/bigquery/docs/tables.

Các trường STRING hỗ trợ toán tử = (bằng) và != (không bằng) để khớp chính xác trên toàn bộ chuỗi. Chúng tôi không hỗ trợ các tiêu chí khớp một phần, khớp tiền tố và khớp biểu thức chính quy.

Các trường DẤU THỜI GIAN hỗ trợ toán tử =, <, <=, > và >=. Dấu thời gian phải ở định dạng RFC-3339, ví dụ: "2025-01-01T00:00:00Z".

Bạn có thể kết hợp các biểu thức bằng cách sử dụng toán tử logic AND, OR và NOT (hoặc -). OR có mức độ ưu tiên cao hơn AND. Sử dụng dấu ngoặc đơn để nhóm theo mức độ ưu tiên rõ ràng.

Ví dụ:

  • 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"

Chuỗi filter không được vượt quá 500 ký tự; các giá trị dài hơn 500 ký tự sẽ dẫn đến lỗi INVALID_ARGUMENT.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Thông báo phản hồi cho DeveloperKnowledge.SearchDocumentChunks.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "results": [
    {
      object (DocumentChunk)
    }
  ],
  "nextPageToken": string
}
Trường
results[]

object (DocumentChunk)

Chứa kết quả tìm kiếm cho truy vấn đã cho. Mỗi DocumentChunk trong danh sách này chứa một đoạn nội dung liên quan đến cụm từ tìm kiếm. Sử dụng trường DocumentChunk.parent của mỗi kết quả với DeveloperKnowledge.GetDocument hoặc DeveloperKnowledge.BatchGetDocuments để truy xuất toàn bộ nội dung tài liệu.
nextPageToken

string

Không bắt buộc. Cung cấp một mã thông báo có thể được gửi dưới dạng pageToken để truy xuất trang tiếp theo. Nếu bạn bỏ qua trường này, thì sẽ không có trang tiếp theo.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.

DocumentChunk

DocumentChunk biểu thị một phần nội dung từ Document trong tập hợp kiến thức của nhà phát triển. Để tìm nạp toàn bộ nội dung tài liệu, hãy truyền parent đến DeveloperKnowledge.GetDocument hoặc DeveloperKnowledge.BatchGetDocuments.

Biểu diễn dưới dạng JSON 
{
  "parent": string,
  "id": string,
  "content": string,
  "document": {
    object (Document)
  }
}
Trường
parent

string

Chỉ có đầu ra. Chứa tên tài nguyên của tài liệu mà đoạn này thuộc về. Định dạng: documents/{uri_without_scheme} Ví dụ: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

Chỉ có đầu ra. Chỉ định mã nhận dạng của đoạn này trong tài liệu. Mã nhận dạng đoạn là mã nhận dạng duy nhất trong một tài liệu, nhưng không phải là mã nhận dạng duy nhất trên toàn cầu giữa các tài liệu. Mã nhận dạng khối không ổn định và có thể thay đổi theo thời gian.
content

string

Chỉ có đầu ra. Chứa nội dung của đoạn tài liệu.
document

object (Document)

Chỉ có đầu ra. Biểu thị siêu dữ liệu về Document mà đoạn này thuộc về. DocumentView của tin nhắn Document này sẽ được đặt thành DOCUMENT_VIEW_BASIC. Thao tác này được đưa vào đây để thuận tiện cho khách hàng, nhờ đó, khách hàng không cần gọi DeveloperKnowledge.GetDocument hoặc DeveloperKnowledge.BatchGetDocuments nếu chỉ cần các trường siêu dữ liệu. Nếu không, các ứng dụng nên dùng DeveloperKnowledge.GetDocument hoặc DeveloperKnowledge.BatchGetDocuments để tìm nạp nội dung đầy đủ của tài liệu.