Cohere
Cohere 提供 Command 模型以及生成、Embedding 和 rerank API。AISIX 将这些能力置于由网关管理的凭证、调用方访问权限、限流和用量核算之后。
Cohere 发布了原生 API,以及用于 OpenAI 形态请求的兼容性 API。本指南使用兼容性 API 处理 Chat Completions 和 Embedding,然后为 rerank 单独配置原生 API。
准备工作
开始前,请准备以下内容:
- 一套 AISIX 环境:
- 对于 AISIX Cloud,需要一个已关联网关的环境和具有写入作用域的 Admin Token。对于 On-Premises,请按照 AISIX Cloud 快速入门操作。如需申请 Hybrid Cloud 访问权限,请联系 API7。
- 对于开源 AISIX 网关,请准备本地 AISIX 安装,或使用开源 AISIX 网关快速入门中的 Docker 配置。配置网关以加载声明式资源文件。
- 从 Cohere 控制台获取的 Cohere API Key。
- 已安装
curl和jq。
使用 AISIX Cloud 配置
导出 AISIX Cloud 连接信息:
# AISIX_CP 是 Admin API 基础 URL;应包含 /api,且不含尾部斜杠
# 本地私有化部署快速入门使用 http://localhost:8080/api
export AISIX_CP="YOUR_AISIX_CLOUD_ADMIN_API_URL"
export AISIX_TOKEN="YOUR_ADMIN_TOKEN"
export ENV_ID="YOUR_ENVIRONMENT_ID"
为 Cohere 支持的 Chat Completions 路由创建服务提供方密钥、模型别名和调用方 API Key。
AISIX 通过 openai 适配器连接 Cohere 兼容性 API。Chat Completions 和 Embedding 无需请求转换。Cohere rerank 使用原生 API,并要求使用添加 Rerank 模型中配置的独立服务提供方密钥。
创建服务提供方密钥
创建用于存储 Cohere 凭证和 API 根路径的服务提供方密钥:
# 请替换为实际值
export COHERE_API_KEY="YOUR_PROVIDER_API_KEY"
PROVIDER_KEY_ID=$(curl -sS -X POST "$AISIX_CP/provider_keys" \
-H "Authorization: Bearer $AISIX_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"display_name": "cohere-prod",
"provider": "cohere",
"api_key": "'"${COHERE_API_KEY}"'",
"api_base": "https://api.cohere.ai/compatibility/v1",
"allowed_environments": ["'"${ENV_ID}"'"]
}' | jq -r '.provider_key.id')
echo "$PROVIDER_KEY_ID"
❶ provider 为 cohere。AISIX Cloud Admin API 从目录服务提供方派生适配器;adapter 字段仅接受 BYO 服务提供方密钥。
❷ api_key 存储 Cohere API Key。它遵循服务提供方密钥中的凭证处理行为。
❸ api_base 指向 Cohere 兼容性 API。该路径在 /v1 版本段之前包含 /compatibility,因为 OpenAI 形态路由与 Cohere 原生 API 使用不同的前缀。AISIX 会向该基础路径追加 /chat/completions。对于 cohere 目录服务提供方,该字段为可选项;省略时 AISIX Cloud Admin API 会填入相同的值。示例仍显式设置该字段,使配置中始终可以看到每个密钥指向的界面。
该命令会把返回的服务提供方密钥 ID 保存到 PROVIDER_KEY_ID。
创建模型
Cohere 模型 ID 由系列名称和发布日期组成:command-a-03-2025 是 command-a 系列 2025 年三月的快照,能力变体会在日期前添加后缀,例如 command-a-reasoning-08-2025 或 command-a-vision-07-2025。日期是 ID 的一部分,因此根据目录 ID 创建的模型别名会固定到一个快照。当前 ID 请查看 Cohere 模型列表。
创建调用方将在请求中发送的模型别名:
MODEL_ID=$(curl -sS -X POST "$AISIX_CP/environments/$ENV_ID/models" \
-H "Authorization: Bearer $AISIX_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"display_name": "cohere-command-a-prod",
"model_name": "command-a-03-2025",
"provider_key_id": "'"${PROVIDER_KEY_ID}"'"
}' | jq -r '.model.id')
echo "$MODEL_ID"
❶ display_name 是调用方在 model 中发送的别名。
❷ model_name 是 Cohere 模型 ID,例如 command-a-03-2025、command-a-plus-05-2026 或 command-a-reasoning-08-2025。
❸ provider_key_id 将别名关联到 Cohere 服务提供方密钥。
创建调用方 API Key
创建能够访问该模型别名的调用方 API Key。明文密钥由服务器生成,并只在响应中返回一次,请安全保存:
AISIX_API_KEY=$(curl -sS -X POST "$AISIX_CP/environments/$ENV_ID/api_keys" \
-H "Authorization: Bearer $AISIX_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"display_name": "cohere-caller",
"allowed_models": ["'"${MODEL_ID}"'"]
}' | jq -r '.plaintext')
echo "$AISIX_API_KEY"
allowed_models 值必须引用上一步保存的模型 ID。写入后,配置会自动投射到已关联的网关。
使用开源 AISIX 网关配置
导出上游凭证,并选择应用将发送给网关的调用方 API Key:
export COHERE_API_KEY="YOUR_PROVIDER_API_KEY"
export CALLER_API_KEY="YOUR_CALLER_API_KEY"
对于新网关,请使用此完整资源文件。对于现有网关,请将这些条目合并到其当前文件中,并保留其他资源:
_format_version: "1"
provider_keys:
- display_name: "cohere-prod"
provider: "cohere"
adapter: "openai"
api_key: ${COHERE_API_KEY}
api_base: "https://api.cohere.ai/compatibility/v1"
models:
- display_name: "cohere-command-a-prod"
provider: "cohere"
model_name: "command-a-03-2025"
provider_key: "cohere-prod"
api_keys:
- display_name: "cohere-caller"
key_env: CALLER_API_KEY
allowed_models:
- "cohere-command-a-prod"
如果 AISIX 安装在本地,请在加载前验证文件:
aisix validate --resources resources.yaml
验证后,在网关进程环境中提供文件引用的环境变量,再启动网关。仅当这些变量已经可供进程使用时,才重新加载现有网关;否则,请使用更新后的环境重启网关。
如果使用 Docker,请调整开源 AISIX 网关快速入门中的验证和启动命令。挂载此 resources.yaml 文件,并在两条命令中使用 -e 传入它引用的每个环境变量。资源加载后,准备下文共用的验证请求:
export AISIX_API_KEY="$CALLER_API_KEY"