Skip to content

docs(quickstart): clarify all-in-one includes model providers #2425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Blue-Berrys wants to merge 3 commits into
base: main
Choose a base branch
from
+36 −54
Open

docs(quickstart): clarify all-in-one includes model providers #2425

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
160871d
docs(quickstart): clarify all-in-one includes model providers
Blue-Berrys Jul 27, 2026
a56af17
Merge branch 'main' into docs/840-update-installation-all-in-one
Blue-Berrys Jul 28, 2026
d4da2d8
Merge branch 'main' into docs/840-update-installation-all-in-one
Blue-Berrys Jul 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 18 additions & 27 deletions docs/v1/en/docs/quickstart/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

AgentScope Java supports multiple models, RAG stores, and extensions, each requiring different third-party SDKs. Bundling everything together would bloat your project, so we offer two ways to add dependencies:

- **All-in-one**: Single dependency with DashScope SDK and MCP SDK included, get started quickly
- **All-in-one**: Single dependency with common model extensions (OpenAI / Gemini / Anthropic / DashScope / Ollama) and MCP SDK included, get started quickly
- **Core + extensions**: Minimal core package, add extension modules as needed, for strict dependency control

For most cases, all-in-one is enough. Switch to core + extensions when you need fine-grained dependency control.
Expand All @@ -13,7 +13,7 @@ For most cases, all-in-one is enough. Switch to core + extensions when you need

| Approach | Use Case | Features |
|----------|----------|----------|
| **all-in-one** | Quick start, most users | Single dependency, includes DashScope SDK |
| **all-in-one** | Quick start, most users | Single dependency, includes common model extensions and MCP SDK |
| **core + extensions** | Fine-grained control | On-demand imports, minimal dependencies |

## All-in-One (Recommended)
Expand All @@ -23,32 +23,33 @@ For most cases, all-in-one is enough. Switch to core + extensions when you need
<dependency>
<groupId>io.agentscope</groupId>
<artifactId>agentscope</artifactId>
<version>1.0.12</version>
<version>2.0.0</version>
</dependency>
```

**Gradle:**
```gradle
implementation 'io.agentscope:agentscope:1.0.12'
implementation 'io.agentscope:agentscope:2.0.0'
```

### Included Dependencies

The all-in-one package includes these dependencies by default:
The all-in-one package (`io.agentscope:agentscope`) already bundles the common model extensions and their required third-party SDKs. **You do not need to add model-provider SDKs separately:**

- DashScope model support (Qwen series models, via native HTTP calls, no additional SDK required)
- OpenAI model support (`agentscope-extensions-model-openai`, native HTTP — no `openai-java` required)
- Google Gemini model support (includes Google GenAI SDK)
- Anthropic model support (includes Anthropic Java SDK)
- DashScope model support (Qwen series)
- Ollama model support
- MCP SDK (Model Context Protocol)
- Reactor Core, Jackson, SLF4J (base frameworks)

### Additional Dependencies

When using other models or features, add the corresponding dependencies:
Add the following only when using **core + extensions**, or when you need runtime drivers / optional components that are not covered above. All-in-one users do **not** need to manually add OpenAI / Gemini / Anthropic / DashScope / Ollama SDKs for the models listed in the previous section.

| Feature | Dependency | Maven Coordinates |
|---------------------------|------------------------------------------------------------------------------------------|----------------------------------|
| **OpenAI Models** | [OpenAI Java SDK](https://central.sonatype.com/artifact/com.openai/openai-java) | `com.openai:openai-java` |
| **Google Gemini Models** | [Google GenAI SDK](https://central.sonatype.com/artifact/com.google.genai/google-genai) | `com.google.genai:google-genai` |
| **Anthropic Models** | [Anthropic Java SDK](https://central.sonatype.com/artifact/com.anthropic/anthropic-java) | `com.anthropic:anthropic-java` |
| **Mem0 Long-term Memory** | [OkHttp](https://central.sonatype.com/artifact/com.squareup.okhttp3/okhttp) | `com.squareup.okhttp3:okhttp` |
| **ReME Long-term Memory** | [OkHttp](https://central.sonatype.com/artifact/com.squareup.okhttp3/okhttp) | `com.squareup.okhttp3:okhttp` |
| **Bailian RAG** | [Bailian SDK](https://central.sonatype.com/artifact/com.aliyun/bailian20231229) | `com.aliyun:bailian20231229` |
Expand All @@ -65,20 +66,10 @@ When using other models or features, add the corresponding dependencies:
| **Document Processing** | [Apache Tika Core](https://central.sonatype.com/artifact/org.apache.tika/tika-core) + [Apache Tika Parsers](https://central.sonatype.com/artifact/org.apache.tika/tika-parsers-standard-package) | `org.apache.tika:tika-core` + `org.apache.tika:tika-parsers-standard-package` |
| **Nacos Registry** | [Nacos Client](https://central.sonatype.com/artifact/com.alibaba.nacos/nacos-client) | `com.alibaba.nacos:nacos-client` |

#### Example: Using OpenAI Models

```xml
<!-- Add on top of agentscope -->
<dependency>
<groupId>com.openai</groupId>
<artifactId>openai-java</artifactId>
</dependency>
```

#### Example: Using Qdrant RAG + PDF Processing

```xml
<!-- Add on top of agentscope -->
<!-- Add on top of agentscope when the runtime drivers are not already available -->
<dependency>
<groupId>io.qdrant</groupId>
<artifactId>client</artifactId>
Expand Down Expand Up @@ -136,13 +127,13 @@ For fine-grained dependency control, use `agentscope-core` with extension module
<dependency>
<groupId>io.agentscope</groupId>
<artifactId>agentscope-core</artifactId>
<version>1.0.12</version>
<version>2.0.0</version>
</dependency>
```

**Gradle:**
```gradle
implementation 'io.agentscope:agentscope-core:1.0.12'
implementation 'io.agentscope:agentscope-core:2.0.0'
```

### Extension Modules
Expand Down Expand Up @@ -202,7 +193,7 @@ Extension modules automatically include their required third-party dependencies.
<dependency>
<groupId>io.agentscope</groupId>
<artifactId>agentscope-extensions-mem0</artifactId>
<version>1.0.12</version>
<version>2.0.0</version>
</dependency>
```

Expand All @@ -214,7 +205,7 @@ Extension modules automatically include their required third-party dependencies.
<dependency>
<groupId>io.agentscope</groupId>
<artifactId>agentscope-spring-boot-starter</artifactId>
<version>1.0.12</version>
<version>2.0.0</version>
</dependency>
```

Expand All @@ -233,7 +224,7 @@ Additional starters:
<dependency>
<groupId>io.agentscope</groupId>
<artifactId>agentscope-quarkus-extension</artifactId>
<version>1.0.12</version>
<version>2.0.0</version>
</dependency>
```

Expand All @@ -243,6 +234,6 @@ Additional starters:
<dependency>
<groupId>io.agentscope</groupId>
<artifactId>agentscope-micronaut-extension</artifactId>
<version>1.0.12</version>
<version>2.0.0</version>
</dependency>
```
45 changes: 18 additions & 27 deletions docs/v1/zh/docs/quickstart/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

AgentScope Java 支持多种模型、RAG 后端和扩展功能，各自需要不同的第三方 SDK。把所有依赖打包到一起会让项目变得臃肿，所以我们提供了两种引入方式：

- **All-in-one**：一个依赖搞定，默认带 DashScope SDK 和 MCP SDK，快速上手
- **All-in-one**：一个依赖搞定，默认带常用模型扩展（OpenAI / Gemini / Anthropic / DashScope / Ollama）和 MCP SDK，快速上手
- **Core + 扩展**：最小化核心包，按需加扩展模块，适合对依赖有严格要求的场景

大多数情况下用 all-in-one 就够了，需要精细控制依赖时再换成 core + 扩展。
Expand All @@ -13,7 +13,7 @@ AgentScope Java 支持多种模型、RAG 后端和扩展功能，各自需要不

| 方式 | 适用场景 | 特点 |
|-----|---------|------|
| **all-in-one** | 快速开始、大多数用户 | 单一依赖，默认带 DashScope SDK |
| **all-in-one** | 快速开始、大多数用户 | 单一依赖，默认带常用模型扩展与 MCP SDK |
| **core + 扩展** | 精细控制依赖 | 按需引入，依赖最小化 |

---
Expand All @@ -25,32 +25,33 @@ AgentScope Java 支持多种模型、RAG 后端和扩展功能，各自需要不
<dependency>
<groupId>io.agentscope</groupId>
<artifactId>agentscope</artifactId>
<version>1.0.12</version>
<version>2.0.0</version>
</dependency>
```

**Gradle：**
```gradle
implementation 'io.agentscope:agentscope:1.0.12'
implementation 'io.agentscope:agentscope:2.0.0'
```

### 默认包含的依赖

All-in-one 包默认带以下依赖，不用额外配置：
All-in-one 包（`io.agentscope:agentscope`）已打包常用模型扩展及其所需第三方 SDK，**不必再额外引入模型厂商 SDK**：

- DashScope 模型支持（通义千问系列模型，通过原生 HTTP 调用，无需额外 SDK）
- OpenAI 模型支持（`agentscope-extensions-model-openai`，原生 HTTP，无需 `openai-java`）
- Google Gemini 模型支持（含 Google GenAI SDK）
- Anthropic 模型支持（含 Anthropic Java SDK）
- DashScope 模型支持（通义千问系列）
- Ollama 模型支持
- MCP SDK（模型上下文协议）
- Reactor Core、Jackson、SLF4J（基础框架）

### 额外功能的依赖

用其他模型或功能时，需要手动加对应依赖：
下列能力在使用 **core + 扩展** 时，或 all-in-one 未覆盖的运行时驱动 / 可选组件时，才需要按需补充。All-in-one 用户使用上方已列出的模型时，**无需**再手动添加 OpenAI / Gemini / Anthropic / DashScope / Ollama SDK。

| 功能 | 依赖 | Maven 坐标 |
|----------------------|------------------------------------------------------------------------------------------|----------------------------------|
| **OpenAI 模型** | [OpenAI Java SDK](https://central.sonatype.com/artifact/com.openai/openai-java) | `com.openai:openai-java` |
| **Google Gemini 模型** | [Google GenAI SDK](https://central.sonatype.com/artifact/com.google.genai/google-genai) | `com.google.genai:google-genai` |
| **Anthropic 模型** | [Anthropic Java SDK](https://central.sonatype.com/artifact/com.anthropic/anthropic-java) | `com.anthropic:anthropic-java` |
| **Mem0 长期记忆** | [OkHttp](https://central.sonatype.com/artifact/com.squareup.okhttp3/okhttp) | `com.squareup.okhttp3:okhttp` |
| **ReME 长期记忆** | [OkHttp](https://central.sonatype.com/artifact/com.squareup.okhttp3/okhttp) | `com.squareup.okhttp3:okhttp` |
| **百炼 RAG** | [百炼 SDK](https://central.sonatype.com/artifact/com.aliyun/bailian20231229) | `com.aliyun:bailian20231229` |
Expand All @@ -67,20 +68,10 @@ All-in-one 包默认带以下依赖，不用额外配置：
| **文档 处理** | [Apache Tika Core](https://central.sonatype.com/artifact/org.apache.tika/tika-core) + [Apache Tika Parsers](https://central.sonatype.com/artifact/org.apache.tika/tika-parsers-standard-package) | `org.apache.tika:tika-core` + `org.apache.tika:tika-parsers-standard-package` |
| **Nacos注册中心** | [Nacos Client](https://central.sonatype.com/artifact/com.alibaba.nacos/nacos-client) | `com.alibaba.nacos:nacos-client` |

#### 示例：用 OpenAI 模型

```xml
<!-- 在 agentscope 基础上加 -->
<dependency>
<groupId>com.openai</groupId>
<artifactId>openai-java</artifactId>
</dependency>
```

#### 示例：用 Qdrant RAG + PDF 处理

```xml
<!-- 在 agentscope 基础上加 -->
<!-- 在 agentscope 基础上加（仅当对应传递依赖未满足运行时需要时） -->
<dependency>
<groupId>io.qdrant</groupId>
<artifactId>client</artifactId>
Expand Down Expand Up @@ -140,13 +131,13 @@ All-in-one 包默认带以下依赖，不用额外配置：
<dependency>
<groupId>io.agentscope</groupId>
<artifactId>agentscope-core</artifactId>
<version>1.0.12</version>
<version>2.0.0</version>
</dependency>
```

**Gradle：**
```gradle
implementation 'io.agentscope:agentscope-core:1.0.12'
implementation 'io.agentscope:agentscope-core:2.0.0'
```

### 扩展模块
Expand Down Expand Up @@ -206,7 +197,7 @@ implementation 'io.agentscope:agentscope-core:1.0.12'
<dependency>
<groupId>io.agentscope</groupId>
<artifactId>agentscope-extensions-mem0</artifactId>
<version>1.0.12</version>
<version>2.0.0</version>
</dependency>
```

Expand All @@ -218,7 +209,7 @@ implementation 'io.agentscope:agentscope-core:1.0.12'
<dependency>
<groupId>io.agentscope</groupId>
<artifactId>agentscope-spring-boot-starter</artifactId>
<version>1.0.12</version>
<version>2.0.0</version>
</dependency>
```

Expand All @@ -237,7 +228,7 @@ implementation 'io.agentscope:agentscope-core:1.0.12'
<dependency>
<groupId>io.agentscope</groupId>
<artifactId>agentscope-quarkus-extension</artifactId>
<version>1.0.12</version>
<version>2.0.0</version>
</dependency>
```

Expand All @@ -247,6 +238,6 @@ implementation 'io.agentscope:agentscope-core:1.0.12'
<dependency>
<groupId>io.agentscope</groupId>
<artifactId>agentscope-micronaut-extension</artifactId>
<version>1.0.12</version>
<version>2.0.0</version>
</dependency>
```
Loading