StreamResponse

メッセージのストリーム レスポンス。ストリームは次のいずれかのシーケンスである必要があります。レスポンスがメッセージの場合、ストリームには 1 つのメッセージのみが含まれ、その後閉じられます。レスポンスがタスクのライフサイクルの場合、最初のレスポンスは Task オブジェクトで、その後に 0 個以上の TaskStatusUpdateEvent と TaskArtifactUpdateEvent が続きます。Task が中断状態または終了状態の場合、ストリームは完了します。これらの条件が満たされる前に終了したストリームは、

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "task": {
    object (Task)
  },
  "message": {
    object (Message)
  },
  "statusUpdate": {
    object (TaskStatusUpdateEvent)
  },
  "artifactUpdate": {
    object (TaskArtifactUpdateEvent)
  }
  // End of mutually exclusive fields.
}
フィールド
以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
task

object (Task)

message

object (Message)

statusUpdate

object (TaskStatusUpdateEvent)

artifactUpdate

object (TaskArtifactUpdateEvent)

相互に排他的なフィールドの終了。

TaskStatusUpdateEvent

TaskStatusUpdateEvent は、タスクが変更されたことを示すタスクの差分イベントです。

JSON 表現
{
  "taskId": string,
  "contextId": string,
  "status": {
    object (TaskStatus)
  },
  "final": boolean,
  "metadata": {
    object
  }
}
フィールド
taskId

string

変更されたタスクの ID

contextId

string

タスクが属するコンテキストの ID

status

object (TaskStatus)

タスクの新しいステータス。

final

boolean

このタスクで想定される最後のステータス更新かどうか。

metadata

object (Struct format)

タスクの更新に関連付けるメタデータ(省略可)。

TaskArtifactUpdateEvent

TaskArtifactUpdateEvent は、アーティファクトが生成されたタスクの差分を表します。

JSON 表現
{
  "taskId": string,
  "contextId": string,
  "artifact": {
    object (Artifact)
  },
  "append": boolean,
  "lastChunk": boolean,
  "metadata": {
    object
  }
}
フィールド
taskId

string

このアーティファクトのタスクの ID

contextId

string

このタスクが属するコンテキストの ID

artifact

object (Artifact)

アーティファクト自体

append

boolean

以前に生成されたものに追加するかどうか

lastChunk

boolean

これがアーティファクトの最後の部分を表すかどうか

metadata

object (Struct format)

アーティファクトの更新に関連付けられたメタデータ(省略可)。