Interface TaskStatusUpdateEvent

An event sent by the agent to notify the client of a change in a task's status. This is typically used in streaming or subscription models.

This interface was referenced by MySchema's JSON-Schema via the definition "TaskStatusUpdateEvent".

interface TaskStatusUpdateEvent {
    contextId: string;
    final: boolean;
    kind: "status-update";
    metadata?: {
        [k: string]: unknown;
    };
    status: TaskStatus1;
    taskId: string;
}

Properties

contextId final kind metadata? status taskId

Properties

contextId

contextId: string

The context ID associated with the task.

final

final: boolean

If true, this is the final event in the stream for this interaction.

kind

kind: "status-update"

The type of this event, used as a discriminator. Always 'status-update'.

Optional metadata

metadata?: {
    [k: string]: unknown;
}

Optional metadata for extensions.

Type declaration

  • [k: string]: unknown

status

status: TaskStatus1

taskId

taskId: string

The ID of the task that was updated.

Settings

Member Visibility

Theme

On This Page

contextIdfinalkindmetadatastatustaskId