调用大模型服务

POST 
/v1/ai/:model/:path

当调用大模型时需要传递额外路径时，可追加 path 参数，如 v1/chat/completions。具体路径定义参考各大模型文档。

例如，直接调用月之暗面（moonshot）开放 API 时请求对话接口的地址为 https://api.moonshot.cn/v1/chat/completions，那么使用大模型接入服务时，需要填写模型名称为moonshot，并将原 URL 的 path 部分拼接到{path}参数上，即请求地址为 https://{envId}.api.tcloudbasegateway.com/moonshot/v1/chat/completions。

当前，腾讯混元（hunyuan）的 path 参数可以为空，调用的接口需通过请求头X-Tc-Action来传递。例如：X-Tc-Action: ChatCompletions，各接口 action 参考 https://cloud.tencent.com/document/api/1729/101848 。

Request

Path Parameters

model ModelEnumrequired

Possible values: [hunyuan, zhipu, 01-ai, moonshot, dashscope, ark]

调用的模型代码，下面中的一个
hunyuan: 腾讯混元
zhipu: 智谱清言
01-ai: 零一万物
moonshot: 月之暗面
dashscope: 阿里灵积
ark: 火山方舟


path stringrequired

对应大模型的调用路径，如 v1/chat/completions

application/json

Body

required

请求参数参考各个大模型文档进行传递。

object

Responses

200

调用大模型成功时返回（不一定返回正确结果）

Response Headers

• X-Request-Id string

  请求ID

application/json

Schema

Schema

property name* any

Example (from schema)

{
  "created": 1723618716,
  "id": "xxx",
  "model": "hunyuan",
  "version": "202403121316",
  "choices": [
    {
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": "我是一个由腾讯开发的人工智能助手，有什么我可以帮你的吗？"
      }
    }
  ],
  "search_info": {
    "mindmap": {}
  },
  "processes": {},
  "usage": {
    "prompt_tokens": 11,
    "completion_tokens": 14,
    "total_tokens": 25
  }
}

text/event-stream

Schema

Schema

string

400

请求失败

Response Headers

• X-Request-Id string

  请求ID

application/json

Schema

Schema

code string

错误码

message string

错误信息

requestId string

请求 ID

Example (from schema)

{
  "code": "string",
  "message": "string",
  "requestId": "string"
}

AIModelConfigMissing

缺少调用模型的必要配置，如 token, clientID 等(400)

{
  "code": "AI_MODEL_CONFIG_MISSING",
  "message": "xxx",
  "requestId": "xxx"
}

AIModelParamInvalid

调用模型的参数异常(400)

{
  "code": "AI_MODEL_PARAM_INVALID",
  "message": "xxx",
  "requestId": "xxx"
}

AIModelRequestFailed

请求模型失败(400)

{
  "code": "AI_MODEL_REQUEST_FAILED",
  "message": "xxx",
  "requestId": "xxx"
}

404

请求失败

Response Headers

• X-Request-Id string

  请求ID

application/json

Schema

Schema

code string

错误码

message string

错误信息

requestId string

请求 ID

Example (from schema)

{
  "code": "string",
  "message": "string",
  "requestId": "string"
}

FeatureNotConfigured

未启用大模型(404)

{
  "code": "ENV_FEATURE_NOT_CONFIGURED",
  "message": "xxx",
  "requestId": "xxx"
}

AIModelNotFound

未找到指定模型(404)

{
  "code": "AI_MODEL_NOT_FOUND",
  "message": "xxx",
  "requestId": "xxx"
}

default

通用报错信息，详见 https://docs.cloudbase.net/error-code/service

Response Headers

• X-Request-Id string

  请求ID

application/json

Schema

Schema

code string

错误码

message string

错误信息

requestId string

请求 ID

Example (from schema)

{
  "code": "string",
  "message": "string",
  "requestId": "string"
}

InvalidHost

请求地址异常

{
  "code": "INVALID_HOST",
  "message": "xxx",
  "requestId": "xxx"
}

Loading...