五分钟掌握大模型定制实务-生成文档草稿

五分钟掌握大模型定制实务-生成文档草稿

文章图片









Oxygen 编辑器提供了大模型服务 , 除此之外 , 关键的优势之一是其内置的大模型定制操作的能力 。 为了实现定制 , 例如“生成文档草稿” , 主要的依据是 Oxygen 提供的 Schema 。 此 Schema 描述了一个用于定义操作(action)的结构以便在特定条件下执行某些操作 。
以下是对该 Schema 的解释以及如何应用的示例说明:
Schema 结构解释1. 基本结构- `type`: 定义为一个对象 , 表示整个 schema 描述的是一个 JSON 对象 。
- `uniqueItems`: 设置为 true , 确保数组中的每个项目都是唯一的 。
2. 属性(properties)- `id`: 字符串类型 , 表示动作的唯一标识符 。
- `title`: 字符串类型 , 表示动作在按钮或菜单项上显示的名称 。
【五分钟掌握大模型定制实务-生成文档草稿】- `short-description`: 字符串类型 , 提供动作的简短描述 。
- `description`: 字符串类型 , 提供动作的详细描述 , 通常用作工具提示 。
- `categoryId`: 字符串类型 , 表示动作的类别 , 相同类别的动作会被视觉上分组 。
- `type`: 枚举类型 , 定义动作的类型 , 例如生成文档草稿、基于图像更新文档等 。
- `framework`: 字符串类型 , 表示与动作相关的框架模式或内容类型 。
- `input-type`: 枚举类型 , 描述发送到平台的文档内容应如何处理(标记或纯文本) 。
- `insert-modes`: 引用定义 , 描述在 XML 文档中插入内容的位置 。
- `context`: 字符串类型 , 定义动作中的提示 , 可能包含动态扩展的参数 。
- `expand-params`: 引用定义 , 定义应在上下文内容中扩展的参数值 。
- `examples`: 引用定义 , 提供提示的附加示例 。
- `parameters`: 引用定义 , 用于动作的高级配置参数 。
- `quick-assist`: 布尔类型 , 指示该动作是否可作为快速辅助使用 。
- `embed-assist`: 布尔类型 , 指示该动作是否可在编辑器中作为嵌入按钮使用 。
3. 必需字段(required)- `id` `title` `type` `context` 是必需字段 , 确保每个动作都有唯一标识、名称、类型和上下文 。
4. 定义(definitions)- `insert-modes_type`: 描述插入模式的数组 , 定义了 XPath 条件、目标位置和插入类型 。
- `examples_type`: 描述提示示例的数组 , 包含用户提示和助手完成响应的示例 。
- `expand-params_type`: 描述参数扩展的数组 , 定义参数名称、值、标签和选择类型 。
- `parameters_type`: 描述动作的高级配置参数 , 包括引擎名称、温度、最大令牌数等 。
应用示例假设我们要定义一个动作 , 用于生成文档草稿 , 以下是一个示例 JSON 对象:
{\"id\": \"action-001\"\"title\": \"Generate Documentation Draft\"\"short-description\": \"Creates a draft document from XML data.\"\"description\": \"This action uses XML-based data to generate a comprehensive documentation draft.\"\"categoryId\": \"documentation\"\"type\": \"generate-documentation-draft\"\"framework\": \"DITA*\"\"input-type\": \"markup\"\"context\": \"Generate a draft using the provided XML data.\"\"quick-assist\": true\"embed-assist\": false\"parameters\": {\"engine\": {\"name\": \"default-engine\"\"temperature\": 0.7\"max_tokens\": 1500在这个示例中:
- `id` 是动作的唯一标识符 。
- `title` 和 `short-description` 提供了动作的名称和简短描述 。
- `description` 提供了详细的动作说明 。
- `type` 指定了动作的类型为生成文档草稿 。
- `framework` 指定了与 DITA 相关的框架 。
- `input-type` 指定内容处理为标记 。
- `context` 提供了生成草稿的上下文提示 。
- `parameters` 包含了动作的高级配置 , 如引擎名称和响应的随机性(temperature) 。


结果当定制指令符合 SCHEMA 时 , 用户可以获得自定义的大模型操作 , 如下图示:





    推荐阅读