Interface ChatResponseModel

The ChatResponseModel wraps the actual ChatResponse with additional information like the current state, progress messages, a unique id etc.

interface ChatResponseModel {
    agentId?: string;
    data: {
        [key: string]: unknown;
    };
    errorObject?: Error;
    id: string;
    isCanceled: boolean;
    isComplete: boolean;
    isError: boolean;
    isWaitingForInput: boolean;
    onDidChange: Event<void>;
    progressMessages: ChatProgressMessage[];
    requestId: string;
    response: ChatResponse;
}

Properties

agentId? data errorObject? id isCanceled isComplete isError isWaitingForInput onDidChange progressMessages requestId response

Properties

Optional Readonly agentId

agentId?: string

The agent who produced the response content, if there is one.

Readonly data

data: {
    [key: string]: unknown;
}

Some functionality might want to store some data associated with the response. This can be used to store and retrieve such data.

Type declaration

  • [key: string]: unknown

Optional Readonly errorObject

errorObject?: Error

An optional error object that caused the response to be in an error state.

Readonly id

id: string

The unique identifier of the response model

Readonly isCanceled

isCanceled: boolean

Indicates whether this response is canceled. No further changes are expected if 'true'.

Readonly isComplete

isComplete: boolean

Indicates whether this response is complete. No further changes are expected if 'true'.

Readonly isError

isError: boolean

Indicates whether an error occurred when processing the response. No further changes are expected if 'true'.

Readonly isWaitingForInput

isWaitingForInput: boolean

Some agents might need to wait for user input to continue. This flag indicates that.

Readonly onDidChange

onDidChange: Event<void>

Use this to be notified for any change in the response model

Readonly progressMessages

progressMessages: ChatProgressMessage[]

In case there are progress messages, then they will be stored here

Readonly requestId

requestId: string

The unique identifier of the request model this response is associated with

Readonly response

response: ChatResponse

The actual response content

Settings

Member Visibility

Theme

On This Page

agentIddataerrorObjectidisCanceledisCompleteisErrorisWaitingForInputonDidChangeprogressMessagesrequestIdresponse