Bot.AI.chat

From SmartBots Developers Docs
Bot PlaygroundAI
Revision as of 16:20, 10 October 2023 by NealB (Talk | contribs)

Jump to: navigation, search

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.