Phương thức: corpora.create
Tạo một Corpus
trống.
Điểm cuối
bài đăng
https://generativelanguage.googleapis.com/v1beta/corpora
Nội dung yêu cầu
Nội dung yêu cầu chứa một bản sao của Corpus
.
name
string
Không thể thay đổi. Giá trị nhận dạng. Tên tài nguyên Corpus
. Mã nhận dạng (tên không bao gồm tiền tố "corpora/") 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, thì 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/my-awesome-corpora-123a456b789c
displayName
string
Không bắt buộc. Tên hiển thị mà con người đọc được cho Corpus
. 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 ngữ nghĩa"
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 Corpus
.
Phương thức: corpora.query
Thực hiện tìm kiếm ngữ nghĩa trên Corpus
.
Điểm cuối
bài đăng
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query
Tham số đường dẫn
name
string
Bắt buộc. Tên của Corpus
cần truy vấn. Ví dụ: corpora/my-corpus-123
Nó có dạng corpora/{corpora}
.
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:
query
string
Bắt buộc. Chuỗi truy vấn để thực hiện tìm kiếm theo ngữ nghĩa.
metadataFilters[]
object (MetadataFilter
)
Không bắt buộc. Lọc siêu dữ liệu Chunk
và Document
. 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 với nhau bằng toán tử logic "AND".
Ví dụ về truy vấn ở cấp tài liệu: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)
MetadataFilter
object list: metadataFilters = [ {key = "document.custom_metadata.year" điều kiện = [{int_value = 2020, hoạt động = GREATER_EQUAL}, {int_value = 2010, hoạt động = LESS}]}, {key = "document.custom_metadata.year" điều kiện = [{int_value = 2020, hoạt động = GREATER_EQUAL}, {int_value = 2010, hoạt động = LESS}]}, {key = "document.custom_metadata.Loại" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]}]
Truy vấn mẫu ở cấp đoạn cho một dải giá trị dạng số: (năm > 2015 VÀ năm <= 2020)
MetadataFilter
object list: metadataFilters = [ {key = "chunk.custom_metadata.year" điều kiện = [{int_value = 2015, Operations = GREATER}]}, {key = "chunk.custom_metadata.year" điều kiện = [{int_value = 2020, hoạt động = LESS_EQUAL}]}]
Lưu ý: Chỉ hỗ trợ toán tử "AND" cho cùng một khoá đối với các giá trị số. Giá trị chuỗi chỉ hỗ trợ "OR" cho cùng một khoá.
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ố kết quả được chỉ định tối đa là 100.
Nội dung phản hồi
Phản hồi của corpora.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:
relevantChunks[]
object (RelevantChunk
)
Các đoạn có liên quan.
Biểu diễn dưới dạng JSON |
---|
{
"relevantChunks": [
{
object ( |
Phương thức: corpora.list
Liệt kê tất cả Corpora
do người dùng sở hữu.
Điểm cuối
get
https://generativelanguage.googleapis.com/v1beta/corpora
Tham số truy vấn
pageSize
integer
Không bắt buộc. Số lượng Corpora
tối đa cần trả về (trên mỗi trang). Dịch vụ có thể trả về ít Corpora
hơn.
Nếu bạn không chỉ định, hệ thống sẽ trả về tối đa 10 Corpora
. Giới hạn kích thước tối đa là 20 Corpora
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 corpora.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 corpora.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ừ corpora.list
chứa danh sách Corpora
được phân trang. Kết quả được sắp xếp theo corpus.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:
corpora[]
object (Corpus
)
Tập sao lục đượ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 bạn bỏ qua trường này, thì sẽ không có trang nào khác.
Biểu diễn dưới dạng JSON |
---|
{
"corpora": [
{
object ( |
Phương thức: corpora.get
Nhận thông tin về một Corpus
cụ thể.
Điểm cuối
get
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}
Tham số đường dẫn
name
string
Bắt buộc. Tên của Corpus
. 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 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 Corpus
.
Phương thức: corpora.patch
Cập nhật Corpus
.
Điểm cuối
bản vá
https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}
PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}
Tham số đường dẫn
corpus.name
string
Không thể thay đổi. Giá trị nhận dạng. Tên tài nguyên Corpus
. Mã nhận dạng (tên không bao gồm tiền tố "corpora/") có thể chứa tối đa 40 ký tự chữ-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 hậu tố ngẫu nhiên gồm 12 ký tự. Ví dụ: corpora/my-awesome-corpora-123a456b789c
Nó có dạng corpora/{corpora}
.
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
.
Đâ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 Corpus
.
displayName
string
Không bắt buộc. Tên hiển thị mà con người có thể đọc được của Corpus
. 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 trên trình truy xuất dữ liệu theo ngữ nghĩa"
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 Corpus
.
Phương thức: corpora.delete
Xoá một Corpus
.
Điểm cuối
xoá
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}
Tham số đường dẫn
name
string
Bắt buộc. Tên tài nguyên của Corpus
. Ví dụ: corpora/my-corpus-123
Hàm này có dạng corpora/{corpora}
.
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 Document
và đối tượng liên quan đến Corpus
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 Corpus
chứa bất kỳ Document
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.
Tài nguyên REST: corpora.permissions
Tài nguyên: Quyền
Tài nguyên quyền cấp cho người dùng, nhóm hoặc mọi người quyền truy cập vào tài nguyên API PaLM (ví dụ: một mô hình được điều chỉnh, tập hợp văn bản).
Vai trò là một tập hợp các thao tác được phép cho phép người dùng thực hiện các hành động cụ thể trên tài nguyên API PaLM. Bạn chỉ định vai trò để người dùng, nhóm hoặc tài khoản dịch vụ có thể sử dụng các vai trò đó. Khi chỉ định một vai trò, bạn sẽ cấp các quyền có trong vai trò đó.
Có 3 vai trò đồng tâm. Mỗi vai trò là tập hợp con của các thao tác được phép của vai trò trước đó:
- người đọc có thể sử dụng tài nguyên (ví dụ: mô hình được điều chỉnh, tập sao lục) để suy luận
- writer có các quyền của reader và ngoài ra có thể chỉnh sửa và chia sẻ
- chủ sở hữu có quyền của người viết và có thể xoá thêm
name
string
Chỉ có đầu ra. Giá trị nhận dạng. Tên quyền. Một tên duy nhất sẽ được tạo khi tạo. Ví dụ: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Chỉ có đầu ra.
granteeType
enum (GranteeType
)
Không bắt buộc. Không thể thay đổi. Loại bên được cấp phép.
emailAddress
string
Không bắt buộc. Bất biến. Địa chỉ email của người dùng thuộc nhóm mà quyền này đề cập đến. Trường này không được đặt khi loại người được cấp quyền là MỌI NGƯỜI.
role
enum (Role
)
Bắt buộc. Vai trò được cấp bằng quyền này.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "granteeType": enum ( |
GranteeType
Xác định các loại bên được cấp quyền này.
Enum | |
---|---|
GRANTEE_TYPE_UNSPECIFIED |
Giá trị mặc định. Giá trị này chưa được sử dụng. |
USER |
Đại diện cho người dùng. Khi đặt, bạn phải cung cấp emailAddress cho người dùng. |
GROUP |
Đại diện cho một nhóm. Khi đặt giá trị này, bạn phải cung cấp emailAddress cho nhóm. |
EVERYONE |
Biểu thị quyền truy cập cho mọi người. Bạn không cần phải cung cấp thêm thông tin. |
Vai trò
Xác định vai trò được cấp bởi quyền này.
Enum | |
---|---|
ROLE_UNSPECIFIED |
Giá trị mặc định. Giá trị này chưa được sử dụng. |
OWNER |
Chủ sở hữu có thể sử dụng, cập nhật, chia sẻ và xoá tài nguyên. |
WRITER |
Người viết có thể sử dụng, cập nhật và chia sẻ tài nguyên. |
READER |
Người đọc có thể sử dụng tài nguyên này. |
MetadataFilter
Bộ lọc do người dùng cung cấp để giới hạn việc truy xuất dựa trên giá trị siêu dữ liệu cấp Chunk
hoặc Document
. Ví dụ (thể loại = phim hoặc thể loại = hành động): key = "document.custom_metadata.Thể loại" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]
key
string
Bắt buộc. Khoá của siêu dữ liệu để lọc.
conditions[]
object (Condition
)
Bắt buộc. Các Condition
cho khoá đã cho sẽ kích hoạt bộ lọc này. Nhiều Condition
được kết hợp bằng các OR logic.
Biểu diễn dưới dạng JSON |
---|
{
"key": string,
"conditions": [
{
object ( |
Điều kiện
Điều kiện lọc áp dụng cho một khoá.
operation
enum (Operator
)
Bắt buộc. Toán tử được áp dụng cho cặp khoá-giá trị đã cho để kích hoạt điều kiện.
value
. Loại giá trị phải phù hợp với loại giá trị đã xác định trong trường dành cho khoá tương ứng. Nếu các loại giá trị không nhất quán, kết quả sẽ là một tập hợp trống. Khi CustomMetadata
có loại giá trị StringList
, điều kiện lọc phải sử dụng string_value
được ghép nối với toán tử INCLUDES/EXCLUDES, nếu không kết quả cũng sẽ là một tập hợp trống. value
chỉ có thể là một trong những giá trị sau:
stringValue
string
Giá trị chuỗi để lọc siêu dữ liệu.
numericValue
number
Giá trị số để lọc siêu dữ liệu.
Biểu diễn dưới dạng JSON |
---|
{ "operation": enum ( |
Đơn vị tổ chức
Xác định các toán tử hợp lệ có thể áp dụng cho cặp khoá-giá trị.
Enum | |
---|---|
OPERATOR_UNSPECIFIED |
Giá trị mặc định. Giá trị này chưa được sử dụng. |
LESS |
Được hỗ trợ bởi số. |
LESS_EQUAL |
Được hỗ trợ ở dạng số. |
EQUAL |
Được hỗ trợ bởi số và chuỗi. |
GREATER_EQUAL |
Được hỗ trợ bởi số. |
GREATER |
Được hỗ trợ ở dạng số. |
NOT_EQUAL |
Được hỗ trợ bằng số và . |
INCLUDES |
Chỉ được chuỗi khi loại giá trị CustomMetadata cho khoá đã cho có stringListValue . |
EXCLUDES |
Chỉ được chuỗi hỗ trợ khi loại giá trị CustomMetadata cho khoá đã cho có stringListValue . |
Tài nguyên REST: corpora
Tài nguyên: Corpus
Corpus
là một tập hợp các Document
. Một dự án có thể tạo tối đa 5 tập hợp văn bản.
name
string
Bất biến. Giá trị nhận dạng. Tên tài nguyên Corpus
. Mã nhận dạng (tên không bao gồm tiền tố "corpora/") có thể chứa tối đa 40 ký tự 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 hậu tố ngẫu nhiên gồm 12 ký tự. Ví dụ: corpora/my-awesome-corpora-123a456b789c
displayName
string
Không bắt buộc. Tên hiển thị mà con người có thể đọc được của Corpus
. 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 trên trình truy xuất dữ liệu theo ngữ nghĩa"
createTime
string (Timestamp
format)
Chỉ có đầu ra. Dấu thời gian của thời điểm tạo Corpus
.
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 Corpus
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"
.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "displayName": string, "createTime": string, "updateTime": string } |