REST Resource: projects.locations.apps.assistantSessions

リソース: AssistantSession

アシスタント セッションは、ユーザーとアシスタント エージェント間の会話を表します。

JSON 表現 
{
  "name": string,
  "requestor": string,
  "messages": [
    {
      object (AssistantMessage)
    }
  ],
  "state": enum (AssistantSessionState),
  "createTime": string,
  "updateTime": string,
  "userResponseSuggestions": {
    object (UserResponseSuggestions)
  },
  "displayName": string,
  "artifacts": [
    {
      object (AssistantSessionArtifact)
    }
  ],
  "sessionCheckpoint": {
    object (SessionCheckpoint)
  },
  "activeTurn": {
    object (ActiveTurnInfo)
  },
  "touchedApps": [
    string
  ]
}
フィールド
name

string

必須。ID。セッションの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{session}
requestor

string

出力専用。セッションを開始したユーザー。
messages[]

object (AssistantMessage)

省略可。セッション内のメッセージの履歴。
state

enum (AssistantSessionState)

出力専用。アシスタント セッションのステータス。
createTime

string (Timestamp format)

出力専用。アシスタント セッションが作成された時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。アシスタント セッションが最後に更新された日時。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
userResponseSuggestions

object (UserResponseSuggestions)

出力専用。アシスタント エージェントからのユーザーの回答候補。
displayName

string

省略可。アシスタント セッションの表示名。
artifacts[]

object (AssistantSessionArtifact)

出力専用。このセッションでアシスタントによって生成されたドキュメント アーティファクト（マークダウンで生成された TDD など）。ポインタのみ。ファイルの内容は、お客様の Cloud Storage バケットに保存されます。
sessionCheckpoint

object (SessionCheckpoint)

出力専用。ユーザー インテントとローリング履歴の概要を含むセッション チェックポイント。
activeTurn

object (ActiveTurnInfo)

出力専用。このセッションで現在実行中のターンのアタッチメント情報。ターンが実行されていない場合は設定されません。
touchedApps[]

string

出力専用。このセッションがターゲットとした、または変更したアプリ（プロジェクト スコープのセッションのみ）。履歴タグ用。形式: projects/{project}/locations/{location}/apps/{app}

AssistantMessage

アシスタント セッション内のメッセージ。

JSON 表現 
{
  "role": string,
  "chunks": [
    {
      object (AssistantChunk)
    }
  ],
  "eventTime": string,
  "attachedGcsUris": [
    string
  ]
}
フィールド
role

string

必須。会話内のロール（「user」または「model」）。
chunks[]

object (AssistantChunk)

省略可。メッセージのコンテンツ（チャンク）。
eventTime

string (Timestamp format)

必須。メッセージが送信または受信されたときのタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
attachedGcsUris[]

string

省略可。このターン中にユーザーがアップロードしたファイルの 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 (TypedPayload)
  }
  // End of mutually exclusive fields.
}
フィールド
createTime

string (Timestamp format)

省略可。チャンクが作成または出力されたときのタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
チャンク内のデータ。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
text

string

省略可。テキストデータ。
thought

string

省略可。モデルによって生成された思考。
payload

object (Struct format)

省略可。品質レポート、エージェント バージョン名、推奨される回答などの構造化されたレスポンスを含むペイロード。
typedPayload

object (TypedPayload)

省略可。構造化されたレスポンスを含む、型付きのペイロード。
相互に排他的なフィールドの終了。

TypedPayload

タイプを含むペイロード。アシスタント履歴（AssistantChunk）とストリーミング typedPayload イベントで使用されます。assistant_service.proto と session_service.proto の両方で必要になるため、ここにあります。

JSON 表現 
{
  "displayName": string,
  "type": string,
  "value": {
    object
  },
  "metadata": {
    object
  }
}
フィールド
displayName

string

必須。ペイロードの表示名。
type

string

必須。ペイロードのタイプ。
value

object (Struct format)

必須。ペイロードの値。
metadata

object (Struct format)

省略可。ペイロードのメタデータ。

AssistantSessionState

アシスタント セッションのステータス。

列挙型
ASSISTANT_SESSION_STATE_UNSPECIFIED デフォルト値。この値は、ステータスが指定されていない場合に使用されます。
PROCESSING アシスタント エージェントは、リクエストを長時間実行タスクとして処理しています。
IDLE アシスタント エージェントはアイドル状態であり、保留中のリクエストやレスポンスはありません。
PENDING_REVIEW アシスタント エージェントが長時間実行タスクの処理を完了し、ユーザーへの回答を準備しました。

UserResponseSuggestions

アシスタント エージェントからのユーザーの回答候補。

JSON 表現 
{
  "suggestions": [
    string
  ]
}
フィールド
suggestions[]

string

必須。アシスタントがユーザーの返信を提案しました。これらは、アシスタントの操作方法に関するユーザー向けの候補です。

AssistantSessionArtifact

セッション内でアシスタントによって生成されたドキュメント アーティファクト。お客様の Cloud Storage バケットにファイルとして保存されます。

JSON 表現 
{
  "id": string,
  "displayName": string,
  "gcsUri": string,
  "mimeType": string,
  "createTime": string,
  "turnIndex": integer
}
フィールド
id

string

出力専用。セッション内のアーティファクトの固有識別子。
displayName

string

出力専用。ユーザーに表示されるファイル名（例: 「hotel_booking_tdd.md」）。
gcsUri

string

出力専用。アーティファクト コンテンツを保持する Cloud Storage オブジェクト。例: gs://{project}-agent-assist-artifacts/agent-assist-generated/1_tdd.md
mimeType

string

出力専用。アーティファクト コンテンツの IANA メディアタイプ（例: text/markdown）。
createTime

string (Timestamp format)

出力専用。アーティファクトが永続化された日時。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
turnIndex

integer

出力専用。履歴が復元されたときにアーティファクト チップを配置するために、アーティファクトを生成したターンの [AssistantSession.messages] 内のメッセージのインデックス。

SessionCheckpoint

セッション タイトルと UI の推定ユーザー インテントを含むセッション チェックポイント。

JSON 表現 
{
  "userIntent": string
}
フィールド
userIntent

string

セッションの推定ユーザー目標またはトピック（例: 「e コマース サポート エージェントの構築」）。

ActiveTurnInfo

現在実行中、クライアントから切断、または別のサーバータスクによるピックアップのためにパークされているセッション ターンのライブ アタッチメント情報。

JSON 表現 
{
  "turnId": string,
  "status": enum (ActiveTurnInfo.Status),
  "startTime": string,
  "lastProgressTime": string,
  "orphanDeadlineTime": string
}
フィールド
turnId

string

ターンを識別します。ストリーミング API の再開スナップショットによってエコーされます。
status

enum (ActiveTurnInfo.Status)

現在の添付ファイルのステータス。
startTime

string (Timestamp format)

出力専用。ターンが開始された時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
lastProgressTime

string (Timestamp format)

出力専用。ターンが最後に進行状況を保持した日時。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
orphanDeadlineTime

string (Timestamp format)

出力専用。クライアントが接続されていない場合にターンが終了するタイミング。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

ActiveTurnInfo.Status

実行中のターンがクライアント タスクとサーバータスクに現在どのように関連しているか。

列挙型
STATUS_UNSPECIFIED 指定なし。
RUNNING ターンは、少なくとも 1 つのクライアントが接続された状態で実行されています。
DISCONNECTED クライアントが接続されていない状態でターンが実行されています。
RESUMING ターンは受け取りのためにパークされます。次のアタッチで続行されます。
ABANDONED ターンのサーバーリースが失効し、タスクがそれを駆動していない。次の読み取りで、コミットされた部分にシールされる。追加できません。

メソッド

cancelAssistantTurn

 アシスタント セッションの処理中のターン（存在する場合）をキャンセルします。これは、ストリームから切り離されて実行されているターンをユーザーが明示的に停止することです。

create

 指定されたアプリで新しいアシスタント セッションを作成します。

delete

 指定されたアシスタント セッションを削除します。

get

 指定されたアシスタント セッションの詳細を取得します。

list

 指定されたアプリ内のすべてのアシスタント セッションを一覧表示します。

streamChatAiAssistant

 指定されたアシスタント セッションで AI アシスタントの Arc をストリーミング形式で実行します。