Struct TaskArtifactUpdateEvent 

pub struct TaskArtifactUpdateEvent {
    pub task_id: String,
    pub context_id: String,
    pub artifact: Artifact,
    pub append: bool,
    pub last_chunk: bool,
    pub metadata: BTreeMap<String, Value>,
}

A streaming event that reports a task artifact being produced or appended.

Wire form:

{
  "taskId": "task-1",
  "contextId": "context-1",
  "artifact": { "name": "answer", "parts": [...] },
  "append": false,
  "lastChunk": false,
  "metadata": { ... }
}

taskId, contextId, and artifact are required; append, lastChunk, and metadata are optional. The append flag is true when the artifact should be appended to a previously sent artifact with the same id (chunked transfer); the lastChunk flag is true when this is the final chunk of an append.

Fields

task_id: String

The task’s id. Required.

context_id: String

The task’s context id. Required.

artifact: Artifact

The artifact that was produced or updated. Required.

append: bool

Whether the artifact should be appended to a previously sent artifact with the same id. The default (false) means this artifact replaces any previous one with the same id.

last_chunk: bool

Whether this is the final chunk of the artifact. Only meaningful when append is true; ignored otherwise.

metadata: BTreeMap<String, Value>

Per-event metadata.

Implementations

impl TaskArtifactUpdateEvent

pub fn new( task_id: impl Into<String>, context_id: impl Into<String>, artifact: Artifact, ) -> Self

Starts a new event with task_id, context_id, and artifact. The append and lastChunk flags default to false. Use with_append to mark the artifact as an append, and with_last_chunk to mark this as the final chunk.

pub const fn with_append(self) -> Self

Sets the append flag to true.

pub const fn with_last_chunk(self) -> Self

Sets the lastChunk flag to true.

Trait Implementations

impl Clone for TaskArtifactUpdateEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TaskArtifactUpdateEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TaskArtifactUpdateEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TaskArtifactUpdateEvent

impl From<TaskArtifactUpdateEvent> for StreamingEvent

fn from(event: TaskArtifactUpdateEvent) -> Self

Converts to this type from the input type.

impl PartialEq for TaskArtifactUpdateEvent

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for TaskArtifactUpdateEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TaskArtifactUpdateEvent