mirror of
https://github.com/modelstudioai/cli.git
synced 2026-09-14 19:49:23 +08:00
docs(cli): 更新 API Key 和相关链接地址
This commit is contained in:
zeyu.fz
@@ -9,7 +9,7 @@
|
||||
[](https://www.typescriptlang.org)
|
||||
[](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
|
||||
@@ -176,8 +176,8 @@ Config file location: `~/.bailian/config.json`
|
||||
| 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& |
|
||||
| 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
|
||||
|
||||
@@ -23,7 +23,7 @@ Use this index for the full quick index and global flags.
|
||||
| `bl file upload` | Upload a local file to DashScope temporary storage (48h) | [file.md](file.md) |
|
||||
| `bl image edit` | Edit an existing image with text instructions (Qwen-Image) | [image.md](image.md) |
|
||||
| `bl image generate` | Generate images (Qwen-Image / wan2.x) | [image.md](image.md) |
|
||||
| `bl knowledge retrieve` | Retrieve from a Bailian knowledge base (requires AK/SK) | [knowledge.md](knowledge.md) |
|
||||
| `bl knowledge retrieve` | Retrieve from a Bailian knowledge base | [knowledge.md](knowledge.md) |
|
||||
| `bl mcp call` | Call a tool on an MCP server (tools/call) | [mcp.md](mcp.md) |
|
||||
| `bl mcp list` | List MCP servers activated under your Bailian account | [mcp.md](mcp.md) |
|
||||
| `bl mcp tools` | List tools exposed by an MCP server (tools/list) | [mcp.md](mcp.md) |
|
||||
|
||||
@@ -7,9 +7,9 @@ Index: [index.md](index.md)
|
||||
|
||||
## Commands in this group
|
||||
|
||||
| Command | Description |
|
||||
| ----------------------- | ------------------------------------------------------- |
|
||||
| `bl knowledge retrieve` | Retrieve from a Bailian knowledge base (requires AK/SK) |
|
||||
| Command | Description |
|
||||
| ----------------------- | -------------------------------------- |
|
||||
| `bl knowledge retrieve` | Retrieve from a Bailian knowledge base |
|
||||
|
||||
## Command details
|
||||
|
||||
@@ -18,28 +18,33 @@ Index: [index.md](index.md)
|
||||
| Field | Value |
|
||||
| --------------- | -------------------------------------------------------------- |
|
||||
| **Name** | `knowledge retrieve` |
|
||||
| **Description** | Retrieve from a Bailian knowledge base (requires AK/SK) |
|
||||
| **Description** | Retrieve from a Bailian knowledge base |
|
||||
| **Usage** | `bl knowledge retrieve --index-id <id> --query <text> [flags]` |
|
||||
|
||||
#### Options
|
||||
|
||||
| Flag | Type | Required | Description |
|
||||
| --------------------------- | ------- | -------- | -------------------------------------------------- |
|
||||
| `--index-id <id>` | string | yes | Knowledge base index ID (required) |
|
||||
| `--query <text>` | string | yes | Search query (required) |
|
||||
| `--workspace-id <id>` | string | no | Bailian workspace ID (or env BAILIAN_WORKSPACE_ID) |
|
||||
| `--top-k <n>` | number | no | Number of results (default: 10) |
|
||||
| `--rerank` | boolean | no | Enable rerank |
|
||||
| `--rerank-top-n <n>` | number | no | Rerank top N results |
|
||||
| `--access-key-id <key>` | string | no | Alibaba Cloud Access Key ID (or env) |
|
||||
| `--access-key-secret <key>` | string | no | Alibaba Cloud Access Key Secret (or env) |
|
||||
| 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 (API-KEY only) |
|
||||
| `--sparse-similarity-top-k <n>` | number | no | Sparse retrieval top K (API-KEY only) |
|
||||
| `--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 (API-KEY only) |
|
||||
| `--rerank-mode <mode>` | string | no | Rerank mode: qa, similar, or custom (API-KEY only) |
|
||||
| `--rerank-instruct <text>` | string | no | Custom rerank instruction, when mode=custom (API-KEY only) |
|
||||
| `--top-k <n>` | number | no | Number of results (deprecated, use --rerank-top-n) |
|
||||
| `--workspace-id <id>` | string | no | Bailian workspace ID (required for AK/SK auth) |
|
||||
| `--access-key-id <key>` | string | no | Alibaba Cloud Access Key ID (deprecated) |
|
||||
| `--access-key-secret <key>` | string | no | Alibaba Cloud Access Key Secret (deprecated) |
|
||||
|
||||
#### Examples
|
||||
|
||||
```bash
|
||||
bl knowledge retrieve --index-id idx_xxx --query "如何使用阿里云百炼" --workspace-id ws_xxx
|
||||
bl knowledge retrieve --index-id idx_xxx --query "如何使用阿里云百炼"
|
||||
```
|
||||
|
||||
```bash
|
||||
bl knowledge retrieve --index-id idx_xxx --query "API限流" --top-k 5 --rerank
|
||||
bl knowledge retrieve --index-id idx_xxx --query "API限流" --rerank --rerank-model qwen3-rerank-hybrid
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user