diff --git a/packages/cli/src/commands/knowledge/retrieve.ts b/packages/cli/src/commands/knowledge/retrieve.ts index d14ada6..400470c 100644 --- a/packages/cli/src/commands/knowledge/retrieve.ts +++ b/packages/cli/src/commands/knowledge/retrieve.ts @@ -64,16 +64,16 @@ export default defineCommand({ }, { flag: "--access-key-id ", - description: "Deprecated: use global --api-key or env DASHSCOPE_API_KEY instead", + description: "Deprecated: use global --api-key instead", }, { flag: "--access-key-secret ", - 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 ` 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 `. 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 "如何使用阿里云百炼"', diff --git a/skills/bailian-cli/reference/knowledge.md b/skills/bailian-cli/reference/knowledge.md index 1cea3d4..169685c 100644 --- a/skills/bailian-cli/reference/knowledge.md +++ b/skills/bailian-cli/reference/knowledge.md @@ -23,26 +23,26 @@ Index: [index.md](index.md) #### Options -| Flag | Type | Required | Description | -| ------------------------------- | ------- | -------- | ----------------------------------------------------------------- | -| `--index-id ` | string | yes | Knowledge base index ID (required) | -| `--query ` | string | yes | Search query (required) | -| `--dense-similarity-top-k ` | number | no | Dense retrieval top K | -| `--sparse-similarity-top-k ` | number | no | Sparse retrieval top K | -| `--rerank` | boolean | no | Enable reranking | -| `--rerank-top-n ` | number | no | Rerank top N results | -| `--rerank-model ` | string | no | Rerank model, e.g. qwen3-rerank-hybrid | -| `--rerank-mode ` | string | no | Rerank mode: qa, similar, or custom | -| `--rerank-instruct ` | string | no | Custom rerank instruction, when mode=custom | -| `--top-k ` | number | no | Number of results (deprecated, use --rerank-top-n) | -| `--workspace-id ` | string | no | Bailian workspace ID (only needed for deprecated AK/SK auth) | -| `--access-key-id ` | string | no | Deprecated: use global --api-key or env DASHSCOPE_API_KEY instead | -| `--access-key-secret ` | string | no | Deprecated: use global --api-key or env DASHSCOPE_API_KEY instead | +| Flag | Type | Required | Description | +| ------------------------------- | ------- | -------- | ------------------------------------------------------------ | +| `--index-id ` | string | yes | Knowledge base index ID (required) | +| `--query ` | string | yes | Search query (required) | +| `--dense-similarity-top-k ` | number | no | Dense retrieval top K | +| `--sparse-similarity-top-k ` | number | no | Sparse retrieval top K | +| `--rerank` | boolean | no | Enable reranking | +| `--rerank-top-n ` | number | no | Rerank top N results | +| `--rerank-model ` | string | no | Rerank model, e.g. qwen3-rerank-hybrid | +| `--rerank-mode ` | string | no | Rerank mode: qa, similar, or custom | +| `--rerank-instruct ` | string | no | Custom rerank instruction, when mode=custom | +| `--top-k ` | number | no | Number of results (deprecated, use --rerank-top-n) | +| `--workspace-id ` | string | no | Bailian workspace ID (only needed for deprecated AK/SK auth) | +| `--access-key-id ` | string | no | Deprecated: use global --api-key instead | +| `--access-key-secret ` | string | no | Deprecated: use global --api-key instead | #### Notes -- Authentication: use global flag `--api-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 `. AK/SK auth is deprecated and will be removed in a future version. +- `--workspace-id` is NOT required when using --api-key. #### Examples