PURISTA

Appearance

PURISTA API

PURISTA API / @purista/ai / ConversationHelpers

Type Alias: ConversationHelpers ​

ConversationHelpers = object

Defined in: packages/ai/src/runtime/conversation.ts:31

Methods ​

addAssistant() ​

addAssistant(content, options?): Promise<ConversationState>

Defined in: packages/ai/src/runtime/conversation.ts:44

Parameters ​

content ​

string

options? ​
metadata? ​

Record<string, unknown>

sessionId? ​

string

Returns ​

Promise<ConversationState>

addSystem() ​

addSystem(content, options?): Promise<ConversationState>

Defined in: packages/ai/src/runtime/conversation.ts:36

Parameters ​

content ​

string

options? ​
metadata? ​

Record<string, unknown>

sessionId? ​

string

Returns ​

Promise<ConversationState>

addTool() ​

addTool(content, options?): Promise<ConversationState>

Defined in: packages/ai/src/runtime/conversation.ts:48

Parameters ​

content ​

string

options? ​
metadata? ​

Record<string, unknown>

sessionId? ​

string

toolCallId? ​

string

toolName? ​

string

Returns ​

Promise<ConversationState>

addToolResult() ​

addToolResult(content, options?): Promise<ConversationState>

Defined in: packages/ai/src/runtime/conversation.ts:52

Parameters ​

content ​

string

options? ​
metadata? ​

Record<string, unknown>

sessionId? ​

string

toolCallId? ​

string

toolName? ​

string

Returns ​

Promise<ConversationState>

addUser() ​

addUser(content, options?): Promise<ConversationState>

Defined in: packages/ai/src/runtime/conversation.ts:40

Parameters ​

content ​

string

options? ​
metadata? ​

Record<string, unknown>

sessionId? ​

string

Returns ​

Promise<ConversationState>

append() ​

append(message, sessionId?): Promise<ConversationState>

Defined in: packages/ai/src/runtime/conversation.ts:35

Parameters ​

message ​

Omit<ConversationMessage, "id" | "createdAt">

sessionId? ​

string

Returns ​

Promise<ConversationState>

buildPromptInput() ​

buildPromptInput(options?): Promise<string>

Defined in: packages/ai/src/runtime/conversation.ts:58

Parameters ​

options? ​
includeSummary? ​

boolean

sessionId? ​

string

Returns ​

Promise<string>

get() ​

get(sessionId?): Promise<ConversationState>

Defined in: packages/ai/src/runtime/conversation.ts:32

Parameters ​

sessionId? ​

string

Returns ​

Promise<ConversationState>

getMessages() ​

getMessages(sessionId?): Promise<ConversationMessage[]>

Defined in: packages/ai/src/runtime/conversation.ts:33

Parameters ​

sessionId? ​

string

Returns ​

Promise<ConversationMessage[]>

getSummary() ​

getSummary(sessionId?): Promise<string | undefined>

Defined in: packages/ai/src/runtime/conversation.ts:34

Parameters ​

sessionId? ​

string

Returns ​

Promise<string | undefined>

revertLast() ​

revertLast(options?): Promise<ConversationState>

Defined in: packages/ai/src/runtime/conversation.ts:57

Parameters ​

options? ​
role? ​

ConversationRole

sessionId? ​

string

Returns ​

Promise<ConversationState>

setSummary() ​

setSummary(summary, sessionId?): Promise<ConversationState>

Defined in: packages/ai/src/runtime/conversation.ts:56

Parameters ​

summary ​

string

sessionId? ​

string

Returns ​

Promise<ConversationState>