- Tài nguyên: cacheContent
- Nội dung
- Phần
- Mở rộng
- FunctionCall
- FunctionResponse
- FileData
- Công cụ
- FunctionDeclaration
- Giản đồ
- Loại
- ToolConfig
- FunctionCallingConfig
- Chế độ
- UsageMetadata (Siêu dữ liệu sử dụng)
- Phương thức
Tài nguyên: cacheContent
Nội dung đã được xử lý trước và có thể được sử dụng trong các yêu cầu tiếp theo tới dịch vụ tạo sinh.
Bạn chỉ có thể sử dụng nội dung đã lưu vào bộ nhớ đệm với mô hình được tạo.
Biểu diễn dưới dạng JSON |
---|
{ "contents": [ { object ( |
Trường | |
---|---|
contents[] |
Không bắt buộc. Chỉ nhập. Không thể thay đổi. Nội dung được lưu vào bộ nhớ đệm. |
tools[] |
Không bắt buộc. Chỉ nhập. Không thể thay đổi. Danh sách |
createTime |
Chỉ có đầu ra. Thời gian tạo của mục bộ nhớ đệm. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: |
updateTime |
Chỉ có đầu ra. Thời điểm mục nhập trong bộ nhớ đệm được cập nhật lần gần đây nhất theo giờ UTC. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: |
usageMetadata |
Chỉ có đầu ra. Siêu dữ liệu về việc sử dụng nội dung được lưu vào bộ nhớ đệm. |
Trường kết hợp expiration . Chỉ định thời điểm tài nguyên này sẽ hết hạn. expiration chỉ có thể là một trong những trạng thái sau đây: |
|
expireTime |
Dấu thời gian theo giờ UTC tại thời điểm tài nguyên này được coi là đã hết hạn. Trạng thái này luôn được cung cấp trên đầu ra, bất kể nội dung nào được gửi trên đầu vào. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: |
ttl |
Chỉ nhập. TTL mới cho tài nguyên này, chỉ nhập. Thời lượng tính bằng giây với tối đa 9 chữ số phân số, kết thúc bằng " |
name |
Không bắt buộc. Giá trị nhận dạng. Tên tài nguyên tham chiếu đến nội dung được lưu vào bộ nhớ đệm. Định dạng |
displayName |
Không bắt buộc. Không thể thay đổi. Tên hiển thị có ý nghĩa do người dùng tạo cho nội dung được lưu vào bộ nhớ đệm. Tối đa 128 ký tự Unicode. |
model |
Bắt buộc. Không thể thay đổi. Tên của |
systemInstruction |
Không bắt buộc. Chỉ nhập. Không thể thay đổi. Hướng dẫn hệ thống thiết lập dành cho nhà phát triển. Hiện chỉ có văn bản. |
toolConfig |
Không bắt buộc. Chỉ nhập. Không thể thay đổi. Cấu hình công cụ. Cấu hình này được dùng chung cho tất cả công cụ. |
Nội dung
Loại dữ liệu có cấu trúc cơ sở chứa nội dung nhiều phần của một thông báo.
Content
bao gồm một trường role
chỉ định thực thể tạo của Content
và trường parts
chứa dữ liệu nhiều phần chứa nội dung của lượt thông báo.
Biểu diễn dưới dạng JSON |
---|
{
"parts": [
{
object ( |
Trường | |
---|---|
parts[] |
Đã sắp xếp |
role |
Không bắt buộc. Nhà sản xuất nội dung. Phải là "người dùng" hoặc "mô hình". Hữu ích khi thiết lập cho các cuộc trò chuyện nhiều lượt, nếu không có thể để trống hoặc không đặt. |
Phần
Một loại dữ liệu chứa nội dung nghe nhìn thuộc thông báo Content
gồm nhiều phần.
Một Part
chứa dữ liệu có một kiểu dữ liệu liên kết. Part
chỉ có thể chứa một trong các kiểu được chấp nhận trong Part.data
.
Part
phải có loại MIME IANA cố định để xác định loại và loại phụ của phương tiện truyền thông nếu trường inlineData
được điền bằng các byte thô.
Biểu diễn dưới dạng JSON |
---|
{ // Union field |
Trường | |
---|---|
Trường kết hợp
|
|
text |
Văn bản cùng dòng. |
inlineData |
byte nội dung nghe nhìn cùng dòng. |
functionCall |
Một |
functionResponse |
Kết quả đầu ra của một |
fileData |
Dữ liệu dựa trên URI. |
Blob
byte nội dung nghe nhìn thô.
Không được gửi văn bản dưới dạng byte thô, hãy sử dụng trường "văn bản".
Biểu diễn dưới dạng JSON |
---|
{ "mimeType": string, "data": string } |
Trường | |
---|---|
mimeType |
Loại MIME tiêu chuẩn IANA của dữ liệu nguồn. Ví dụ: - image/png - image/jpeg Nếu cung cấp loại MIME không được hỗ trợ, hệ thống sẽ trả về lỗi. Để biết danh sách đầy đủ các loại được hỗ trợ, hãy xem Định dạng tệp được hỗ trợ. |
data |
byte thô cho định dạng nội dung nghe nhìn. Chuỗi được mã hoá base64. |
FunctionCall
Một FunctionCall
được dự đoán được trả về từ mô hình chứa chuỗi đại diện cho FunctionDeclaration.name
cùng với các đối số và giá trị của các đối số đó.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "args": { object } } |
Trường | |
---|---|
name |
Bắt buộc. Tên hàm cần gọi. Phải là a-z, A-Z, 0-9 hoặc chứa dấu gạch dưới và dấu gạch ngang, với độ dài tối đa là 63. |
args |
Không bắt buộc. Các tham số và giá trị hàm ở định dạng đối tượng JSON. |
FunctionResponse
Kết quả đầu ra từ FunctionCall
chứa một chuỗi đại diện cho FunctionDeclaration.name
và một đối tượng JSON có cấu trúc chứa bất kỳ đầu ra nào của hàm sẽ được dùng làm ngữ cảnh cho mô hình. Hàm này phải chứa kết quả của FunctionCall
được đưa ra dựa trên thông tin dự đoán về mô hình.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "response": { object } } |
Trường | |
---|---|
name |
Bắt buộc. Tên hàm cần gọi. Phải là a-z, A-Z, 0-9 hoặc chứa dấu gạch dưới và dấu gạch ngang, với độ dài tối đa là 63. |
response |
Bắt buộc. Phản hồi hàm ở định dạng đối tượng JSON. |
FileData
Dữ liệu dựa trên URI.
Biểu diễn dưới dạng JSON |
---|
{ "mimeType": string, "fileUri": string } |
Trường | |
---|---|
mimeType |
Không bắt buộc. Loại MIME tiêu chuẩn IANA của dữ liệu nguồn. |
fileUri |
Bắt buộc. URI. |
Công cụ
Thông tin chi tiết về công cụ mà mô hình có thể sử dụng để tạo câu trả lời.
Tool
là một đoạn mã cho phép hệ thống tương tác với các hệ thống bên ngoài để thực hiện một hành động hoặc một tập hợp hành động, nằm ngoài phạm vi kiến thức và phạm vi của mô hình.
Biểu diễn dưới dạng JSON |
---|
{
"functionDeclarations": [
{
object ( |
Trường | |
---|---|
functionDeclarations[] |
Không bắt buộc. Danh sách Mô hình hoặc hệ thống không thực thi hàm. Thay vào đó, hàm đã xác định có thể được trả về dưới dạng [FunctionCall][content.part.function_call] có các đối số phía máy khách để thực thi. Mô hình có thể quyết định gọi một tập hợp con các hàm này bằng cách điền [FunctionCall][content.part.function_call] trong phản hồi. Lượt trò chuyện tiếp theo có thể chứa [FunctionResponse][content.part.function_response] với ngữ cảnh tạo "hàm" [content.role] cho lượt mô hình tiếp theo. |
FunctionDeclaration
Biểu diễn có cấu trúc của nội dung khai báo hàm như xác định trong thông số kỹ thuật OpenAPI 3.03. Tên hàm và tham số có trong phần khai báo này. FunctionDeclaration này là bản trình bày về một khối mã có thể được mô hình dùng làm Tool
và được ứng dụng thực thi.
Biểu diễn dưới dạng JSON |
---|
{
"name": string,
"description": string,
"parameters": {
object ( |
Trường | |
---|---|
name |
Bắt buộc. Tên hàm. Phải là a-z, A-Z, 0-9 hoặc chứa dấu gạch dưới và dấu gạch ngang, với độ dài tối đa là 63. |
description |
Bắt buộc. Mô tả ngắn gọn về hàm. |
parameters |
Không bắt buộc. Mô tả các tham số cho hàm này. Phản ánh Khóa chuỗi đối tượng tham số Open API 3.03: tên của tham số. Tên tham số có phân biệt chữ hoa chữ thường. Giá trị giản đồ: Giản đồ xác định loại dùng cho tham số. |
Lược đồ
Đối tượng Schema
cho phép định nghĩa các kiểu dữ liệu đầu vào và đầu ra. Các loại này có thể là đối tượng, cũng có thể là dữ liệu nguyên gốc và mảng. Đại diện cho một tập hợp con chọn lọc của đối tượng giản đồ OpenAPI 3.0.
Biểu diễn dưới dạng JSON |
---|
{ "type": enum ( |
Trường | |
---|---|
type |
Bắt buộc. Kiểu dữ liệu. |
format |
Không bắt buộc. Định dạng của dữ liệu. Dữ liệu này chỉ được dùng cho các loại dữ liệu gốc. Các định dạng được hỗ trợ: cho loại NUMBER: số thực, gấp đôi cho loại INTEGER: int32, int64 |
description |
Không bắt buộc. Nội dung mô tả ngắn gọn về tham số. Ví dụ về cách sử dụng. Nội dung mô tả tham số có thể được định dạng là Markdown. |
nullable |
Không bắt buộc. Cho biết liệu giá trị này có thể là rỗng hay không. |
enum[] |
Không bắt buộc. Các giá trị có thể có của phần tử Type.STRING có định dạng enum. Ví dụ: chúng ta có thể xác định một Hướng Enum là : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} |
properties |
Không bắt buộc. Thuộc tính của Type.OBJECT. Một đối tượng chứa danh sách các cặp |
required[] |
Không bắt buộc. Các thuộc tính bắt buộc của Type.OBJECT. |
items |
Không bắt buộc. Giản đồ các phần tử của Type.ARRAY. |
Loại
Loại chứa danh sách các loại dữ liệu OpenAPI như được xác định theo https://spec.openapis.org/oas/v3.0.3#data-types
Enum | |
---|---|
TYPE_UNSPECIFIED |
Không được chỉ định, không nên sử dụng. |
STRING |
Loại chuỗi. |
NUMBER |
Loại số. |
INTEGER |
Loại số nguyên. |
BOOLEAN |
Loại boolean. |
ARRAY |
Loại mảng. |
OBJECT |
Loại đối tượng. |
ToolConfig
Cấu hình Công cụ chứa các tham số để chỉ định cách sử dụng Tool
trong yêu cầu.
Biểu diễn dưới dạng JSON |
---|
{
"functionCallingConfig": {
object ( |
Trường | |
---|---|
functionCallingConfig |
Không bắt buộc. Cấu hình gọi hàm. |
FunctionCallingConfig
Cấu hình để chỉ định hành vi gọi hàm.
Biểu diễn dưới dạng JSON |
---|
{
"mode": enum ( |
Trường | |
---|---|
mode |
Không bắt buộc. Chỉ định chế độ thực thi lệnh gọi hàm. Nếu bạn không chỉ định, giá trị mặc định sẽ được đặt thành TỰ ĐỘNG. |
allowedFunctionNames[] |
Không bắt buộc. Một tập hợp tên hàm mà khi được cung cấp, sẽ giới hạn các hàm mà mô hình sẽ gọi. Bạn chỉ nên đặt thuộc tính này khi chế độ là BẤT KỲ. Tên hàm phải khớp với [FunctionDeclaration.name]. Khi chế độ được đặt thành BẤT KỲ, mô hình sẽ dự đoán lệnh gọi hàm từ tập hợp tên hàm được cung cấp. |
Chế độ
Xác định hành vi thực thi cho lệnh gọi hàm bằng cách xác định chế độ thực thi.
Enum | |
---|---|
MODE_UNSPECIFIED |
Chế độ gọi hàm không xác định. Không nên sử dụng giá trị này. |
AUTO |
Hành vi mặc định của mô hình, mô hình sẽ quyết định dự đoán lệnh gọi hàm hoặc phản hồi bằng ngôn ngữ tự nhiên. |
ANY |
Mô hình bị hạn chế để chỉ luôn dự đoán lệnh gọi hàm. Nếu bạn đặt " allowedFunctionNames", thì lệnh gọi hàm dự đoán sẽ bị giới hạn ở bất kỳ một trong số "". |
NONE |
Mô hình sẽ không dự đoán bất kỳ lệnh gọi hàm nào. Hành vi của mô hình cũng giống như khi không truyền bất kỳ nội dung khai báo hàm nào. |
UsageMetadata
Siêu dữ liệu về việc sử dụng nội dung được lưu vào bộ nhớ đệm.
Biểu diễn dưới dạng JSON |
---|
{ "totalTokenCount": integer } |
Trường | |
---|---|
totalTokenCount |
Tổng số mã thông báo mà nội dung được lưu vào bộ nhớ đệm sử dụng. |
Phương thức |
|
---|---|
|
Tạo tài nguyên Nội dung được lưu trong bộ nhớ đệm. |
|
Xoá tài nguyên Nội dung được lưu trong bộ nhớ đệm. |
|
Đọc tài nguyên Nội dung được lưu trong bộ nhớ đệm. |
|
Liệt kê Nội dung được lưu trong bộ nhớ đệm. |
|
Cập nhật tài nguyên Nội dung được lưu vào bộ nhớ đệm (chỉ có thể cập nhật khi hết hạn). |