Skip to main content

Interface: StructuredOutputSegment

Defined in: packages/core/src/stream-segments/types.ts:67

Structured output segment (for schema-based responses)

Extends

Properties

agentId?

optional agentId?: string

Defined in: packages/core/src/stream-segments/types.ts:20

Agent that produced this segment (populated in group chat contexts)

Inherited from

BaseSegment.agentId


agentName?

optional agentName?: string

Defined in: packages/core/src/stream-segments/types.ts:22

Display name of the agent

Inherited from

BaseSegment.agentName


avatarEmoji?

optional avatarEmoji?: string

Defined in: packages/core/src/stream-segments/types.ts:24

Avatar emoji for display

Inherited from

BaseSegment.avatarEmoji


content

content: string

Defined in: packages/core/src/stream-segments/types.ts:69


id

id: string

Defined in: packages/core/src/stream-segments/types.ts:16

Unique identifier for React keys

Inherited from

BaseSegment.id


isStreaming

isStreaming: boolean

Defined in: packages/core/src/stream-segments/types.ts:70


timestamp

timestamp: number

Defined in: packages/core/src/stream-segments/types.ts:18

Timestamp for ordering

Inherited from

BaseSegment.timestamp


type

type: "structured_output"

Defined in: packages/core/src/stream-segments/types.ts:68