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

From SmartBots Developers Docs
Jump to: navigation, search
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
 
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
  
<onlyinclude>'''Sets some configuration values for the future usage'''</onlyinclude>
+
<onlyinclude>Sets some configuration values for the future usage</onlyinclude>
 
<syntaxhighlight lang="javascript">
 
<syntaxhighlight lang="javascript">
 
Conversation.configure(options)
 
Conversation.configure(options)
Line 11: Line 11:
 
{{API Variable Group|Input}}
 
{{API Variable Group|Input}}
 
{{API Variable|options|yes}} configuration directives for the AI engine. Example:
 
{{API Variable|options|yes}} configuration directives for the AI engine. Example:
<pre>
+
<syntaxhighlight lang="json">
 
{
 
{
 
     // Main configuration instructions for the AI: role, behavior, response rules etc.
 
     // Main configuration instructions for the AI: role, behavior, response rules etc.
Line 18: Line 18:
 
     // Maximum number of tokens to generate in response
 
     // Maximum number of tokens to generate in response
 
     maxResponseTokens?: number;
 
     maxResponseTokens?: number;
 +
 +
    // The amount of history to retain for the conversation.
 +
    maxHistoryMessages?: number;
 
}
 
}
</pre>
+
</syntaxhighlight>
  
 
{{API Variable Group|Output}}
 
{{API Variable Group|Output}}

Latest revision as of 16:47, 12 September 2024


Sets some configuration values for the future usage

Conversation.configure(options)

Reference

This command accepts the following parameters:

Variable Required Description


Input:
options yes configuration directives for the AI engine. Example:
{
     // Main configuration instructions for the AI: role, behavior, response rules etc.
     instructions?: string;
     
     // Maximum number of tokens to generate in response
     maxResponseTokens?: number;

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