1、接口描述
智能解析评论文本内容,将文本转化为结构化的属性字段,自动甄别正负面评论观点标签。
2、请求方法
POST
3、接口要求
- 文本长度不超过512
- 中文字符占比需高于50%,这里的中文字符仅包括汉字,不包括中英文标点、数字、特殊符号、英文等
4、URI
/v1/aiop/api/2gyuqiiopt6o/text/textanalyse/api/textopinion
5、请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
Content-Type | 是 | String | json 格式 | application/json | |
appkey | 是 | String | 应用appkey | 562b89493b1a40e1b97ea05e50dd8170 | |
ctyun-eop-request-id | 是 | String | 用户请求 id,由用户构造,用户可以通过 uuid 等方法自行生成唯一字符串,用于日志请求追踪。 详见文档:Python3调用示例 |
33dfa732-b27b-464f-b15a-21ed6845afd5 | |
eop-date | 是 | String | 请求时间,由用户构造,形如 yyyymmddTHHMMSSZ。 详见文档:Python3调用示例 |
20211221T163014Z | |
host | 是 | String | 终端节点域名,固定字段 | ai-global.ctapi.ctyun.cn | |
Eop-Authorization | 是 | String | 由天翼云官网 accessKey 和 securityKey 经签名后生成,参与签名生成的字段包括天翼云官网 accessKey 、securityKey、平台应用的appkey(非必须),用户请求 id(非必须),请求时间,终端节点域名(非必须)以及请求体内容。 签名逻辑详见文档:认证鉴权和Python3调用示例 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
data | 是 | Object | 由评价文本内容和评价文本所属类别构成的dict | data |
表data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
text | 是 | String | 评价文本内容 | 环境很不错... | |
cate | 是 | String | 评价文本所属类别,目前适用的类别有hotel、catering、shopping三类 | catering |
6、请求代码示例
Curl -X POST
"https://ai-global.ctapi.ctyun.cn/v1/aiop/api/2gyuqiiopt6o/text/textanalyse/api/textopinion"
-H "Content-Type: application/json"
-H "ctyun-eop-request-id:33dfa732-b27b-464f-b15a-21ed6845afd5"
-H "AppKey:XXX"
-H "Eop-Authorization:XXX"
-H "Eop-date:20211109T104641Z"
-H "Host:ai-global.ctapi.ctyun.cn"
--data '{"data":{"text":"环境很不错,不愧是老店~服务热情,倒车停车还有工作人员主动帮忙,三文鱼尤其好吃,五星好评","cate":"catering"}}'
7、返回值说明
请求成功返回响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | int | 返回状态,返回 0 表示成功,返回错误代码参考下面的错误代码列表 | 0 | |
message | 是 | String | 如果statusCode 为 0,返回 success;如果 statusCode非 0,则返回对应的可读错误信息 | success | |
returnObj | 是 | object | 返回的商品评价文本解析的结果对象 | returnObj |
表returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
Aspect | 否 | String | 文本中提到的商品属性 | ||
Opinion | 否 | String | 文本中与商品属性相对应的评论观点 | ||
Category | 否 | String | 商品属性所属类别 | ||
Polarity | 否 | String | 与文本中提到的商品属性相对应的情感极性 |
请求失败返回响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Int | 错误码,放置API对应的错误码 | 4001 | |
message | 是 | String | 返回对应的错误信息 | error | |
details | 是 | String | 返回对应的错误描述 | 请求中未包含文本 | |
error | 是 | String | 返回对应的错误码 | AI_OP_4001 |
8、 返回值示例
请求成功返回值示例
{
"statusCode": 0,
"message": "success",
"returnObj": [
{
"Aspect": "服务",
"Opinion": "好",
"Category": "服务",
"Polarity": "正面"
},
{
"Aspect": "房费",
"Opinion": "贵",
"Category": "价格",
"Polarity": "负面"
}
]
}
请求失败返回值示例
{
"statusCode": 4001,
"message": "error",
"details": "请求中未包含文本",
"error":"AI_OP_4001"
}
9、状态码
http状态码 | 描述 |
---|---|
200 | 表示请求成功 |
10、错误码说明
4 位错误码。4 开头为业务错误码,5 开头为服务错误码。
错误码 | 错误信息 | 错误描述 |
---|---|---|
AI_OP_4001 | 请求中未包含文本 | 请求体中未传入待分析的有效文本字符串 |
AI_OP_4002 | 请求参数异常 | 请求的参数格式不正确或者参数名错误或参数缺失,如仅传入text未传入cate |
AI_OP_4004 | 单条文本长度超过限度 | 传递的文本超过规定的最大文本长度,最大长度为512 |
AI_OP_4005 | 请求文本为非法字符串 | 传递的文本中存在大量的非中文字符,中文字符占比需高于50% |
AI_OP_5000 | 服务内部错误 | 服务内部发生错误,需要联系管理员处理 |