ByteChef LogoByteChef

Vector Store Chat Memory

Vector Store Chat Memory.

Categories: Artificial Intelligence

Type: vectorStoreChatMemory/v1


Actions

Add Messages

Name: addMessages

Adds messages to the vector store chat memory for a conversation.

Properties

NameLabelTypeDescriptionRequired
conversationIdConversation IDSTRINGThe unique identifier for the conversation.true
messagesMessagesARRAY
Items [{STRING(role), STRING(content)}]
The messages to add to the conversation.true

Example JSON Structure

{
  "label" : "Add Messages",
  "name" : "addMessages",
  "parameters" : {
    "conversationId" : "",
    "messages" : [ {
      "role" : "",
      "content" : ""
    } ]
  },
  "type" : "vectorStoreChatMemory/v1/addMessages"
}

Output

Type: OBJECT

Properties

NameTypeDescription
conversationIdSTRING
messageCountINTEGER

Output Example

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

Get Messages

Name: getMessages

Retrieves messages from the vector store chat memory for a conversation.

Properties

NameLabelTypeDescriptionRequired
conversationIdConversation IDSTRINGThe unique identifier for the conversation.true
topKTop KINTEGERThe maximum number of messages to retrieve.false

Example JSON Structure

{
  "label" : "Get Messages",
  "name" : "getMessages",
  "parameters" : {
    "conversationId" : "",
    "topK" : 1
  },
  "type" : "vectorStoreChatMemory/v1/getMessages"
}

Output

Type: OBJECT

Properties

NameTypeDescription
conversationIdSTRING
messagesARRAY
Items [{STRING(role), STRING(content)}]

Output Example

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

Delete Conversation

Name: deleteConversation

Deletes all messages for a conversation from the vector store.

Properties

NameLabelTypeDescriptionRequired
conversationIdConversation IDSTRINGThe unique identifier for the conversation to delete.true

Example JSON Structure

{
  "label" : "Delete Conversation",
  "name" : "deleteConversation",
  "parameters" : {
    "conversationId" : ""
  },
  "type" : "vectorStoreChatMemory/v1/deleteConversation"
}

Output

Type: OBJECT

Properties

NameTypeDescription
conversationIdSTRING
deletedBOOLEAN
Options true, false

Output Example

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

How is this guide?

Last updated on

On this page