- 資源:AssistantSession
- AssistantMessage
- AssistantChunk
- TypedPayload
- AssistantSessionState
- UserResponseSuggestions
- AssistantSessionArtifact
- SessionCheckpoint
- ActiveTurnInfo
- ActiveTurnInfo.Status
- 方法
資源:AssistantSession
助理工作階段代表使用者與助理代理之間的對話。
| JSON 表示法 |
|---|
{ "name": string, "requestor": string, "messages": [ { object ( |
| 欄位 | |
|---|---|
name |
這是必要旗標,ID。工作階段的專屬 ID。格式: |
requestor |
僅供輸出。發起工作階段的使用者。 |
messages[] |
選用。工作階段中的訊息記錄。 |
state |
僅供輸出。助理工作階段的狀態。 |
createTime |
僅供輸出。建立助理工作階段的時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例: |
updateTime |
僅供輸出。上次更新 Google 助理工作階段的時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例: |
userResponseSuggestions |
僅供輸出。助理代理建議的使用者回覆。 |
displayName |
選用。助理工作階段的顯示名稱。 |
artifacts[] |
僅供輸出。助理在這個工作階段中產生的文件構件 (例如以 Markdown 格式產生的 TDD)。僅限指標;檔案內容會儲存在客戶的 Cloud Storage bucket。 |
sessionCheckpoint |
僅供輸出。工作階段檢查點,包含使用者意圖和滾動記錄摘要。 |
activeTurn |
僅供輸出。這個工作階段目前執行中的回合附件資訊。如果沒有執行中的回合,則不設定。 |
touchedApps[] |
僅供輸出。這個工作階段指定或變更的應用程式 (僅限專案範圍工作階段),用於記錄標記。格式: |
AssistantMessage
助理工作階段中的訊息。
| JSON 表示法 |
|---|
{
"role": string,
"chunks": [
{
object ( |
| 欄位 | |
|---|---|
role |
這是必要旗標,對話中的角色:「user」或「model」。 |
chunks[] |
選用。訊息內容 (以區塊形式呈現)。 |
eventTime |
這是必要旗標,傳送或接收訊息的時間戳記。 使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例: |
attachedGcsUris[] |
選用。使用者在這輪對話上傳檔案的 Cloud Storage URI。這樣一來,附件就能保留並顯示在工作階段記錄 UI 中。範例:「gs://cxas-transient-uploads/uuid/prd.pdf」 |
AssistantChunk
助理訊息中的資料區塊。
| JSON 表示法 |
|---|
{
"createTime": string,
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"text": string,
"thought": string,
"payload": {
object
},
"typedPayload": {
object ( |
| 欄位 | |
|---|---|
createTime |
選用。建立或發出區塊的時間戳記。 使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例: |
| 區塊中的資料。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位: | |
text |
選用。文字資料。 |
thought |
選用。模型生成的想法。 |
payload |
選用。酬載,內含品質報表、代理版本名稱、建議回覆等結構化回覆。 |
typedPayload |
選用。包含結構化回應的類型化酬載。 |
| 互斥欄位結束。 | |
TypedPayload
具有類型的酬載。Used by the assistant history (AssistantChunk) and by the streaming typedPayload event; lives here because both assistant_service.proto and session_service.proto need it.
| JSON 表示法 |
|---|
{ "displayName": string, "type": string, "value": { object }, "metadata": { object } } |
| 欄位 | |
|---|---|
displayName |
這是必要旗標,酬載的顯示名稱。 |
type |
這是必要旗標,酬載類型。 |
value |
這是必要旗標,酬載的值。 |
metadata |
選用。酬載的中繼資料。 |
AssistantSessionState
助理工作階段的狀態。
| 列舉 | |
|---|---|
ASSISTANT_SESSION_STATE_UNSPECIFIED |
預設值。如未指定狀態,系統會使用這個值。 |
PROCESSING |
助理代理正在處理要求,這項工作需要較長時間。 |
IDLE |
助理代理處於閒置狀態,沒有任何待處理的要求或回覆。 |
PENDING_REVIEW |
助理代理已完成長時間執行的工作,並準備好回覆使用者。 |
UserResponseSuggestions
助理代理建議的使用者回覆。
| JSON 表示法 |
|---|
{ "suggestions": [ string ] } |
| 欄位 | |
|---|---|
suggestions[] |
這是必要旗標,助理建議的使用者回覆。這些是建議使用者如何與助理互動的提示。 |
AssistantSessionArtifact
助理在工作階段中生成的文件構件,會以檔案形式儲存在客戶的 Cloud Storage bucket。
| JSON 表示法 |
|---|
{ "id": string, "displayName": string, "gcsUri": string, "mimeType": string, "createTime": string, "turnIndex": integer } |
| 欄位 | |
|---|---|
id |
僅供輸出。工作階段中構件的專屬 ID。 |
displayName |
僅供輸出。向使用者顯示的檔案名稱,例如「hotel_booking_tdd.md」。 |
gcsUri |
僅供輸出。存放構件內容的 Cloud Storage 物件。例如:「gs://{project}-agent-assist-artifacts/agent-assist-generated/1_tdd.md」 |
mimeType |
僅供輸出。構件內容的 IANA 媒體類型,例如「text/markdown」。 |
createTime |
僅供輸出。構件保存時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例: |
turnIndex |
僅供輸出。[AssistantSession.messages] 中訊息的索引,其回合產生了構件,用於在還原歷史記錄時放置構件方塊。 |
SessionCheckpoint
工作階段檢查點,包含工作階段標題和 UI 的推論使用者意圖。
| JSON 表示法 |
|---|
{ "userIntent": string } |
| 欄位 | |
|---|---|
userIntent |
推論出的工作階段使用者目標或主題 (例如「建構電子商務支援代理」)。 |
ActiveTurnInfo
目前執行中、與用戶端中斷連線,或暫停等待其他伺服器工作接手的會話群組輪流即時附加資訊。
| JSON 表示法 |
|---|
{
"turnId": string,
"status": enum ( |
| 欄位 | |
|---|---|
turnId |
識別回合;由 Streaming API 的 Resume 快照回應。 |
status |
目前的附件狀態。 |
startTime |
僅供輸出。回合開始時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例: |
lastProgressTime |
僅供輸出。上次保留回合進度的時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例: |
orphanDeadlineTime |
僅供輸出。如果沒有用戶端附加,則輪流結束的時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例: |
ActiveTurnInfo.Status
目前執行中的回合與用戶端和伺服器工作的關係。
| 列舉 | |
|---|---|
STATUS_UNSPECIFIED |
未指定。 |
RUNNING |
執行回合時,至少附加一個用戶端。 |
DISCONNECTED |
回合正在執行,但未連結任何用戶端。 |
RESUMING |
回合已暫停,等待接續:下次附加時會繼續。 |
ABANDONED |
該回合的伺服器租約已到期,且沒有任何工作在執行;下次讀取時,系統會將其封存為已提交的部分。無法附加。 |
方法 |
|
|---|---|
|
取消 Google 助理工作階段的進行中回合 (如有):使用者明確停止與任何串流分離的回合。 |
|
在指定應用程式中建立新的助理工作階段。 |
|
刪除指定的助理工作階段。 |
|
取得指定助理工作階段的詳細資料。 |
|
列出指定應用程式中的所有助理工作階段。 |
|
以串流方式,為指定助理工作階段執行 AI 助理 Arc。 |