Method: corpora.documents.query

Thực hiện tìm kiếm ngữ nghĩa trên Document.

Yêu cầu HTTP

POST https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query

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

Tham số đường dẫn

Các tham số
name

string

Bắt buộc. Tên của Document cần truy vấn. Ví dụ: corpora/my-corpus-123/documents/the-doc-abc

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON
{
  "query": string,
  "resultsCount": integer,
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ]
}
Các trường
query

string

Bắt buộc. Chuỗi truy vấn để thực hiện tìm kiếm ngữ nghĩa.

resultsCount

integer

Không bắt buộc. Số lượng Chunk tối đa cần trả về. Dịch vụ có thể trả về ít Chunk hơn.

Nếu không chỉ định, hệ thống sẽ trả về tối đa 10 Chunk. Số lượng kết quả được chỉ định tối đa là 100.

metadataFilters[]

object (MetadataFilter)

Không bắt buộc. Lọc siêu dữ liệu Chunk. Mỗi đối tượng MetadataFilter phải tương ứng với một khoá riêng biệt. Nhiều đối tượng MetadataFilter được liên kết bằng logic "AND".

Lưu ý: Không hỗ trợ lọc ở cấp độ Document cho yêu cầu này vì tên Document đã được chỉ định.

Cụm từ tìm kiếm ví dụ: (năm >= 2020 HOẶC năm < 2010) AND (thể loại = kịch OR thể loại = hành động)

Danh sách đối tượng MetadataFilter: metadataFilters = [ {key = "chunk.custom_metadata.year" điều kiện = [{int_value = 2020, activity = GREATER_EQUAL}, {int_value = 2010, activity = LESS}}, {key = "chunk.custom_metadata.gắng" điều kiện = "{stringValue hoạt động = EQUAL", hoạt động {stringValue} EQUAL,

Truy vấn mẫu cho một dải giá trị dạng số: (năm > 2015 VÀ năm <= 2020)

Danh sách đối tượng MetadataFilter: metadataFilters = [ {key = các điều kiện "chunk.custom_metadata.year" = [{int_value = 2015, activity = GREATER}]}, {key = "chunk.custom_metadata.year" điều kiện = [{int_value = 2020, activity = LESS_EQUAL}]}]

Lưu ý: "AND" cho cùng một khoá chỉ được hỗ trợ cho giá trị số. Giá trị chuỗi chỉ hỗ trợ "OR" cho cùng một khoá.

Nội dung phản hồi

Phản hồi từ documents.query chứa danh sách các đoạn có liên quan.

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
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}
Các trường
relevantChunks[]

object (RelevantChunk)

Các đoạn có liên quan được trả về.

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/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

Để biết thêm thông tin, hãy xem bài viết Tổng quan về xác thực.