Skip to content

Commit 2389bf0

Browse files
chore(eino): sync en docs for ecosystem
1 parent f2945ab commit 2389bf0

30 files changed

Lines changed: 287 additions & 381 deletions
Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,54 @@
11
---
22
Description: ""
3-
date: "2025-03-04"
3+
date: "2025-12-11"
44
lastmod: ""
55
tags: []
66
title: Callback - CozeLoop
77
weight: 0
88
---
99

10-
# CozeLoop Callback
10+
# **CozeLoop Callback**
1111

1212
This is a Trace callback implementation for [CozeLoop](https://github.com/cloudwego/eino). It implements the `Handler` interface and integrates seamlessly with Eino applications to provide enhanced observability.
1313

14-
## Features
14+
## **Features**
1515

1616
- Implements `github.com/cloudwego/eino/internel/callbacks.Handler` interface
1717
- Easy integration with Eino applications
1818

19-
## Installation
19+
## **Installation**
2020

2121
```bash
2222
go get github.com/cloudwego/eino-ext/callbacks/cozeloop
2323
```
2424

25-
## Quick Start
25+
## **Quick Start**
2626

2727
```go
2828
package main
2929
import (
30-
"context"
31-
"log"
30+
"context"
31+
"log"
3232

33-
ccb "github.com/cloudwego/eino-ext/callbacks/cozeloop"
34-
"github.com/cloudwego/eino/callbacks"
35-
"github.com/coze-dev/cozeloop-go"
33+
ccb "github.com/cloudwego/eino-ext/callbacks/cozeloop"
34+
"github.com/cloudwego/eino/callbacks"
35+
"github.com/coze-dev/cozeloop-go"
3636
)
3737

3838
func main() {
39-
// Set environment variables
40-
// COZELOOP_WORKSPACE_ID=your workspace id
41-
// COZELOOP_API_TOKEN=your token
42-
client, err := cozeloop.NewClient()
43-
if err != nil {
44-
panic(err)
45-
}
46-
defer client.Close(ctx)
47-
// Call once during service init
48-
handler := ccb.NewLoopHandler(client)
49-
callbacks.AppendGlobalHandlers(handler)
39+
// Set environment variables
40+
// COZELOOP_WORKSPACE_ID=your workspace id
41+
// COZELOOP_API_TOKEN=your token
42+
client, err := cozeloop.NewClient()
43+
if err != nil {
44+
panic(err)
45+
}
46+
defer client.Close(ctx)
47+
// Call once during service init
48+
handler := ccb.NewLoopHandler(client)
49+
callbacks.AppendGlobalHandlers(handler)
5050
}
5151
```
5252

53-
## More Details
53+
## **More Details**
5454
- [CozeLoop Docs](https://github.com/coze-dev/cozeloop-go)
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
Description: ""
3-
date: "2025-02-10"
3+
date: "2025-07-21"
44
lastmod: ""
55
tags: []
66
title: ChatModel
77
weight: 0
88
---
9-

content/en/docs/eino/ecosystem_integration/chat_model/chat_model_ark.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1234,7 +1234,11 @@ func main() {
12341234

12351235
```
12361236

1237-
## More Information
1237+
### [More Examples](https://github.com/cloudwego/eino-ext/tree/main/components/model/ark/examples)
12381238

1239-
- [Eino Documentation](https://www.cloudwego.io/en/docs/eino/)
1240-
- [Volcengine Ark Model Documentation](https://www.volcengine.com/docs/82379/1263272)
1239+
## **Related Documentation**
1240+
1241+
- `Eino: ChatModel Guide` at `/en/docs/eino/core_modules/components/chat_model_guide`
1242+
- `ChatModel - OpenAI` at `/en/docs/eino/ecosystem_integration/chat_model/chat_model_openai`
1243+
- `ChatModel - Ollama` at `/en/docs/eino/ecosystem_integration/chat_model/chat_model_ollama`
1244+
- [Volcengine Official Site](https://www.volcengine.com/product/doubao)

content/en/docs/eino/ecosystem_integration/chat_model/chat_model_arkbot.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
Description: ""
3-
date: "2025-12-02"
3+
date: "2025-12-11"
44
lastmod: ""
55
tags: []
6-
title: ChatModel - arkbot
6+
title: ChatModel - ARKBot
77
weight: 0
88
---
99

1010
A Volcengine Ark Bot implementation for [Eino](https://github.com/cloudwego/eino) that implements the `ToolCallingChatModel` interface. This enables seamless integration with Eino's LLM capabilities to enhance natural language processing and generation.
1111

12-
## Features
12+
## **Features**
1313

1414
- Implements `github.com/cloudwego/eino/components/model.ToolCallingChatModel`
1515
- Easy integration with Eino's model system
@@ -19,13 +19,13 @@ A Volcengine Ark Bot implementation for [Eino](https://github.com/cloudwego/eino
1919
- Supports custom response parsing
2020
- Flexible model configuration
2121

22-
## Installation
22+
## **Installation**
2323

2424
```bash
2525
go get github.com/cloudwego/eino-ext/components/model/arkbot@latest
2626
```
2727

28-
## Quick Start
28+
## **Quick Start**
2929

3030
Here's a quick example of how to use the Ark Bot:
3131

@@ -85,7 +85,7 @@ func main() {
8585

8686
```
8787

88-
## Configuration
88+
## **Configuration**
8989

9090
You can configure the model using the `arkbot.Config` struct:
9191

@@ -175,17 +175,17 @@ type Config struct {
175175
}
176176
```
177177

178-
## Request Options
178+
## **Request Options**
179179

180180
```go
181181
// WithCustomHeader sets custom headers for a single request
182182
// the headers will override all the headers given in ChatModelConfig.CustomHeader
183183
func WithCustomHeader(m map[string]string) model.Option {}
184184
```
185185

186-
## Examples
186+
## **Examples**
187187

188-
### Text Generation
188+
### **Text Generation**
189189

190190
```go
191191

@@ -243,7 +243,7 @@ func main() {
243243

244244
```
245245

246-
### Streaming Generation
246+
### **Streaming Generation**
247247

248248
```go
249249

@@ -327,7 +327,7 @@ func main() {
327327

328328
```
329329

330-
## More Information
330+
## **More Information**
331331

332332
- [Eino Documentation](https://www.cloudwego.io/en/docs/eino/)
333333
- [Volcengine Ark Model Documentation](https://www.volcengine.com/docs/82379/1263272)

content/en/docs/eino/ecosystem_integration/chat_model/chat_model_claude.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Description: ""
3-
date: "2025-12-02"
3+
date: "2025-12-11"
44
lastmod: ""
55
tags: []
66
title: ChatModel - claude
@@ -9,7 +9,7 @@ weight: 0
99

1010
A Claude model implementation for [Eino](https://github.com/cloudwego/eino) that implements the `ToolCallingChatModel` interface. This enables seamless integration with Eino's LLM capabilities to enhance natural language processing and generation.
1111

12-
## Features
12+
## **Features**
1313

1414
- Implements `github.com/cloudwego/eino/components/model.Model`
1515
- Easy integration with Eino's model system
@@ -19,13 +19,13 @@ A Claude model implementation for [Eino](https://github.com/cloudwego/eino) that
1919
- Supports custom response parsing
2020
- Flexible model configuration
2121

22-
## Installation
22+
## **Installation**
2323

2424
```bash
2525
go get github.com/cloudwego/eino-ext/components/model/claude@latest
2626
```
2727

28-
## Quick Start
28+
## **Quick Start**
2929

3030
Here's a quick example of how to use the Claude model:
3131

@@ -107,7 +107,7 @@ func main() {
107107

108108
```
109109

110-
## Configuration
110+
## **Configuration**
111111

112112
You can configure the model using the `claude.ChatModelConfig` struct:
113113

@@ -190,9 +190,9 @@ type Config struct {
190190
}
191191
```
192192

193-
## Examples
193+
## **Examples**
194194

195-
### Text Generation
195+
### **Text Generation**
196196

197197
```go
198198

@@ -273,7 +273,7 @@ func main() {
273273

274274
```
275275

276-
### Multimodal Support (Image Understanding)
276+
### **Multimodal Support (Image Understanding)**
277277

278278
```go
279279

@@ -359,7 +359,7 @@ func of[T any](v T) *T {
359359

360360
```
361361

362-
### Streaming Generation
362+
### **Streaming Generation**
363363

364364
```go
365365

@@ -460,7 +460,7 @@ func main() {
460460

461461
```
462462

463-
### Claude Prompt Cache
463+
### **Claude Prompt Cache**
464464

465465
```go
466466

@@ -696,7 +696,7 @@ func sessionCache() {
696696

697697
```
698698

699-
### function_call
699+
### **function_call**
700700

701701
```go
702702

@@ -823,7 +823,11 @@ func main() {
823823

824824
```
825825

826-
## More Information
826+
### [More Examples](https://github.com/cloudwego/eino-ext/tree/main/components/model/claude/examples)
827827

828-
- [Eino Documentation](https://www.cloudwego.io/en/docs/eino/)
829-
- [Claude Documentation](https://docs.claude.com/en/api/messages)
828+
## **Related Documentation**
829+
830+
- `Eino: ChatModel Guide` at `/en/docs/eino/core_modules/components/chat_model_guide`
831+
- `Eino: ToolsNode & Tool Guide` at `/en/docs/eino/core_modules/components/tools_node_guide`
832+
- `ChatModel - ARK` at `/en/docs/eino/ecosystem_integration/chat_model/chat_model_ark`
833+
- `ChatModel - Ollama` at `/en/docs/eino/ecosystem_integration/chat_model/chat_model_ollama`

content/en/docs/eino/ecosystem_integration/chat_model/chat_model_deepseek.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Description: ""
3-
date: "2025-12-02"
3+
date: "2025-12-11"
44
lastmod: ""
55
tags: []
66
title: ChatModel - deepseek
@@ -9,7 +9,7 @@ weight: 0
99

1010
A DeepSeek model implementation for [Eino](https://github.com/cloudwego/eino) that implements the `ToolCallingChatModel` interface. This enables seamless integration with Eino's LLM capabilities to enhance natural language processing and generation.
1111

12-
## Features
12+
## **Features**
1313

1414
- Implements `github.com/cloudwego/eino/components/model.Model`
1515
- Easy integration with Eino's model system
@@ -19,13 +19,13 @@ A DeepSeek model implementation for [Eino](https://github.com/cloudwego/eino) th
1919
- Supports custom response parsing
2020
- Flexible model configuration
2121

22-
## Installation
22+
## **Installation**
2323

2424
```bash
2525
go get github.com/cloudwego/eino-ext/components/model/deepseek@latest
2626
```
2727

28-
## Quick Start
28+
## **Quick Start**
2929

3030
Here's a quick example of how to use the DeepSeek model:
3131

@@ -93,7 +93,7 @@ func main() {
9393
}
9494
```
9595

96-
## Configuration
96+
## **Configuration**
9797

9898
You can configure the model using the `deepseek.ChatModelConfig` struct:
9999

@@ -173,9 +173,9 @@ type ChatModelConfig struct {
173173

174174
```
175175

176-
## Examples
176+
## **Examples**
177177

178-
### Text Generation
178+
### **Text Generation**
179179

180180
```go
181181

@@ -244,7 +244,7 @@ func main() {
244244

245245
```
246246

247-
### Text Generation with Prefix
247+
### **Text Generation with Prefix**
248248

249249
```go
250250

@@ -300,7 +300,7 @@ func main() {
300300

301301
```
302302

303-
### Streaming Generation
303+
### **Streaming Generation**
304304

305305
```go
306306

@@ -374,7 +374,7 @@ func main() {
374374

375375
```
376376

377-
### Tool Calling
377+
### **Tool Calling**
378378

379379
```go
380380

@@ -475,7 +475,7 @@ func main() {
475475

476476
```
477477

478-
## More Information
478+
## **More Information**
479479

480480
- [Eino Documentation](https://www.cloudwego.io/en/docs/eino/)
481481
- [DeepSeek Documentation](https://api-docs.deepseek.com/api/create-chat-completion)

0 commit comments

Comments
 (0)