Corpora

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.

Trường
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

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ự, bao gồm 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ể Corpus mới tạo.

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 để 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:

Trường
query string

Bắt buộc. Chuỗi truy vấn để thực hiện tìm kiếm 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)

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

Ví dụ về truy vấn ở cấp đoạn cho một dải giá trị dạ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ợ 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ợ toán tử "HOẶC" 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ố lượng kết quả được chỉ định tối đa là 100.

Nội dung phản hồi

Phản hồi từ corpora.query chứa danh sách các đoạn 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.

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

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 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 đố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:

Trường
corpora[] object (Corpus)

Tập hợp từ vựng đượ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 (Corpus)
    }
  ],
  "nextPageToken": string
}

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 Nó 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

patch 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 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 Corpus.

Trường
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ự, bao gồm 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 phiên bản của Corpus.

Phương thức: corpora.delete

Xoá 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 Nó có dạng corpora/{corpora}.

Tham số truy vấn

force boolean

Không bắt buộc. Nếu bạn đặt giá trị là đúng (true), mọi Document và đối tượng liên quan đến Corpus này cũng sẽ bị xoá.

Nếu là false (mặc định), lỗi FAILED_PRECONDITION sẽ được trả về 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ẽ là một đối tượng JSON 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. Để cung cấp các quyền này cho người dùng, nhóm hoặc tài khoản dịch vụ, bạn chỉ định vai trò. Khi chỉ định một vai trò, bạn sẽ cấp các quyền mà vai trò đó chứa.

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 đó:

  • trình đọc có thể sử dụng tài nguyên (ví dụ: mô hình được điều chỉnh, tập hợp văn bản) để 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à ngoài ra có thể xoá
Trường
name string

Chỉ có đầu ra. Giá trị nhận dạng. Tên quyền. Hệ thống sẽ tạo một tên riêng biệt khi bạn 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. Không thể thay đổi. Đị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 theo quyền này.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

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 không được sử dụng.
USER Biểu thị một 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, 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 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 không đượ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 Trình đọc có thể sử dụng tài nguyên.

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 = chính kịch HOẶC thể loại = hành động): khoá = "document.custom_metadata.genre" điều kiện = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

Trường
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 với nhau bằng toán tử OR logic.

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

Điều kiện

Điều kiện lọc áp dụng cho một khoá duy nhất.

Trường
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 Union type
Loại giá trị phải nhất quán với loại giá trị được xác định trong trường 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 loại 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 (Operator),

  // value
  "stringValue": string,
  "numericValue": number
  // Union type
}

Đơn vị tổ chức

Xác định các toán tử hợp lệ có thể áp dụng cho một cặp khoá-giá trị.

Enum
OPERATOR_UNSPECIFIED Giá trị mặc định. Giá trị này không được sử dụng.
LESS Được hỗ trợ bởi số.
LESS_EQUAL Được hỗ trợ bởi số.
EQUAL Được hỗ trợ bởi số và chuỗi.
GREATER_EQUAL Được hỗ trợ bởi số.
GREATER Được hỗ trợ bởi số.
NOT_EQUAL Được hỗ trợ bởi số và chuỗi.
INCLUDES Chỉ được chuỗi hỗ trợ 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.

RelevantChunk

Thông tin về một đoạn liên quan đến một truy vấn.

Trường
chunkRelevanceScore number

Mức độ liên quan của Chunk với cụm từ tìm kiếm.

chunk object (Chunk)

Chunk liên kết với cụm từ tìm kiếm.

Biểu diễn dưới dạng JSON 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  }
}

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.

Trường
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

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ự, bao gồm cả dấu cách. Ví dụ: "Tài liệu về Trình truy xuất 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.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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".

updateTime string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian của lần cập nhật gần đây nhất đối với Corpus.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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,
  "createTime": string,
  "updateTime": string
}