novelai-bot/docs/config.md
2023-06-19 01:46:41 +08:00

6.7 KiB

配置项

登录设置

type

  • 类型:'login' | 'token' | 'naifu' | 'sd-webui' | 'stable-horde'
  • 默认值:'token'

登录方式。login 表示使用账号密码登录,token 表示使用授权令牌登录。naifusd-webuistable-horde 对应着其他类型的后端。

email

  • 类型:string
  • typelogin 时必填

你的账号邮箱。

password

  • 类型:string
  • typelogin 时必填

你的账号密码。

token

  • 类型:string
  • typetoken 时必填

授权令牌。获取方式如下:

  1. 在网页中登录你的 NovelAI 账号
  2. 打开控制台 (F12),并切换到控制台 (Console) 标签页
  3. 输入下面的代码并按下回车运行
console.log(JSON.parse(localStorage.session).auth_token)
  1. 输出的字符串就是你的授权令牌

endpoint

  • 类型:string
  • 默认值:'https://api.novelai.net'
  • typenaifusd-webui 时必填

API 服务器地址。如果你搭建了私服,可以将此项设置为你的服务器地址。

headers

  • 类型:Dict<string>
  • 默认值:官服的 RefererUser-Agent

要附加的额外请求头。如果你的 endpoint 是第三方服务器,你可能需要设置正确的请求头,否则请求可能会被拒绝。

trustedWorkers

  • 类型: boolean
  • 默认值: false
  • typestable-horde 时可选

是否只请求可信任工作节点。

pollInterval

  • 类型: number
  • 默认值: 1000
  • typestable-horde 时可选

轮询进度间隔时长。单位为毫秒。

参数设置

model

  • 类型:'safe' | 'nai' | 'furry'
  • 默认值:'nai'

默认的生成模型。

sampler

  • 类型:'k_euler_ancestral' | 'k_euler' | 'k_lms' | 'plms' | 'ddim'
  • 默认值:'k_euler_ancestral'

默认的采样器。

scale

  • 类型:number
  • 默认值:11

默认对输入的服从度。

textSteps

  • 类型:number
  • 默认值:28

文本生图时默认的迭代步数。

imageSteps

  • 类型:number
  • 默认值:50

以图生图时默认的迭代步数。

maxSteps

  • 类型:number
  • 默认值:64

允许的最大迭代步数。

strength

  • 类型:number
  • 默认值:0.7
  • 取值范围:(0, 1]

默认的重绘强度。

resolution

  • 类型:'portrait' | 'square' | 'landscape' | { width: number, height: number }
  • 默认值:'portrait'

默认生成的图片尺寸。

maxResolution

  • 类型:number
  • 默认值:1024

允许生成的宽高最大值。

输入设置

basePrompt

  • 类型: string
  • 默认值: 'masterpiece, best quality'

所有请求的附加标签。默认值相当于网页版的「Add Quality Tags」功能。

negativePrompt

  • 类型: string
  • 默认值:
    nsfw, lowres, bad anatomy, bad hands, text, error, missing fingers,
    extra digit, fewer digits, cropped, worst quality, low quality,
    normal quality, jpeg artifacts, signature, watermark, username, blurry
    

所有请求附加的负面标签。默认值相当于网页版的「Low Quality + Bad Anatomy」排除。

forbidden

  • 类型:string
  • 默认值:''

违禁词列表。请求中的违禁词将会被自动删除。

违禁词语法与关键词类似,使用逗号隔开英文单词。由于它只用于过滤输入,因此不接受影响因子和要素混合等高级语法。默认情况下,每个违禁词均采用模糊匹配,即只要输入的某个关键词中包含任何一个违禁词作为子串,就会被自动删除。如果要使用精确匹配,可以在词尾加上 !。例如 sex! 仅会过滤 sex toys 而不过滤 sexy girl

默认情况下本插件不设违禁词。对于想要禁用 nsfw 内容的用户,下面的违禁词表可供参考:

guro, nipple, anal, anus, masturbation, sex!, rape, fuck,
dick, testis, nude, nake, cum, nudity, virgina, penis, nsfw,
topless, ass, bdsm, footjob, handjob, fellatio, deepthroat,
cum, ejaculation, bukkake, orgasm, pussy, bloody

placement

  • 类型:'before' | 'after'
  • 默认值:'after'

默认附加标签相对用户输入的摆放位置。

设置为 before 意味着默认标签拥有更高的优先级 (如果希望与 NovelAI 官网行为保持一致,推荐这个选项),而设置为 after 将允许用户更高的创作自由度。

before 模式下,用户仍然可以通过 -O, --override 选项手动忽略默认标签;而在 after 模式下,用户仍然可以通过将基础标签写在前面的方式手动提高基础标签的优先级。

translator

  • 类型:boolean
  • 默认值:true

是否启用自动翻译。安装任意 翻译插件 后即可自动将用户输入转换为英文。

latinOnly

  • 类型:boolean
  • 默认值:false

是否只接受英文单词。启用后将对于非拉丁字母的输入进行错误提示。

::: tip 自动翻译 会转化用户输入,因此不建议与此选项同时启用。 :::

maxWords

  • 类型:number
  • 默认值:0

用户输入的最大词数 (设置为 0 时无限制)。下面是一些细节设定:

  • 这个配置项限制的是词数而不是标签数或字符数 (girl, pleated skirt 的词数为 3)
  • 正向标签和反向标签分别计数,每种均不能超出此限制,但总词数可以达到限制的两倍
  • 如果开启了 自动翻译,此限制将作用于翻译后的结果
  • 默认附加的正向和反向标签均不计入此限制

高级设置

output

  • 类型:'minimal' | 'default' | 'verbose'
  • 默认值:'default'

输出方式。minimal 表示只发送图片,default 表示发送图片和关键信息,verbose 表示发送全部信息。

allowAnlas

  • 类型:boolean | number
  • 默认值:true

是否启用高级功能。高级功能包括:

  • 以图生图相关功能
  • -r, --resolution 选项中,手动指定具体宽高
  • -O, --override 选项
  • -t, --steps 选项
  • -n, --noise 选项
  • -N, --strength 选项

当设置为数字时,表示使用上述功能所需的最低权限等级。

requestTimeout

  • 类型:number
  • 默认值:30000

当请求超过这个时间时会中止并提示超时。

maxRetryCount

  • 类型:number
  • 默认值:3

连接失败时最大的重试次数。

maxIterations

  • 类型:number
  • 默认值:1

允许的最大绘制次数。参见 批量生成

maxConcurrency

  • 类型:number
  • 默认值:0

单个频道下的最大并发数量 (设置为 0 以禁用此功能)。