mirror of
https://github.com/modelstudioai/cli.git
synced 2026-09-14 19:49:23 +08:00
refactor(knowledge): update deprecation notices for access key options in CLI and documentation
This commit is contained in:
@@ -64,16 +64,16 @@ export default defineCommand({
|
||||
},
|
||||
{
|
||||
flag: "--access-key-id <key>",
|
||||
description: "Deprecated: use global --api-key or env DASHSCOPE_API_KEY instead",
|
||||
description: "Deprecated: use global --api-key instead",
|
||||
},
|
||||
{
|
||||
flag: "--access-key-secret <key>",
|
||||
description: "Deprecated: use global --api-key or env DASHSCOPE_API_KEY instead",
|
||||
description: "Deprecated: use global --api-key instead",
|
||||
},
|
||||
],
|
||||
notes: [
|
||||
"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.",
|
||||
"`--workspace-id` is NOT required when using API-KEY auth.",
|
||||
"Authentication: pass `--api-key <key>`. AK/SK auth is deprecated and will be removed in a future version.",
|
||||
"`--workspace-id` is NOT required when using --api-key.",
|
||||
],
|
||||
examples: [
|
||||
'bl knowledge retrieve --index-id idx_xxx --query "如何使用阿里云百炼"',
|
||||
|
||||
@@ -23,26 +23,26 @@ Index: [index.md](index.md)
|
||||
|
||||
#### Options
|
||||
|
||||
| Flag | Type | Required | Description |
|
||||
| ------------------------------- | ------- | -------- | ----------------------------------------------------------------- |
|
||||
| `--index-id <id>` | string | yes | Knowledge base index ID (required) |
|
||||
| `--query <text>` | string | yes | Search query (required) |
|
||||
| `--dense-similarity-top-k <n>` | number | no | Dense retrieval top K |
|
||||
| `--sparse-similarity-top-k <n>` | number | no | Sparse retrieval top K |
|
||||
| `--rerank` | boolean | no | Enable reranking |
|
||||
| `--rerank-top-n <n>` | number | no | Rerank top N results |
|
||||
| `--rerank-model <name>` | string | no | Rerank model, e.g. qwen3-rerank-hybrid |
|
||||
| `--rerank-mode <mode>` | string | no | Rerank mode: qa, similar, or custom |
|
||||
| `--rerank-instruct <text>` | string | no | Custom rerank instruction, when mode=custom |
|
||||
| `--top-k <n>` | number | no | Number of results (deprecated, use --rerank-top-n) |
|
||||
| `--workspace-id <id>` | string | no | Bailian workspace ID (only needed for deprecated AK/SK auth) |
|
||||
| `--access-key-id <key>` | string | no | Deprecated: use global --api-key or env DASHSCOPE_API_KEY instead |
|
||||
| `--access-key-secret <key>` | string | no | Deprecated: use global --api-key or env DASHSCOPE_API_KEY instead |
|
||||
| Flag | Type | Required | Description |
|
||||
| ------------------------------- | ------- | -------- | ------------------------------------------------------------ |
|
||||
| `--index-id <id>` | string | yes | Knowledge base index ID (required) |
|
||||
| `--query <text>` | string | yes | Search query (required) |
|
||||
| `--dense-similarity-top-k <n>` | number | no | Dense retrieval top K |
|
||||
| `--sparse-similarity-top-k <n>` | number | no | Sparse retrieval top K |
|
||||
| `--rerank` | boolean | no | Enable reranking |
|
||||
| `--rerank-top-n <n>` | number | no | Rerank top N results |
|
||||
| `--rerank-model <name>` | string | no | Rerank model, e.g. qwen3-rerank-hybrid |
|
||||
| `--rerank-mode <mode>` | string | no | Rerank mode: qa, similar, or custom |
|
||||
| `--rerank-instruct <text>` | string | no | Custom rerank instruction, when mode=custom |
|
||||
| `--top-k <n>` | number | no | Number of results (deprecated, use --rerank-top-n) |
|
||||
| `--workspace-id <id>` | string | no | Bailian workspace ID (only needed for deprecated AK/SK auth) |
|
||||
| `--access-key-id <key>` | string | no | Deprecated: use global --api-key instead |
|
||||
| `--access-key-secret <key>` | string | no | Deprecated: use global --api-key instead |
|
||||
|
||||
#### Notes
|
||||
|
||||
- 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.
|
||||
- `--workspace-id` is NOT required when using API-KEY auth.
|
||||
- Authentication: pass `--api-key <key>`. AK/SK auth is deprecated and will be removed in a future version.
|
||||
- `--workspace-id` is NOT required when using --api-key.
|
||||
|
||||
#### Examples
|
||||
|
||||
|
||||
Reference in New Issue
Block a user