Redis

The Redis component is a data component that allows users to manage data in NoSQL Redis databases. It can carry out the following tasks:

#Release Stage

Alpha

#Configuration

The component configuration is defined and maintained here.

#Setup

FieldField IDTypeNote
Host (required)hoststringRedis host to connect to
Port (required)portintegerPort of Redis
UsernameusernamestringUsername associated with Redis
PasswordpasswordstringPassword associated with Redis
SSL ConnectionsslbooleanIndicates whether SSL encryption protocol will be used to connect to Redis. It is recommended to use SSL connection if possible.
SSL Configurationssl-modeobjectSSL connection modes. verify-full - This is the most secure mode. Always require encryption and verifies the identity of the source database server

#Supported Tasks

#Retrieve Chat History

Retrieve chat history from Redis.

InputIDTypeDescription
Task ID (required)taskstringTASK_RETRIEVE_CHAT_HISTORY
Session ID (required)session-idstringA unique identifier for the chat session
Latest Klatest-kintegerThe number of latest conversation turns to retrieve. A conversation turn typically includes one participant speaking or sending a message, and the other participant(s) responding to it.
Include System Message If Existsinclude-system-messagebooleanInclude system message in the retrieved conversation turns if exists
OutputIDTypeDescription
Chat Messagemessagesarray[object]Messages

#Write Chat-Message

Write chat message into Redis.

InputIDTypeDescription
Task ID (required)taskstringTASK_WRITE_chat-message
Session ID (required)session-idstringA unique identifier for the chat session
Role (required)rolestringThe message role, i.e. 'system', 'user' or 'assistant'
Content (required)contentstringThe message content
MetadatametadataobjectThe message metadata
OutputIDTypeDescription
StatusstatusbooleanThe status of the write operation

#Write Multi Modal Chat-Message

Write multi-modal chat message into Redis.

InputIDTypeDescription
Task ID (required)taskstringTASK_WRITE_MULTI_MODAL_chat-message
Session ID (required)session-idstringA unique identifier for the chat session
Role (required)rolestringThe message role, i.e. 'system', 'user' or 'assistant'
Content (required)contentstringThe multi-modal message content
MetadatametadataobjectThe message metadata
OutputIDTypeDescription
StatusstatusbooleanThe status of the write operation

Last updated: 6/18/2024, 11:35:38 AM