修改用户人设

提示

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

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

replacePersona

完全替换 persona_id 用户人设的内容为 persona

replacePersona

function replacePersona(
  persona_id: LiteralUnion<'current', string>,
  persona: PartialDeep<Persona>,
  options?: ReplacePersonaOptions,
): Promise<void>;

ReplacePersonaOptions

type ReplacePersonaOptions = {
  /** 酒馆网页应该防抖渲染 persona 管理列表 (debounced)、立即渲染 (immediate) 还是不刷新前端显示 (none)? 默认为防抖渲染 */
  render?: 'debounced' | 'immediate' | 'none';
};

参数

persona_id

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

persona

• 类型: PartialDeep<Persona>
• 描述: 用户人设内容

options?

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

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

异常

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

示例

修改用户人设的描述

const persona = getPersona('玩家');
persona.description = '新的玩家描述';
await replacePersona('玩家', persona);

updatePersonaWith

用 updater 函数更新 persona_id 用户人设

updatePersonaWith

function updatePersonaWith(
  persona_id: LiteralUnion<'current', string>,
  updater: PersonaUpdater,
  options?: ReplacePersonaOptions,
): Promise<Persona>;

PersonaUpdater

type PersonaUpdater = ((persona: Persona) => Persona) | ((persona: Persona) => Promise<Persona>);

参数

persona_id

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

updater

• 类型: PersonaUpdater
• 描述: 用于更新用户人设的函数. 它应该接收用户人设内容作为参数, 并返回更新后的用户人设内容.

options?

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

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

返回值

• 更新后的用户人设内容: Persona

异常

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

示例

修改用户人设的旁白显示标题

await updatePersonaWith('玩家', persona => {
  persona.title = '旁白显示标题';
  return persona;
});