基础配置
Options配置
功能板块配置
介绍
在创建简历的过程中，可根据自己的业务场景需要某个功能不需要进行展示的时候，可以调用此参数进行实现。
功能提示
该参数的配置具有父子级对应关系，如果开启了生成方式(2001)，那么AI智能生成和导入本地都会进行开启。
具体的接收值可以为布尔值、数组。不传递的情况下，则默认全部开启。
- 布尔值：传递true则代表全部开启，传递false则代表全部关闭。
- 数组：
[2002]代表只开启AI智能生成，[20030]代表只开启文件上传。 具体可参考下述场景值参考
场景值参考
使用方式
js
AiResumeIframe.show({
options: {
// plate: true, // 默认
plate: [2001, 2005, 2009]
},
})场景鉴权配置
介绍
在创建简历的过程中，根据自己的业务场景需要增加一些验证权限，可增加该配置。
功能提示
具体的接收值可以为布尔值、数组。
不传递的情况下，则默认全部不需要进行鉴权
- 布尔值：传递true则代表全部需要进行鉴权，传递false则代表全部不需要进行鉴权。
- 数组： [1001,1002] 代表只开启输入生成和上传本地简历文档需要进行验证权限。
具体可参考下述场景值参考
方法
| 参数值 | 详细说明 | 传参类型 |
|---|---|---|
| sceneAuthContinue | 是否通过当前的鉴权场景 true: 可进行到下一步 false: 不允许进行下一步 （具体可参考使用方式） | boolean |
场景值参考
使用方式
js
AiResumeIframe.show({
options: {
// sceneAuth: false, // 默认值
sceneAuth: [1004],
},
onMessage(type,data){
if (type === 'SCENE_AUTH') { // 鉴权功能验证
if (data.scene === 1004) { // 点击重新生成（大纲） 不允许进行下一步
AiResumeIframe.sceneAuthContinue(false);
} else {
AiResumeIframe.sceneAuthContinue(true); // 可继续执行下一步
}
}
}
})自定义创建功能
在创建简历的过程中，根据自己的业务场景可增加自由传递关键词或者文件跳转至自动生成大纲页面。
默认参数
| 参数 | 子参数 | 类型 | 详细说明 |
|---|---|---|---|
| customGenerate | mode | string | 生成模式。可选值： 1.ai-template：AI智能生成 2.optimize-local-resume：上传本地简历 |
| type | string | 生成类型。可选值：intern（实习）、campus（校招）、social（社招） 1.当mode为ai-template时必传。 2.当mode为optimize-local-resume时不需要传递该参数。 | |
| content | string|File | 1.当mode为ai-template时则类型为string 2.当mode为optimize-local-resume时则类型为File。 |
异常处理
| 异常问题描述 | 异常返回数据 |
|---|---|
| mode参数不匹配 | { code: -1, message: '自定义生成模式错误', type:'customGenerate' } |
| mode模式为ai-template且type为空 | { code: -1, message: '简历类型缺失', type:'customGenerate' } |
| mode模式为ai-template且type为不为指定参数 | { code: -1, message: '简历类型错误', type:'customGenerate' } |
| mode模式为ai-template且content为空 | { code: -1, message: '请输入岗位名称/描述或求职者信息', type:'customGenerate' } |
| mode模式为ai-template且content大于100字符 | { code: -1, message: '请输入100字以内的岗位名称/描述或求职者信息', type:'customGenerate' } |
| mode模式为optimize-local-resume且content为空 | { code: -1, message: '文件不能为空', type:'customGenerate' } |
| mode模式为optimize-local-resume且content不是对应的文件类型 | { code: -1, message: '文件格式错误', type:'customGenerate' } |
| mode模式为optimize-local-resume且content文件大小大于5M | { code: -1, message: '文件大小不能超过5M', type:'customGenerate' } |
默认使用方式
js
try {
await AiResumeIframe.show({
options: {
customGenerate: {
content: "标题",
type: 'ai-template'
}
}
})
} catch (e) { // 进行异常描述的信息捕获
console.log(e)
}RouterOptions配置
介绍
目前AI简历版本有三个页面：
- 简历任务列表页面(workspace)
- 简历任务生成页面(generate)
- 编辑器页面(editor)
可根据自己的需求进行配置自己需要的界面， 其中简历任务生成页面和编辑器页面必须存在，如果缺失，则不会进行创建Iframe页面；作品列表页面则可选择是否存在。
配置项
| 参数 | 说明 | 参考值 | 参数说明 |
|---|---|---|---|
| list | 路由配置项列表 | [workspace: 简历任务列表页面（可选）,generate: 简历任务生成页面（必选）,editor: 编辑简历页面（必选）] | 简历任务生成页面和编辑器页面必须存在 |
| editor | 调用AIResumeIframe.show方法的时候直接跳转进入编辑器页面 | {uid: 简历任务ID（如果初始化存在ID的时候则直接进入编辑简历页面）showLogo: 企业配置编辑器logo显示逻辑} | showLogo:0: 不显示内容 1: 显示企业LOGO 2: (默认)显示返回页任务列表页 |
使用说明
默认配置
js
try {
await AiResumeIframe.show({
routerOptions: {
list: ['workspace', 'generate', 'editor'],
}
})
} catch (e) { // 进行异常描述的信息捕获
console.log(e, 'catch exception')
}直接进入编辑简历页面
js
try {
await AiResumeIframe.show({
routerOptions: {
list: ['workspace', 'generate', 'editor'],
// 存在uid的情况下 则直接跳转至编辑器页面
editor: {
uid: 'Ur32CW8X'
}
}
})
} catch (e) { // 进行异常描述的信息捕获
console.log(e, 'catch exception')
}异常处理
| 异常问题描述 | 异常返回数据 |
|---|---|
| 只存在generate或editor页面 | { code: -1, message: 'routerOptions.list 中必须包含 generate 和 editor 页面', type:'routerOptions' } |