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

From SmartBots Developers Docs
Jump to: navigation, search
 
Line 14: Line 14:
 
{{API Variable|residentName|yes}} The name of the resident sending the message
 
{{API Variable|residentName|yes}} The name of the resident sending the message
 
{{API Variable|options|optional}} The name of the resident sending the message Format:
 
{{API Variable|options|optional}} The name of the resident sending the message Format:
<pre>
+
<syntaxhighlight lang="json">
 
{
 
{
 
instructions?: string;
 
instructions?: string;
Line 22: Line 22:
 
maxResponseTokens?: number;
 
maxResponseTokens?: number;
 
}
 
}
</pre>
+
</syntaxhighlight>
 
{{API Variable Group|Output}}
 
{{API Variable Group|Output}}
 
{{API Variable|text|}} The response of the bot
 
{{API Variable|text|}} The response of the bot
 
{{API Variable|messageId|}} The id of the response message. Can be specified as parentMessageId later
 
{{API Variable|messageId|}} The id of the response message. Can be specified as parentMessageId later
 
{{API Variable|usage|}}  The object which contains Token Usage. Format:  The object which contains all groups. Format:  
 
{{API Variable|usage|}}  The object which contains Token Usage. Format:  The object which contains all groups. Format:  
<pre>
+
<syntaxhighlight lang="json">
 
{
 
{
 
// Number of tokens in a request (message + instructions + history)
 
// Number of tokens in a request (message + instructions + history)
Line 38: Line 38:
 
tokens_left: number;
 
tokens_left: number;
 
}
 
}
</pre>
+
</syntaxhighlight>
 
{{API Variables Table End}}
 
{{API Variables Table End}}
  

Latest revision as of 16:24, 10 October 2023

Sends a chat message request to bot AI.

Bot.AI.chat(message, senderName[, options])


Reference

This command accepts the following parameters:

Variable Required Description


Input:
message yes chat message to the bot
residentName yes The name of the resident sending the message
options optional The name of the resident sending the message Format:
{
instructions?: string;
// Previous messade ID, if responding to a particular previous AI message of the bot
parentMessageId?: string;
// Maximum number of tokens to generate in response
maxResponseTokens?: number;
}
Output:
text The response of the bot
messageId The id of the response message. Can be specified as parentMessageId later
usage The object which contains Token Usage. Format: The object which contains all groups. Format:
{
// Number of tokens in a request (message + instructions + history)
prompt_tokens: number;
// Number of tokens in a response
completion_tokens: number;
// Total tokens used
total_tokens: number;
// Tokens left on SmartBots AI balance
tokens_left: number;
}
  • In case of error functions throws an error with a message.