Interface: ChatResponse

Defined in: src/_other-scraper/chatup-ai.ts:21

The ChatResponse interface represents the response object returned from the chat method. It encapsulates various properties that provide insight into the outcome of the chat operation.

Properties

success

success: boolean

Defined in: src/_other-scraper/chatup-ai.ts:23

Indicates whether the chat operation was successful.

code

code: number

Defined in: src/_other-scraper/chatup-ai.ts:25

An HTTP-like status code that reflects the outcome of the operation.

result

result: string

Defined in: src/_other-scraper/chatup-ai.ts:27

A string containing the result of the chat operation, which is typically the assistant’s response or an error message.

sessionId?

optional sessionId: string

Defined in: src/_other-scraper/chatup-ai.ts:29

A unique identifier for the chat session, allowing for tracking of individual conversations.

sessionExpiry?

optional sessionExpiry: string

Defined in: src/_other-scraper/chatup-ai.ts:31

An ISO 8601 timestamp indicating when the session will expire.

messageCount?

optional messageCount: object

Defined in: src/_other-scraper/chatup-ai.ts:33

Metadata regarding the number of stored messages within the session.

current

current: number

The count of currently stored messages.

max

max: number

The maximum capacity for messages stored in the session.

isNewSession?

optional isNewSession: boolean

Defined in: src/_other-scraper/chatup-ai.ts:38

Indicates whether the current interaction represents a new session.

isFollowUp?

optional isFollowUp: boolean

Defined in: src/_other-scraper/chatup-ai.ts:40

Indicates whether the current message is a follow-up message to a previous interaction.