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

From SmartBots Developers Docs
Jump to: navigation, search
 
(3 intermediate revisions by 2 users not shown)
Line 12: Line 12:
 
{{API Variable|message|yes}} chat message to the bot
 
{{API Variable|message|yes}} chat message to the bot
 
{{API Variable|options|optional}} configuration directives for the AI engine. Example:
 
{{API Variable|options|optional}} configuration directives for the AI engine. Example:
<pre>
+
<syntaxhighlight lang="javascript">
 
{
 
{
 
     // Main configuration instructions for the AI: role, behavior, response rules etc.
 
     // Main configuration instructions for the AI: role, behavior, response rules etc.
Line 19: Line 19:
 
     // Maximum number of tokens to generate in response
 
     // Maximum number of tokens to generate in response
 
     maxResponseTokens?: number;
 
     maxResponseTokens?: number;
 +
 +
    // Max number of response in bytes. SL IM has a max limit of 1023bytes.
 +
    maxResponseBytes?: number;
 
}
 
}
</pre>
+
</syntaxhighlight>
  
 
{{API Variable Group|Output}}
 
{{API Variable Group|Output}}

Latest revision as of 18:35, 12 November 2024


Sends a chat message request to bot AI within a conversation with a specific resident.

Conversation.chat(message[, options])

Reference

This command accepts the following parameters:

Variable Required Description


Input:
message yes chat message to the bot
options optional 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;

     // Max number of response in bytes. SL IM has a max limit of 1023bytes.
     maxResponseBytes?: number;
}
Output:
same value as Bot.AI.chat(...) This command returns the same value as Bot.AI.chat(...)