新增元数据接口
场景描述
给第三方接入方调用,实现新增元数据,用于工单类型识别和工单字段抽取的功能。
接口方法
设置成“POST”。
URL
https://IP:PORT/oifde/rest/api/batchAddPromptMetaData
消息头
|
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|---|
|
1 |
Content-Type |
String |
True |
固定填 application/json; charset=UTF-8。 |
|
2 |
userName |
String |
True |
参见C3 智能助手平台接口鉴权方式中的说明下的第三点的appKey。 |
|
3 |
token |
String |
True |
生成方式参见C3 智能助手平台接口鉴权方式。 |
请求说明
|
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
|---|---|---|---|---|
|
tenantId |
String |
body |
True |
租户ID。 |
|
category |
String |
body |
True |
工单类型。 |
|
typeId |
String |
body |
True |
工单类型ID |
|
language |
String |
body |
True |
语言。选项如下:
|
|
description |
String |
body |
False |
工单类型描述 |
|
addPromptMetaDataInfoList |
metaData[] |
body |
True |
元数据对象数组 |
|
Name |
Mandatory |
Type |
Description |
|---|---|---|---|
|
metaDataId |
True |
String |
元数据ID(工单字段ID) |
|
metaDataName |
True |
String |
元数据名称(工单字段名称) |
|
fieldType |
True |
String |
元数据类型(工单类型) |
|
metaDataDesc |
False |
String |
元数据描述(工单字段描述) |
响应说明
|
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
|---|---|---|---|---|
|
errorCode |
int |
body |
True |
错误码
|
|
errorMsg |
String |
body |
True |
响应信息 |
|
data |
int |
body |
True |
新增数据量 |
|
count |
int |
body |
True |
新增数据量 |
报文样例
- 请求样例
{ "category": "宽带故障维修", "tenantId": "2023010325181111", "typeId": "301ElNaslZCkK11111111kkkk", "language": "zh_CN", "description":"宽带故障维修", "authToken":"E2mjXcv*******************XX1av", "addPromptMetaDataInfoList": [ { "metaDataId": "AICC111", "metaDataName": "地址", "fieldType": "String" }, { "metaDataId": "AICC112", "metaDataName": "姓名", "fieldType": "String", "metaDataDesc": "客户姓名" }, { "metaDataId": "AICC113", "metaDataName": "性别", "fieldType": "String", "metaDataDesc": "客户性别" }, { "metaDataId": "AICC114", "metaDataName": "联系人号码", "fieldType": "String", "metaDataDesc": "客户号码" } ] } - 响应样例
{ "errorCode": 0, "errorMsg": null, "data": 5, "count": 5 }