Class ChatResponseStream

A stream object used to stream messages to the client.

Index

Constructors

Properties

chunks conversationId onPush? requestId

Methods

push resolveContent

Constructors

constructor

new ChatResponseStream(conversationId, requestId, options?): ChatResponseStream
Parameters
- conversationId: string
- requestId: string
- Optional options: ChatResponseStreamOptions
Returns ChatResponseStream
- Defined in packages/palico-app/src/agent/chat/stream.ts:35

Properties

chunks

chunks: AgentResponseChunkDelta[] = []

The chunks of content that have been pushed to the stream

conversationId

conversationId: string

The conversation ID associated with the stream

`Private` `Optional` onPush

onPush?: ((content) => void)

Type declaration

- (content): void
- Parameters
  - content: AgentResponseChunk
  Returns void

requestId

requestId: string

The request ID associated with the stream

Methods

push

push(chunk): void
Push new content to the stream
Parameters
- chunk: AgentResponseChunkDelta
  The content to push to the stream
Returns void
- Defined in packages/palico-app/src/agent/chat/stream.ts:49

resolveContent

resolveContent(): Promise<AgentResponse<Record<string, any>>>
Merge all the chunks that have been pushed to the stream

Returns Promise<AgentResponse<Record<string, any>>>
The merged content as an AgentResponse object
- Defined in packages/palico-app/src/agent/chat/stream.ts:64