Skip to content

PURISTA API


PURISTA API / @purista/ai / AgentStreamResponder

Type Alias: AgentStreamResponder

AgentStreamResponder = object

Defined in: packages/ai/src/types/AgentDefinition.ts:99

Methods

onComplete()

onComplete(): void

Defined in: packages/ai/src/types/AgentDefinition.ts:101

Returns

void


onError()

onError(error): void

Defined in: packages/ai/src/types/AgentDefinition.ts:102

Parameters

error

unknown

Returns

void


onFrame()

onFrame(frame): void

Defined in: packages/ai/src/types/AgentDefinition.ts:100

Parameters

frame
actor

{ agent?: string; instanceId?: string; service: string; version?: string; } = protocolActorSchema

actor.agent?

string = ...

actor.instanceId?

string = ...

actor.service

string = ...

actor.version?

string = ...

conversationId

string = ...

frame

{ content: string; final?: boolean; kind: "message"; partial?: boolean; role: "user" | "assistant" | "system" | "tool"; summary?: string; } | { artifactId: string; content: string | Record<string, unknown>; kind: "artifact"; lastChunk?: boolean; mimeType?: string; phase: "final" | "chunk"; sequence?: number; total?: number; } | { errorCode?: string; input?: unknown; kind: "tool"; message?: string; output?: unknown; status: "error" | "success" | "invoked"; toolName: string; } | { activeWorkers?: number; durationMs?: number; effectiveMaxConcurrencyHint?: number; kind: "telemetry"; maxWorkersPerInstance?: number; poolId?: string; provider?: string; replicaCountHint?: number; usage?: { completionTokens?: number; costUsd?: number; promptTokens?: number; totalTokens?: number; }; waitingWorkers?: number; waitTimeMs?: number; } | { code: string; details?: unknown; handled: boolean; kind: "error"; message: string; } = agentProtocolFrameSchema

inReplyTo?

string = ...

messageId

string = ...

metadata?

Record<string, unknown> = ...

role?

"user" | "assistant" | "system" | "tool" = ...

tenantId?

string = ...

timestamp

string = ...

userId?

string = ...

version

"purista.ai/1.0" = ...

Returns

void