Management API Reference for chat-memory

Provided Capabilities (1)

Attributes (3)

• size - The size of the chat memory.

  Type	INT
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Min	1
  Max	2147483647
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The size of the chat memory.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

• type - The type of chat memory.

  Type	STRING
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Allowed Values	MESSAGE TOKEN
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of chat memory.", "expressions-allowed" : true, "required" : true, "nillable" : false, "allowed" : [ "MESSAGE", "TOKEN" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

• use-http-session - To use the HTTP session id as chat memory id.

  Type	BOOLEAN
  Default Value	true
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "To use the HTTP session id as chat memory id.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

Operations (2)

• add - This operation adds a chat memory.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  size	INT	true	true		The size of the chat memory.
  type	STRING	true	true		The type of chat memory.
  use-http-session	BOOLEAN	false	true	true	To use the HTTP session id as chat memory id.

  Raw DMR model

  { "operation-name" : "add", "description" : "This operation adds a chat memory.", "request-properties" : { "size" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The size of the chat memory.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of chat memory.", "expressions-allowed" : true, "required" : true, "nillable" : false, "allowed" : [ "MESSAGE", "TOKEN" ], "stability" : "default" }, "use-http-session" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "To use the HTTP session id as chat memory id.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• remove - This operation removes a chat memory.

  Raw DMR model

  { "operation-name" : "remove", "description" : "This operation removes a chat memory.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "resource-services", "runtime-only" : false }

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

• subsystem.ai.chat-memory

          
  <feature spec="subsystem.ai.chat-memory">
    <param name="chat-memory" value="{resource name}"/>
    <param name="size" value="{value}"/>
    <param name="type" value="{value}"/>
    <param name="use-http-session" value="{value}"/>
  <feature/>
          
        

  📋