创建用户人设

提示

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

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

createPersona

新建 persona_name 用户人设, 内容为 persona

createPersona

function createPersona(
  persona_name: Exclude<string, 'current'>,
  persona?: PartialDeep<Persona>,
  options?: ReplacePersonaOptions,
): Promise<boolean>;

参数

persona_name

• 类型: string
• 描述: 用户人设名称

persona

• 类型: PartialDeep<Persona>
• 描述: 用户人设数据; 不填则使用默认头像和默认描述设置

options?

一个可选的配置对象, 包含以下属性:

• render: debounced|immediate|none
  • 酒馆网页应该防抖渲染 (debounced)、立即渲染 (immediate) 还是不刷新前端显示 (none)? 默认为性能更好的防抖渲染

返回值

• 是否成功创建: boolean; 如果已经存在同名用户人设、同唯一 id 用户人设或尝试创建名为 'current' 的用户人设会失败

异常

• 如果访问后端失败, 将会抛出异常

createOrReplacePersona

创建或替换名为 persona_name 的用户人设, 内容为 persona

function createOrReplacePersona(
  persona_name: Exclude<string, 'current'>,
  persona?: PartialDeep<Persona>,
  options?: ReplacePersonaOptions,
): Promise<boolean>;

参数

persona_name

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

persona

• 类型: PartialDeep<Persona>
• 描述: 用户人设数据; 不填则使用默认头像和默认描述设置

options?

一个可选的配置对象, 包含以下属性:

• render: debounced|immediate|none
  • 酒馆网页应该防抖渲染 (debounced)、立即渲染 (immediate) 还是不刷新前端显示 (none)? 默认为性能更好的防抖渲染

返回值

• 是否成功创建或替换: boolean; 如果发生创建, 则返回 true; 如果发生替换, 则返回 false

异常

• 如果用户人设名称不唯一, 将会抛出异常
• 如果访问后端失败, 将会抛出异常