在成功创建网关访问密钥后,您就可以开始使用边缘大模型网关提供的 API 调用方法,来访问各种支持的模型和智能体。您的调用请求将由边缘大模型网关负责路由到指定的目标模型。
在向边缘大模型网关发起 API 调用请求时,有两个参数是必须提供的:
网关访问密钥(api_key
)
这是您的专属密钥,用于验证调用者身份。您可以在控制台通过 查看密钥 按钮获取该密钥。
目标模型(model
)
指定本次调用要使用的模型。该模型必须包含在您网关访问密钥关联的模型列表中。您可以在控制台通过 查看代码 按钮,查看当前密钥支持的所有模型以及相应的调用示例。
了解以上信息基础上,您可以参考使用网关访问密钥来发起调用请求。
总体而言,边缘大模型网关的 API 接口与 OpenAI 保持兼容,但在某些细节上也有差异。
例如,边缘大模型网关中的部分预置模型和智能体,其 API 接口定义与 OpenAI 有所不同。在调用这些模型或智能体时,请参考边缘大模型网关提供的专属接口文档。其他情形下,您都可以参考 OpenAI 的相关 API 说明发起请求。
下表罗列了平台预置模型和智能体的 API 定义参考链接。
说明
如果您调用第三方模型,一律以模型提供商平台的接口说明为准。
平台预置资源类型 | API 定义 | 参考链接 |
---|---|---|
智能体(Agent) | 以边缘大模型网关 API 定义为准 | |
对话模型(Chat) | 与 OpenAI /v1/chat/completions 接口一致 | Create chat completion |
语音识别(ASR, Automatic Speech Recognition)模型 | HTTP 调用方法与 OpenAI | 注意 Doubao-语音识别模型目前只支持以下格式的音频文件:pcm(pcm_s16le)。 |
Realtime 调用方法以边缘大模型网关 API 定义为准 | 使用 Realtime API 调用 Doubao - 语音识别模型 | |
语音合成(TTS, Text to Speech)模型 | HTTP 调用方法与 OpenAI /v1/audio/speech 接口一致 | Create speech |
Realtime 调用方法以边缘大模型网关 API 定义为准 | 使用 Realtime API 调用 Doubao - 语音合成模型 | |
同声传译模型 | 以边缘大模型网关 API 定义为准 | 使用 Realtime API 调用 Doubao - 同声传译模型 |
文生图(Text to Image)模型 | 与 OpenAI /v1/images/generations 接口一致 | Create image |
向量化(Embedding)模型 | 与 OpenAI /v1/embeddings 接口一致 | Create embeddings |