Skip to content

Commit 3ca8da8

Browse files
committed
refactor(knowledge): update deprecation notices for access key options in CLI and documentation
1 parent 6c4ac80 commit 3ca8da8

2 files changed

Lines changed: 21 additions & 21 deletions

File tree

packages/cli/src/commands/knowledge/retrieve.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,16 @@ export default defineCommand({
6464
},
6565
{
6666
flag: "--access-key-id <key>",
67-
description: "Deprecated: use global --api-key or env DASHSCOPE_API_KEY instead",
67+
description: "Deprecated: use global --api-key instead",
6868
},
6969
{
7070
flag: "--access-key-secret <key>",
71-
description: "Deprecated: use global --api-key or env DASHSCOPE_API_KEY instead",
71+
description: "Deprecated: use global --api-key instead",
7272
},
7373
],
7474
notes: [
75-
"Authentication: use global flag `--api-key <key>` or env var `DASHSCOPE_API_KEY` (recommended). AK/SK auth is deprecated and will be removed in a future version.",
76-
"`--workspace-id` is NOT required when using API-KEY auth.",
75+
"Authentication: pass `--api-key <key>`. AK/SK auth is deprecated and will be removed in a future version.",
76+
"`--workspace-id` is NOT required when using --api-key.",
7777
],
7878
examples: [
7979
'bl knowledge retrieve --index-id idx_xxx --query "如何使用阿里云百炼"',

skills/bailian-cli/reference/knowledge.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -23,26 +23,26 @@ Index: [index.md](index.md)
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-
| `--dense-similarity-top-k <n>` | number | no | Dense retrieval top K |
31-
| `--sparse-similarity-top-k <n>` | number | no | Sparse retrieval top K |
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 |
35-
| `--rerank-mode <mode>` | string | no | Rerank mode: qa, similar, or custom |
36-
| `--rerank-instruct <text>` | string | no | Custom rerank instruction, when mode=custom |
37-
| `--top-k <n>` | number | no | Number of results (deprecated, use --rerank-top-n) |
38-
| `--workspace-id <id>` | string | no | Bailian workspace ID (only needed for deprecated AK/SK auth) |
39-
| `--access-key-id <key>` | string | no | Deprecated: use global --api-key or env DASHSCOPE_API_KEY instead |
40-
| `--access-key-secret <key>` | string | no | Deprecated: use global --api-key or env DASHSCOPE_API_KEY instead |
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 |
31+
| `--sparse-similarity-top-k <n>` | number | no | Sparse retrieval top K |
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 |
35+
| `--rerank-mode <mode>` | string | no | Rerank mode: qa, similar, or custom |
36+
| `--rerank-instruct <text>` | string | no | Custom rerank instruction, when mode=custom |
37+
| `--top-k <n>` | number | no | Number of results (deprecated, use --rerank-top-n) |
38+
| `--workspace-id <id>` | string | no | Bailian workspace ID (only needed for deprecated AK/SK auth) |
39+
| `--access-key-id <key>` | string | no | Deprecated: use global --api-key instead |
40+
| `--access-key-secret <key>` | string | no | Deprecated: use global --api-key instead |
4141

4242
#### Notes
4343

44-
- Authentication: use global flag `--api-key <key>` or env var `DASHSCOPE_API_KEY` (recommended). AK/SK auth is deprecated and will be removed in a future version.
45-
- `--workspace-id` is NOT required when using API-KEY auth.
44+
- Authentication: pass `--api-key <key>`. AK/SK auth is deprecated and will be removed in a future version.
45+
- `--workspace-id` is NOT required when using --api-key.
4646

4747
#### Examples
4848

0 commit comments

Comments
 (0)