Merge pull request #45 from modelstudioai/feat/knowledge-api-key

Feat/knowledge api key

Author: clark-fc

CHANGELOG.md

@@ -6,6 +6,27 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and
 
 [中文版](CHANGELOG.zh.md) · [README](README.md) · [Contributing](CONTRIBUTING.md)
 
+## [1.3.0] - 2026-06-10
+
+### Added
+
+- `bl knowledge retrieve` now supports API-Key authentication (DashScope gateway), in addition to AK/SK. API-Key is auto-detected and preferred when available.
+- New retrieval options: `--dense-similarity-top-k`, `--sparse-similarity-top-k`, `--rerank-model`, `--rerank-mode`, `--rerank-instruct` — supported on both API-Key and AK/SK paths.
+- `DashScopeKnowledgeRetrieveRequest` / `DashScopeKnowledgeRetrieveResponse` types and `knowledgeRetrieveEndpoint` added to `bailian-cli-core`.
+- Comprehensive E2E tests for knowledge retrieve covering both auth paths, dry-run, rerank flags, and error cases.
+
+### Changed
+
+- Credential resolution priority: explicit API-Key → explicit AK/SK flags → auto-detected API-Key → fallback AK/SK from config/env.
+- `--workspace-id` is now only required for AK/SK auth, no longer mandatory for API-Key mode.
+- `--top-k` deprecated in favor of `--rerank-top-n`; emits a warning and maps to `--rerank-top-n` when used.
+- `--access-key-id` / `--access-key-secret` flags marked as deprecated (API-Key is recommended).
+- API Key and console links updated to direct key management pages across all docs.
+
+### Fixed
+
+- `--rerank` flag in AK/SK path now correctly sets `EnableReranking` instead of the non-functional `Rerank: true` boolean.
+
 ## [1.2.1] - 2026-06-09
 
 ### Changed

CHANGELOG.zh.md

@@ -6,6 +6,27 @@
 
 [English](CHANGELOG.md) · [README](README.zh.md) · [参与贡献](CONTRIBUTING.zh.md)
 
+## [1.3.0] - 2026-06-10
+
+### 新增
+
+- `bl knowledge retrieve` 新增 API-Key 鉴权（DashScope 网关），与原有 AK/SK 并存，可用时自动优先使用 API-Key。
+- 新增检索参数：`--dense-similarity-top-k`、`--sparse-similarity-top-k`、`--rerank-model`、`--rerank-mode`、`--rerank-instruct`，API-Key 与 AK/SK 两条链路均支持。
+- `bailian-cli-core` 新增 `DashScopeKnowledgeRetrieveRequest` / `DashScopeKnowledgeRetrieveResponse` 类型及 `knowledgeRetrieveEndpoint` 端点。
+- 知识库检索全面 E2E 测试，覆盖两种鉴权路径、dry-run、rerank 参数及错误场景。
+
+### 变更
+
+- 凭据解析优先级：显式 API-Key → 显式 AK/SK flag → 自动检测 API-Key → 回退至配置/环境变量中的 AK/SK。
+- `--workspace-id` 仅在 AK/SK 鉴权时必填，API-Key 模式下不再强制要求。
+- `--top-k` 标记为废弃，改用 `--rerank-top-n`；使用时输出警告并自动映射。
+- `--access-key-id` / `--access-key-secret` 标记为废弃（推荐使用 API-Key）。
+- 全部文档中的 API Key 和控制台链接更新为直达密钥管理页面。
+
+### 修复
+
+- AK/SK 链路 `--rerank` 现在正确设置 `EnableReranking`，而非之前无效的 `Rerank: true` 布尔值。
+
 ## [1.2.1] - 2026-06-09
 
 ### 变更

packages/cli/README.md

@@ -9,7 +9,7 @@
 [![TypeScript](https://img.shields.io/badge/TypeScript-strict-3178c6)](https://www.typescriptlang.org)
 [![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
 
-[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&)
+[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)
 
 ---
 
@@ -119,7 +119,7 @@ bl usage free --model qwen3-max
 
 ### DashScope API Key
 
-Required for most commands. Get your key from the [DashScope Console](https://bailian.console.aliyun.com/cli?source_channel=key_github&).
+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).
 
 ```bash
 # Option 1: Environment variable
@@ -171,14 +171,14 @@ Config file location: `~/.bailian/config.json`
 
 ## Links
 
-| Resource                     | URL                                                               |
-| :--------------------------- | :---------------------------------------------------------------- |
-| Aliyun Model Studio CLI Site | https://bailian.console.aliyun.com/cli?source_channel=cli_github& |
-| DashScope API Docs           | https://help.aliyun.com/zh/model-studio/                          |
-| Qwen Model List              | https://help.aliyun.com/zh/model-studio/getting-started/models    |
-| Aliyun Model Studio Console  | https://bailian.console.aliyun.com/                               |
-| Get API Key                  | https://bailian.console.aliyun.com/cli?source_channel=key_github& |
-| Get AccessKey                | https://ram.console.aliyun.com/manage/ak                          |
+| Resource                     | URL                                                                                       |
+| :--------------------------- | :---------------------------------------------------------------------------------------- |
+| Aliyun Model Studio CLI Site | https://bailian.console.aliyun.com/cli?source_channel=cli_github&                         |
+| DashScope API Docs           | https://help.aliyun.com/zh/model-studio/                                                  |
+| Qwen Model List              | https://help.aliyun.com/zh/model-studio/getting-started/models                            |
+| Aliyun Model Studio Console  | https://bailian.console.aliyun.com/?source_channel=cli_github                             |
+| Get API Key                  | https://bailian.console.aliyun.com/cn-beijing/?source_channel=key_github&tab=app#/api-key |
+| Get AccessKey                | https://ram.console.aliyun.com/manage/ak                                                  |
 
 ## Changelog
 

packages/cli/README.zh.md

@@ -9,7 +9,7 @@
 [![TypeScript](https://img.shields.io/badge/TypeScript-strict-3178c6)](https://www.typescriptlang.org)
 [![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
 
-[阿里云百炼 CLI 官方主页](https://bailian.console.aliyun.com/cli?source_channel=cli_github&) · [English](https://github.com/modelstudioai/cli/blob/main/README.md) · [API 文档](https://help.aliyun.com/zh/model-studio/) · [获取 API Key](https://bailian.console.aliyun.com/cli?source_channel=key_github&)
+[阿里云百炼 CLI 官方主页](https://bailian.console.aliyun.com/cli?source_channel=cli_github&) · [English](https://github.com/modelstudioai/cli/blob/main/README.md) · [API 文档](https://help.aliyun.com/zh/model-studio/) · [获取 API Key](https://bailian.console.aliyun.com/cn-beijing/?source_channel=key_github&tab=app#/api-key)
 
 ---
 
@@ -114,7 +114,7 @@ bl usage free --model qwen3-max
 
 ### DashScope API Key
 
-大部分命令均需要 API Key。前往 [DashScope 控制台](https://bailian.console.aliyun.com/cli?source_channel=key_github&) 获取。
+大部分命令均需要 API Key。前往 [DashScope 控制台](https://bailian.console.aliyun.com/cn-beijing/?source_channel=key_github&tab=app#/api-key) 获取。
 
 ```bash
 # 方式一：环境变量
@@ -166,14 +166,14 @@ bl update
 
 ## 相关链接
 
-| 资源                    | 地址                                                              |
-| :---------------------- | :---------------------------------------------------------------- |
-| 阿里云百炼 CLI 官方主页 | https://bailian.console.aliyun.com/cli?source_channel=cli_github& |
-| DashScope API 文档      | https://help.aliyun.com/zh/model-studio/                          |
-| 通义千问模型列表        | https://help.aliyun.com/zh/model-studio/getting-started/models    |
-| 阿里云百炼控制台        | https://bailian.console.aliyun.com/                               |
-| 获取 API Key            | https://bailian.console.aliyun.com/cli?source_channel=key_github& |
-| 获取 AccessKey          | https://ram.console.aliyun.com/manage/ak                          |
+| 资源                    | 地址                                                                                      |
+| :---------------------- | :---------------------------------------------------------------------------------------- |
+| 阿里云百炼 CLI 官方主页 | https://bailian.console.aliyun.com/cli?source_channel=cli_github&                         |
+| DashScope API 文档      | https://help.aliyun.com/zh/model-studio/                                                  |
+| 通义千问模型列表        | https://help.aliyun.com/zh/model-studio/getting-started/models                            |
+| 阿里云百炼控制台        | https://bailian.console.aliyun.com/?source_channel=cli_github                             |
+| 获取 API Key            | https://bailian.console.aliyun.com/cn-beijing/?source_channel=key_github&tab=app#/api-key |
+| 获取 AccessKey          | https://ram.console.aliyun.com/manage/ak                                                  |
 
 ## 更新日志
 

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bailian-cli",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "CLI for Aliyun Model Studio (DashScope) AI Platform.",
   "keywords": [
     "agent",