diff --git a/en/.doctrees/docs/api.doctree b/en/.doctrees/docs/api.doctree index c524e51c..a91c6e2b 100644 Binary files a/en/.doctrees/docs/api.doctree and b/en/.doctrees/docs/api.doctree differ diff --git a/en/.doctrees/environment.pickle b/en/.doctrees/environment.pickle index 9e1ae4c9..774db87c 100644 Binary files a/en/.doctrees/environment.pickle and b/en/.doctrees/environment.pickle differ diff --git a/en/.doctrees/index.doctree b/en/.doctrees/index.doctree index a25d71ac..278cb63b 100644 Binary files a/en/.doctrees/index.doctree and b/en/.doctrees/index.doctree differ diff --git a/en/.doctrees/memoryscope.constants.common_constants.doctree b/en/.doctrees/memoryscope.constants.common_constants.doctree index 8596ab50..3545e2ac 100644 Binary files a/en/.doctrees/memoryscope.constants.common_constants.doctree and b/en/.doctrees/memoryscope.constants.common_constants.doctree differ diff --git a/en/.doctrees/memoryscope.constants.doctree b/en/.doctrees/memoryscope.constants.doctree index 0c255212..575eb27a 100644 Binary files a/en/.doctrees/memoryscope.constants.doctree and b/en/.doctrees/memoryscope.constants.doctree differ diff --git a/en/.doctrees/memoryscope.constants.language_constants.doctree b/en/.doctrees/memoryscope.constants.language_constants.doctree index fb7ab191..719004d8 100644 Binary files a/en/.doctrees/memoryscope.constants.language_constants.doctree and b/en/.doctrees/memoryscope.constants.language_constants.doctree differ diff --git a/en/.doctrees/memoryscope.enumeration.action_status_enum.doctree b/en/.doctrees/memoryscope.enumeration.action_status_enum.doctree index f3607c82..22a12181 100644 Binary files a/en/.doctrees/memoryscope.enumeration.action_status_enum.doctree and b/en/.doctrees/memoryscope.enumeration.action_status_enum.doctree differ diff --git a/en/.doctrees/memoryscope.enumeration.doctree b/en/.doctrees/memoryscope.enumeration.doctree index 02517bfa..cd89d878 100644 Binary files a/en/.doctrees/memoryscope.enumeration.doctree and b/en/.doctrees/memoryscope.enumeration.doctree differ diff --git a/en/.doctrees/memoryscope.enumeration.language_enum.doctree b/en/.doctrees/memoryscope.enumeration.language_enum.doctree index da8daca3..8b83080c 100644 Binary files a/en/.doctrees/memoryscope.enumeration.language_enum.doctree and b/en/.doctrees/memoryscope.enumeration.language_enum.doctree differ diff --git a/en/.doctrees/memoryscope.enumeration.memory_type_enum.doctree b/en/.doctrees/memoryscope.enumeration.memory_type_enum.doctree index 27688556..2d59095f 100644 Binary files a/en/.doctrees/memoryscope.enumeration.memory_type_enum.doctree and b/en/.doctrees/memoryscope.enumeration.memory_type_enum.doctree differ diff --git a/en/.doctrees/memoryscope.enumeration.message_role_enum.doctree b/en/.doctrees/memoryscope.enumeration.message_role_enum.doctree index e5d84fd0..7da33140 100644 Binary files a/en/.doctrees/memoryscope.enumeration.message_role_enum.doctree and b/en/.doctrees/memoryscope.enumeration.message_role_enum.doctree differ diff --git a/en/.doctrees/memoryscope.enumeration.model_enum.doctree b/en/.doctrees/memoryscope.enumeration.model_enum.doctree index c9cd6d18..aefce610 100644 Binary files a/en/.doctrees/memoryscope.enumeration.model_enum.doctree and b/en/.doctrees/memoryscope.enumeration.model_enum.doctree differ diff --git a/en/.doctrees/memoryscope.enumeration.store_status_enum.doctree b/en/.doctrees/memoryscope.enumeration.store_status_enum.doctree index f050062f..709f9c4f 100644 Binary files a/en/.doctrees/memoryscope.enumeration.store_status_enum.doctree and b/en/.doctrees/memoryscope.enumeration.store_status_enum.doctree differ diff --git a/en/README.html b/en/README.html index 01e5d64b..ee18bc3e 100644 --- a/en/README.html +++ b/en/README.html @@ -77,7 +77,15 @@
+from enum import Enum
+
+
+[docs]class ActionStatusEnum(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"
+
+from enum import Enum
+
+
+[docs]class LanguageEnum(str, Enum):
+ """
+ An enumeration representing supported languages.
+
+ Members:
+ - CN: Represents the Chinese language.
+ - EN: Represents the English language.
+ """
+ CN = "cn"
+
+ EN = "en"
+
+from enum import Enum
+
+
+[docs]class MemoryTypeEnum(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"
+
+from enum import Enum
+
+
+[docs]class MessageRoleEnum(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" # Represents a message sent by the user.
+
+ ASSISTANT = "assistant" # Represents a response or action performed by an assistant.
+
+ SYSTEM = "system" # Represents system-level messages or actions.
+
+from enum import Enum
+
+
+[docs]class ModelEnum(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"
+
+from enum import Enum
+
+
+
+
MemoryScope API Documentation
-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.
+An enumeration representing supported languages.
+CN: Represents the Chinese language.
EN: Represents the English language.
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.
+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.
+An enumeration representing different types of models used within the system.
+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.
++ | + |
+ | + |
+ |
+ | + |
+ |
+ |
+ |
+ | + |
+ | + |
+ |
+ | + |
+ |
+ |
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.
+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.
+Bases: str
, Enum
An enumeration representing supported languages.
+CN: Represents the Chinese language.
EN: Represents the English language.
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.
+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.
+Bases: str
, Enum
An enumeration representing different types of models used within the system.
+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.
+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.
+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.
+Bases: str
, Enum
An enumeration representing different types of models used within the system.
+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.
++ m | ||
+ |
+ memoryscope | + |
+ |
+ memoryscope.constants | + |
+ |
+ memoryscope.constants.common_constants | + |
+ |
+ memoryscope.constants.language_constants | + |
+ |
+ memoryscope.enumeration | + |
+ |
+ memoryscope.enumeration.action_status_enum | + |
+ |
+ memoryscope.enumeration.language_enum | + |
+ |
+ memoryscope.enumeration.memory_type_enum | + |
+ |
+ memoryscope.enumeration.message_role_enum | + |
+ |
+ memoryscope.enumeration.model_enum | + |
+ |
+ memoryscope.enumeration.store_status_enum | + |
© Copyright 2024, Alibaba Tongyi Lab.
+© 版权所有 2024, Alibaba Tongyi Lab。
+
+from enum import Enum
+
+
+[文档]class ActionStatusEnum(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"
+
© 版权所有 2024, Alibaba Tongyi Lab。
+
+from enum import Enum
+
+
+[文档]class LanguageEnum(str, Enum):
+ """
+ An enumeration representing supported languages.
+
+ Members:
+ - CN: Represents the Chinese language.
+ - EN: Represents the English language.
+ """
+ CN = "cn"
+
+ EN = "en"
+
© 版权所有 2024, Alibaba Tongyi Lab。
+
+from enum import Enum
+
+
+[文档]class MemoryTypeEnum(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"
+
© 版权所有 2024, Alibaba Tongyi Lab。
+
+from enum import Enum
+
+
+[文档]class MessageRoleEnum(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" # Represents a message sent by the user.
+
+ ASSISTANT = "assistant" # Represents a response or action performed by an assistant.
+
+ SYSTEM = "system" # Represents system-level messages or actions.
+
© 版权所有 2024, Alibaba Tongyi Lab。
+
+from enum import Enum
+
+
+[文档]class ModelEnum(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"
+
© 版权所有 2024, Alibaba Tongyi Lab。
+
+from enum import Enum
+
+
+
+
© 版权所有 2024, Alibaba Tongyi Lab。
+MemoryScope API 接口文档
-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.
+An enumeration representing supported languages.
+CN: Represents the Chinese language.
EN: Represents the English language.
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.
+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.
+An enumeration representing different types of models used within the system.
+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.
++ | + |
+ | + |
+ | + |
+ | + |
+ | + |
+ | + |
+ | + |
+ | + |
+ | + |
+ | + |
+ | + |
+ | + |
+ | + |
基类: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.
+基类: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.
+基类:str
, Enum
An enumeration representing supported languages.
+CN: Represents the Chinese language.
EN: Represents the English language.
基类: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.
+基类: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.
+基类:str
, Enum
An enumeration representing different types of models used within the system.
+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.
+基类: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.
+基类: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.
+基类:str
, Enum
An enumeration representing different types of models used within the system.
+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.
++ m | ||
+ |
+ memoryscope | + |
+ |
+ memoryscope.constants | + |
+ |
+ memoryscope.constants.common_constants | + |
+ |
+ memoryscope.constants.language_constants | + |
+ |
+ memoryscope.enumeration | + |
+ |
+ memoryscope.enumeration.action_status_enum | + |
+ |
+ memoryscope.enumeration.language_enum | + |
+ |
+ memoryscope.enumeration.memory_type_enum | + |
+ |
+ memoryscope.enumeration.message_role_enum | + |
+ |
+ memoryscope.enumeration.model_enum | + |
+ |
+ memoryscope.enumeration.store_status_enum | + |
© 版权所有 2024, Alibaba Tongyi Lab。
+