IAssistantService
katanakit-js / IAssistantService
Interface: IAssistantService
Section titled “Interface: IAssistantService”Defined in: types/core/ai.ts:117
Contract of the assistant facade.
Methods
Section titled “Methods”useCreateSession()
Section titled “useCreateSession()”useCreateSession(channel?): Promise<string>;Defined in: types/core/ai.ts:124
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
channel? |
string |
Returns
Section titled “Returns”Promise<string>
useGetHistory()
Section titled “useGetHistory()”useGetHistory(sessionId): Promise<{ content: string | null; name?: string; role: "system" | "user" | "assistant" | "tool"; tool_call_id?: string; tool_calls?: { function: { arguments: string; name: string; }; id: string; type: "function"; }[];}[]>;Defined in: types/core/ai.ts:126
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
sessionId |
string |
Returns
Section titled “Returns”Promise<{
content: string | null;
name?: string;
role: "system" | "user" | "assistant" | "tool";
tool_call_id?: string;
tool_calls?: {
function: {
arguments: string;
name: string;
};
id: string;
type: "function";
}[];
}[]>
useInitAssistant()
Section titled “useInitAssistant()”useInitAssistant(config?): void;Defined in: types/core/ai.ts:118
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
config? |
AssistantInitConfig |
Returns
Section titled “Returns”void
useReply()
Section titled “useReply()”useReply( sessionId, text, options?): Promise<AssistantResult>;Defined in: types/core/ai.ts:119
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
sessionId |
string | undefined |
text |
string |
options? |
AssistantReplyOptions |
Returns
Section titled “Returns”Promise<AssistantResult>
useResetSession()
Section titled “useResetSession()”useResetSession(sessionId): Promise<void>;Defined in: types/core/ai.ts:127
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
sessionId |
string |
Returns
Section titled “Returns”Promise<void>
useSessionExists()
Section titled “useSessionExists()”useSessionExists(sessionId): Promise<boolean>;Defined in: types/core/ai.ts:125
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
sessionId |
string |
Returns
Section titled “Returns”Promise<boolean>