Documents

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

Tạo một Document trống.

Điểm cuối

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

Tham số đường dẫn

parent string

Bắt buộc. Tên của Corpus nơi Document này sẽ được tạo. Ví dụ: corpora/my-corpus-123 sẽ 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.

Trường
name string

Không thể thay đổi. 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 bị trống khi tạo, thì 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ị dễ đọc cho Document. Tên hiển thị không được dài quá 512 ký tự, bao gồm cả dấu cách. Ví dụ: "Tài liệu về Semantic Retriever"

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ác cặp khoá-giá trị dùng để truy vấn. Một Document có thể có tối đa 20 CustomMetadata.

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 mới được tạo của Document.

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

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

Điểm cuối

post 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 sẽ 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:

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, tối đa 10 Chunk sẽ được trả về. Số lượng kết quả tối đa được chỉ định là 100.

metadataFilters[] object (MetadataFilter)

Không bắt buộc. Bộ lọc cho 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 kết hợp bằng "AND" logic.

Lưu ý: Yêu cầu này không hỗ trợ việc lọc ở cấp Document vì bạn đã chỉ định tên Document.

Cụm từ tìm kiếm mẫu: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

Danh sách đối tượng MetadataFilter: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = "chunk.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}}]

Ví dụ về truy vấn cho một phạm vi giá trị bằng số: (year > 2015 AND year <= 2020)

Danh sách đối tượng MetadataFilter: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

Lưu ý: Chỉ hỗ trợ "AND" cho cùng một khoá đối với các giá trị bằng 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:

Trường
relevantChunks[] object (RelevantChunk)

Các đ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.list

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

Điểm cuối

get 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 các Document. Ví dụ: corpora/my-corpus-123 sẽ có dạng corpora/{corpora}.

Tham số truy vấn

pageSize integer

Không bắt buộc. Số lượng Document 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 không chỉ định, tối đa 10 Document sẽ được trả về. Giới hạn kích thước tối đa là 20 Document cho mỗi trang.

pageToken string

Không bắt buộc. Mã thông báo trang nhận được từ mộ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 từ documents.list chứa danh sách được phân trang của Document. Các 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:

Trường
documents[] object (Document)

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

nextPageToken string

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òn trang nào nữa.

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

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

Nhận thông tin về một Document cụ thể.

Điểm cuối

get 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 sẽ 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

patch 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

Không thể thay đổi. 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 bị trống khi tạo, thì 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 sẽ 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ợ việc cập nhật displayName và customMetadata.

Đây là danh sách tên đủ điều kiện của các trường đượ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.

Trường
displayName string

Không bắt buộc. Tên hiển thị dễ đọc cho Document. Tên hiển thị không được dài quá 512 ký tự, bao gồm cả dấu cách. Ví dụ: "Tài liệu về Semantic Retriever"

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ác cặp khoá-giá trị dùng để truy vấn. Một Document có thể có tối đa 20 CustomMetadata.

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 sẽ 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 thành true, mọi Chunk và đối tượng liên quan đến Document này cũng sẽ bị xoá.

Nếu là false (mặc định), lỗi FAILED_PRECONDITION sẽ được trả về 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, phần nội dung phản hồi sẽ là một đối tượng JSON trống.

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. Một Corpus có thể có tối đa 10.000 Document.

Trường
name string

Không thể thay đổi. 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 bị trống khi tạo, thì 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ị dễ đọc cho Document. Tên hiển thị không được dài quá 512 ký tự, bao gồm cả dấu cách. Ví dụ: "Tài liệu về Semantic Retriever"

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ác 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 cho biết thời điểm Document được cập nhật lần gần đây nhất.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".

createTime string (Timestamp format)

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

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".

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

CustomMetadata

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

Trường
key string

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

value Union type
value chỉ có thể là một trong những trạng thái sau:
stringValue string

Giá trị kiểu 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ị bằng số của siêu dữ liệu cần lưu trữ.

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

  // value
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // Union type
}

StringList

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

Trường
values[] string

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

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