# 简历生成
# 1. 服务描述
简历智能生成,定制化需求:无论是面向校园招聘还是社会招聘,只需输入个人信息与求职需求,即刻量身打造专业简历,一键生成1~3份完整简历模板加内容,省时省力更省心;
# 2. 接口说明
# 2.1. 请求方法和URL
POST https://cn-huadong-1.xf-yun.com/v1/private/s73f4add9
注:全链路请求会话时长不超过1分钟
# 2.2. 接口Demo
Python demo (opens new window) Java demo (opens new window)
demo 覆盖部分语言,其他语言参照下方接口文档进行开发。
# 2.3. 接口要求
接口类型:非流式 [http(s)]
接口鉴权:使用签名机制进行鉴权,签名详情参照"http鉴权 (opens new window)"
# 3. 请求
# 3.1. 请求协议示例
{
"header": {
"app_id": appid,
"status": 3,
},
"parameter": {
"ai_resume": {
"resData": {
"encoding": "utf8",
"compress": "raw",
"format": "json"
}
}
},
"payload": {
"reqData": {
"encoding": "utf8",
"compress": "raw",
"format": "plain",
"status": 3,
"text":base64.b64encode(text.encode("utf-8")).decode('utf-8') # 文本base64之后的数据
}
}
}
# 3.2. 请求参数
# 3.2.1. header参数说明
字段 | 含义 | 类型 | 限制 | 是否必传 |
---|---|---|---|---|
app_id | 在平台申请的app id信息 | string | maxLength: 50 | 是 |
status | 请求状态,可选值为:3-一次传完 | int | 3 | 是 |
# 3.2.2. 服务特性参数
字段 | 含义 | 数据类型 | 取值范围 | 默认值 | 说明 | 必填 |
---|---|---|---|---|---|---|
encoding | 文本编码 | string | utf8, gb2312, gbk | utf8 | 取值范围可枚举 | 否 |
compress | 文本压缩格式 | string | raw, gzip | raw | 取值范围可枚举 | 否 |
format | 文本格式 | string | plain, json, xml | json | 取值范围可枚举 | 否 |
# 3.2.3. 请求数据
字段 | 含义 | 数据类型 | 取值范围 | 默认值 | 说明 | 必填 |
---|---|---|---|---|---|---|
encoding | 文本编码 | string | utf8, gb2312, gbk | utf8 | 取值范围可枚举 | 否 |
compress | 文本压缩格式 | string | raw, gzip | raw | 取值范围可枚举 | 否 |
format | 文本格式 | string | plain, json, xml | plain | 取值范围可枚举 | 否 |
status | 数据状态 | int | 3:一次性传完 | 3 | 取值范围为:3(一次传完) | 否 |
text | 文本数据 | string | 最小尺寸:1B, 最大尺寸:4194304B | 需base64编码,文本大小:0-4M | 是 |
# 4. 响应
# 4.1. 响应协议示例
{
"header": {
"code": 0,
"message": "success",
"sid": "ase000704fa@dx16ade44e4d87a1c802"
},
"payload": {
"resData": {
"encoding": "utf8",
"compress": "raw",
"format": "json",
"text": ""
}
}
}
协议结构说明
字段 | 含义 |
---|---|
header | 协议头部 |
payload | 响应数据块 |
resData | 响应数据块 |
# 4.2. 响应参数
# 4.2.1. header参数字段说明
字段 | 含义 | 类型 | 是否必选 |
---|---|---|---|
code | 返回码,0表示成功,其它表示异常 | int | 是 |
message | 错误描述 | string | 是 |
sid | 本次会话的id | string | 是 |
# 4.2.2. 响应数据参数说明
payload.resData(默认返回)
字段 | 含义 | 数据类型 | 取值范围 | 默认值 | 说明 | 必填 |
---|---|---|---|---|---|---|
encoding | 文本编码 | string | utf8, gb2312, gbk | utf8 | 取值范围可枚举 | 否 |
compress | 文本压缩格式 | string | raw, gzip | raw | 取值范围可枚举 | 否 |
format | 文本格式 | string | plain, json, xml | json | 取值范围可枚举 | 否 |
text | 文本数据 | string | 最小尺寸:1B, 最大尺寸:4194304B | 需base64编码,文本大小:0-4M | 是 |
# 4.3. 响应数据解析 {#4.3. 响应数据解析}
resData.text
示例:
{
"links": [
{
"img_url": null,
"word_url": null
}
]
}
# 5. 错误码列表 {#5. 错误码列表}
错误码示例:
{
"code":10003, // 平台通用错误码,详细信息请参照 5.1 平台通用错误码
"message":"WrapperInitErr;errno=101", // errno 为引擎错误码
"sid":"ocr00088c7d@dx170194697e9a11d902"
}
# 5.1. 平台通用错误码 {#5.1. 平台通用错误码}
# 错误码与错误描述
错误码 | 错误描述 | 说明 | 处理策略 |
---|---|---|---|
10009 | input invalid data | 输入数据非法 | 检查输入数据 |
10010 | service license not enough | 没有授权许可或授权数已满 | 提交工单 |
10019 | service read buffer timeout, session timeout | session超时 | 检查是否数据发送完毕但未关闭连接 |
10043 | Syscall AudioCodingDecode error | 音频解码失败 | 检查aue参数,如果为speex,请确保音频是speex音频并分段压缩且与帧大小一致 |
10114 | session timeout | session 超时 | 会话时间超时,检查是否发送数据时间超过了60s |
10139 | invalid param | 参数错误 | 检查参数是否正确 |
10160 | parse request json error | 请求数据格式非法 | 检查请求数据是否是合法的json |
10161 | parse base64 string error | base64解码失败 | 检查发送的数据是否使用base64编码了 |
10163 | param validate error:... | 参数校验失败 | 具体原因见详细的描述 |
10200 | read data timeout | 读取数据超时 | 检查是否累计10s未发送数据并且未关闭连接 |
10222 | context deadline exceeded | 1.上传的数据超过了接口上限;2.SSL证书无效 | 1.检查接口上传的数据(文本、音频、图片等)是否超越了接口的最大限制,可到相应的接口文档查询具体的上限;2.请将log导出发到工单:提交工单 (opens new window); |
10223 | RemoteLB: can't find valued addr | lb 找不到节点 | 提交工单 |
10313 | invalid appid | appid和apikey不匹配 | 检查appid是否合法 |
10317 | invalid version | 版本非法 | 请到控制台提交工单联系技术人员 |
10700 | not authority | 引擎异常 | 按照报错原因的描述,对照开发文档检查输入输出,如果仍然无法排除问题,请提供sid以及接口返回的错误信息,到控制台提交工单联系技术人员排查。 |
11200 | auth no license | 功能未授权 | 请先检查appid是否正确,并且确保该appid下添加了相关服务。若没问题,则按照如下方法排查。1.确认总调用量是否已超越限制,或者总次数授权已到期,若已超限或者已过期请联系商务人员。2.查看是否使用了未授权的功能,或者授权已过期。 |
11201 | auth no enough license | 该APPID的每日交互次数超过限制 | 根据自身情况提交应用审核进行服务量提额,或者联系商务购买企业级正式接口,获得海量服务量权限以便商用。 |
11503 | server error :atmos return an error data | 服务内部响应数据错误 | 提交工单 |
11502 | server error: too many datas in resp | 服务配置错误 | 提交工单 |
100001~100010 | WrapperInitErr | 调用引擎时出现错误 | 请根据message中包含的errno前往 5.2引擎错误码 查看对应的说明及处理策略 |
在这篇文章中: