Schemas

ChatRequest

ChatRequest
  • object
    Example: {"user_id":"user123","query":"What is the latest update?"}
    Properties:
    • user_id
      mixed
      User Id
      User ID for the request
      Example: "user123"
    • query
      string
      Required
      Query
      Chat query message.
      Example: "What is the latest update?"

ChatResponse

ChatResponse
Response model for chat operations.
  • object
    Example: {"code":200,"message":"Operation successful","data":"string"}
    Properties:
    • code
      integer
      Code
      Response status code
      Example: 200
    • message
      string
      Required
      Message
      Response message
      Example: "Operation successful"
    • data
      mixed
      Data
      Response data
      Example: "string"

ConfigResponse

ConfigResponse
Response model for configuration endpoint.
  • object
    Example: {"code":200,"message":"Operation successful","data":null}
    Properties:
    • code
      integer
      Code
      Response status code
      Example: 200
    • message
      string
      Required
      Message
      Response message
      Example: "Operation successful"
    • data
      null
      Data
      Response data
      Example: null

CubeShare

CubeShare
  • object
    Example: {"user_id":"user123","target_user_id":"user456"}
    Properties:
    • user_id
      mixed
      User Id
      User ID for the request
      Example: "user123"
    • target_user_id
      string
      Required
      Target User Id
      Target user ID to share with
      Example: "user456"

HTTPValidationError

HTTPValidationError
  • object
    Example: {"detail":[{"loc":["string"],"msg":"string","type":"string"}]}
    Properties:
    • detail
      array
      Detail
      Example: [{"loc":["string"],"msg":"string","type":"string"}]
      Items:
      • object
        ValidationError
        Example: {"loc":["string"],"msg":"string","type":"string"}

LLMConfigFactory

LLMConfigFactory
Factory class for creating LLM configurations.
  • object
    Example: {"model_schema":"NOT_SET","backend":"string","config":{}}
    Additional Properties: false
    Properties:
    • model_schema
      string
      Model Schema
      Schema for configuration. This value will be automatically set.
      Example: "NOT_SET"
    • backend
      string
      Required
      Backend
      Backend for LLM
      Example: "string"
    • config
      object
      Required
      Config
      Configuration for the LLM backend
      Example: {}
      Additional Properties: true

MOSConfig

MOSConfig
  • object
    Example: {"model_schema":"NOT_SET","user_id":"root","session_id":"0ce84b9c-0615-4b9d-83dd-fba50537d5d3","chat_model":{"model_schema":"NOT_SET","backend":"string","config":{}},"mem_reader":{"model_schema":"NOT_SET","backend":"string","config":{}},"mem_scheduler":{"model_schema":"NOT_SET","backend":"string","config":{}},"user_manager":{"backend":"sqlite","config":{}},"max_turns_window":15,"top_k":5,"enable_textual_memory":true,"enable_activation_memory":false,"enable_parametric_memory":false,"enable_mem_scheduler":false,"PRO_MODE":false}
    Additional Properties: false
    Properties:
    • model_schema
      string
      Model Schema
      Schema for configuration. This value will be automatically set.
      Example: "NOT_SET"
    • user_id
      string
      User Id
      User ID for the MOS. This is used to distinguish between different users' memories.
      Example: "root"
    • session_id
      string
      Session Id
      Session ID for the MOS. This is used to distinguish between different dialogue
      Example: "0ce84b9c-0615-4b9d-83dd-fba50537d5d3"
    • chat_model
      object
      LLMConfigFactory
      Factory class for creating LLM configurations.
      Example: {"model_schema":"NOT_SET","backend":"string","config":{}}
      Additional Properties: false
    • mem_reader
      object
      MemReaderConfigFactory
      Factory class for creating MemReader configurations.
      Example: {"model_schema":"NOT_SET","backend":"string","config":{}}
      Additional Properties: false
    • mem_scheduler
      mixed
      Memory scheduler configuration for managing memory operations
      Example: {"model_schema":"NOT_SET","backend":"string","config":{}}
    • user_manager
      object
      UserManagerConfigFactory
      Factory for user manager configurations.
      Example: {"backend":"sqlite","config":{}}
    • max_turns_window
      integer
      Max Turns Window
      Maximum number of turns to keep in the conversation history
      Example: 15
    • top_k
      integer
      Top K
      Maximum number of memories to retrieve for each query
      Example: 5
    • enable_textual_memory
      boolean
      Enable Textual Memory
      Enable textual memory for the MemChat
      Example: true
    • enable_activation_memory
      boolean
      Enable Activation Memory
      Enable activation memory for the MemChat
      Example: false
    • enable_parametric_memory
      boolean
      Enable Parametric Memory
      Enable parametric memory for the MemChat
      Example: false
    • enable_mem_scheduler
      boolean
      Enable Mem Scheduler
      Enable memory scheduler for automated memory management
      Example: false
    • PRO_MODE
      boolean
      Pro Mode
      Enable PRO mode for complex query decomposition
      Example: false

MemCubeRegister

MemCubeRegister
  • object
    Example: {"user_id":"user123","mem_cube_name_or_path":"/path/to/cube","mem_cube_id":"cube123"}
    Properties:
    • user_id
      mixed
      User Id
      User ID for the request
      Example: "user123"
    • mem_cube_name_or_path
      string
      Required
      Mem Cube Name Or Path
      Name or path of the MemCube to register.
      Example: "/path/to/cube"
    • mem_cube_id
      mixed
      Mem Cube Id
      ID for the MemCube
      Example: "cube123"

MemReaderConfigFactory

MemReaderConfigFactory
Factory class for creating MemReader configurations.
  • object
    Example: {"model_schema":"NOT_SET","backend":"string","config":{}}
    Additional Properties: false
    Properties:
    • model_schema
      string
      Model Schema
      Schema for configuration. This value will be automatically set.
      Example: "NOT_SET"
    • backend
      string
      Required
      Backend
      Backend for MemReader
      Example: "string"
    • config
      object
      Required
      Config
      Configuration for the MemReader backend
      Example: {}
      Additional Properties: true

MemoryCreate

MemoryCreate
  • object
    Example: {"user_id":"user123","messages":[{"content":"Hello","role":"user"}],"mem_cube_id":"cube123","memory_content":"This is a memory content","doc_path":"/path/to/document.txt"}
    Properties:
    • user_id
      mixed
      User Id
      User ID for the request
      Example: "user123"
    • messages
      mixed
      Messages
      List of messages to store.
      Example: [{"content":"Hello","role":"user"}]
    • mem_cube_id
      mixed
      Mem Cube Id
      ID of the memory cube
      Example: "cube123"
    • memory_content
      mixed
      Memory Content
      Content to store as memory
      Example: "This is a memory content"
    • doc_path
      mixed
      Doc Path
      Path to document to store
      Example: "/path/to/document.txt"

MemoryResponse

MemoryResponse
Response model for memory operations.
  • object
    Example: {"code":200,"message":"Operation successful","data":{}}
    Properties:
    • code
      integer
      Code
      Response status code
      Example: 200
    • message
      string
      Required
      Message
      Response message
      Example: "Operation successful"
    • data
      mixed
      Data
      Response data
      Example: {}

Message

Message
  • object
    Example: {"role":"user","content":"Hello, how can I help you?"}
    Properties:
    • role
      string
      Required
      Role
      Role of the message (user or assistant).
      Example: "user"
    • content
      string
      Required
      Content
      Message content.
      Example: "Hello, how can I help you?"

SchedulerConfigFactory

SchedulerConfigFactory
Factory class for creating scheduler configurations.
  • object
    Example: {"model_schema":"NOT_SET","backend":"string","config":{}}
    Additional Properties: false
    Properties:
    • model_schema
      string
      Model Schema
      Schema for configuration. This value will be automatically set.
      Example: "NOT_SET"
    • backend
      string
      Required
      Backend
      Backend for scheduler
      Example: "string"
    • config
      object
      Required
      Config
      Configuration for the scheduler backend
      Example: {}
      Additional Properties: true

SearchRequest

SearchRequest
  • object
    Example: {"user_id":"user123","query":"How to implement a feature?","install_cube_ids":["cube123","cube456"]}
    Properties:
    • user_id
      mixed
      User Id
      User ID for the request
      Example: "user123"
    • query
      string
      Required
      Query
      Search query.
      Example: "How to implement a feature?"
    • install_cube_ids
      mixed
      Install Cube Ids
      List of cube IDs to search in
      Example: ["cube123","cube456"]

SearchResponse

SearchResponse
Response model for search operations.
  • object
    Example: {"code":200,"message":"Operation successful","data":{}}
    Properties:
    • code
      integer
      Code
      Response status code
      Example: 200
    • message
      string
      Required
      Message
      Response message
      Example: "Operation successful"
    • data
      mixed
      Data
      Response data
      Example: {}

SimpleResponse

SimpleResponse
Simple response model for operations without data return.
  • object
    Example: {"code":200,"message":"Operation successful","data":null}
    Properties:
    • code
      integer
      Code
      Response status code
      Example: 200
    • message
      string
      Required
      Message
      Response message
      Example: "Operation successful"
    • data
      null
      Data
      Response data
      Example: null

UserCreate

UserCreate
  • object
    Example: {"user_id":"user123","user_name":"john_doe","role":"user"}
    Properties:
    • user_id
      string
      Required
      User Id
      User ID
      Example: "user123"
    • user_name
      mixed
      User Name
      Name of the user
      Example: "john_doe"
    • role
      string
      Role
      Role of the user
      Example: "user"

UserListResponse

UserListResponse
Response model for user list operations.
  • object
    Example: {"code":200,"message":"Operation successful","data":[null]}
    Properties:
    • code
      integer
      Code
      Response status code
      Example: 200
    • message
      string
      Required
      Message
      Response message
      Example: "Operation successful"
    • data
      mixed
      Data
      Response data
      Example: [null]

UserManagerConfigFactory

UserManagerConfigFactory
Factory for user manager configurations.
  • object
    Example: {"backend":"sqlite","config":{}}
    Properties:
    • backend
      string
      Backend
      Backend for user manager
      Example: "sqlite"
    • config
      object
      Config
      Configuration for the user manager backend
      Example: {}
      Additional Properties: true

UserResponse

UserResponse
Response model for user operations.
  • object
    Example: {"code":200,"message":"Operation successful","data":{}}
    Properties:
    • code
      integer
      Code
      Response status code
      Example: 200
    • message
      string
      Required
      Message
      Response message
      Example: "Operation successful"
    • data
      mixed
      Data
      Response data
      Example: {}

ValidationError

ValidationError
  • object
    Example: {"loc":["string"],"msg":"string","type":"string"}
    Properties:
    • loc
      array
      Required
      Location
      Example: ["string"]
      Items:
      • mixed
        Example: "string"
    • msg
      string
      Required
      Message
      Example: "string"
    • type
      string
      Required
      Error Type
      Example: "string"