酒馆助手

Appearance

获取用户人设 ​

提示

请务必先阅读如何正确使用酒馆助手

点击查看对应类型定义文件 (可发给 AI 或 IDE 使用, 酒馆助手界面中提供了打包下载)

getPersonaNames ​

获取用户人设 (persona) 名称列表

ts
function getPersonaNames(): string[];

返回值 ​

  • 用户人设名称列表: string[]

getPersonaIds ​

获取用户人设唯一 id 列表

ts
function getPersonaIds(): string[];

返回值 ​

  • 用户人设唯一 id 列表: string[]

getCurrentPersonaName ​

ts
function getCurrentPersonaName(): string | null;

返回值 ​

  • 当前用户人设名称: string|null; 如果当前没有用户人设, 则返回 null

getCurrentPersonaId ​

ts
function getCurrentPersonaId(): string | null;

返回值 ​

  • 当前用户人设唯一 id: string|null; 如果当前没有用户人设, 则返回 null

getPersonaAvatarPath ​

获取用户人设的头像路径

ts
function getPersonaAvatarPath(persona_id?: LiteralUnion<'current', string>): string | null;

参数 ​

persona_id ​

  • 类型: string
  • 描述: 用户人设名称、唯一 id 或 'current'; 不填则默认为 'current'

返回值 ​

  • 用户人设头像路径: string | null - 可直接用于 img 标签的 src 属性, 如果用户人设不存在或名称不唯一, 则返回 null

getPersona ​

获取 persona_id 用户人设的内容

ts
function getPersona(persona_id: LiteralUnion<'current', string>): Persona;
ts
type PersonaConnection = {
  type: 'character' | 'group';
  id: string;
};

type Persona = {
  avatar_id: string;
  avatar: `${string}.png` | Blob;
  name: string;
  title: string;
  description: string;
  position: number;
  depth: number;
  role: number;
  lorebook: string;
  connections: PersonaConnection[];
  is_default: boolean;
};

参数 ​

persona_id ​

  • 类型: string
  • 描述: 用户人设名称、唯一 id 或 'current'

返回值 ​

异常 ​

  • 如果用户人设不存在或名称不唯一, 将会抛出异常