列出快取內容¶
GET https://generativelanguage.googleapis.com/v1beta/cachedContents
列出 CachedContents。
參數¶
pageSize: integer
選填。要傳回的快取內容數量上限。服務傳回的數量可能少於此值。若未指定,將傳回某個預設(低於上限)數量的項目。最大值為 1000;超過 1000 的值將強制設為 1000。
pageToken: string
選填。頁面權杖,來自先前的 ListCachedContents 呼叫。提供此權杖以取得下一頁。分頁時,提供給 ListCachedContents 的所有其他參數都必須與提供該頁面權杖的呼叫相符。
範例請求
curl "https://generativelanguage.googleapis.com/v1beta/cachedContents?key=$GEMINI_API_KEY"
from google import genai
client = genai.Client(http_options={"api_version": "v1beta"})
document = client.files.upload(file=media / "a11.txt")
model_name = "gemini-3.8-flash"
cache = client.caches.create(
model=model_name,
config={
"contents": [document],
"system_instruction": "You are an expert analyzing transcripts.",
},
)
print("My caches:")
for c in client.caches.list():
print(" ", c.name)
// Make sure to include the following import:
// import {GoogleGenAI} from '@google/genai';
const ai = new GoogleGenAI({
apiKey: process.env.GEMINI_API_KEY,
apiVersion: 'v1beta',
});
const filePath = path.join(media, 'a11.txt');
const document = await ai.files.upload({
file: filePath,
config: {mimeType: 'text/plain'},
});
console.log('Uploaded file name:', document.name);
const modelName = 'gemini-3.8-flash';
const contents = [
createUserContent(createPartFromUri(document.uri, document.mimeType)),
];
// Create a cache for demonstration.
const cache = await ai.caches.create({
model: modelName,
config: {
contents: contents,
systemInstruction: 'You are an expert analyzing transcripts.',
},
});
console.log('My caches:');
const pager = await ai.caches.list({config: {pageSize: 10}});
let page = pager.page;
while (true) {
for (const c of page) {
console.log(' ', c.name);
}
if (!pager.hasNextPage()) break;
page = await pager.nextPage();
}
ctx := context.Background()
client, err := genai.NewClient(ctx, &genai.ClientConfig{
APIKey: os.Getenv("GEMINI_API_KEY"),
Backend: genai.BackendGeminiAPI,
HTTPOptions: genai.HTTPOptions{APIVersion: "v1beta"},
})
if err != nil {
log.Fatal(err)
}
// For demonstration, create a cache first.
modelName := "gemini-3.8-flash"
document, err := client.Files.UploadFromPath(
ctx,
filepath.Join(getMedia(), "a11.txt"),
&genai.UploadFileConfig{
MIMEType: "text/plain",
},
)
if err != nil {
log.Fatal(err)
}
parts := []*genai.Part{
genai.NewPartFromURI(document.URI, document.MIMEType),
}
contents := []*genai.Content{
genai.NewContentFromParts(parts, genai.RoleUser),
}
cache, err := client.Caches.Create(ctx, modelName, &genai.CreateCachedContentConfig{
Contents: contents,
SystemInstruction: genai.NewContentFromText(
"You are an expert analyzing transcripts.", genai.RoleUser,
),
})
if err != nil {
log.Fatal(err)
}
// List caches using the List method with a page size of 2.
page, err := client.Caches.List(ctx, &genai.ListCachedContentsConfig{PageSize: 2})
if err != nil {
log.Fatal(err)
}
pageIndex := 1
for {
fmt.Printf("Listing caches (page %d):\n", pageIndex)
for _, item := range page.Items {
fmt.Println(" ", item.Name)
}
if page.NextPageToken == "" {
break
}
page, err = page.Next(ctx)
if err == genai.ErrPageDone {
break
} else if err != nil {
return err
}
pageIndex++
}
回應¶
cachedContents: CachedContent array
快取內容清單。
nextPageToken: string
可作為 page_token 傳送以取得下一頁的權杖。若省略此欄位,表示沒有後續頁面。
資源¶
CachedContent¶
已經過預先處理、可在後續要求中 用於 GenerativeService 的內容。
快取內容只能用於其建立時所用的模型。
屬性:
model: required string
不可變更。快取內容要使用的 Model 名稱。格式:models/{model}
**expiration**:`Union type`,指定此資源何時到期。
聯集欄位 `expiration` 只能是下列其中一項: **expireTime**: `string` 以 UTC 表示的時間戳,代表此資源被視為到期的時間。此欄位在輸出時*一律*會提供,無論輸入時送了什麼。 **ttl**: `string` 僅供輸入。此資源的新 TTL,僅供輸入。name: string
僅供輸出。識別碼。指向快取內容的資源名稱。格式:cachedContents/{id}
displayName: string
選填。不可變更。由使用者產生、具意義的快取內容顯示名稱。最多 128 個 Unicode 字元。
**systemInstruction**:`Content`,選填。僅供輸入。不可變更。開發人員設定的系統指令。目前僅支援文字。
**parts**: `Part array` 構成單一訊息的有序 `Parts`。各 Part 的 MIME 類型可能不同。
**data**: `Union type`
聯合欄位 `data` 只能是下列其中之一: **text**: `string` 行內文字。**inlineData**: `Blob` 行內媒體位元組。
**mimeType**: `string` 來源資料的 IANA 標準 MIME 類型。支援的類型範例如下: - 圖片:image/png、image/jpeg、image/jpg、image/webp、image/heic、image/heif、image/gif、image/avif - 音訊:audio/*、video/audio/s16le、video/audio/wav - 影片:video/* - 文字:text/plain、text/html、text/css、text/javascript、text/x-typescript、text/csv、text/markdown、text/x-python、text/xml、text/rtf、video/text/timestamp - 應用程式:application/x-javascript、application/x-typescript、application/x-python-code、application/json、application/x-ipynb+json、application/rtf、application/pdf。更多背景資訊請參閱 [Supported file formats](/docs/file-input-methods/#supported-content-types)。 **data**: `string` 媒體格式的原始位元組。 **displayName**: `string` 選填。指定向模型提及這個 blob 時所用的名稱(例如「my_blob.png」)。當 `verbalization_mode` 設為 `REFERENCE_ONLY` 時,作為 blob 的參照識別碼使用。**functionCall**: `FunctionCall` 模型傳回的預測 `FunctionCall`,其中包含一個字串,表示 `FunctionDeclaration.name` 及其引數與引數值。
**name**: required `string` 要呼叫的函式名稱。必須由 a-z、A-Z、0-9 組成,或包含底線與連字號,長度上限為 128。 **id**: `string` 選填。函式呼叫的唯一識別碼。若有填入,用戶端會執行 `function_call`,並傳回帶有相符 `id` 的回應。 **args**: `object` 選填。以 JSON 物件格式表示的函式參數與值。**functionResponse**: `FunctionResponse` `FunctionCall` 的結果輸出,其中包含表示 `FunctionDeclaration.name` 的字串,以及含有函式任何輸出內容的結構化 JSON 物件,作為提供給模型的上下文。
**name**: required `string` 要呼叫的函式名稱。必須由 a-z、A-Z、0-9 組成,或包含底線與連字號,長度上限為 128。 **response**: required `object` 以 JSON 物件格式表示的函式回應。呼叫端可使用任何符合函式語法的自訂鍵來傳回函式輸出,例如「output」、「result」等。特別是當函式呼叫執行失敗時,回應可帶有「error」鍵,將錯誤詳情傳回給模型。多媒體內容可透過子物件納入,該子物件含有單一「$ref」鍵,其值為 `inline_data.display_name` 或 `file_data.display_name`,來自承載該多媒體內容的 `FunctionResponsePart`。請參閱 [Multimodal function responses](/docs/function-calling/#multimodal)。 **id**: `string` 選填。此回應所對應函式呼叫的識別碼。由用戶端填入,以對應相對應函式呼叫的 `id`。**parts**: `FunctionResponsePart array` 選填。構成函式回應的有序 `Parts`。各 Part 的 IANA MIME 類型可能不同。
**data**: `Union type` 函式回應 part 的資料。
聯合欄位 `data` 只能是下列其中之一:**inlineData**: `FunctionResponseBlob` 行內媒體位元組。
**mimeType**: `string` 來源資料的 IANA 標準 MIME 類型。範例: - image/png - image/jpeg 若提供不支援的 MIME 類型,將傳回錯誤。完整支援類型清單請參閱 [Supported file formats](/docs/file-input-methods/#supported-content-types)。 **data**: `string` 媒體格式的原始位元組。 **displayName**: `string` 選填。blob 的顯示名稱。用於提供標籤或檔名以區分各個 blob,並可從 `FunctionResponse.response` 參照該 blob(例如透過 `{"$ref": "DISPLAY_NAME"}`)。**fileData**: `FunctionResponseFileData` 以 URI 為基礎的資料。
**fileUri**: required `string` URI. **mimeType**: `string` 來源資料的 IANA 標準 MIME 類型。若提供不支援的 MIME 類型,將傳回錯誤。完整支援類型清單請參閱 [Multimodal function responses](/docs/function-calling/#multimodal) 與 [Supported file formats](/docs/file-input-methods/#supported-content-types)。 **displayName**: `string` 選填。檔案的顯示名稱。用於提供標籤或檔名以區分檔案資料,並可從 `FunctionResponse.response` 參照該檔案(例如透過 `{"$ref": "DISPLAY_NAME"}`)。**mediaProcessing**: `string enum` 選填。模型為理解內容而處理這個 part 媒體的方式。僅對影片 part(`inline_data` 或 MIME 為影片的 `file_data`)有意義,非影片 part 會忽略此欄位。
可能的值: - `MEDIA_PROCESSING_UNSPECIFIED`:預設採用模型專屬的處理方式。 - `STATIC`:以固定速率擷取影格,所有影格都放入上下文。 - `AGENTIC`:由模型驅動的動態導覽,建議用於大多數使用情境。**scheduling**: `string enum` 選填。指定回應在對話中的排程方式。僅適用於 NON_BLOCKING 函式呼叫,其他情況會忽略。預設為 WHEN_IDLE。
可能的值: - `SCHEDULING_UNSPECIFIED`:不使用此值。 - `SILENT`:僅將結果加入對話上下文,不中斷也不觸發產生。 - `WHEN_IDLE`:將結果加入對話上下文,並提示產生輸出,但不中斷進行中的產生。 - `INTERRUPT`:將結果加入對話上下文,中斷進行中的產生,並提示產生輸出。**fileData**: `FileData` 以 URI 為基礎的資料。
**fileUri**: required `string` URI. **mimeType**: `string` 選填。來源資料的 IANA 標準 MIME 類型。 **displayName**: `string` 選填。指定向模型提及這個檔案時所用的名稱(例如「my_file.pdf」)。當 `verbalization_mode` 設為 `REFERENCE_ONLY` 時,作為檔案的參照識別碼使用。**executableCode**: `ExecutableCode` 由模型產生、供執行的程式碼。
**language**: required `string enum` `code` 的程式語言。
可能的值: - `LANGUAGE_UNSPECIFIED`:未指定語言。不應使用此值。 - `PYTHON`:Python >= 3.10,可使用 numpy 與 simpy。Python 為預設語言。**codeExecutionResult**: `CodeExecutionResult` 執行 `ExecutableCode` 的結果。
**outcome**: required `string enum` 程式碼執行的結果。
可能的值: - `OUTCOME_UNSPECIFIED`:未指定的狀態。不應使用此值。 - `OUTCOME_OK`:程式碼執行成功完成。`output` 包含 stdout(若有)。 - `OUTCOME_FAILED`:程式碼執行失敗。`output` 包含 stderr 與 stdout(若有)。 - `OUTCOME_DEADLINE_EXCEEDED`:程式碼執行時間過長,已取消。可能有也可能沒有部分 `output`。**toolCall**: `ToolCall` 伺服器端工具呼叫。當模型預測有應在伺服器上執行的工具呼叫時,會填入此欄位。用戶端應將此訊息回傳給 API。
**toolType**: required `V1mainToolType` 被呼叫的工具類型。
可能的值: - `TOOL_TYPE_UNSPECIFIED`:未指定的工具類型。 - `GOOGLE_SEARCH_WEB`:Google 搜尋工具,對應 Tool.google_search.search_types.web_search。 - `GOOGLE_SEARCH_IMAGE`:圖片搜尋工具,對應 Tool.google_search.search_types.image_search。 - `URL_CONTEXT`:URL 上下文工具,對應 Tool.url_context。 - `GOOGLE_MAPS`:Google 地圖工具,對應 Tool.google_maps。 - `FILE_SEARCH`:檔案搜尋工具,對應 Tool.file_search。 - `MEDIA_PROCESSING`:媒體處理工具類型(例如影片、音訊等),對應多模態理解所用的隱形工具,如 GOOGLE_UNDERSTANDING_VIDEO。**toolResponse**: `ToolResponse` 伺服器端 `ToolCall` 執行的輸出。用戶端會以執行相對應 `ToolCall` 的結果填入此欄位。
**toolType**:必填 `V1mainToolType`,被呼叫的工具類型,與 `tool_type` 相符,該欄位位於相對應的 `ToolCall` 中。
可能的值: - `TOOL_TYPE_UNSPECIFIED`:未指定的工具類型。 - `GOOGLE_SEARCH_WEB`:Google 搜尋工具,對應 Tool.google_search.search_types.web_search。 - `GOOGLE_SEARCH_IMAGE`:圖片搜尋工具,對應 Tool.google_search.search_types.image_search。 - `URL_CONTEXT`:URL 上下文工具,對應 Tool.url_context。 - `GOOGLE_MAPS`:Google 地圖工具,對應 Tool.google_maps。 - `FILE_SEARCH`:檔案搜尋工具,對應 Tool.file_search。 - `MEDIA_PROCESSING`:媒體處理工具類型(例如影片、音訊等),對應多模態理解所用的隱形工具,如 GOOGLE_UNDERSTANDING_VIDEO。**metadata**: `Union type` 控制資料的額外前處理。當 `inline_data` 或 `file_data` 存在時設定此欄位,以設定每個 part 的靜態媒體前處理。
聯合欄位 `metadata` 只能是下列其中之一:**videoMetadata**: `VideoMetadata` 選填。影片中繼資料。僅在影片資料以 inline_data 或 file_data 呈現時,才應指定此中繼資料。
**startOffset**: `string` 選填。影片的起始位移。 **endOffset**: `string` 選填。影片的結束位移。 **fps**: `number` 選填。傳送給模型的影片影格率。若未指定,預設值為 1.0。fps 範圍為 (0.0, 24.0]。**mediaResolution**: `V1mainMediaResolution` 選填。輸入媒體的媒體解析度。
**value**: `Union type` 媒體解析度等級。
聯合欄位 `value` 只能是下列其中之一:**level**: `string enum` 用於指定媒體的權杖化品質,適用於 Gemini API 支援。
可能的值: - `MEDIA_RESOLUTION_UNSPECIFIED`:尚未設定媒體解析度。 - `MEDIA_RESOLUTION_LOW`:媒體解析度設為低。 - `MEDIA_RESOLUTION_MEDIUM`:媒體解析度設為中。 - `MEDIA_RESOLUTION_HIGH`:媒體解析度設為高。 - `MEDIA_RESOLUTION_ULTRA_HIGH`:媒體解析度設為超高。**mediaProcessing**: `string enum` 選填。模型為理解內容而處理這個 part 媒體的方式。僅對影片 part(`inline_data` 或 MIME 為影片的 `file_data`)有意義,非影片 part 會忽略此欄位。
可能的值: - `MEDIA_PROCESSING_UNSPECIFIED`:預設採用模型專屬的處理方式。 - `STATIC`:以固定速率擷取影格,所有影格都放入上下文。 - `AGENTIC`:由模型驅動的動態導覽,建議用於大多數使用情境。**audioTranscription**: `AudioTranscription` 選填。音訊(輸入或輸出)轉錄。僅當這個 Part 含有音訊資料時才會設定。
**text**: required `string` 這個音訊片段的轉錄文字。 **speakerLabel**: `string` 選填。標示這個音訊片段說話者的標籤(例如「spk_1」、「spk_2」)。設定語者分離時會出現。**words**: `WordInfo array` 選填。詳細的單字層級轉錄與時間詳情。設定 word_timestamp 時會出現。
**word**: required `string` 單字的轉錄。 **startOffset**: `string` 選填。單字相對於音訊開頭的起始時間位移。 **endOffset**: `string` 選填。單字相對於音訊開頭的結束時間位移。**speechMetadata**: `SpeechMetadata` 選填。套用於文字 part 的中繼資料,用來訂製朗讀或合成方式,例如指定說話者身分或說話風格。
**speaker**: `string` 選填。多說話者合成時可選填的說話者名稱。 **style**: `string` 選填。語音合成時可選填的風格指令。**contents**:`Content array`,選填。僅供輸入。不可變更。要快取的內容。
**parts**: `Part array` 構成單一訊息的有序 `Parts`。各 Part 的 MIME 類型可能不同。
**data**: `Union type`
聯合欄位 `data` 只能是下列其中之一: **text**: `string` 行內文字。**inlineData**: `Blob` 行內媒體位元組。
**mimeType**: `string` 來源資料的 IANA 標準 MIME 類型。支援的類型範例如下: - 圖片:image/png、image/jpeg、image/jpg、image/webp、image/heic、image/heif、image/gif、image/avif - 音訊:audio/*、video/audio/s16le、video/audio/wav - 影片:video/* - 文字:text/plain、text/html、text/css、text/javascript、text/x-typescript、text/csv、text/markdown、text/x-python、text/xml、text/rtf、video/text/timestamp - 應用程式:application/x-javascript、application/x-typescript、application/x-python-code、application/json、application/x-ipynb+json、application/rtf、application/pdf。更多背景資訊請參閱 [Supported file formats](/docs/file-input-methods/#supported-content-types)。 **data**: `string` 媒體格式的原始位元組。 **displayName**: `string` 選填。指定向模型提及這個 blob 時所用的名稱(例如「my_blob.png」)。當 `verbalization_mode` 設為 `REFERENCE_ONLY` 時,作為 blob 的參照識別碼使用。**functionCall**: `FunctionCall` 模型傳回的預測 `FunctionCall`,其中包含一個字串,表示 `FunctionDeclaration.name` 及其引數與引數值。
**name**: required `string` 要呼叫的函式名稱。必須由 a-z、A-Z、0-9 組成,或包含底線與連字號,長度上限為 128。 **id**: `string` 選填。函式呼叫的唯一識別碼。若有填入,用戶端會執行 `function_call`,並傳回帶有相符 `id` 的回應。 **args**: `object` 選填。以 JSON 物件格式表示的函式參數與值。**functionResponse**: `FunctionResponse` `FunctionCall` 的結果輸出,其中包含表示 `FunctionDeclaration.name` 的字串,以及含有函式任何輸出內容的結構化 JSON 物件,作為提供給模型的上下文。
**name**: required `string` 要呼叫的函式名稱。必須由 a-z、A-Z、0-9 組成,或包含底線與連字號,長度上限為 128。 **response**: required `object` 以 JSON 物件格式表示的函式回應。呼叫端可使用任何符合函式語法的自訂鍵來傳回函式輸出,例如「output」、「result」等。特別是當函式呼叫執行失敗時,回應可帶有「error」鍵,將錯誤詳情傳回給模型。多媒體內容可透過子物件納入,該子物件含有單一「$ref」鍵,其值為 `inline_data.display_name` 或 `file_data.display_name`,來自承載該多媒體內容的 `FunctionResponsePart`。請參閱 [Multimodal function responses](/docs/function-calling/#multimodal)。 **id**: `string` 選填。此回應所對應函式呼叫的識別碼。由用戶端填入,以對應相對應函式呼叫的 `id`。**parts**: `FunctionResponsePart array` 選填。構成函式回應的有序 `Parts`。各 Part 的 IANA MIME 類型可能不同。
**data**: `Union type` 函式回應 part 的資料。
聯合欄位 `data` 只能是下列其中之一:**inlineData**: `FunctionResponseBlob` 行內媒體位元組。
**mimeType**: `string` 來源資料的 IANA 標準 MIME 類型。範例: - image/png - image/jpeg 若提供不支援的 MIME 類型,將傳回錯誤。完整支援類型清單請參閱 [Supported file formats](/docs/file-input-methods/#supported-content-types)。 **data**: `string` 媒體格式的原始位元組。 **displayName**: `string` 選填。blob 的顯示名稱。用於提供標籤或檔名以區分各個 blob,並可從 `FunctionResponse.response` 參照該 blob(例如透過 `{"$ref": "DISPLAY_NAME"}`)。**fileData**: `FunctionResponseFileData` 以 URI 為基礎的資料。
**fileUri**: required `string` URI. **mimeType**: `string` 來源資料的 IANA 標準 MIME 類型。若提供不支援的 MIME 類型,將傳回錯誤。完整支援類型清單請參閱 [Multimodal function responses](/docs/function-calling/#multimodal) 與 [Supported file formats](/docs/file-input-methods/#supported-content-types)。 **displayName**: `string` 選填。檔案的顯示名稱。用於提供標籤或檔名以區分檔案資料,並可從 `FunctionResponse.response` 參照該檔案(例如透過 `{"$ref": "DISPLAY_NAME"}`)。**mediaProcessing**: `string enum` 選填。模型為理解內容而處理這個 part 媒體的方式。僅對影片 part(`inline_data` 或 MIME 為影片的 `file_data`)有意義,非影片 part 會忽略此欄位。
可能的值: - `MEDIA_PROCESSING_UNSPECIFIED`:預設採用模型專屬的處理方式。 - `STATIC`:以固定速率擷取影格,所有影格都放入上下文。 - `AGENTIC`:由模型驅動的動態導覽,建議用於大多數使用情境。**scheduling**: `string enum` 選填。指定回應在對話中的排程方式。僅適用於 NON_BLOCKING 函式呼叫,其他情況會忽略。預設為 WHEN_IDLE。
可能的值: - `SCHEDULING_UNSPECIFIED`:不使用此值。 - `SILENT`:僅將結果加入對話上下文,不中斷也不觸發產生。 - `WHEN_IDLE`:將結果加入對話上下文,並提示產生輸出,但不中斷進行中的產生。 - `INTERRUPT`:將結果加入對話上下文,中斷進行中的產生,並提示產生輸出。**fileData**: `FileData` 以 URI 為基礎的資料。
**fileUri**: required `string` URI. **mimeType**: `string` 選填。來源資料的 IANA 標準 MIME 類型。 **displayName**: `string` 選填。指定向模型提及這個檔案時所用的名稱(例如「my_file.pdf」)。當 `verbalization_mode` 設為 `REFERENCE_ONLY` 時,作為檔案的參照識別碼使用。**executableCode**: `ExecutableCode` 由模型產生、供執行的程式碼。
**language**: required `string enum` `code` 的程式語言。
可能的值: - `LANGUAGE_UNSPECIFIED`:未指定語言。不應使用此值。 - `PYTHON`:Python >= 3.10,可使用 numpy 與 simpy。Python 為預設語言。**codeExecutionResult**: `CodeExecutionResult` 執行 `ExecutableCode` 的結果。
**outcome**: required `string enum` 程式碼執行的結果。
可能的值: - `OUTCOME_UNSPECIFIED`:未指定的狀態。不應使用此值。 - `OUTCOME_OK`:程式碼執行成功完成。`output` 包含 stdout(若有)。 - `OUTCOME_FAILED`:程式碼執行失敗。`output` 包含 stderr 與 stdout(若有)。 - `OUTCOME_DEADLINE_EXCEEDED`:程式碼執行時間過長,已取消。可能有也可能沒有部分 `output`。**toolCall**: `ToolCall` 伺服器端工具呼叫。當模型預測有應在伺服器上執行的工具呼叫時,會填入此欄位。用戶端應將此訊息回傳給 API。
**toolType**: required `V1mainToolType` 被呼叫的工具類型。
可能的值: - `TOOL_TYPE_UNSPECIFIED`:未指定的工具類型。 - `GOOGLE_SEARCH_WEB`:Google 搜尋工具,對應 Tool.google_search.search_types.web_search。 - `GOOGLE_SEARCH_IMAGE`:圖片搜尋工具,對應 Tool.google_search.search_types.image_search。 - `URL_CONTEXT`:URL 上下文工具,對應 Tool.url_context。 - `GOOGLE_MAPS`:Google 地圖工具,對應 Tool.google_maps。 - `FILE_SEARCH`:檔案搜尋工具,對應 Tool.file_search。 - `MEDIA_PROCESSING`:媒體處理工具類型(例如影片、音訊等),對應多模態理解所用的隱形工具,如 GOOGLE_UNDERSTANDING_VIDEO。**toolResponse**: `ToolResponse` 伺服器端 `ToolCall` 執行的輸出。用戶端會以執行相對應 `ToolCall` 的結果填入此欄位。
**toolType**:必填 `V1mainToolType`,被呼叫的工具類型,與 `tool_type` 相符,該欄位位於相對應的 `ToolCall` 中。
可能的值: - `TOOL_TYPE_UNSPECIFIED`:未指定的工具類型。 - `GOOGLE_SEARCH_WEB`:Google 搜尋工具,對應 Tool.google_search.search_types.web_search。 - `GOOGLE_SEARCH_IMAGE`:圖片搜尋工具,對應 Tool.google_search.search_types.image_search。 - `URL_CONTEXT`:URL 上下文工具,對應 Tool.url_context。 - `GOOGLE_MAPS`:Google 地圖工具,對應 Tool.google_maps。 - `FILE_SEARCH`:檔案搜尋工具,對應 Tool.file_search。 - `MEDIA_PROCESSING`:媒體處理工具類型(例如影片、音訊等),對應多模態理解所用的隱形工具,如 GOOGLE_UNDERSTANDING_VIDEO。**metadata**: `Union type` 控制資料的額外前處理。當 `inline_data` 或 `file_data` 存在時設定此欄位,以設定每個 part 的靜態媒體前處理。
聯合欄位 `metadata` 只能是下列其中之一:**videoMetadata**: `VideoMetadata` 選填。影片中繼資料。僅在影片資料以 inline_data 或 file_data 呈現時,才應指定此中繼資料。
**startOffset**: `string` 選填。影片的起始位移。 **endOffset**: `string` 選填。影片的結束位移。 **fps**: `number` 選填。傳送給模型的影片影格率。若未指定,預設值為 1.0。fps 範圍為 (0.0, 24.0]。**mediaResolution**: `V1mainMediaResolution` 選填。輸入媒體的媒體解析度。
**value**: `Union type` 媒體解析度等級。
聯合欄位 `value` 只能是下列其中之一:**level**: `string enum` 用於指定媒體的權杖化品質,適用於 Gemini API 支援。
可能的值: - `MEDIA_RESOLUTION_UNSPECIFIED`:尚未設定媒體解析度。 - `MEDIA_RESOLUTION_LOW`:媒體解析度設為低。 - `MEDIA_RESOLUTION_MEDIUM`:媒體解析度設為中。 - `MEDIA_RESOLUTION_HIGH`:媒體解析度設為高。 - `MEDIA_RESOLUTION_ULTRA_HIGH`:媒體解析度設為超高。**mediaProcessing**: `string enum` 選填。模型為理解內容而處理這個 part 媒體的方式。僅對影片 part(`inline_data` 或 MIME 為影片的 `file_data`)有意義,非影片 part 會忽略此欄位。
可能的值: - `MEDIA_PROCESSING_UNSPECIFIED`:預設採用模型專屬的處理方式。 - `STATIC`:以固定速率擷取影格,所有影格都放入上下文。 - `AGENTIC`:由模型驅動的動態導覽,建議用於大多數使用情境。**audioTranscription**: `AudioTranscription` 選填。音訊(輸入或輸出)轉錄。僅當這個 Part 含有音訊資料時才會設定。
**text**: required `string` 這個音訊片段的轉錄文字。 **speakerLabel**: `string` 選填。標示這個音訊片段說話者的標籤(例如「spk_1」、「spk_2」)。設定語者分離時會出現。**words**: `WordInfo array` 選填。詳細的單字層級轉錄與時間詳情。設定 word_timestamp 時會出現。
**word**: required `string` 單字的轉錄。 **startOffset**: `string` 選填。單字相對於音訊開頭的起始時間位移。 **endOffset**: `string` 選填。單字相對於音訊開頭的結束時間位移。**speechMetadata**: `SpeechMetadata` 選填。套用於文字 part 的中繼資料,用來訂製朗讀或合成方式,例如指定說話者身分或說話風格。
**speaker**: `string` 選填。多說話者合成時可選填的說話者名稱。 **style**: `string` 選填。語音合成時可選填的風格指令。**tools**:`Tool array`,選填。僅供輸入。不可變更。模型可用來產生下一個回應的 `Tools` 清單
**functionDeclarations**:`FunctionDeclaration array`,選填。模型可用的 `FunctionDeclarations` 清單,可用於函式呼叫。模型或系統不會執行該函式,而是將定義好的函式以帶有引數的 FunctionCall 形式傳回用戶端執行。模型可決定呼叫這些函式的子集,方式是在回應中填入 FunctionCall。下一個對話回合可包含 FunctionResponse,作為下一個模型回合的 Content.role「function」產生背景資訊。
**name**: required `string` 函式的名稱。必須為 a-z、A-Z、0-9,或包含底線、冒號、句點與破折號,長度上限為 128。 **description**: required `string` 函式的簡要說明。**parameters**:`Schema`,選填。說明此函式的參數。反映 Open API 3.03 Parameter Object:字串 Key 為參數的名稱,參數名稱區分大小寫;Schema Value 為定義該參數所用類型的 Schema。
**type**:必填 `Type`,資料類型。
可能的值: - `TYPE_UNSPECIFIED`:未指定,不應使用。 - `STRING`:字串類型。 - `NUMBER`:數字類型。 - `INTEGER`:整數類型。 - `BOOLEAN`:布林類型。 - `ARRAY`:陣列類型。 - `OBJECT`:物件類型。 - `NULL`:Null 類型。**response**:`Schema`,選填。以 JSON Schema 格式說明此函式的輸出。反映 Open API 3.03 Response Object。該 Schema 定義函式回應值所用的類型。
**type**:必填 `Type`,資料類型。
可能的值: - `TYPE_UNSPECIFIED`:未指定,不應使用。 - `STRING`:字串類型。 - `NUMBER`:數字類型。 - `INTEGER`:整數類型。 - `BOOLEAN`:布林類型。 - `ARRAY`:陣列類型。 - `OBJECT`:物件類型。 - `NULL`:Null 類型。**behavior**:`string enum`,選填。指定函式的行為。目前僅 BidiGenerateContent 方法支援。
可能的值: - `UNSPECIFIED`:此值未使用。 - `BLOCKING`:若設定,系統會等待收到函式回應後才繼續對話。 - `NON_BLOCKING`:若設定,系統不會等待收到函式回應,而是會在函式回應陸續可用時嘗試處理,同時維持使用者與模型之間的對話。**googleSearchRetrieval**:`GoogleSearchRetrieval`,選填。由 Google 搜尋提供支援的檢索工具。
**dynamicRetrievalConfig**:`DynamicRetrievalConfig`,指定給定來源的動態檢索設定。
**mode**:`string enum`,動態檢索要使用的預測器模式。
可能的值: - `MODE_UNSPECIFIED`:一律觸發檢索。 - `MODE_DYNAMIC`:僅在系統判斷有必要時才執行檢索。**codeExecution**:`CodeExecution`,選填。讓模型能在產生過程中執行程式碼。
**googleSearch**:`GoogleSearch`,選填。GoogleSearch 工具類型。支援模型使用 Google 搜尋的工具。由 Google 提供支援。
**timeRangeFilter**:`Interval`,選填。將搜尋結果篩選至特定時間範圍。若客戶設定了開始時間,就必須設定結束時間(反之亦然)。
**startTime**: `string` 選填。區間的起始時間(含)。若有指定,符合此區間的時間戳必須等於或晚於起始時間。 **endTime**: `string` 選填。區間的結束時間(不含)。若有指定,符合此區間的時間戳必須早於結束時間。**searchTypes**:`SearchTypes`,選填。要啟用的搜尋類型集合。若未設定,預設啟用網路搜尋。
**webSearch**:`WebSearch`,選填。啟用網路搜尋。僅傳回文字結果。
**imageSearch**:`ImageSearch`,選填。啟用圖片搜尋。傳回圖片位元組。
**computerUse**:`ComputerUse`,選填。支援模型直接與電腦互動的工具。若啟用,會自動填入電腦使用專屬的 Function Declarations。
**environment**:必填 `string enum`,所操作的環境。
可能的值: - `ENVIRONMENT_UNSPECIFIED`:預設為瀏覽器。 - `ENVIRONMENT_BROWSER`:在網路瀏覽器中操作。 - `ENVIRONMENT_MOBILE`:在行動環境中操作。 - `ENVIRONMENT_DESKTOP`:在桌面環境中操作。**disabledSafetyPolicies**:`string enum array`,選填。電腦使用已停用的安全政策。
可能的值: - `SAFETY_POLICY_UNSPECIFIED`:未指定的安全政策。 - `FINANCIAL_TRANSACTIONS`:金融交易的安全政策。 - `SENSITIVE_DATA_MODIFICATION`:敏感資料修改的安全政策。 - `COMMUNICATION_TOOL`:通訊工具(例如 Gmail、Chat、Meet)的安全政策。 - `ACCOUNT_CREATION`:建立帳號的安全政策。 - `DATA_MODIFICATION`:資料修改的安全政策。 - `USER_CONSENT_MANAGEMENT`:使用者同意管理的安全政策。 - `LEGAL_TERMS_AND_AGREEMENTS`:法律條款與協議的安全政策。**urlContext**:`UrlContext`,選填。支援 URL 背景資訊檢索的工具。
**fileSearch**:`FileSearch`,選填。FileSearch 工具類型。用來從 Semantic Retrieval 語料庫檢索知識的工具。
**fileSearchStoreNames**: required `string array` 要從中檢索的 file_search_stores 名稱。範例:`fileSearchStores/my-file-search-store-123` **topK**: `integer` 選填。要檢索的語意檢索區塊數量。 **metadataFilter**: `string` 選填。要套用到語意檢索文件與區塊的中繼資料篩選條件。**mcpServers**:`McpServer array`,選填。要連線的 MCP Servers。
**transport**:`Union type`,用來連線至 MCPServer 的傳輸方式。
聯集欄位 `transport` 只能是下列其中一項:**streamableHttpTransport**:`StreamableHttpTransport`,可串流 HTTP 要求與回應的傳輸方式。
**url**: `string` MCPServer 端點的完整 URL。範例:"https://api.example.com/mcp" **headers**: `object` 選填:如有需要,提供驗證標頭、逾時等欄位。 **timeout**: `string` 一般操作的 HTTP 逾時。 **sseReadTimeout**: `string` SSE 讀取操作的逾時。 **terminateOnClose**: `boolean` 當傳輸關閉時,是否關閉用戶端工作階段。**googleMaps**:`GoogleMaps`,選填。讓模型回應能以與使用者查詢相關的地理空間背景資訊接地的工具。
**enableWidget**: `boolean` 選填。是否在回應的 GroundingMetadata 中傳回 widget 背景資訊權杖。開發人員可使用 widget 背景資訊權杖,呈現 Google Maps widget,其中包含與模型在回應中提及地點相關的地理空間背景資訊。**toolConfig**:`ToolConfig`,選填。僅供輸入。不可變更。工具設定。此設定由所有工具共用。
**functionCallingConfig**:`FunctionCallingConfig`,選填。函式呼叫設定。
**mode**:`string enum`,選填。指定函式呼叫的執行模式。若未指定,預設值將設為 AUTO。
可能的值: - `MODE_UNSPECIFIED`:未指定的函式呼叫模式。不應使用此值。 - `AUTO`:模型預設行為,由模型決定要預測函式呼叫或自然語言回應。 - `ANY`:模型受限於一律只預測函式呼叫。若已設定「allowed_function_names」,預測的函式呼叫將限於「allowed_function_names」其中之一;否則將為所提供「function_declarations」其中之一。 - `NONE`:模型不會預測任何函式呼叫。模型行為與未傳入任何函式宣告時相同。 - `VALIDATED`:由模型決定預測函式呼叫或自然語言回應,但會以受限解碼驗證函式呼叫。若已設定「allowed_function_names」,預測的函式呼叫將限於「allowed_function_names」其中之一;否則將為所提供「function_declarations」其中之一。**retrievalConfig**:`RetrievalConfig`,選填。檢索設定。
**latLng**:`LatLng`,選填。使用者的位置。
**latitude**: `number` 以度為單位的緯度。必須介於 [-90.0, +90.0] 範圍內。 **longitude**: `number` 以度為單位的經度。必須介於 [-180.0, +180.0] 範圍內。createTime: string
僅供輸出。快取項目的建立時間。
updateTime: string
僅供輸出。快取項目上次更新的 UTC 時間。