API 介绍

本文介绍了百度智能云千帆大模型平台提供的API能力，以及如何调用API的流程等。

API 列表

百度智能云千帆平台提供了丰富的API，包括对话Chat、续写Completions、向量Embeddings、插件应用、Prompt工程、模型服务、管理、调优及数据管理等API能力，详情请查看API列表。

• 模型相关
  • 对话Chat：支持创建chat，用于发起一次对话。
  • 续写Completions：支持创建completion，用于发起一次续写请求，不支持多轮会话等。
  • 向量Embeddings：支持Embeddings，用于根据输入内容生成对应的向量表示。
  • 自定义模型：平台支持HuggingFace Transformer架构的自定义大模型导入，将自定义模型发布为服务，并支持通过相关API调用该服务。
  • 图像Images：提供图像相关API能力。
• 模型服务：提供创建服务、获取服务详情等API能力。
• 模型管理：提供获取模型、模型版本详情及将训练任务发布为模型等API能力。
• 模型调优：提供创建训练任务、任务运行、停止任务运行及获取任务运行详情等API能力。
• 数据管理：提供创建数据集、导入导出数据集等API能力。
• Prompt工程：提供模版相关API能力。
• 插件应用：提供域内知识搜索增强插件API相关能力。

API 调用流程简介

API 的调用流程如下图所示，详情请查看 API 调用流程介绍。

1. 创建千帆应用。
   登录百度智能云千帆控制台创建应用，创建成功后，在应用列表页获取AppID、API Key、Secret Key 等信息。如果已有千帆应用，可以在应用列表页查看已有应用的API Key、Secret Key 等信息。
2. API 授权。
   对应用的 AppID 进行授权。
3. 获取接口访问凭证 access_token 。
   根据第1步获取的 API Key 和 Secret Key ，调用获取access_token接口获取 access_token ，通过 access_token 鉴权调用者身份。
4. 调用API接口。
   例如调用ERNIE-Bot相关接口，详见API列表。

在线调试

千帆大模型平台提供了 API在线调试平台-示例代码 ，用于帮助开发者调试接口，平台集成快速检索、查看开发文档、查看在线调用的请求内容和返回结果、复制和下载示例代码等功能，简单易用，更多内容请查看API在线调试介绍。

具体操作可查看视频：[快速上手API调用](https://bce-doc-on.bj.bcebos.com/ wenxinworkshop/千帆-调用服务.mp4)。

SDK

千帆大模型平台提供了 SDK，开发者可使用 SDK，快捷地开发功能，提升开发效率。SDK 支持对话Chat、续写Completions、向量Embeddings、模型管理、模型服务、模型调优等调用。
如何通过SDK 调用千帆大模型平台相关能力，请查看千帆 SDK 介绍。

错误码

在调用API请求后，可以通过返回的错误码、错误信息及排查建议等进行问题排查，请参考错误码列表。