Docuents

Tài nguyên REST: corpora.documents

Tài nguyên: Tài liệu

Document là một tập hợp các Chunk. Corpus có thể có tối đa 10.000 Document.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
Số trường
name string

Bất biến. Giá trị nhận dạng. Tên tài nguyên Document. Mã nhận dạng (tên không bao gồm tiền tố "corpora/*/documents/") có thể chứa tối đa 40 ký tự là chữ và số viết thường hoặc dấu gạch ngang (-). Mã nhận dạng không được bắt đầu hoặc kết thúc bằng dấu gạch ngang. Nếu tên trống khi tạo, một tên duy nhất sẽ được lấy từ displayName cùng với một hậu tố ngẫu nhiên gồm 12 ký tự. Ví dụ: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName string

Không bắt buộc. Tên hiển thị mà con người có thể đọc được của Document. Tên hiển thị không được dài quá 512 ký tự, kể cả dấu cách. Ví dụ: "Tài liệu về trình truy xuất dữ liệu theo ngữ nghĩa"

customMetadata[] object (CustomMetadata)

Không bắt buộc. Siêu dữ liệu tuỳ chỉnh do người dùng cung cấp được lưu trữ dưới dạng cặp khoá-giá trị dùng để truy vấn. Một Document có thể có tối đa 20 CustomMetadata.

updateTime string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian về lần cập nhật Document gần đây nhất.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

createTime string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian về thời điểm tạo Document.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

Phương thức: corpora.documents.create

Tạo một Document trống.

Điểm cuối

bài đăng https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

Tham số đường dẫn

parent string

Bắt buộc. Tên của Corpus mà Document này sẽ được tạo. Ví dụ: corpora/my-corpus-123 Hàm này có dạng corpora/{corpora}.

Nội dung yêu cầu

Nội dung yêu cầu chứa một bản sao của Document.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một thực thể mới tạo của Document.

Phương thức: corpora.documents.list

Liệt kê tất cả Document trong một Corpus.

Điểm cuối

nhận https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

Tham số đường dẫn

parent string

Bắt buộc. Tên của Corpus chứa Document. Ví dụ: corpora/my-corpus-123 Hàm này có dạng corpora/{corpora}.

Tham số truy vấn

pageSize integer

Không bắt buộc. Số Document giây tối đa cần trả về (trên mỗi trang). Dịch vụ có thể trả về ít Document hơn.

Nếu bạn không chỉ định, hàm sẽ trả về tối đa 10 Document giây. Giới hạn kích thước tối đa là 20 Document giây trên mỗi trang.

pageToken string

Không bắt buộc. Mã thông báo trang, nhận được từ lệnh gọi documents.list trước đó.

Cung cấp nextPageToken được trả về trong phản hồi dưới dạng một đối số cho yêu cầu tiếp theo để truy xuất trang tiếp theo.

Khi phân trang, tất cả các tham số khác được cung cấp cho documents.list phải khớp với lệnh gọi đã cung cấp mã thông báo trang.

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

Phản hồi của documents.list chứa danh sách Document được phân trang. Document được sắp xếp theo document.create_time tăng dần.

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:

Số trường
documents[] object (Document)

Các Document được trả về.

nextPageToken string

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

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

Phương thức: corpora.documents.query

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

Điểm cuối

bài đăng https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query

Tham số đường dẫn

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 Hàm này có dạng corpora/{corpora}/documents/{document}.

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:

Số trường
query string

Bắt buộc. Chuỗi truy vấn để thực hiện tìm kiếm theo 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 bạn không chỉ định, hàm sẽ trả về tối đa 10 Chunk giây. Số lượng kết quả tối đa được chỉ định 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á duy nhất. Nhiều đối tượng MetadataFilter được nối bằng hàm logic "AND".

Lưu ý: Hệ thống không hỗ trợ tính năng 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 OR năm < 2010) AND (thể loại = phim hay 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, hoạt động = GREATER_EQUAL}, {int_value = 2010, hoạt động = LESS}}, {key = "chunk.custom_metadata.movies" điều kiện = [{stringGiá trị = "drama", hoạt động = EQUAL}, {stringValue = "action", hoạt động = EQUAL}}]

Truy vấn mẫu cho khoảng giá trị bằng số: (năm > 2015 VÀ năm <= 2020)

Danh sách đối tượng MetadataFilter: MetadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot; điều kiện = [{int_value = 2020, hoạt động = LESS_EQUAL}]}]

Lưu ý: "VÀ" 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 của documents.query chứa danh sách các phân đ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:

Số trường
relevantChunks[] object (RelevantChunk)

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

Biểu diễn dưới dạng JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Phương thức: corpora.documents.get

Lấy thông tin về một Document cụ thể.

Điểm cuối

nhận https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

Tham số đường dẫn

name string

Bắt buộc. Tên của Document cần truy xuất. Ví dụ: corpora/my-corpus-123/documents/the-doc-abc Hàm này có dạng corpora/{corpora}/documents/{document}.

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

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của Document.

Phương thức: corpora.documents.patch

Cập nhật một Document.

Điểm cuối

bản vá https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

Tham số đường dẫn

document.name string

Bất biến. Giá trị nhận dạng. Tên tài nguyên Document. Mã nhận dạng (tên không bao gồm tiền tố "corpora/*/documents/") có thể chứa tối đa 40 ký tự là chữ và số viết thường hoặc dấu gạch ngang (-). Mã nhận dạng không được bắt đầu hoặc kết thúc bằng dấu gạch ngang. Nếu tên trống khi tạo, một tên duy nhất sẽ được lấy từ displayName cùng với một hậu tố ngẫu nhiên gồm 12 ký tự. Ví dụ: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c Hàm này có dạng corpora/{corpora}/documents/{document}.

Tham số truy vấn

updateMask string (FieldMask format)

Bắt buộc. Danh sách các trường cần cập nhật. Hiện tại, tính năng này chỉ hỗ trợ cập nhật displayName và customMetadata.

Đây là danh sách các tên trường đủ điều kiện được phân tách bằng dấu phẩy. Ví dụ: "user.displayName,photo"

Nội dung yêu cầu

Nội dung yêu cầu chứa một bản sao của Document.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của Document.

Phương thức: corpora.documents.delete

Xoá một Document.

Điểm cuối

xoá https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

Tham số đường dẫn

name string

Bắt buộc. Tên tài nguyên của Document cần xoá. Ví dụ: corpora/my-corpus-123/documents/the-doc-abc Hàm này có dạng corpora/{corpora}/documents/{document}.

Tham số truy vấn

force boolean

Không bắt buộc. Nếu bạn đặt chính sách này thành true, thì mọi Chunk và đối tượng liên quan đến Document này cũng sẽ bị xoá.

Nếu giá trị là false (giá trị mặc định), thì hệ thống sẽ trả về lỗi FAILED_PRECONDITION nếu Document chứa bất kỳ Chunk nào.

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

Nếu thành công, nội dung phản hồi sẽ trống.

CustomMetadata

Siêu dữ liệu do người dùng cung cấp được lưu trữ dưới dạng cặp khoá-giá trị.

Biểu diễn dưới dạng JSON 
{
  "key": string,

  // Union field value can be only one of the following:
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // End of list of possible types for union field value.
}
Số trường
key string

Bắt buộc. Khoá của siêu dữ liệu để lưu trữ.

Trường kết hợp value.

value chỉ có thể là một trong những trạng thái sau đây:

stringValue string

Giá trị chuỗi của siêu dữ liệu cần lưu trữ.

stringListValue object (StringList)

Giá trị StringList của siêu dữ liệu cần lưu trữ.

numericValue number

Giá trị số của siêu dữ liệu cần lưu trữ.

StringList

Các giá trị chuỗi do người dùng cung cấp được gán cho một khoá siêu dữ liệu duy nhất.

Biểu diễn dưới dạng JSON 
{
  "values": [
    string
  ]
}
Số trường
values[] string

Các giá trị chuỗi của siêu dữ liệu cần lưu trữ.