StreamMessageContent.md

StreamMessageContent

Stream message content payload.

Properties

Name	Type	Description	Notes
content	string	Stream data chunk. Total message size must not exceed 128 KB across all chunks.	[default to undefined]
seq	number	Sequence number. Must be greater than 0, starting from 1, strictly incrementing and continuous.	[default to undefined]
complete	boolean	Whether this is the final chunk in the stream. `true` marks the end of the stream.	[default to undefined]
completeReason	number	Custom completion reason code. Only effective when `complete` is `true`.	[optional] [default to undefined]
type	string	Stream content type. Supported on the first chunk only. Default: text. Supported values: text, markdown, html.	[optional] [default to undefined]
messageId	string	Stream message unique ID. Not required for the first chunk. Required for subsequent chunks (use the value returned in the first chunk response).	[optional] [default to undefined]
user	{ [key: string]: any; }	Sender user information object. Supported on the first chunk only.	[optional] [default to undefined]
mentionedInfo	{ [key: string]: any; }	@mention information. Supported on the first chunk only.	[optional] [default to undefined]
extra	{ [key: string]: any; }	Extension information. Supported on the first chunk only.	[optional] [default to undefined]

Example

import { StreamMessageContent } from '@nexconn/server-sdk';

const instance: StreamMessageContent = {
    content,
    seq,
    complete,
    completeReason,
    type,
    messageId,
    user,
    mentionedInfo,
    extra,
};

[Back to Model list] [Back to API list] [Back to README]