Skip to content

Commit 385b3c7

Browse files
szl97szl97
committed
feat: update api name
1 parent 0928175 commit 385b3c7

6 files changed

Lines changed: 46 additions & 46 deletions

File tree

‎docs/bella-assistants/api/codex-usage.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# 使用codex
22

33
## 介绍
4-
codex是Openai推出的一个强大的code agent。支持chat-completion和response-api两种模式。其中response-api可以更好地适配深度思考和网络搜索工具。
4+
codex是Openai推出的一个强大的code agent。支持chat completions和responses api两种模式。其中responses api可以更好地适配深度思考和网络搜索工具。
55

66
## 特点
77
- 对比Claude Code，其优势主要在GPT-5 high的强大。不过Bella Openapi同样支持GPT-5 high的`/v1/messages`协议，同样适配了GPT-5 high，欢迎尝试切换体验

docs/bella-assistants/api/create-response.md renamed to docs/bella-assistants/api/create-responses.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Response API 完整使用文档
1+
# Responses API 完整使用文档
22

33
## 概述
44

@@ -11,11 +11,11 @@ Response API 是一个轻量、灵活的对话接口，支持多模态输入、
1111
1212
> 文件输入以及file_search工具需要的file-id，以 `purpose`为`assistants`的方式，上传到`file-api`，见 [文件上传](../../bella-knowledge/api/files/upload.md)
1313
14-
## 为什么选择Response API?
14+
## 为什么选择Responses API?
1515

16-
[更好地理解Response API能为你做什么](../why-response-api.md)
16+
[更好地理解Responses API能为你做什么](../why-responses-api)
1717

18-
[如何判断Response API是否适合你？](../when-to-use-response-api.md)
18+
[如何判断Responses API是否适合你？](../when-to-use-responses-api)
1919

2020
## 核心端点
2121

@@ -82,7 +82,7 @@ Response API 是一个轻量、灵活的对话接口，支持多模态输入、
8282

8383
### 3. 多模态输入
8484

85-
Response API支持多种输入模态的组合使用：
85+
Responses API支持多种输入模态的组合使用：
8686
- **文本**（input_text）
8787
- **图片**（input_image）
8888
- **音频**（input_audio）
@@ -987,11 +987,11 @@ API使用标准HTTP状态码：
987987

988988
## API vs Assistant API对比
989989

990-
| 特性 | Response API | Assistant API |
991-
|-----|-------------|---------------|
992-
| 使用场景 | 轻量对话、无状态交互 | 复杂智能体、有状态工作流 |
993-
| 会话管理 | 灵活（可选持久化） | 强制Thread管理 |
994-
| 配置方式 | 每次请求配置 | 预定义Assistant |
995-
| 工具使用 | 即时定义 | 预配置+运行时覆盖 |
996-
| 学习曲线 | 简单直接 | 需要理解Thread概念 |
997-
| 性能 | 更轻量 | 额外管理开销 |
990+
| 特性 | Responses API | Assistant API |
991+
|-----|---------------|---------------|
992+
| 使用场景 | 轻量对话、无状态交互 | 复杂智能体、有状态工作流 |
993+
| 会话管理 | 灵活（可选持久化） | 强制Thread管理 |
994+
| 配置方式 | 每次请求配置 | 预定义Assistant |
995+
| 工具使用 | 即时定义 | 预配置+运行时覆盖 |
996+
| 学习曲线 | 简单直接 | 需要理解Thread概念 |
997+
| 性能 | 更轻量 | 额外管理开销 |

docs/bella-assistants/api/response-api-sdk.md renamed to docs/bella-assistants/api/responses-api-sdk.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Response API SDK使用说明
1+
# Responses API SDK使用说明
22

33
bella-openai4j 库完整支持 OpenAI Response API，包括流式（SSE）和非流式两种模式。
44

@@ -446,7 +446,7 @@ CreateResponseRequest request = CreateResponseRequest.builder()
446446

447447
## 事件处理
448448

449-
Response API 支持丰富的流式事件类型。
449+
Responses API 支持丰富的流式事件类型。
450450

451451
### 主要事件类型
452452

@@ -684,7 +684,7 @@ try {
684684

685685
## 相关链接
686686

687-
- [OpenAI Response API 官方文档](https://platform.openai.com/docs/api-reference/response)
687+
- [OpenAI Responses API 官方文档](https://platform.openai.com/docs/api-reference/response)
688688
- [bella-openai4j GitHub](https://github.com/LianjiaTech/bella-openai4j)
689689
- [更多示例](https://github.com/LianjiaTech/bella-openai4j/blob/main/example/src/main/java/example/ResponseApiExample.java)
690690

docs/bella-assistants/when-to-use-response-api.md renamed to docs/bella-assistants/when-to-use-responses-api.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# 我的Agent服务是否应该使用Response API？
1+
# 我的Agent服务是否应该使用Responses API？
22

33
## 功能性考量——你的Agent需要什么功能
44

5-
判断是否应该选择Response API，最基本的一点，是要看你的服务**目前或未来**是否需要response api的特性。
5+
判断是否应该选择Responses API，最基本的一点，是要看你的服务**目前或未来**是否需要responses api的特性。
66

77
如果不需要，那么继续使用更为简单的chat completions接口，性能会比response api更佳。
88

99
对比Response API，Chat Completions是一个更单纯的接口。可以说Response API涵盖了Chat Completions。
1010

1111
> Chat Completions = 开启非store模式 + 不使用任何内置工具（只使用function call）+ 不使用audio/file input 的 Response API
1212
13-
如果需要使用Response API的功能，也不一定必须要使用Response API，因为Bella的其他能力，比如`Bella-Workflow`同样可以很方便地使用这些工具。我们还要继续思考以下问题。
13+
如果需要使用Responses API的功能，也不一定必须要使用Responses API，因为Bella的其他能力，比如`Bella-Workflow`同样可以很方便地使用这些工具。我们还要继续思考以下问题。
1414

1515
## 智能性考量——考虑用户问题的复杂性
1616

@@ -25,51 +25,51 @@
2525
且解决这些问题可能需要与用户进行多轮交互，不断地修正答案。 此时就应该给模型更大的选择权，通过提示词的引导让模型自主决策下一步该做什么。
2626

2727
**举例**：
28-
- 为Bella Openapi服务实现一个为用户查询账单的Agent，流程非常固定，只需要使用LLM提取用户信息以及用户问题中的查询信息，再调用查询账单的接口。这个场景肯定是使用`Chat Completions + Bella Workflow`最简单，不需要考虑Response API。
29-
- 上文举例的房地产领域的知识专家，就可以考虑使用Response API。再比如实现一个Code Agent，它所需面临的问题可想而知，更不可能使用既定流程解决问题，需要高度的智能化，此时就可以考虑使用Response API来实现。
28+
- 为Bella Openapi服务实现一个为用户查询账单的Agent，流程非常固定，只需要使用LLM提取用户信息以及用户问题中的查询信息，再调用查询账单的接口。这个场景肯定是使用`Chat Completions + Bella Workflow`最简单，不需要考虑Responses API。
29+
- 上文举例的房地产领域的知识专家，就可以考虑使用Responses API。再比如实现一个Code Agent，它所需面临的问题可想而知，更不可能使用既定流程解决问题，需要高度的智能化，此时就可以考虑使用Responses API来实现。
3030

3131

3232
## 服务层级的考量——你的服务的定位是什么
3333
前文已经讨论过，如果去实现一件`需要模型高自由度的自主决策且多轮交互`的事情，此时轻量级的`Chat Completions + Bella Workflow`就没那么好用了。
3434

35-
此时，便可以考虑使用Response API。可是一定需要使用它吗？设想如下两个场景：
35+
此时，便可以考虑使用Responses API。可是一定需要使用它吗？设想如下两个场景：
3636

3737
**场景1**：
3838

3939
你希望快速搭建一个Agent应用做一件比较复杂的事情，或者说你只是想在正式开始做某个领域的Agent之前，临时做一个demo来验证自己的某个想法是否可行。
4040

4141
在此场景下，你当然不希望做一个沉重的系统，你的需求就只是一个低成本的、简洁的、可快速实现核心功能的轻量级服务。对稳定性、性能的要求没那么高。
4242

43-
此时，Response API就完全满足你的需求。直接使用`store`模式，你甚至不需要实现任何的上下文管理工程，只需要简单的接口调用即可实现所有功能。
43+
此时，Responses API就完全满足你的需求。直接使用`store`模式，你甚至不需要实现任何的上下文管理工程，只需要简单的接口调用即可实现所有功能。
4444

45-
甚至`response api`丰富的内置工具生态，可能你不需要实现任何客户端的工具调用，或者是只需要提供一个mcp服务。开发极其简单
45+
甚至`responses api`丰富的内置工具生态，可能你不需要实现任何客户端的工具调用，或者是只需要提供一个mcp服务。开发极其简单
4646

4747
面对此场景时，你可以借助Response API快速做出很多轻量级的应用，去探索AI应用的可能性。它的价值在于帮助你快速落地、快速验证。
4848

4949
**场景2**：
5050

5151
你的服务规模庞大、稳定性、效果要求极高，或是需要很定制化的对话管理。
5252

53-
此时就不建议依赖`store`模式的Response API来实现用户对话的管理。因为Response API归根结底，是一个通用的智能体解决方案，不可能针对所有场景做出足够的优化。
53+
此时就不建议依赖`store`模式的Responses API来实现用户对话的管理。因为Responses API归根结底，是一个通用的智能体解决方案，不可能针对所有场景做出足够的优化。
5454

5555
一个追求泛化的通用智能体，在性能、稳定性和效果方面肯定是不如经过层层优化的垂直领域智能体。
5656

57-
但是如果有功能层面的需求，依然可以使用Response API的`非store`模式来直接使用丰富的工具生态，减少开发成本。
57+
但是如果有功能层面的需求，依然可以使用Responses API的`非store`模式来直接使用丰富的工具生态，减少开发成本。
5858

5959
**小结**：
60-
- 其实服务规模庞大、稳定性、效果要求极高的场景没那么多。Response API，从逻辑上讲，是能cover非常多场景的，但也需要更多的工程落地进一步验证其可行性
60+
- 其实服务规模庞大、稳定性、效果要求极高的场景没那么多。Responses API，从逻辑上讲，是能cover非常多场景的，但也需要更多的工程落地进一步验证其可行性
6161
- 通用智能体的意义可能不在于取代所有智能体，或许它可以作为辅助Agent开发者进行创作的万能助手，再此基础上探索出特定领域更优秀的智能体解决方案
6262

6363
## 可持续发展的考量——考虑未来的发展
6464

65-
Response API所实现的内置工具，是成了Bella服务体系下的各个AI能力点。
65+
Responses API所实现的内置工具，是成了Bella服务体系下的各个AI能力点。
6666

67-
在实现一个复杂的Agent系统时，当然可以使用function call实现自己的自定义工具，而不使用Response API的内置工具。
67+
在实现一个复杂的Agent系统时，当然可以使用function call实现自己的自定义工具，而不使用Responses API的内置工具。
6868

6969
比如调用LLM时最普遍的挂载私有知识库的需求，自行实现一个RAG工具也并非难事。
7070

7171
但是，Bella体系提供的能力服务是会紧随着业界AI能力的发展，不断地进行探索、更新、迭代、优化。
7272

73-
使用Response API可以确保你所依赖的AI能力紧随业界发展，不断进步升级。同时，不需要付出任何维护和学习成本。
73+
使用Responses API可以确保你所依赖的AI能力紧随业界发展，不断进步升级。同时，不需要付出任何维护和学习成本。
7474

75-
而对于业界推出的最新AI能力，Response API也会根据需要持续扩展，可以让你最快地得到最优质、最稳定的使用体验。
75+
而对于业界推出的最新AI能力，Responses API也会根据需要持续扩展，可以让你最快地得到最优质、最稳定的使用体验。

docs/bella-assistants/why-response-api.md renamed to docs/bella-assistants/why-responses-api.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# 为什么选择Response API?
1+
# 为什么选择Responses API?
22

33
## 官方定义
44
> Responses API 是一个用于构建功能强大的代理类应用程序的统一接口。它包含很多内置工具，如：网络搜索，文件搜索，计算机使用，代码解释器和远程MCP。且对文本和图像原生支持支持多模态。
55
6-
Bella Assistant服务对Openai的Response API做了全面地兼容和升级。比如内置工具的全模型支持以及多模态输入的全模型支持等等。并且整合了Bella体系下的各个能力服务，为Agent的搭建提供了强大的支持，让Agent的搭建变得更简单更高效。
6+
Bella Assistant服务对Openai的Responses API做了全面地兼容和升级。比如内置工具的全模型支持以及多模态输入的全模型支持等等。并且整合了Bella体系下的各个能力服务，为Agent的搭建提供了强大的支持，让Agent的搭建变得更简单更高效。
77

88
## 完全覆盖Chat Completions
99
支持chat completions的所有功能以及**全部模型**，非store模式可以理解为功能更丰富的chat completions接口
@@ -14,12 +14,12 @@ Bella Assistant服务对Openai的Response API做了全面地兼容和升级。
1414
## 丰富的多模态输入/输出
1515
- 全模型支持File Input，以 `purpose`为`assistants`的方式，上传到`file-api`后，可以直接使用File Input，LLM将根据文件内容生成响应
1616
- 全模型支持Audio Input，支持直接以语音作为输入
17-
- 兼容chat-completions的图片识别能力，后续会扩展为全模型支持
17+
- 兼容chat completions的图片识别能力，后续会扩展为全模型支持
1818
- 内置生图工具支持图像输出
1919
- 未来会扩展语音输出的能力（敬请期待）
2020

2121
## 强大的内置工具
22-
- 支持集成私有知识库，私有知识的上下文组织是使用LLM的痛点之一，response-api提供了file-search工具，结合`bella-knowledge`使用，让LLM掌握你的私有知识更加简单
22+
- 支持集成私有知识库，私有知识的上下文组织是使用LLM的痛点之一，responses api提供了file-search工具，结合`bella-knowledge`使用，让LLM掌握你的私有知识更加简单
2323
- 支持网络搜索，原生支持web search工具，使用简单，可以减少模型幻觉，让LLM的知识储备可以即时更新
2424
- 支持MCP工具，可以让LLM与应用服务进行交互，获取私有知识或者执行你的既定流程，为LLM提供与外部进行交互的窗口
2525
- MCP工具支持服务调用时的审批操作，保障MCP服务调用的安全性，Client端在实现与用户交互时更方便
@@ -36,8 +36,8 @@ Bella Assistant服务对Openai的Response API做了全面地兼容和升级。
3636
### `非store`模式
3737
- `非store`模式拥有更高的性能和安全性，在response-api的服务端完全不留痕
3838
- 适用于客户端自行管理上下文的场景
39-
- 使用chat-completions搭建的应用可以此模式快速迁移
40-
- 相当于chat-completions的扩展，可使用response-api的全部工具和多模态输入能力
39+
- 使用chat completions搭建的应用可以此模式快速迁移
40+
- 相当于chat completions的扩展，可使用responses api的全部工具和多模态输入能力
4141

4242
## 可重复使用的 `previous_response_id`
4343
- 同一`previous_response_id`支持并发使用/重复使用

‎sidebars.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -94,24 +94,24 @@ const sidebars: SidebarsConfig = {
9494
},
9595
{
9696
type: 'doc',
97-
id: 'bella-assistants/why-response-api',
98-
label: 'Why Response API?',
99-
key: 'why-response-api',
97+
id: 'bella-assistants/why-responses-api',
98+
label: 'Why Responses API?',
99+
key: 'why-responses-api',
100100
},
101101
{
102102
type: 'doc',
103-
id: 'bella-assistants/when-to-use-response-api',
104-
label: 'When to Use Response API?',
105-
key: 'when-to-use-response-api',
103+
id: 'bella-assistants/when-to-use-responses-api',
104+
label: 'When to Use Responses API?',
105+
key: 'when-to-use-responses-api',
106106
},
107107
{
108108
type: 'category',
109109
label: '使用文档 (Usage Documents)',
110110
key: 'assistant-usage-docs',
111111
items: [
112112
'bella-assistants/api/assistant-core-api',
113-
'bella-assistants/api/create-response',
114-
'bella-assistants/api/response-api-sdk',
113+
'bella-assistants/api/create-responses',
114+
'bella-assistants/api/responses-api-sdk',
115115
'bella-assistants/api/codex-usage'
116116
],
117117
},

0 commit comments

Comments
 (0)