跳轉到

更新快取內容

PATCH https://generativelanguage.googleapis.com/v1beta/cachedContents/{id}

更新 CachedContent 資源(僅到期時間可更新)。

參數

id: required string

快取內容 ID。構成資源名稱 cachedContents/{id}。


updateMask: string

要更新的欄位清單。

請求主體

model: required string

不可變。用於快取內容的 Model 名稱。格式:models/{model}


**expiration**: `Union type` 指定此資源何時到期。 聯合欄位 `expiration` 只能為下列其中之一: **expireTime**: `string` 此資源被視為到期時的 UTC 時間戳記。無論輸入時傳送了什麼,輸出時*一律*會提供此值。 **ttl**: `string` 僅供輸入。此資源的新 TTL,僅供輸入。

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 如需更多背景資訊,請參閱[支援的檔案格式](/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` 的顯示名稱。請參閱[多模態函式回應](/docs/function-calling/#multimodal)。 **id**: `string` 選用。此回應所對應函式呼叫的識別碼。由用戶端填入,以對應相對應的函式呼叫 `id`。
**parts**: `FunctionResponsePart array` 選用。構成函式回應的已排序 `Parts`。各 Part 的 IANA MIME 類型可能不同。
**data**: `Union type` 函式回應部分的資料。 聯合欄位 `data` 只能為下列其中之一:
**inlineData**: `FunctionResponseBlob` 內嵌媒體位元組。 **mimeType**: `string` 來源資料的 IANA 標準 MIME 類型。範例: - image/png - image/jpeg 若提供不支援的 MIME 類型,將傳回錯誤。完整支援類型清單請參閱[支援的檔案格式](/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 類型,將傳回錯誤。完整支援類型清單請參閱[多模態函式回應](/docs/function-calling/#multimodal)與[支援的檔案格式](/docs/file-input-methods/#supported-content-types)。 **displayName**: `string` 選用。檔案的顯示名稱。用於提供標籤或檔名以區分檔案資料,並可從 `FunctionResponse.response` 參照該檔案(例如透過 `{"$ref": "DISPLAY_NAME"}`)。
**mediaProcessing**: `string enum` 選用。模型如何處理此部分的媒體以進行理解。僅對影片部分(具影片 MIME 的 `inline_data` 或 `file_data`)有意義。非影片部分會忽略此欄位。 可能的值: - `MEDIA_PROCESSING_UNSPECIFIED`:預設為模型專屬的處理方式。 - `STATIC`:固定速率影格擷取。所有影格都放入上下文。 - `AGENTIC`:由模型驅動的動態導覽。建議用於大多數使用情境。
**willContinue**: `boolean` 選用。表示函式呼叫將繼續,且會傳回更多回應,使函式呼叫成為產生器。僅適用於 NON_BLOCKING 函式呼叫,否則會被忽略。若設為 false,後續回應將不予考慮。允許傳回空的 `response` 並搭配 `will_continue=False`,以表示函式呼叫已完成。這仍可能觸發模型產生。若要避免觸發產生並結束函式呼叫,請另外將 `scheduling` 設為 `SILENT`。
**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 為預設語言。
**code**: required `string` 要執行的程式碼。 **id**: `string` 選用。`ExecutableCode` 部分的唯一識別碼。伺服器會傳回 `CodeExecutionResult`,其 `id` 與之相符。
**codeExecutionResult**: `CodeExecutionResult` 執行 `ExecutableCode` 的結果。
**outcome**: required `string enum` 程式碼執行的結果。 可能的值: - `OUTCOME_UNSPECIFIED`:未指定的狀態。不應使用此值。 - `OUTCOME_OK`:程式碼執行成功完成。`output` 包含 stdout(若有)。 - `OUTCOME_FAILED`:程式碼執行失敗。`output` 包含 stderr 與 stdout(若有)。 - `OUTCOME_DEADLINE_EXCEEDED`:程式碼執行時間過長,已取消。可能有、也可能沒有部分 `output`。
**id**: `string` 選用。此結果所對應 `ExecutableCode` 部分的識別碼。僅在相對應的 `ExecutableCode` 具有 id 時才會填入。 **output**: `string` 選用。程式碼執行成功時包含 stdout,否則包含 stderr 或其他說明。
**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。
**id**: `string` 選用。工具呼叫的唯一識別碼。伺服器會傳回帶有相符 `id` 的工具回應。 **toolName**: `string` 選用。被呼叫工具的名稱。 **args**: `object` 選用。工具呼叫引數。範例:{"arg1" : "value1", "arg2" : "value2" , ...}
**toolResponse**: `ToolResponse` 伺服器端 `ToolCall` 執行的輸出。用戶端會將執行相對應 `ToolCall` 的結果填入此欄位。
**toolType**: required `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。
**id**: `string` 選用。此回應所對應工具呼叫的識別碼。 **response**: `object` 選用。工具回應。
**metadata**: `Union type` 控制資料的額外前置處理。當 `inline_data` 或 `file_data` 存在時設定此欄位,以設定各部分的靜態媒體前置處理。 聯合欄位 `metadata` 只能為下列其中之一:
**videoMetadata**: `VideoMetadata` 選用。影片中繼資料。僅當影片資料以 inline_data 或 file_data 形式呈現時,才應指定此中繼資料。 **startOffset**: `string` 選用。影片的開始偏移。 **endOffset**: `string` 選用。影片的結束偏移。 **fps**: `number` 選用。傳送給模型的影片影格速率。若未指定,預設值為 1.0。fps 範圍為 (0.0, 24.0]。
**thought**: `boolean` 選用。表示此部分是否為模型的思考內容。 **thoughtSignature**: `string` 選用。思考內容的不透明簽章,可在後續請求中重複使用。 **partMetadata**: `object` 與 Part 相關聯的自訂中繼資料。使用 genai.Part 作為內容表示的代理,可能需要追蹤額外資訊。例如,Part 來源檔案/來源的名稱,或多工處理多個 Part 串流的方法。
**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` 選用。模型如何處理此部分的媒體以進行理解。僅對影片部分(具影片 MIME 的 `inline_data` 或 `file_data`)有意義。非影片部分會忽略此欄位。 可能的值: - `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` 選用。套用至文字部分的中繼資料,用來客製化朗讀或合成方式,例如指定說話者身分或說話風格。 **speaker**: `string` 選用。多說話者合成的說話者名稱。 **style**: `string` 選用。語音合成的風格指令。
**role**: `string` 選用。內容的產生者。必須為 'user' 或 'model' 其中之一。適合在多輪對話中設定,否則可留空或不設定。

**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 如需更多背景資訊,請參閱[支援的檔案格式](/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` 的顯示名稱。請參閱[多模態函式回應](/docs/function-calling/#multimodal)。 **id**: `string` 選用。此回應所對應函式呼叫的識別碼。由用戶端填入,以對應相對應的函式呼叫 `id`。
**parts**: `FunctionResponsePart array` 選用。構成函式回應的已排序 `Parts`。各 Part 的 IANA MIME 類型可能不同。
**data**: `Union type` 函式回應部分的資料。 聯合欄位 `data` 只能為下列其中之一:
**inlineData**: `FunctionResponseBlob` 內嵌媒體位元組。 **mimeType**: `string` 來源資料的 IANA 標準 MIME 類型。範例: - image/png - image/jpeg 若提供不支援的 MIME 類型,將傳回錯誤。完整支援類型清單請參閱[支援的檔案格式](/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 類型,將傳回錯誤。完整支援類型清單請參閱[多模態函式回應](/docs/function-calling/#multimodal)與[支援的檔案格式](/docs/file-input-methods/#supported-content-types)。 **displayName**: `string` 選用。檔案的顯示名稱。用於提供標籤或檔名以區分檔案資料,並可從 `FunctionResponse.response` 參照該檔案(例如透過 `{"$ref": "DISPLAY_NAME"}`)。
**mediaProcessing**: `string enum` 選用。模型如何處理此部分的媒體以進行理解。僅對影片部分(具影片 MIME 的 `inline_data` 或 `file_data`)有意義。非影片部分會忽略此欄位。 可能的值: - `MEDIA_PROCESSING_UNSPECIFIED`:預設為模型專屬的處理方式。 - `STATIC`:固定速率影格擷取。所有影格都放入上下文。 - `AGENTIC`:由模型驅動的動態導覽。建議用於大多數使用情境。
**willContinue**: `boolean` 選用。表示函式呼叫將繼續,且會傳回更多回應,使函式呼叫成為產生器。僅適用於 NON_BLOCKING 函式呼叫,否則會被忽略。若設為 false,後續回應將不予考慮。允許傳回空的 `response` 並搭配 `will_continue=False`,以表示函式呼叫已完成。這仍可能觸發模型產生。若要避免觸發產生並結束函式呼叫,請另外將 `scheduling` 設為 `SILENT`。
**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 為預設語言。
**code**: required `string` 要執行的程式碼。 **id**: `string` 選用。`ExecutableCode` 部分的唯一識別碼。伺服器會傳回 `CodeExecutionResult`,其 `id` 與之相符。
**codeExecutionResult**: `CodeExecutionResult` 執行 `ExecutableCode` 的結果。
**outcome**: required `string enum` 程式碼執行的結果。 可能的值: - `OUTCOME_UNSPECIFIED`:未指定的狀態。不應使用此值。 - `OUTCOME_OK`:程式碼執行成功完成。`output` 包含 stdout(若有)。 - `OUTCOME_FAILED`:程式碼執行失敗。`output` 包含 stderr 與 stdout(若有)。 - `OUTCOME_DEADLINE_EXCEEDED`:程式碼執行時間過長,已取消。可能有、也可能沒有部分 `output`。
**id**: `string` 選用。此結果所對應 `ExecutableCode` 部分的識別碼。僅在相對應的 `ExecutableCode` 具有 id 時才會填入。 **output**: `string` 選用。程式碼執行成功時包含 stdout,否則包含 stderr 或其他說明。
**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。
**id**: `string` 選用。工具呼叫的唯一識別碼。伺服器會傳回帶有相符 `id` 的工具回應。 **toolName**: `string` 選用。被呼叫工具的名稱。 **args**: `object` 選用。工具呼叫引數。範例:{"arg1" : "value1", "arg2" : "value2" , ...}
**toolResponse**: `ToolResponse` 伺服器端 `ToolCall` 執行的輸出。用戶端會將執行相對應 `ToolCall` 的結果填入此欄位。
**toolType**: required `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。
**id**: `string` 選用。此回應所對應工具呼叫的識別碼。 **response**: `object` 選用。工具回應。
**metadata**: `Union type` 控制資料的額外前置處理。當 `inline_data` 或 `file_data` 存在時設定此欄位,以設定各部分的靜態媒體前置處理。 聯合欄位 `metadata` 只能為下列其中之一:
**videoMetadata**: `VideoMetadata` 選用。影片中繼資料。僅當影片資料以 inline_data 或 file_data 形式呈現時,才應指定此中繼資料。 **startOffset**: `string` 選用。影片的開始偏移。 **endOffset**: `string` 選用。影片的結束偏移。 **fps**: `number` 選用。傳送給模型的影片影格速率。若未指定,預設值為 1.0。fps 範圍為 (0.0, 24.0]。
**thought**: `boolean` 選用。表示此部分是否為模型的思考內容。 **thoughtSignature**: `string` 選用。思考內容的不透明簽章,可在後續請求中重複使用。 **partMetadata**: `object` 與 Part 相關聯的自訂中繼資料。使用 genai.Part 作為內容表示的代理,可能需要追蹤額外資訊。例如,Part 來源檔案/來源的名稱,或多工處理多個 Part 串流的方法。
**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` 選用。模型如何處理此部分的媒體以進行理解。僅對影片部分(具影片 MIME 的 `inline_data` 或 `file_data`)有意義。非影片部分會忽略此欄位。 可能的值: - `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` 選用。套用至文字部分的中繼資料,用來客製化朗讀或合成方式,例如指定說話者身分或說話風格。 **speaker**: `string` 選用。多說話者合成的說話者名稱。 **style**: `string` 選用。語音合成的風格指令。
**role**: `string` 選用。內容的產生者。必須為 'user' 或 'model' 其中之一。適合在多輪對話中設定,否則可留空或不設定。

**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**: required `Type` 資料類型。 可能的值: - `TYPE_UNSPECIFIED`:未指定,不應使用。 - `STRING`:字串類型。 - `NUMBER`:數字類型。 - `INTEGER`:整數類型。 - `BOOLEAN`:布林類型。 - `ARRAY`:陣列類型。 - `OBJECT`:物件類型。 - `NULL`:Null 類型。
**format**: `string` 選用。資料的格式。允許任何值,但大多數值不會觸發任何特殊功能。 **title**: `string` 選用。結構描述的標題。 **description**: `string` 選用。參數的簡要說明。可包含使用範例。參數說明可使用 Markdown 格式。 **nullable**: `boolean` 選用。表示該值是否可為 null。 **enum**: `string array` 選用。Type.STRING 元素在 enum 格式下的可能值。例如,可將 Enum Direction 定義為:{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} **items**: `Schema` 選用。Type.ARRAY 元素的結構描述。 **maxItems**: `string` 選用。Type.ARRAY 元素的數量上限。 **minItems**: `string` 選用。Type.ARRAY 元素的數量下限。 **properties**: `object` 選用。Type.OBJECT 的屬性。 **required**: `string array` 選用。Type.OBJECT 的必要屬性。 **minProperties**: `string` 選用。Type.OBJECT 屬性的數量下限。 **maxProperties**: `string` 選用。Type.OBJECT 屬性的數量上限。 **minimum**: `number` 選用。TYPE INTEGER 與 NUMBER 的結構描述欄位:Type.INTEGER 與 Type.NUMBER 的最小值 **maximum**: `number` 選用。Type.INTEGER 與 Type.NUMBER 的最大值 **minLength**: `string` 選用。TYPE STRING 的結構描述欄位:Type.STRING 的最小長度 **maxLength**: `string` 選用。Type.STRING 的最大長度 **pattern**: `string` 選用。Type.STRING 的模式,用正規表示式限制字串。 **example**: `object` 選用。物件的範例。僅當物件為根物件時才會填入。 **anyOf**: `Schema array` 選用。該值應對照清單中的任一(一個或多個)子結構描述進行驗證。 **propertyOrdering**: `string array` 選用。屬性的順序。並非 Open API 規格的標準欄位。用來決定回應中屬性的順序。 **default**: `object` 選用。欄位的預設值。依 JSON Schema,此欄位旨在供文件產生器使用,不影響驗證。因此在此納入並忽略,使傳送帶有 `default` 欄位的結構描述的開發人員不會收到未知欄位錯誤。
**parametersJsonSchema**: `object` 選用。以 JSON Schema 格式說明函式的參數。結構描述必須描述一個物件,其屬性即為函式的參數。例如:`{ "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] }` 此欄位與 `parameters` 互斥。
**response**: `Schema` 選用。以 JSON Schema 格式說明此函式的輸出。反映 Open API 3.03 Response Object。結構描述定義了函式回應值所用的類型。
**type**: required `Type` 資料類型。 可能的值: - `TYPE_UNSPECIFIED`:未指定,不應使用。 - `STRING`:字串類型。 - `NUMBER`:數字類型。 - `INTEGER`:整數類型。 - `BOOLEAN`:布林類型。 - `ARRAY`:陣列類型。 - `OBJECT`:物件類型。 - `NULL`:Null 類型。
**format**: `string` 選用。資料的格式。允許任何值,但大多數值不會觸發任何特殊功能。 **title**: `string` 選用。結構描述的標題。 **description**: `string` 選用。參數的簡要說明。可包含使用範例。參數說明可使用 Markdown 格式。 **nullable**: `boolean` 選用。表示該值是否可為 null。 **enum**: `string array` 選用。Type.STRING 元素在 enum 格式下的可能值。例如,可將 Enum Direction 定義為:{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} **items**: `Schema` 選用。Type.ARRAY 元素的結構描述。 **maxItems**: `string` 選用。Type.ARRAY 元素的數量上限。 **minItems**: `string` 選用。Type.ARRAY 元素的數量下限。 **properties**: `object` 選用。Type.OBJECT 的屬性。 **required**: `string array` 選用。Type.OBJECT 的必要屬性。 **minProperties**: `string` 選用。Type.OBJECT 屬性的數量下限。 **maxProperties**: `string` 選用。Type.OBJECT 屬性的數量上限。 **minimum**: `number` 選用。TYPE INTEGER 與 NUMBER 的結構描述欄位:Type.INTEGER 與 Type.NUMBER 的最小值 **maximum**: `number` 選用。Type.INTEGER 與 Type.NUMBER 的最大值 **minLength**: `string` 選用。TYPE STRING 的結構描述欄位:Type.STRING 的最小長度 **maxLength**: `string` 選用。Type.STRING 的最大長度 **pattern**: `string` 選用。Type.STRING 的模式,用正規表示式限制字串。 **example**: `object` 選用。物件的範例。僅當物件為根物件時才會填入。 **anyOf**: `Schema array` 選用。該值應對照清單中的任一(一個或多個)子結構描述進行驗證。 **propertyOrdering**: `string array` 選用。屬性的順序。並非 Open API 規格的標準欄位。用來決定回應中屬性的順序。 **default**: `object` 選用。欄位的預設值。依 JSON Schema,此欄位旨在供文件產生器使用,不影響驗證。因此在此納入並忽略,使傳送帶有 `default` 欄位的結構描述的開發人員不會收到未知欄位錯誤。
**responseJsonSchema**: `object` 選用。以 JSON Schema 格式說明此函式的輸出。結構描述所指定的值即為函式的回應值。此欄位與 `response` 互斥。
**behavior**: `string enum` 選用。指定函式的 Behavior。目前僅 BidiGenerateContent 方法支援。 可能的值: - `UNSPECIFIED`:此值未使用。 - `BLOCKING`:若設定,系統會等待收到函式回應後才繼續對話。 - `NON_BLOCKING`:若設定,系統不會等待收到函式回應。相反地,系統會在維持使用者與模型對話的同時,嘗試在函式回應可用時加以處理。
**googleSearchRetrieval**: `GoogleSearchRetrieval` 選用。由 Google 搜尋提供支援的擷取工具。
**dynamicRetrievalConfig**: `DynamicRetrievalConfig` 指定該來源的動態擷取設定。
**mode**: `string enum` 動態擷取所用預測器的模式。 可能的值: - `MODE_UNSPECIFIED`:一律觸發擷取。 - `MODE_DYNAMIC`:僅在系統判定有必要時才執行擷取。
**dynamicThreshold**: `number` 動態擷取所用的閾值。若未設定,將使用系統預設值。
**codeExecution**: `CodeExecution` 選用。讓模型能在產生過程中執行程式碼。
**googleSearch**: `GoogleSearch` 選用。GoogleSearch 工具類型。支援模型中使用 Google Search 的工具。由 Google 提供支援。
**timeRangeFilter**: `Interval` 選用。將搜尋結果篩選至特定時間範圍。若客戶設定了開始時間,就必須設定結束時間(反之亦然)。 **startTime**: `string` 選用。區間的起始點(含)。若有指定,符合此區間的 Timestamp 必須等於或晚於起始點。 **endTime**: `string` 選用。區間的結束點(不含)。若有指定,符合此區間的 Timestamp 必須早於結束點。
**searchTypes**: `SearchTypes` 選用。要啟用的搜尋類型集合。若未設定,預設啟用網頁搜尋。
**webSearch**: `WebSearch` 選用。啟用網頁搜尋。僅傳回文字結果。
**imageSearch**: `ImageSearch` 選用。啟用圖片搜尋。會傳回圖片位元組。
**computerUse**: `ComputerUse` 選用。支援模型直接與電腦互動的工具。若啟用,會自動填入電腦使用專屬的 Function Declarations。
**environment**: required `string enum` 所操作的環境。 可能的值: - `ENVIRONMENT_UNSPECIFIED`:預設為瀏覽器。 - `ENVIRONMENT_BROWSER`:在網頁瀏覽器中操作。 - `ENVIRONMENT_MOBILE`:在行動環境中操作。 - `ENVIRONMENT_DESKTOP`:在桌面環境中操作。
**excludedPredefinedFunctions**: `string array` 選用。預設情況下,預先定義的函式會納入最終的模型呼叫。其中部分函式可明確排除,不自動納入。這有兩個目的:1. 使用更受限/不同的動作空間。2. 改進預先定義函式的定義/指令。 **enablePromptInjectionDetection**: `boolean` 選用。是否對電腦使用請求啟用提示詞注入偵測檢查。
**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` 傳輸關閉時是否關閉用戶端工作階段。
**name**: `string` MCPServer 的名稱。
**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" 中的任一項。
**allowedFunctionNames**: `string array` 選用。一組函式名稱,提供時會限制模型可呼叫的函式。僅當 Mode 為 ANY 或 VALIDATED 時才應設定。函式名稱應與 [FunctionDeclaration.name] 相符。設定後,模型僅會從允許的函式名稱中預測函式呼叫。
**retrievalConfig**: `RetrievalConfig` 選用。擷取設定。
**latLng**: `LatLng` 選用。使用者的位置。 **latitude**: `number` 以度為單位的緯度。必須介於 [-90.0, +90.0] 範圍內。 **longitude**: `number` 以度為單位的經度。必須介於 [-180.0, +180.0] 範圍內。
**languageCode**: `string` 選用。使用者的語言代碼。內容的語言代碼。使用 [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) 所定義的語言標記。
**includeServerSideToolInvocations**: `boolean` 選用。若為 true,API 回應會在 `Content` 訊息中包含伺服器端工具呼叫與回應。這讓用戶端能觀察伺服器的工具互動。

範例請求

curl -X PATCH "https://generativelanguage.googleapis.com/v1beta/$CACHE_NAME?key=$GEMINI_API_KEY" \
 -H 'Content-Type: application/json' \
 -d '{"ttl": "600s"}'
from google import genai
from google.genai import types
import datetime

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.",
    },
)

# Update the cache's time-to-live (ttl)
ttl = f"{int(datetime.timedelta(hours=2).total_seconds())}s"
client.caches.update(
    name=cache.name, config=types.UpdateCachedContentConfig(ttl=ttl)
)
print(f"After update:\n {cache}")

# Alternatively, update the expire_time directly
# Update the expire_time directly in valid RFC 3339 format (UTC with a "Z" suffix)
expire_time = (
    (
        datetime.datetime.now(datetime.timezone.utc)
        + datetime.timedelta(minutes=15)
    )
    .isoformat()
    .replace("+00:00", "Z")
)
client.caches.update(
    name=cache.name,
    config=types.UpdateCachedContentConfig(expire_time=expire_time),
)
// 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)),
];

let cache = await ai.caches.create({
  model: modelName,
  config: {
    contents: contents,
    systemInstruction: 'You are an expert analyzing transcripts.',
  },
});

// Update the cache's time-to-live (ttl)
const ttl = `${2 * 3600}s`;  // 2 hours in seconds
cache = await ai.caches.update({
  name: cache.name,
  config: {ttl},
});
console.log('After update (TTL):', cache);

// Alternatively, update the expire_time directly (in RFC 3339 format with a
// "Z" suffix)
const expireTime =
    new Date(Date.now() + 15 * 60000).toISOString().replace(/\.\d{3}Z$/, 'Z');
cache = await ai.caches.update({
  name: cache.name,
  config: {expireTime: expireTime},
});
console.log('After update (expire_time):', cache);
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)
}

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)
}

_, err = client.Caches.Delete(ctx, cache.Name, &genai.DeleteCachedContentConfig{})
if err != nil {
    log.Fatal(err)
}
fmt.Println("Cache deleted:", cache.Name)

回應

model: required string

不可變。用於快取內容的 Model 名稱。格式:models/{model}


**expiration**: `Union type` 指定此資源何時到期。 聯合欄位 `expiration` 只能為下列其中之一: **expireTime**: `string` 此資源被視為到期時的 UTC 時間戳記。無論輸入時傳送了什麼,輸出時*一律*會提供此值。

name: string

僅供輸出。識別碼。指涉快取內容的資源名稱。格式:cachedContents/{id}


displayName: string

選用。不可變。使用者為快取內容產生的具意義顯示名稱。最多 128 個 Unicode 字元。


createTime: string

僅供輸出。快取項目的建立時間。


updateTime: string

僅供輸出。快取項目上次更新的 UTC 時間。


**usageMetadata**: `CachedContentUsageMetadata` 僅供輸出。快取內容使用量的中繼資料。 **totalTokenCount**: `integer` 快取內容所消耗的權杖總數。