sessionprompt

package
v2.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 4, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package sessionprompt 渲染「唤醒词」:把一个会话叫醒、或让一个新的智能体接上这个会话时,交给智能体的那段文字 (#232 D3、#233,决策 D-376)。

过去这段文字有几处各自生成:非交互续聊、非交互新开对话、网页新建会话时给用户转发的启动提示词, 原来还有一处——键入终端的守护唤醒,它随会话守护一起下线了(#245)。 它们各认各的变量(有的只认 %workflow)、各带各的默认正文,所以智能体醒来后常常要先自己理解一遍现状才能开工。 这个包是统一的渲染器:同一套变量(只增不减,老变量含义不变;唯一的例外见 VarList)、同一套清洗规则、同一份内置默认模板; 「现状」类变量(未读条数、未完成任务、检查点的下一步……)由调用方在发出的那一刻现算好填进 Vars。

本包只做纯文本的渲染:不读库、不依赖任何别的业务包,所以几个调用点与预览接口可以共用,也便于单测。

Index

Constants

View Source
const (
	// TemplateMaxRunes 是一份模板(会话自有、全局覆盖、预设正文)的字数上限,按字符数。
	TemplateMaxRunes = 1500

	// None 是取不到的「现状」变量的替换文字:唤醒不能因为某个变量取不到而被阻断。
	None = "(暂无)"
	// NotSet 是没有设置常驻规则时 %resident 的替换文字。
	NotSet = "(未设置)"
)

Variables

This section is empty.

Functions

func Builtin

func Builtin(kind Kind, hasWorkflow bool) string

Builtin 返回某类唤醒词的内置默认模板(带 %变量,未渲染)。 hasWorkflow 为 false(预设没配工作流、或编号不能写进提示词)时,续聊的默认模板去掉点名工作流的整行, 免得出现「工作流 ()」之类的残句;新开对话本来就必须带工作流编号,没有工作流时与升级前一样原样渲染。 网页启动提示词(KindWebStart)的默认正文由 store.WebWorkflowStartPrompt 生成(它要按「有没有绑定目录」分支),这里返回空串。

func NeedsState

func NeedsState(tpl string) bool

NeedsState 回答模板有没有引用要查库才能知道的变量;没有就不必为渲染付查询的代价(升级前的自定义正文大多只用编号)。

func OneLine

func OneLine(s string) string

OneLine 把一段文字压成一行:控制字符与换行变空格,连续空白压成一个,去首尾。 续聊与新开对话的提示词最终是命令行里的一个参数,不能含换行(headlessCmd 会拒绝),所以渲染后统一压成一行。

func Render

func Render(tpl string, v Vars) string

Render 把模板里的 %变量 换成 v 里的值。

规则:

  • 单遍扫描:变量值里即使出现 %xxx(比如任务标题),也不会被再次展开——标题里的内容不会变成「指令」;
  • 不认识的 %xxx 原样保留,所以老正文里的百分号文字照常;
  • 所有变量值先清洗(去控制字符、压缩空白、限长),Resident 之外都压成一行;
  • 整段结果有硬上限,超出截断并注明。

Types

type Kind

type Kind string

Kind 是唤醒词的类型;不同类型的内置默认模板不同。

const (
	// KindResume 是非交互续聊:在主机上无人值守地继续一个已有的会话(启动器预设「非交互续聊」)。
	KindResume Kind = "resume"
	// KindNew 是非交互新开对话:全新的对话,要先带着工作流编号接入(启动器预设的「新开对话」)。
	KindNew Kind = "new"
	// KindWebStart 是网页新建会话时给用户转发的启动提示词(用户把它贴给智能体)。
	KindWebStart Kind = "web_start"
)

func (Kind) Label

func (k Kind) Label() string

Label 是类型的中文名(界面与错误提示用)。

func (Kind) Valid

func (k Kind) Valid() bool

Valid 判断是不是认识的类型。

type VarInfo

type VarInfo struct {
	Name string `json:"name"`           // 不含 %
	Desc string `json:"desc"`           // 一句话说明
	Live bool   `json:"live,omitempty"` // 「现状」变量:发出那一刻由 Hub 现算
}

VarInfo 描述一个变量,给界面(变量清单)与手册用。

func VarList

func VarList() []VarInfo

VarList 返回全部变量,顺序即界面显示顺序。**只增不减**:老变量的名字与含义永远不变。 唯一的例外:%n(第几次唤醒)、%max(唤醒次数上限)、%reason(唤醒原因)三个只有键入唤醒用的变量, 随键入唤醒一起删了(#245);老模板正文里残留的 %n / %max / %reason 不再替换,原样保留。

type Vars

type Vars struct {
	Workflow string // %workflow 工作流编号
	Title    string // %title 工作流标题
	Project  string // %project 项目目录
	Host     string // %host 主机名
	Mode     string // %mode 异步 / 同步
	Auth     string // %auth 授权档位名
	Phase    string // %phase 当前阶段
	Resident string // %resident 会话常驻规则全文
	Inbox    string // %inbox 未读追加条数(文字,如「3」)
	Tasks    string // %tasks 未完成任务(如「3 个(#2 #3 #5)」)
	Next     string // %next 最近一次检查点的第一条「下一步」
	Anchor   string // %anchor 最近一次交付锚点(提交哈希 + 标题)

	Limit string // %limit 本次运行的最长运行时间提醒(只有预设运行才有,其他场合为空)
}

Vars 是渲染一段唤醒词用到的全部变量值。调用方负责取值;本包只做清洗与替换。 空字符串表示「取不到」:身份类变量(Workflow / Title / Project / Host)渲染成空, 状态类变量(Mode / Auth / Phase / Inbox / Tasks / Next / Anchor)渲染成「(暂无)」,Resident 渲染成「(未设置)」。

func SampleVars

func SampleVars() Vars

SampleVars 是界面预览用的示例值:没选具体会话时(比如在全局设置里编辑模板),用它让用户看到变量大致会变成什么样。

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL