memoryscope.enumeration

class memoryscope.enumeration.ActionStatusEnum(value)[source]

Bases: str, Enum

Enumeration representing various statuses of a memory node.

Each status reflects a different state of the node in terms of its lifecycle or content: - NEW: Indicates a newly created node. - MODIFIED: Signifies that the node has been altered. - CONTENT_MODIFIED: Specifies changes in the actual content of the node. - NONE: do nothing. - DELETE: delete memories.

NEW = 'new'
MODIFIED = 'modified'
CONTENT_MODIFIED = 'content_modified'
NONE = 'none'
DELETE = 'delete'
class memoryscope.enumeration.LanguageEnum(value)[source]

Bases: str, Enum

An enumeration representing supported languages.

Members:
  • CN: Represents the Chinese language.

  • EN: Represents the English language.

CN = 'cn'
EN = 'en'
class memoryscope.enumeration.MemoryTypeEnum(value)[source]

Bases: str, Enum

Defines an enumeration for different types of memory categories.

Each member represents a distinct type of memory content: - CONVERSATION: Represents conversation-based memories. - OBSERVATION: Denotes observational memories. - INSIGHT: Indicates insightful memories derived from analysis. - OBS_CUSTOMIZED: Customized observational memories.

CONVERSATION = 'conversation'
OBSERVATION = 'observation'
INSIGHT = 'insight'
OBS_CUSTOMIZED = 'obs_customized'
class memoryscope.enumeration.MessageRoleEnum(value)[source]

Bases: str, Enum

Enumeration for different message roles within a conversation context.

This enumeration includes predefined roles such as User, Assistant, and System, which can be used to categorize messages in chat interfaces, AI interactions, or any system that involves distinct participant roles.

USER = 'user'
ASSISTANT = 'assistant'
SYSTEM = 'system'
class memoryscope.enumeration.ModelEnum(value)[source]

Bases: str, Enum

An enumeration representing different types of models used within the system.

Members:

GENERATION_MODEL: Represents a model responsible for generating content. EMBEDDING_MODEL: Represents a model tasked with creating embeddings, typically used for transforming data into a

numerical form suitable for machine learning tasks.

RANK_MODEL: Denotes a model that specializes in ranking, often used to order items based on relevance.

GENERATION_MODEL = 'generation_model'
EMBEDDING_MODEL = 'embedding_model'
RANK_MODEL = 'rank_model'
class memoryscope.enumeration.StoreStatusEnum(value)[source]

Bases: str, Enum

An enumeration.

VALID = 'valid'
EXPIRED = 'expired'