Difference between revisions of "Bot Playground/AI/Bot.AI.configure"

From SmartBots Developers Docs
Jump to: navigation, search
 
Line 27: Line 27:
  
 
     // The amount of history to retain for the conversation.
 
     // The amount of history to retain for the conversation.
     maxHistoryMessages?: string;
+
     maxHistoryMessages?: number;
  
 
}
 
}

Latest revision as of 16:47, 12 September 2024


Configures AI options to be used in all further communications within the current script.

Bot.AI.configure(options)

Reference

This command accepts the following parameters:

Variable Required Description


Input:
options yes configuration directives for the AI engine. Format:
{
     // Main configuration instructions for the AI: role, behavior, response rules etc.
     instructions?: string;

     // If responding to a particular previous AI message of the bot
     parentMessageId?: string;

     // Maximum number of tokens to generate in response
     maxResponseTokens?: number;

     // The unique conversation id. Usually generated automatically based
     // on the sender and bot name.
     conversationId?: string;

     // The amount of history to retain for the conversation.
     maxHistoryMessages?: number;

}
Output:
result This function does not return anything