Chat History (Lookup) v1.0.0 Help ​

Saves the history of a chat interaction in a structured format, tailored to work with the Conversation (Lookup) Step.

How can I use the Step? ​

You can use this Step to keep records of chat conversations. This can help review conversations, train chatbots, or analyze customer inquiries.

How does the Step work? ​

The Step appends recent question-answer pairs to a chat history array, ensuring the total does not exceed the predefined capacity. If the capacity limit is reached, it removes the oldest entries to accommodate new ones.

Prerequisites ​

  • Integration with the Conversation (Lookup) Step to process chat content.

Input settings ​

  • Question: question from the Conversation (Lookup) Step template. Optional, defaults to an empty Merge field.
  • Answer: answer from the Conversation (Lookup) Step template. Optional, defaults to an empty Merge field.
  • History capacity: maximum number of question-answer pairs. It must be an integer greater or equal to two. The field is required and defaults to 10.

Merge field settings ​

The Step returns the chat history as a JSON array and stores it under the Merge field name. To learn more about Merge fields and how to work with them, see our Merge fields guide.

Output example ​

Each object in the JSON array represents a chat interaction and includes the participant role and message content for each entry in the chat history, for example:

json
[
  {
    "role": "user",
    "content": "Hello"
  },
  {
    "role": "bot",
    "content": "Hi! How can I assist you today?"
  }
]
[
  {
    "role": "user",
    "content": "Hello"
  },
  {
    "role": "bot",
    "content": "Hi! How can I assist you today?"
  }
]

Error handling ​

By default, the Step uses a separate exit for error handling. If an error occurs, the Flow continues down the error exit. For more info, see Error and timeout handling.

Reporting ​

The Step automatically generates Reporting events during its execution, allowing for real-time tracking and analysis of its performance and user interactions. To learn more, see Reporting events

Service dependencies ​

  • flow builder - v2.28.3
  • event-manager - v2.3.0
  • deployer - v2.6.0
  • library v2.11.3
  • studio v2.64.1

Release notes ​

v1.0.0

  • Initial release