AI Chat Assistant

ConnectionType

Select the AI providers to be used. The options are Open AI, Google Gemini, or Anthropic.

Connection

Enter an existing connection to the AI provider.

Model

Enter the model of the AI provider to be used.

Instructions

Enter the plain language instructions to be provided to the AI bot. This field supports up to 20,000 characters.

ErrorMessage

Error message to be sent if the request to the AI bot fails.

AssistantName

Enter the name of the AI Assistant. This will be displayed as the name in the chat conversation.

UserName

Enter the name of the customer. This will be displayed as the customer's name in the chat conversation.

InsertSummaryOnCompletion

Set to True to send a summary of the chat conversation as a chat message when the conversation completes.

DeleteChatPostTranscription

Set to True to delete the chat conversation when the activity completes.

CompletionFormatResult

Define a JSON-formatted object that is appended to the instructions sent to the AI Chat Assistant, indicating how the response should be returned.

SummaryResult

Enter the chat message text to be sent with the summary information when InsertSummaryOnCompletion is set to True. It can be set to something similar to "This is a summary of the chat conversation"

Participants

Select a set of users and groups to be added to the conversation.

ConversationId

Enter the ConversationId to use an existing conversation. Otherwise, a new conversation will be created.

Greeting

Enter the Initial greeting message sent in the chat conversation.

NoResponseRetries

Enter the maximum number of retries for a customer response to the message.

NoResponseMessage

Enter the message to be sent to the conversation when no message is received by the customer before NoResponseTimeoutValue expires.

NoResponseTimeoutValue

Enter the number of seconds to wait for a response from the customer before retrying or exiting.

HTTPRequestURL

Enter the URL of the HTTP GET request that will be invoked. The response from the HTTP GET request will be used by the AI Chat Assistant to handle the request.

AssistantThinkingProgress

Enter the URL to the image to be displayed in the chat conversation when the AI Chat Assistant is processing the information and the activity is waiting for it to return a result.

Success

Indicates whether the activity was completed successfully (value = True) or not (value = False).

Result

Full result sent from the AI bot

TranscriptionConversationId

If a conversation is created, this is set to the ConversationId of the created conversation. Otherwise, it is set to the value of the input variable ConversationId.

TranscriptionContent

JSON-formatted content of the chat conversation transcript.