Skip to content

Commit d93b951

Browse files
clark-fcclark-fc
committed
docs(cli): 更新 API Key 和相关链接地址
1 parent d5407ae commit d93b951

3 files changed

Lines changed: 26 additions & 21 deletions

File tree

‎packages/cli/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
[![TypeScript](https://img.shields.io/badge/TypeScript-strict-3178c6)](https://www.typescriptlang.org)
1010
[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
1111

12-
[Aliyun Model Studio CLI Site](https://bailian.console.aliyun.com/cli?source_channel=cli_github&) · [中文文档](https://github.com/modelstudioai/cli/blob/main/README.zh.md) · [API Documentation](https://help.aliyun.com/zh/model-studio/) · [Get API Key](https://bailian.console.aliyun.com/cli?source_channel=key_github&)
12+
[Aliyun Model Studio CLI Site](https://bailian.console.aliyun.com/cli?source_channel=cli_github&) · [中文文档](https://github.com/modelstudioai/cli/blob/main/README.zh.md) · [API Documentation](https://help.aliyun.com/zh/model-studio/) · [Get API Key](https://bailian.console.aliyun.com/cn-beijing/?source_channel=key_github&tab=app#/api-key)
1313

1414
---
1515

@@ -119,7 +119,7 @@ bl usage free --model qwen3-max
119119

120120
### DashScope API Key
121121

122-
Required for most commands. Get your key from the [DashScope Console](https://bailian.console.aliyun.com/cli?source_channel=key_github&).
122+
Required for most commands. Get your key from the [DashScope Console](https://bailian.console.aliyun.com/cn-beijing/?source_channel=key_github&tab=app#/api-key).
123123

124124
```bash
125125
# Option 1: Environment variable
@@ -176,8 +176,8 @@ Config file location: `~/.bailian/config.json`
176176
| Aliyun Model Studio CLI Site | https://bailian.console.aliyun.com/cli?source_channel=cli_github& |
177177
| DashScope API Docs | https://help.aliyun.com/zh/model-studio/ |
178178
| Qwen Model List | https://help.aliyun.com/zh/model-studio/getting-started/models |
179-
| Aliyun Model Studio Console | https://bailian.console.aliyun.com/ |
180-
| Get API Key | https://bailian.console.aliyun.com/cli?source_channel=key_github& |
179+
| Aliyun Model Studio Console | https://bailian.console.aliyun.com/?source_channel=cli_github |
180+
| Get API Key | https://bailian.console.aliyun.com/cn-beijing/?source_channel=key_github&tab=app#/api-key |
181181
| Get AccessKey | https://ram.console.aliyun.com/manage/ak |
182182

183183
## Changelog

‎skills/bailian-cli/reference/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Use this index for the full quick index and global flags.
2323
| `bl file upload` | Upload a local file to DashScope temporary storage (48h) | [file.md](file.md) |
2424
| `bl image edit` | Edit an existing image with text instructions (Qwen-Image) | [image.md](image.md) |
2525
| `bl image generate` | Generate images (Qwen-Image / wan2.x) | [image.md](image.md) |
26-
| `bl knowledge retrieve` | Retrieve from a Bailian knowledge base (requires AK/SK) | [knowledge.md](knowledge.md) |
26+
| `bl knowledge retrieve` | Retrieve from a Bailian knowledge base | [knowledge.md](knowledge.md) |
2727
| `bl mcp call` | Call a tool on an MCP server (tools/call) | [mcp.md](mcp.md) |
2828
| `bl mcp list` | List MCP servers activated under your Bailian account | [mcp.md](mcp.md) |
2929
| `bl mcp tools` | List tools exposed by an MCP server (tools/list) | [mcp.md](mcp.md) |

‎skills/bailian-cli/reference/knowledge.md‎

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Index: [index.md](index.md)
77

88
## Commands in this group
99

10-
| Command | Description |
11-
| ----------------------- | ------------------------------------------------------- |
12-
| `bl knowledge retrieve` | Retrieve from a Bailian knowledge base (requires AK/SK) |
10+
| Command | Description |
11+
| ----------------------- | -------------------------------------- |
12+
| `bl knowledge retrieve` | Retrieve from a Bailian knowledge base |
1313

1414
## Command details
1515

@@ -18,28 +18,33 @@ Index: [index.md](index.md)
1818
| Field | Value |
1919
| --------------- | -------------------------------------------------------------- |
2020
| **Name** | `knowledge retrieve` |
21-
| **Description** | Retrieve from a Bailian knowledge base (requires AK/SK) |
21+
| **Description** | Retrieve from a Bailian knowledge base |
2222
| **Usage** | `bl knowledge retrieve --index-id <id> --query <text> [flags]` |
2323

2424
#### Options
2525

26-
| Flag | Type | Required | Description |
27-
| --------------------------- | ------- | -------- | -------------------------------------------------- |
28-
| `--index-id <id>` | string | yes | Knowledge base index ID (required) |
29-
| `--query <text>` | string | yes | Search query (required) |
30-
| `--workspace-id <id>` | string | no | Bailian workspace ID (or env BAILIAN_WORKSPACE_ID) |
31-
| `--top-k <n>` | number | no | Number of results (default: 10) |
32-
| `--rerank` | boolean | no | Enable rerank |
33-
| `--rerank-top-n <n>` | number | no | Rerank top N results |
34-
| `--access-key-id <key>` | string | no | Alibaba Cloud Access Key ID (or env) |
35-
| `--access-key-secret <key>` | string | no | Alibaba Cloud Access Key Secret (or env) |
26+
| Flag | Type | Required | Description |
27+
| ------------------------------- | ------- | -------- | ---------------------------------------------------------- |
28+
| `--index-id <id>` | string | yes | Knowledge base index ID (required) |
29+
| `--query <text>` | string | yes | Search query (required) |
30+
| `--dense-similarity-top-k <n>` | number | no | Dense retrieval top K (API-KEY only) |
31+
| `--sparse-similarity-top-k <n>` | number | no | Sparse retrieval top K (API-KEY only) |
32+
| `--rerank` | boolean | no | Enable reranking |
33+
| `--rerank-top-n <n>` | number | no | Rerank top N results |
34+
| `--rerank-model <name>` | string | no | Rerank model, e.g. qwen3-rerank-hybrid (API-KEY only) |
35+
| `--rerank-mode <mode>` | string | no | Rerank mode: qa, similar, or custom (API-KEY only) |
36+
| `--rerank-instruct <text>` | string | no | Custom rerank instruction, when mode=custom (API-KEY only) |
37+
| `--top-k <n>` | number | no | Number of results (deprecated, use --rerank-top-n) |
38+
| `--workspace-id <id>` | string | no | Bailian workspace ID (required for AK/SK auth) |
39+
| `--access-key-id <key>` | string | no | Alibaba Cloud Access Key ID (deprecated) |
40+
| `--access-key-secret <key>` | string | no | Alibaba Cloud Access Key Secret (deprecated) |
3641

3742
#### Examples
3843

3944
```bash
40-
bl knowledge retrieve --index-id idx_xxx --query "如何使用阿里云百炼" --workspace-id ws_xxx
45+
bl knowledge retrieve --index-id idx_xxx --query "如何使用阿里云百炼"
4146
```
4247

4348
```bash
44-
bl knowledge retrieve --index-id idx_xxx --query "API限流" --top-k 5 --rerank
49+
bl knowledge retrieve --index-id idx_xxx --query "API限流" --rerank --rerank-model qwen3-rerank-hybrid
4550
```

0 commit comments

Comments
 (0)