Interface ISkeel

Public facade for the Skeel launcher. Accessible as window.Skeel.

interface ISkeel {
    closeCard(): void;
    createChat(options?: CreateChatOptions): Promise<IChat>;
    getChat(options?: GetChatOptions): IChat;
    initialize(messageConfig: SendMessageRequest): void;
    openCard(messageConfig?: Partial<SendMessageRequest>): void;
    setAuthorization(token: string | undefined): void;
    setTool(tool: ChatTool): () => void;
}

Index

Methods

closeCard createChat getChat initialize openCard setAuthorization setTool

Methods

closeCard

closeCard(): void
Close the built-in chat card. Works when the widget script is loaded with {@code data-skeel-widget="true"}.

Returns void
- Defined in models/ISkeel.ts:48

createChat

createChat(options?: CreateChatOptions): Promise<IChat>
Create a new chat and return a reference to it.
Parameters
- Optionaloptions: CreateChatOptions
Returns Promise<IChat>
- Defined in models/ISkeel.ts:60

getChat

getChat(options?: GetChatOptions): IChat
Return a reference to an existing chat, or the current chat session.
Parameters
- Optionaloptions: GetChatOptions
Returns IChat
- Defined in models/ISkeel.ts:63

initialize

initialize(messageConfig: SendMessageRequest): void
Configure default LLM parameters for chat messages sent from the built-in card.
Parameters
- messageConfig: SendMessageRequest
Returns void
- Defined in models/ISkeel.ts:38

openCard

openCard(messageConfig?: Partial<SendMessageRequest>): void
Open the built-in chat card. Works when the widget script is loaded with {@code data-skeel-widget="true"}.
Parameters
- OptionalmessageConfig: Partial<SendMessageRequest>
  Optional overrides applied on top of ISkeel.initialize.
Returns void
- Defined in models/ISkeel.ts:45

setAuthorization

setAuthorization(token: string | undefined): void
Set the Bearer authorization token for authenticated instances.
Parameters
- token: string | undefined
Returns void
- Defined in models/ISkeel.ts:51

setTool

setTool(tool: ChatTool): () => void
Register a tool available on all chats. Returns a function that removes this registration.
Parameters
- tool: ChatTool
Returns () => void
- Defined in models/ISkeel.ts:57