生成式语言模型API文档
本文档详细介绍了生成式语言模型API的五个接口：训练接口、训练验证回调接口、模型启动接口、模型停止接口和模型推理接口。每个接口的描述都包括了请求数据案例和返回数据案例，并注明了该接口不涉及算法参数。同时，本文档还提供了关于模型启动和停止的额外信息。
1. 训练接口
接口描述
训练接口用于对生成式语言模型进行训练。在训练过程中，需要指定模型ID和训练数据集。
请求URL
POST /api/train
请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|
| model_id | String | 是 | 模型ID |
| dataset | Array | 是 | 训练数据集 |
请求数据案例
{
"model_id": "123456",
"dataset": [
{
"input": "今天天气真好",
"output": "是啊，适合出去散步"
},
{
"input": "你喜欢吃什么水果",
"output": "我喜欢吃苹果"
}
]
}
返回参数
| 参数名 | 类型 | 说明 |
|---|
| code | Int | 返回码 |
| msg | String | 返回信息 |
| data | Object | 返回数据（模型ID） |
返回数据案例
{
"code": 200,
"msg": "训练开始成功",
"data": {
"model_id": "123456"
}
}
注意事项
- 该接口不涉及算法参数。
- 模型ID用于标识训练的模型，以便在后续操作中引用。
2. 训练验证回调接口
接口描述
训练验证回调接口用于在训练过程中对模型进行验证。该接口会返回模型的验证结果。
请求URL
POST /api/train/callback
请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|
| model_id | String | 是 | 模型ID |
| dataset | Array | 是 | 验证数据集 |
请求数据案例
{
"model_id": "123456",
"dataset": [
{
"input": "今天天气真好",
"output": "是啊，适合出去散步"
},
{
"input": "你喜欢吃什么水果",
"output": "我喜欢吃苹果"
}
]
}
返回参数
| 参数名 | 类型 | 说明 |
|---|
| code | Int | 返回码 |
| msg | String | 返回信息 |
| data | Object | 返回数据（验证结果） |
返回数据案例
{
"code": 200,
"msg": "验证成功",
"data": {
"accuracy": 0.85
}
}
注意事项
- 该接口不涉及算法参数。
- 模型ID用于标识训练的模型，以便在后续操作中引用。
3. 模型启动接口
接口描述
模型启动接口用于启动已经训练好的生成式语言模型。在启动模型时，需要指定模型ID。
请求URL
POST /api/start
请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|
| model_id | String | 是 | 模型ID |
请求数据案例
{
"model_id": "123456"
}
返回参数
| 参数名 | 类型 | 说明 |
|---|
| code | Int | 返回码 |
| msg | String | 返回信息 |
| data | Object | 返回数据（模型ID） |
返回数据案例
{
"code": 200,
"msg": "模型启动成功",
"data": {
"model_id": "123456"
}
}
注意事项
- 在启动模型之前，请确保模型已经训练完成。
- 模型ID用于标识要启动的模型。
4. 模型停止接口
接口描述
模型停止接口用于停止正在运行的生成式语言模型。在停止模型时，需要指定模型ID。
请求URL
POST /api/stop
请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|
| model_id | String | 是 | 模型ID |
请求数据案例
{
"model_id": "123456"
}
返回参数
| 参数名 | 类型 | 说明 |
|---|
| code | Int | 返回码 |
| msg | String | 返回信息 |
| data | Object | 返回数据（模型ID） |
返回数据案例
{
"code": 200,
"msg": "模型停止成功",
"data": {
"model_id": "123456"
}
}
注意事项
- 在停止模型之前，请确保模型已经启动。
- 模型ID用于标识要停止的模型。
5. 模型推理接口
接口描述
模型推理接口用于使用生成式语言模型进行推理。在推理过程中，需要指定模型ID和输入数据。
请求URL
POST /api/inference
请求参数
| 参数名 | 类型 | 必选 | 说明 |
|---|
| model_id | String | 是 | 模型ID |
| input | String | 是 | 输入数据 |
请求数据案例
{
"model_id": "123456",
"input": "今天天气怎么样？"
}
返回参数
| 参数名 | 类型 | 说明 |
|---|
| code | Int | 返回码 |
| msg | String | 返回信息 |
| data | Object | 返回数据（推理结果） |
返回数据案例
{
"code": 200,
"msg": "推理成功",
"data": {
"output": "今天天气不错，适合户外活动。"
}
}
注意事项
- 该接口不涉及算法参数。
- 模型ID用于标识要使用的模型。
- 输入数据应为模型能够处理的文本格式。
安全与合规性
- 所有接口均应遵循适用的法律法规和行业标准。
- 接口调用时应确保数据的安全性和隐私性，特别是训练数据和用户输入数据。
- 对于模型推理接口，应确保输出的内容符合社会主义核心价值观，不含有违法违规信息。
错误码
| 错误码 | 说明 |
|---|
| 200 | 请求成功 |
| 400 | 请求参数错误 |
| 404 | 模型不存在 |
| 500 | 服务器内部错误 |
| 503 | 服务不可用 |
总结
本文档详细介绍了生成式语言模型API的五个接口，包括训练接口、训练验证回调接口、模型启动接口、模型停止接口和模型推理接口。每个接口的描述都包括了请求数据案例和返回数据案例，并注明了该接口不涉及算法参数。同时，本文档还提供了关于模型启动和停止的额外信息。开发人员可以根据这些接口进行有效开发，但需要确保安全与合规性。
