Overview

This node operation updates an existing OpenAI bot instance with specified parameters such as instance name, model, system prompt, maximum tokens, and additional options. It is useful for managing and customizing AI bot behavior dynamically within workflows, for example, adjusting the bot's response style or session management settings.

Use Case Examples

1. Updating a bot to use a different OpenAI model like GPT-4 Turbo for more advanced responses.
2. Changing the system prompt to redefine the bot's behavior for a specific use case.
3. Modifying session timeout and temperature settings to control conversation context and creativity.

Properties

Output

JSON

• botId - The unique identifier of the updated bot.
• instanceName - The name of the updated bot instance.
• model - The OpenAI model assigned to the bot.
• systemPrompt - The system prompt defining the bot's behavior.
• maxTokens - The maximum tokens allowed in the bot's responses.
• additionalOptions
  • keepSession - Whether the bot maintains conversation context.
  • listenToBroadcasts - Whether the bot listens to broadcast messages.
  • listenToGroups - Whether the bot listens to group messages.
  • sessionTimeout - The session timeout duration in seconds.
  • temperature - The temperature setting controlling response creativity.
  • triggerKeywords - Keywords that trigger the bot.
  • triggerType - The trigger type setting for the bot.

Dependencies

• An API key credential for authenticating with the OpenAI API.

Troubleshooting

• Ensure the Bot ID is correct and corresponds to an existing bot instance to avoid 'bot not found' errors.
• Verify that the selected model is supported and available in your OpenAI account.
• Check that required parameters like Instance Name and Bot ID are provided to prevent validation errors.
• If the API request fails, confirm that the API key credential is valid and has necessary permissions.