Skip to content

Commit da3c9e1

Browse files
SunrisepeakSunrisepeak
committed
Document production readiness gaps
1 parent 9c60107 commit da3c9e1

6 files changed

Lines changed: 105 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,23 @@
2222
- Conversation save/load helpers
2323
- OpenAI-compatible endpoint support through `openai::Config::baseUrl`
2424

25+
## Production Readiness
26+
27+
`llmapi` is usable for internal tools, prototypes, and early production experiments, but it should not yet be treated as fully industrial-grade infrastructure.
28+
29+
Required gaps before that bar:
30+
31+
- Unified error model across providers and transport
32+
- Retry, backoff, timeout, and idempotency policy
33+
- Request cancellation for long-running and streaming calls
34+
- Logging, metrics, trace hooks, and request correlation
35+
- Hardening of the custom HTTP/TLS transport layer
36+
- Fault-injection, concurrency, and large-scale mock testing
37+
- Stronger API compatibility and versioning guarantees
38+
- More complete production configuration surface
39+
- Explicit thread-safety and concurrency semantics
40+
- Operational documentation for retries, keys, proxies, and failure handling
41+
2542
## Quick Start
2643

2744
```cpp
@@ -89,7 +106,7 @@ target("demo")
89106
add_packages("llmapi")
90107
```
91108

92-
See [docs/en/getting-started.md](docs/en/getting-started.md) and [docs/en/providers.md](docs/en/providers.md) for more setup detail.
109+
See [docs/en/getting-started.md](docs/en/getting-started.md), [docs/en/providers.md](docs/en/providers.md), and [docs/en/README.md](docs/en/README.md) for more setup and readiness detail.
93110

94111
## License
95112

‎README.zh.hant.md‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,23 @@
2222
- 支援儲存 / 載入對話歷史
2323
- 可透過 `baseUrl` 存取 OpenAI 相容端點
2424

25+
## 生產可用性
26+
27+
`llmapi` 目前適合內部工具、原型專案與早期生產試用，但還不應直接視為完整工業級基礎設施。
28+
29+
要達到那個標準，至少還需要補齊：
30+
31+
- 統一的 provider / 傳輸層錯誤模型
32+
- 重試、退避、逾時、冪等策略
33+
- 長請求與串流請求的取消能力
34+
- 日誌、指標、trace hook、請求關聯資訊
35+
- 自研 HTTP/TLS 傳輸層的進一步加固
36+
- 故障注入、並發、Mock、大規模測試
37+
- 更強的 API 相容性與版本穩定性承諾
38+
- 更完整的生產設定面
39+
- 明確的執行緒安全與並發語義
40+
- 面向維運的重試、金鑰、代理、故障處理文件
41+
2542
## 快速開始
2643

2744
```cpp
@@ -89,7 +106,7 @@ target("demo")
89106
add_packages("llmapi")
90107
```
91108

92-
更多內容見 [docs/zh-hant/getting-started.md](docs/zh-hant/getting-started.md) 與 [docs/zh-hant/providers.md](docs/zh-hant/providers.md)。
109+
更多內容見 [docs/zh-hant/getting-started.md](docs/zh-hant/getting-started.md)、[docs/zh-hant/providers.md](docs/zh-hant/providers.md) 與 [docs/zh-hant/README.md](docs/zh-hant/README.md)。
93110

94111
## 授權
95112

‎README.zh.md‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,23 @@
2222
- 支持保存 / 加载对话历史
2323
- 可通过 `baseUrl` 访问 OpenAI 兼容端点
2424

25+
## 生产可用性
26+
27+
`llmapi` 目前适合内部工具、原型项目和早期生产试用，但还不应直接视为完整工业级基础设施。
28+
29+
要达到那个标准，至少还需要补齐：
30+
31+
- 统一的 provider / 传输层错误模型
32+
- 重试、退避、超时、幂等策略
33+
- 长请求和流式请求的取消能力
34+
- 日志、指标、trace hook、请求关联信息
35+
- 自研 HTTP/TLS 传输层的进一步加固
36+
- 故障注入、并发、Mock、大规模测试
37+
- 更强的 API 兼容性与版本稳定性承诺
38+
- 更完整的生产配置面
39+
- 明确的线程安全和并发语义
40+
- 面向运维的重试、密钥、代理、故障处理文档
41+
2542
## 快速开始
2643

2744
```cpp
@@ -89,7 +106,7 @@ target("demo")
89106
add_packages("llmapi")
90107
```
91108

92-
更多内容见 [docs/zh/getting-started.md](docs/zh/getting-started.md) 与 [docs/zh/providers.md](docs/zh/providers.md)。
109+
更多内容见 [docs/zh/getting-started.md](docs/zh/getting-started.md)、[docs/zh/providers.md](docs/zh/providers.md) 与 [docs/zh/README.md](docs/zh/README.md)。
93110

94111
## 许可证
95112

‎docs/en/README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,23 @@ Language:
2525
- OpenAI-compatible endpoint support through configurable base URLs
2626
- Conversation save/load helpers for local session persistence
2727

28+
## Production Readiness
29+
30+
The library is usable for internal tools, prototypes, and early production adoption, but it should not yet be described as fully industrial-grade infrastructure.
31+
32+
Required gaps before that claim:
33+
34+
- Unified error model across providers and transport
35+
- Retry, backoff, timeout, and idempotency policy
36+
- Request cancellation for long-running and streaming calls
37+
- Logging, metrics, trace hooks, and request correlation
38+
- Hardening of the custom HTTP/TLS transport layer
39+
- Fault-injection, concurrency, and large-scale mock testing
40+
- Stronger API compatibility and versioning guarantees
41+
- More complete production configuration surface
42+
- Explicit thread-safety and concurrency semantics
43+
- Operational documentation for retries, keys, proxies, and failure handling
44+
2845
## License
2946

3047
Apache-2.0 - see [LICENSE](../../LICENSE)

‎docs/zh-hant/README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,20 @@
2424
- 內建 OpenAI / Anthropic 支援
2525
- OpenAI 相容端點支援
2626
- 對話儲存與還原
27+
28+
## 生產可用性
29+
30+
這個函式庫已可用於內部工具、原型專案與早期生產試用，但還不應被定義為「完整工業級基礎設施」。
31+
32+
要達到那個標準，至少還需要補齊：
33+
34+
- 統一的 provider / 傳輸層錯誤模型
35+
- 重試、退避、逾時、冪等策略
36+
- 長請求與串流請求的取消能力
37+
- 日誌、指標、trace hook、請求關聯資訊
38+
- 自研 HTTP/TLS 傳輸層的進一步加固
39+
- 故障注入、並發、Mock、大規模測試
40+
- 更強的 API 相容性與版本穩定性承諾
41+
- 更完整的生產設定面
42+
- 明確的執行緒安全與並發語義
43+
- 面向維運的重試、金鑰、代理、故障處理文件

‎docs/zh/README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,20 @@
2424
- OpenAI / Anthropic 内置支持
2525
- OpenAI 兼容端点支持
2626
- 对话保存与恢复
27+
28+
## 生产可用性
29+
30+
这个库已经可以用于内部工具、原型项目和早期生产试用，但还不应被定义为“完整工业级基础设施”。
31+
32+
要达到那个标准，至少还需要补齐：
33+
34+
- 统一的 provider / 传输层错误模型
35+
- 重试、退避、超时、幂等策略
36+
- 长请求和流式请求的取消能力
37+
- 日志、指标、trace hook、请求关联信息
38+
- 自研 HTTP/TLS 传输层的进一步加固
39+
- 故障注入、并发、Mock、大规模测试
40+
- 更强的 API 兼容性与版本稳定性承诺
41+
- 更完整的生产配置面
42+
- 明确的线程安全和并发语义
43+
- 面向运维的重试、密钥、代理、故障处理文档

0 commit comments

Comments
 (0)