Interface AgenticaTextEvent<Role>

interface AgenticaTextEvent<
    Role extends "assistant"
    | "user" = "assistant" | "user",
> {
    join: () => Promise<string>;
    role: Role;
    stream: AsyncGenerator<string, undefined, undefined>;
    toHistory: () => AgenticaTextHistory;
    toJSON: () => IAgenticaEventJson.IText;
    type: "text";
}

Type Parameters

Role extends "assistant" | "user" = "assistant" | "user"

Hierarchy

AgenticaEventBase<"text">
- AgenticaTextEvent

Index

Properties

join role stream toHistory toJSON type

Properties

join

join: () => Promise<string>

role

role: Role

stream

stream: AsyncGenerator<string, undefined, undefined>

toHistory

toHistory: () => AgenticaTextHistory

toJSON

toJSON: () => IAgenticaEventJson.IText

type

type: "text"

Discriminator type.