Skip to content

Commit 7f3c87b

Browse files
lightislostlightislost
committed
update coagent docs
1 parent 261db48 commit 7f3c87b

File tree

91 files changed

+11643
-505
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+11643
-505
lines changed

‎content/en/coagent/overview/prompt-manager.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
title: Prompt Manager
3+
slug: Prompt Manager
4+
url: "coagent/prompt-manager"
5+
aliases:
6+
- "/coagent/prompt-manager"
7+
---
8+
9+
10+
### 提示管理器（Prompt Manager）
11+
管理多智能体链路中的prompt创建
12+
- 快速配置：采用预设的处理函数，用户仅需通过定义智能体的输入输出即可轻松配置，实现多智能体的prompt快速组装和配置。
13+
- 自定义支持：允许用户自定义prompt内部各模块的处理逻辑，以达到个性化的智能体prompt实现。
14+
15+
### Prompt预设模板结构
16+
17+
- Agent Profile：此部分涉及到智能体的基础描述，包括但不限于代理的类型、功能和指令集。用户可以在这里设置智能体的基本属性，确保其行为与预期相符。
18+
- Context：上下文信息，给智能体做参考，帮助智能体更好的进行决策。
19+
- Tool Information：此部分为智能体提供了一套可用工具的清单，智能体可以根据当前的场景需求从中挑选合适的工具以辅助其执行任务。
20+
- Reference Documents：这里可以包含代理参考使用的文档或代码片段，以便于它在处理请求时能够参照相关资料。
21+
- Session Records：在进行多轮对话时，此部分会记录之前的交谈内容，确保智能体能够在上下文中保持连贯性。
22+
- Response Output Format：用户可以在此设置智能体的输出格式，以确保生成的响应满足特定的格式要求，包括结构、语法等。
23+
- Response：在与智能体的对话中，如果用户希望智能体继续某个话题或内容，可以在此模块中输入续写的上文。例如，在运用REACT模式时，可以在此区域内详细阐述智能体先前的行为和观察结果，以便于智能体构建连贯的后续响应。
24+
25+
### Prompt自定义配置
26+
27+
#### Prompt模块参数
28+
- field_name：唯一的字段名称标识，必须提供。
29+
- function：指定如何处理输入数据的函数，必须提供。
30+
- title：定义模块的标题。若未提供，将自动生成一个标题，该标题通过把字段名称中的下划线替换为空格并将每个单词的首字母大写来构建。
31+
- description：提供模块的简要描述，位于模块最上方（标题下方）。默认为空，可选填。
32+
- is_context：标识该字段是否属于上下文模块的一部分。默认为True，意味着除非显式指定为False，否则都被视为上下文的一部分。
33+
- omit_if_empty：设定当模块内容为空时，是否在prompt中省略该模块，即不显示相应的模板标题和内容。默认为False，意味着即使内容为空也会显示标题。如果希望内容为空时省略模块，需显式设置为True。
34+
35+
#### Prompt配置示例
36+
37+
Prompt配置由一系列定义prompt模块的字典组成，这些模块将根据指定的参数和功能来处理输入数据并组织成一个完整的prompt。
38+
39+
在配置中，每个字典代表一个模块，其中包含相关的参数如 field_name, function_name, is_context, title, description, 和 omit_if_empty，用以控制模块的行为和呈现方式。
40+
41+
context_placeholder 字段用于标识上下文模板的位置，允许在prompt中插入动态内容。
42+
```
43+
[
44+
{"field_name": 'agent_profile', "function_name": 'handle_agent_profile', "is_context": False},
45+
{"field_name": 'context_placeholder', "function_name": '', "is_context": True},
46+
{"field_name": 'tool_information',"function_name": 'handle_tool_data', "is_context": True},
47+
{"field_name": 'reference_documents', "function_name": 'handle_doc_info'},
48+
{"field_name": 'session_records', "function_name": 'handle_session_records'},
49+
{"field_name": 'task_records', "function_name": 'handle_task_records'},
50+
{"field_name": 'output_format', "function_name": 'handle_output_format', 'title': 'Response Output Format', "is_context": False},
51+
{"field_name": 'response', "function_name": 'handle_response', "title"="begin!!!", "is_context": False, "omit_if_empty": False}
52+
]
53+
```
54+
55+
### 未来规划
56+
57+
#### Prompt配置简化
58+
59+
未来的Prompt配置简化旨在降低用户面对复杂配置的难度。通过引入更直观的配置方法，我们计划使得Prompt配置不仅对高级用户友好，还能让初学者轻松上手。简化计划可能包括：
60+
61+
- 预设配置短语：将复杂的配置字典转换为简洁的短语，每个短语都预定义了一个Prompt模块。用户将能够使用简单的字符串指令来快速配置Prompt，而无需深入了解所有参数。
62+
- 配置校验和建议：增加配置的即时校验，如果检测到配置错误或不一致性，自动提供修改建议，帮助用户优化Prompt结构。
63+
64+
#### 动作（Action）注册的改进计划
65+
66+
在现行系统中，智能体必须在其角色提示（role prompt）内定义所有的动作（actions）。这意味着智能体需要同时处理动作的意图识别和生成动作所需的输入数据，这一过程对语言模型的理解和推理能力提出了更高要求。
67+
68+
为了优化这一流程，我们打算在后续版本中对动作的输入生成和执行进行模块化。这将使智能体的工作重点转移至判断当前情境下应执行哪些动作，而不必负责具体的操作指令。在这种新的架构下，当需要执行某个动作时，将有专门的机制负责生成相应动作的具体输入指令。
69+
70+
这种分离将显著降低单个模块的复杂性，使得整个系统更加灵活、易于扩展，同时也提升了动作执行的效率和准确性。

‎content/zh/coagent/overview/prompt-manager.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
title: Prompt 管理器
3+
slug: Prompt 管理器
4+
url: "coagent/prompt-管理器"
5+
aliases:
6+
- "/coagent/prompt-管理器"
7+
- "/coagent/prompt-manager-zh"
8+
---
9+
10+
111
### 提示管理器（Prompt Manager）
212
管理多智能体链路中的prompt创建
313
- 快速配置：采用预设的处理函数，用户仅需通过定义智能体的输入输出即可轻松配置，实现多智能体的prompt快速组装和配置。

‎data/en/coagent/sidebar.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22
pages:
33
- title: CoAgent Overview
44
- title: Agent Flow
5+
- title: Prompt Manager
56
- title: Quick Start
67

8+
79
- title: Modules
810
pages:
911
- title: Connector-Agent

‎data/zh/coagent/sidebar.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
pages:
44
- title: CoAgent 概览
55
- title: Agent 编排
6+
- title: Prompt 管理器
67
- title: 快速开始
78

89
- title: Connector

‎docs/coagent/agent-flow-zh/index.html‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!DOCTYPE html>
2+
<html lang="en-CN">
3+
<head>
4+
<title>/zh/coagent/agent-%E7%BC%96%E6%8E%92/</title>
5+
<link rel="canonical" href="/zh/coagent/agent-%E7%BC%96%E6%8E%92/">
6+
<meta name="robots" content="noindex">
7+
<meta charset="utf-8">
8+
<meta http-equiv="refresh" content="0; url=/zh/coagent/agent-%E7%BC%96%E6%8E%92/">
9+
</head>
10+
</html>

0 commit comments

Comments
 (0)