Interface Ai

interface Ai {
    chatFromVloopexId: (chatId: string) => Chat;
    followup: (chat: Chat, options: ChatTurnOptions) => Chat;
    start: (options: ChatStartOptions) => Chat;
    startOrFollowup: (chatTag: string, options: TaggedFollowupOptions) => Chat;
    startOrResume: (chatTag: string, options: ChatStartOptions) => Chat;
}

Index

Properties

chatFromVloopexId followup start startOrFollowup startOrResume

Properties

chatFromVloopexId

chatFromVloopexId: (chatId: string) => Chat

Type Declaration

- (chatId: string): Chat
- Gets the chat with this Vloopex chat id, which the chat's Details show, and subscribes this loop to it. The chat does not have to be one that this loop started. The subscription receives events and permits commands through the controller. It does not start a turn or change provider ownership or the run tree. Chats started from task files and empty workbench chats work too.
  Parameters
  - chatId: string
    Vloopex chat ID, not the provider session ID.
  Returns Chat

followup

followup: (chat: Chat, options: ChatTurnOptions) => Chat

Type Declaration

- (chat: Chat, options: ChatTurnOptions): Chat
- Sends a follow-up prompt to an existing chat.
  Parameters
  - chat: Chat
    Chat that receives the prompt.
  - options: ChatTurnOptions
    Turn options.
  Returns Chat

start

start: (options: ChatStartOptions) => Chat

Type Declaration

- (options: ChatStartOptions): Chat
- Starts a new AI chat every time it is called.
  Parameters
  - options: ChatStartOptions
    Launch options.
  Returns Chat

startOrFollowup

startOrFollowup: (chatTag: string, options: TaggedFollowupOptions) => Chat

Type Declaration

- (chatTag: string, options: TaggedFollowupOptions): Chat
- Starts a tagged chat, reconnects its active turn, or sends a follow-up after its current turn finishes successfully.
  Parameters
  - chatTag: string
    Non-empty name that identifies a chat within this loop run.
  - options: TaggedFollowupOptions
    Launch options on the first call; turn options on later calls.
  Returns Chat

startOrResume

startOrResume: (chatTag: string, options: ChatStartOptions) => Chat

Type Declaration

- (chatTag: string, options: ChatStartOptions): Chat
- Starts a tagged chat once for this loop run, or reconnects its saved chat. When the tag already exists, all options are ignored, including prompt.
  Parameters
  - chatTag: string
    Non-empty name that identifies a chat within this loop run.
  - options: ChatStartOptions
    Used only when the tag has no chat yet.
  Returns Chat