好感度系统 (FavourProAPI)
FavourProAPI 由 FavourPro 插件提供,负责管理机器人对用户的多维度好感度状态。
async def get_user_state(self, user_id: str, session_id: Optional[str] = None) -> Optional[Dict[str, Any]]
获取用户的完整好感度状态。
- 参数:
user_id (str): 用户的唯一ID。session_id (Optional[str]): (可选) 会话ID,用于区分不同场景。
- 返回:
dict或None。成功时返回包含favour,attitude,relationship的字典,如果用户无记录则返回None。
async def add_favour(self, user_id: str, amount: int, session_id: Optional[str] = None)
为指定用户增加或减少好感度。
- 参数:
user_id (str): 用户的唯一ID。amount (int): 要变动的数量。正数为增加,负数为减少。session_id (Optional[str]): (可选) 会话ID。
- 返回: 无。
async def set_favour(self, user_id: str, amount: int, session_id: Optional[str] = None)
[慎用] 直接将用户的好感度设置为一个特定值。
- 参数:
user_id (str): 用户的唯一ID。amount (int): 要设定的目标好感度值。session_id (Optional[str]): (可选) 会话ID。
- 返回: 无。
async def set_attitude(self, user_id: str, attitude: str, session_id: Optional[str] = None)
设置机器人对用户的印象描述。
- 参数:
user_id (str): 用户的唯一ID。attitude (str): 新的印象描述文本。session_id (Optional[str]): (可选) 会话ID。
- 返回: 无。
async def set_relationship(self, user_id: str, relationship: str, session_id: Optional[str] = None)
设置机器人与用户的关系描述。
- 参数:
user_id (str): 用户的唯一ID。relationship (str): 新的关系描述文本。session_id (Optional[str]): (可选) 会话ID。
- 返回: 无。
async def get_favour_ranking(self, limit: int = 10) -> List[Dict[str, Any]]
获取好感度排行榜。
- 参数:
limit (int): (可选) 希望获取的榜单长度,默认为10。
- 返回:
list- 一个由字典组成的列表,每个字典包含user_id和favour。
async def get_dislike_ranking(self, limit: int = 10) -> List[Dict[str, Any]]
[新增] 获取厌恶度排行榜(好感度从低到高排序)。
- 参数:
limit (int): (可选) 希望获取的榜单长度,默认为10。
- 返回:
list- 一个由字典组成的列表,每个字典包含user_id和favour。
