AWS S3 Chat Memory Component v2

Stores session-based conversation history as JSON objects in an Amazon S3 bucket.

Categories: Artificial Intelligence

Type: awsChatMemory/v2

Connections

Version: 1

custom

Properties

Name	Label	Type	Description	Required
accessKeyId	Access Key ID	STRING		true
secretAccessKey	Secret Access Key	STRING		true
region	Region	STRING		true
bucket	Bucket	STRING		true
keyPrefix	Key Prefix	STRING	Optional prefix prepended to every conversation object key.	false

Actions

Add Messages

Name: addMessages

Adds messages to a conversation, creating the conversation if it does not exist.

Properties

Name	Label	Type	Description	Required
conversationId	Conversation ID	STRING	The unique identifier for the conversation.	true
userId	User ID	STRING	User id assigned to the conversation when it is created.	false
messages	Messages	ARRAY Items [{STRING(role), STRING(content)}]	The messages to add to the conversation.	true

Example JSON Structure

{
  "label" : "Add Messages",
  "name" : "addMessages",
  "parameters" : {
    "conversationId" : "",
    "userId" : "",
    "messages" : [ {
      "role" : "",
      "content" : ""
    } ]
  },
  "type" : "awsChatMemory/v2/addMessages"
}

Output

Type: OBJECT

Properties

Name	Type	Description
conversationId	STRING
messageCount	INTEGER

Output Example

{
  "conversationId" : "",
  "messageCount" : 1
}

Get Messages

Name: getMessages

Retrieves the messages of a conversation.

Properties

Name	Label	Type	Description	Required
conversationId	Conversation ID	STRING	The unique identifier for the conversation.	true
includeCompactedHistory	Include compacted history	BOOLEAN Options true, false	When off, only the messages the agent currently sees are returned.	false

Example JSON Structure

{
  "label" : "Get Messages",
  "name" : "getMessages",
  "parameters" : {
    "conversationId" : "",
    "includeCompactedHistory" : false
  },
  "type" : "awsChatMemory/v2/getMessages"
}

Output

Type: OBJECT

Properties

Name	Type	Description
conversationId	STRING
messages	ARRAY Items [{STRING(role), STRING(content)}]

Output Example

{
  "conversationId" : "",
  "messages" : [ {
    "role" : "",
    "content" : ""
  } ]
}

Delete Conversation

Name: deleteConversation

Deletes a conversation and all of its messages.

Properties

Name	Label	Type	Description	Required
conversationId	Conversation ID	STRING	The unique identifier for the conversation.	true

Example JSON Structure

{
  "label" : "Delete Conversation",
  "name" : "deleteConversation",
  "parameters" : {
    "conversationId" : ""
  },
  "type" : "awsChatMemory/v2/deleteConversation"
}

Output

Type: OBJECT

Properties

Name	Type	Description
conversationId	STRING
deleted	BOOLEAN Options true, false

Output Example

{
  "conversationId" : "",
  "deleted" : false
}

List Conversations

Name: listConversations

Lists the conversation IDs of a user.

Properties

Name	Label	Type	Description	Required
userId	User ID	STRING	Lists the conversations of this user.	false

Example JSON Structure

{
  "label" : "List Conversations",
  "name" : "listConversations",
  "parameters" : {
    "userId" : ""
  },
  "type" : "awsChatMemory/v2/listConversations"
}

Output

Type: OBJECT

Properties

Name	Type	Description
conversationIds	ARRAY Items [STRING]
count	INTEGER

Output Example

{
  "conversationIds" : [ "" ],
  "count" : 1
}

AWS S3 Chat Memory

On this page