Interface CompleteItemChunk

The interface for a chunk that represents a complete update to a message item. The item provided here should have all the data necessary to render the item including any data that was previously received from partial chunks. This chunk may contain corrections to previous chunks.

interface CompleteItemChunk {
complete_item: GenericItem;
streaming_metadata?: { response_id: string };
}

Hierarchy (View Summary, Expand)

Chunk
- CompleteItemChunk

Index

Properties

complete_item streaming_metadata?

Properties

complete_item

complete_item: GenericItem

`Optional`streaming_metadata

streaming_metadata?: { response_id: string }

Additional metadata associated with the stream.

Type declaration

response_id: string
The ID of the complete message response object. This ID will be the ID of the full message that is received in the final chunk of the stream.