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

From SmartBots Developers Docs
Jump to: navigation, search
(Created page with "{{DISPLAYTITLE:{{SUBPAGENAME}}}} <onlyinclude>'''Configures AI options to be used in all further communications within the current script.'''</onlyinclude> <syntaxhighlight l...")
 
Line 30: Line 30:
 
{{API Return none}}
 
{{API Return none}}
 
{{API Variables Table End}}
 
{{API Variables Table End}}
 +
 +
{{NavMenu}}

Revision as of 16:10, 10 October 2023


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;
}
Output:
result This function does not return anything