Chunks

Tài nguyên REST: corpora.documents.chunks

Tài nguyên: Phân đoạn

Chunk là một phần con của Document được xem như một đơn vị độc lập nhằm mục đích biểu diễn và lưu trữ vectơ. Corpus có thể có tối đa 1 triệu Chunk.

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

Không thể thay đổi. Giá trị nhận dạng. Tên tài nguyên Chunk. Mã nhận dạng (tên không bao gồm tiền tố "corpora/*/documents/*/chunks/") có thể chứa tối đa 40 ký tự là chữ hoặc số hoặc dấu gạch ngang (-) viết thường. 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 này trống khi tạo, một mã nhận dạng duy nhất ngẫu nhiên gồm 12 ký tự sẽ được tạo. Ví dụ: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

Bắt buộc. Nội dung cho Chunk, chẳng hạn như chuỗi văn bản. Số lượng mã thông báo tối đa cho mỗi phân đoạn là 2043.

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ị. Số lượng tối đa CustomMetadata trên mỗi đoạn là 20.

createTime string (Timestamp format)

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

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

updateTime string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian về lần cập nhật Chunk 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".

state enum (State)

Chỉ có đầu ra. Trạng thái hiện tại của Chunk.

ChunkData

Dữ liệu đã trích xuất đại diện cho nội dung Chunk.

Biểu diễn dưới dạng JSON 
{

  // Union field data can be only one of the following:
  "stringValue": string
  // End of list of possible types for union field data.
}
Số trường

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

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

stringValue string

Nội dung Chunk dưới dạng chuỗi. Số lượng mã thông báo tối đa cho mỗi phân đoạn là 2043.

Tiểu bang

Các trạng thái trong vòng đời của Chunk.

Enum
STATE_UNSPECIFIED Giá trị mặc định. Giá trị này được dùng nếu trạng thái bị bỏ qua.
STATE_PENDING_PROCESSING Chunk đang được xử lý (nhúng và lưu trữ vectơ).
STATE_ACTIVE Chunk đã được xử lý và có thể truy vấn.
STATE_FAILED Không xử lý được yêu cầu Chunk.

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

Tạo Chunk.

Điểm cuối

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

Tham số đường dẫn

parent string

Bắt buộc. Tên của Document mà Chunk này sẽ được tạo. 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 một bản sao của Chunk.

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 Chunk.

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

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

Điểm cuối

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

Tham số đường dẫn

parent string

Bắt buộc. Tên của Document chứa Chunk. 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

pageSize integer

Không bắt buộc. Số Chunk giây tối đa cần trả về (trên mỗi trang). 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. Giới hạn kích thước tối đa là 100 Chunk 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 chunks.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 chunks.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 chunks.list chứa danh sách Chunk được phân trang. Chunk được sắp xếp theo chunk.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
chunks[] object (Chunk)

Các Chunk đượ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 
{
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "nextPageToken": string
}

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

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

Điểm cuối

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

Tham số đường dẫn

name string

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

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 Chunk.

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

Cập nhật một Chunk.

Điểm cuối

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

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

Tham số đường dẫn

chunk.name string

Không thể thay đổi. Giá trị nhận dạng. Tên tài nguyên Chunk. Mã nhận dạng (tên không bao gồm tiền tố "corpora/*/documents/*/chunks/") có thể chứa tối đa 40 ký tự là chữ hoặc số hoặc dấu gạch ngang (-) viết thường. 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 này trống khi tạo, một mã nhận dạng duy nhất ngẫu nhiên gồm 12 ký tự sẽ được tạo. Ví dụ: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c Hàm này có dạng corpora/{corpora}/documents/{document}/chunks/{chunk}.

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 customMetadata và data.

Đâ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 Chunk.

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 Chunk.

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

Xoá một Chunk.

Điểm cuối

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

Tham số đường dẫn

name string

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

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.

Phương thức: corpora.documents.chunks.batchCreate

Tạo hàng loạt Chunk.

Điểm cuối

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

Tham số đường dẫn

parent string

Không bắt buộc. Tên của Document mà lô Chunk này sẽ được tạo. Trường mẹ trong mỗi CreateChunkRequest phải khớp với giá trị này. 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
requests[] object (CreateChunkRequest)

Bắt buộc. Các thông báo yêu cầu chỉ định các Chunk cần tạo. Bạn có thể tạo tối đa 100 Chunk một lúc.

Nội dung phản hồi

Phản hồi của chunks.batchCreate chứa danh sách các Chunk đã tạo.

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
chunks[] object (Chunk)

Đã tạo các Chunk.

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

CreateChunkRequest

Yêu cầu tạo Chunk.

Biểu diễn dưới dạng JSON 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}
Số trường
parent string

Bắt buộc. Tên của Document mà Chunk này sẽ được tạo. Ví dụ: corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

Bắt buộc. Chunk để tạo.

Phương thức: corpora.documents.chunks.batchUpdate

Cập nhật theo lô Chunk.

Điểm cuối

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

Tham số đường dẫn

parent string

Không bắt buộc. Tên của Document chứa các Chunk cần cập nhật. Trường mẹ trong mỗi UpdateChunkRequest phải khớp với giá trị này. 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
requests[] object (UpdateChunkRequest)

Bắt buộc. Các thông báo yêu cầu chỉ định các Chunk cần cập nhật. Bạn có thể cập nhật tối đa 100 Chunk hàng loạt.

Nội dung phản hồi

Phản hồi của chunks.batchUpdate chứa danh sách các Chunk đã cập nhật.

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
chunks[] object (Chunk)

Đã cập nhật Chunk giây.

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

UpdateChunkRequest

Yêu cầu cập nhật một Chunk.

Biểu diễn dưới dạng JSON 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}
Số trường
chunk object (Chunk)

Bắt buộc. Chunk cần cập nhật.

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 customMetadata và data.

Đâ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"

Phương thức: corpora.documents.chunks.batchDelete

Xoá hàng loạt Chunk.

Điểm cuối

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

Tham số đường dẫn

parent string

Không bắt buộc. Tên của Document chứa các Chunk cần xoá. Trường mẹ trong mỗi DeleteChunkRequest phải khớp với giá trị này. 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
requests[] object (DeleteChunkRequest)

Bắt buộc. Các thông báo yêu cầu chỉ định các Chunk cần xoá.

Nội dung phản hồi

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

DeleteChunkRequest

Yêu cầu xoá Chunk.

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

Bắt buộc. Tên tài nguyên của Chunk cần xoá. Ví dụ: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk