工具:get_agent
取得指定代理程式的詳細資料。
下列範例示範如何使用 curl 叫用 get_agent MCP 工具。
| Curl 要求 |
|---|
curl --location 'https://ces.[REGION].rep.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "get_agent", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
輸入內容的結構定義
AgentService.GetAgent 的要求訊息。
GetAgentRequest
| JSON 表示法 |
|---|
{ "name": string } |
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的代理程式資源名稱。 |
輸出內容的結構定義
代理是基本建構模塊,可為大型語言模型 (LLM) 提供指令,以執行特定工作。
代理
| JSON 表示法 |
|---|
{ "name": string, "displayName": string, "description": string, "modelSettings": { object ( |
| 欄位 | |
|---|---|
name |
ID。代理程式的專屬 ID。格式: |
displayName |
這是必要旗標,代理程式的顯示名稱。 |
description |
選用。使用者可理解的代理說明。 |
modelSettings |
選用。LLM 模型的設定。 |
instruction |
選用。給大型語言模型模型的指示,引導代理程式的行為。 |
tools[] |
選用。代理可用的工具清單。格式: |
childAgents[] |
選用。代理程式樹狀結構中的子項代理程式清單。格式: |
beforeAgentCallbacks[] |
選用。在呼叫代理程式前執行的回呼。系統會按照清單中的順序,依序執行提供的回呼。如果回呼傳回覆寫的回應,執行作業就會停止,並略過所有剩餘的回呼。 |
afterAgentCallbacks[] |
選用。呼叫代理程式後要執行的回呼。系統會按照清單中的順序,依序執行提供的回呼。如果回呼傳回覆寫的回應,執行作業就會停止,並略過所有剩餘的回呼。 |
beforeModelCallbacks[] |
選用。在呼叫模型前執行的回呼。如果多次呼叫模型,回呼就會執行多次。系統會按照清單中的順序,依序執行提供的回呼。如果回呼傳回覆寫的回應,執行作業就會停止,並略過所有剩餘的回呼。 |
afterModelCallbacks[] |
選用。模型呼叫後要執行的回呼。如果多次呼叫模型,回呼就會執行多次。系統會按照清單中的順序,依序執行提供的回呼。如果回呼傳回覆寫的回應,執行作業就會停止,並略過所有剩餘的回呼。 |
beforeToolCallbacks[] |
選用。在叫用工具前執行的回呼。如果多次叫用工具,回呼就會執行多次。系統會按照清單中的順序,依序執行提供的回呼。如果回呼傳回覆寫的回應,執行作業就會停止,並略過所有剩餘的回呼。 |
afterToolCallbacks[] |
選用。工具叫用後要執行的回呼。如果多次叫用工具,回呼就會執行多次。系統會按照清單中的順序,依序執行提供的回呼。如果回呼傳回覆寫的回應,執行作業就會停止,並略過所有剩餘的回呼。 |
createTime |
僅供輸出。建立代理程式的時間戳記。 使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例: |
updateTime |
僅供輸出。上次更新代理程式的時間戳記。 使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例: |
guardrails[] |
選用。代理程式的防護措施清單。格式: |
etag |
Etag 用於確保物件在讀取 - 修改 - 寫入作業期間未變更。如果 etag 為空,更新作業會覆寫任何並行變更。 |
toolsets[] |
選用。代理的工具集清單。 |
generatedSummary |
僅供輸出。如果代理是由 LLM 助理產生,這個欄位會包含生成作業的描述性摘要。 |
transferRules[] |
選用。客服專員轉接規則。如果符合多項規則,系統會使用清單中的第一項規則。 |
聯集欄位 agent_type。代理程式類型。agent_type 只能是下列其中一個設定: |
|
llmAgent |
選用。預設代理程式類型。 |
remoteDialogflowAgent |
選用。用於執行代理程式的遠端 Dialogflow 代理程式。如果設定這個欄位,系統會忽略所有其他代理程式層級的屬性。 注意:如果 Dialogflow 代理程式與應用程式位於不同專案,請將 |
RemoteDialogflowAgent
| JSON 表示法 |
|---|
{ "agent": string, "flowId": string, "environmentId": string, "inputVariableMapping": { string: string, ... }, "outputVariableMapping": { string: string, ... }, "respectResponseInterruptionSettings": boolean } |
| 欄位 | |
|---|---|
agent |
這是必要旗標,Dialogflow 代理資源名稱。格式: |
flowId |
選用。Dialogflow 代理程式中流程的流程 ID。 |
environmentId |
選用。用於執行代理程式的 Dialogflow 代理程式環境 ID。如未指定,系統會使用草稿環境。 |
inputVariableMapping |
選用。將應用程式變數名稱對應至要傳送給 Dialogflow 代理程式做為輸入內容的 Dialogflow 工作階段參數名稱。 包含 |
outputVariableMapping |
選用。將 Dialogflow 會期參數名稱對應至應用程式變數名稱,以便在 Dialogflow 代理程式執行完畢後傳回 CES 代理程式。 包含 |
respectResponseInterruptionSettings |
選用。指出是否要遵守 Dialogflow 代理程式中設定的訊息層級中斷設定。
|
InputVariableMappingEntry
| JSON 表示法 |
|---|
{ "key": string, "value": string } |
| 欄位 | |
|---|---|
key |
|
value |
|
OutputVariableMappingEntry
| JSON 表示法 |
|---|
{ "key": string, "value": string } |
| 欄位 | |
|---|---|
key |
|
value |
|
ModelSettings
| JSON 表示法 |
|---|
{ "model": string, // Union field |
| 欄位 | |
|---|---|
model |
選用。代理程式應使用的 LLM 模型。如未設定,代理程式會沿用上層代理程式的模型。 |
聯集欄位
|
|
temperature |
選用。如果設定這項引數,LLM 模型就會使用這個溫度。溫度會控制模型回覆的隨機程度。溫度越低,生成的回覆就越容易預測。溫度越高,生成的回覆就越有創意。 |
回撥電話
| JSON 表示法 |
|---|
{ "description": string, "disabled": boolean, "proactiveExecutionEnabled": boolean, // Union field |
| 欄位 | |
|---|---|
description |
選用。使用者可理解的回呼說明。 |
disabled |
選用。回呼是否已停用。代理程式會忽略已停用的回呼。 |
proactiveExecutionEnabled |
選用。如果啟用這項功能,系統也會對中繼模型輸出內容執行回呼。這項設定只會影響模型回呼後續作業。請謹慎啟用。通常在收到所有模型回覆後,才需要執行模型回呼。啟用主動執行功能可能會對執行費用和延遲時間造成負面影響,因此只應在極少數情況下啟用。 |
聯集欄位 callback。要執行的回呼。callback 只能是下列其中一個設定: |
|
pythonCode |
這是必要旗標,要為回呼執行的 Python 程式碼。 |
時間戳記
| JSON 表示法 |
|---|
{ "seconds": string, "nanos": integer } |
| 欄位 | |
|---|---|
seconds |
代表自 Unix 紀元 1970-01-01T00:00:00Z 起算的世界標準時間秒數。必須介於 -62135596800 和 253402300799 之間 (含),對應至 0001-01-01T00:00:00Z 至 9999-12-31T23:59:59Z。 |
nanos |
以奈秒為單位的非負秒數小數。這個欄位是時間長度的奈秒部分,並非秒數的替代值。如果第二個值為負數,且包含分數,奈秒值仍須為非負數,且會向前計時。必須介於 0 至 999,999,999 之間 (含)。 |
AgentToolset
| JSON 表示法 |
|---|
{ "toolset": string, "toolIds": [ string ] } |
| 欄位 | |
|---|---|
toolset |
這是必要旗標,工具集的資源名稱。格式: |
toolIds[] |
選用。用於篩選工具集的工具 ID。 |
TransferRule
| JSON 表示法 |
|---|
{ "childAgent": string, "direction": enum ( |
| 欄位 | |
|---|---|
childAgent |
這是必要旗標,規則套用的子項代理程式資源名稱。格式: |
direction |
這是必要旗標,轉移方向。 |
聯集欄位 rule_type。規則類型。rule_type 只能是下列其中一個設定: |
|
deterministicTransfer |
選用。規則:條件符合時,立即轉移至目標服務專員。 |
disablePlannerTransfer |
選用。這項規則會禁止規劃師轉移給目標服務專員。 |
DeterministicTransfer
| JSON 表示法 |
|---|
{ // Union field |
| 欄位 | |
|---|---|
聯集欄位 condition_type。要評估的條件。condition_type 只能是下列其中一個設定: |
|
expressionCondition |
選用。評估工作階段狀態條件的規則。如果條件評估結果為 true,就會發生轉移。 |
pythonCodeCondition |
選用。使用 Python 程式碼區塊評估條件的規則。如果條件評估結果為 true,就會發生轉移。 |
ExpressionCondition
| JSON 表示法 |
|---|
{ "expression": string } |
| 欄位 | |
|---|---|
expression |
這是必要旗標,cloud.api.Expression 條件的字串表示法。 |
PythonCodeCondition
| JSON 表示法 |
|---|
{ "pythonCode": string } |
| 欄位 | |
|---|---|
pythonCode |
這是必要旗標,要執行的 Python 程式碼。 |
DisablePlannerTransfer
| JSON 表示法 |
|---|
{
"expressionCondition": {
object ( |
| 欄位 | |
|---|---|
expressionCondition |
這是必要旗標,如果條件評估結果為 true,規劃人員就無法轉移至目標代理。 |
工具註解
破壞性提示:❌ | 等冪提示:✅ | 唯讀提示:✅ | 開放世界提示:❌