1、接口描述
用于自动分析用户评论的情感倾向性,并给出评论观点的情感极性类别(积极或消极),目前仅支持中文识别。
2、请求方法
POST
3、接口要求
- 文本长度不超过256
- 中文字符占比需高于50%,这里的中文字符仅包括汉字,不包括中英文标点、数字、特殊符号、英文等
4、URI
/v1/aiop/api/2gyv07uqvroc/text/textanalyse/api/sentiment
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 | 是 | String | 待分析的文本字符串 | 今天天气不错 |
6、请求代码示例
Curl -X POST
"https://ai-global.ctapi.ctyun.cn/v1/aiop/api/2gyv07uqvroc/text/textanalyse/api/sentiment"
-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":"今天天气不错"}'
7、返回值说明
请求成功返回响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Int | 返回状态,返回 0 表示成功,返回错误代码参考下面的错误代码列表 | 0 | |
message | 是 | String | 如果statusCode 为 0,返回 success;如果 statusCode非 0,则返回对应的可读错误信息 | success | |
returnObj | 是 | Object | 返回的情感分析结果对象 | returnObj |
表returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
pro_neg | 是 | Float | 请求文本所表达的情绪是负面的概率 | 0.5 | |
pro_pos | 是 | Float | 请求文本所表达的情绪是正面的概率 | 0.5 |
请求失败返回响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Int | 接口状态码 | 400001 | |
error | 是 | String | 返回错误码,代码参考下面的错误代码列表 | AI_OP_400001 | |
message | 是 | String | 返回对应的错误信息 | error | |
details | 是 | String | 返回对应的错误描述 | 请求中未包含文本 |
8、返回值示例
请求成功返回值示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"pro_neg" :0.0033719746861606,
"pro_pos" :0.9966280460357666,
}
}
请求失败返回值示例
{
"statusCode": 400001,
"error": "AI_OP_400001",
"message": "error",
"details": "请求路径错误"
}
9、状态码
http状态码 | 描述 |
---|---|
200 | 表示请求成功 |
10、错误码说明
6位错误码。4 开头为业务错误码,5 开头为服务错误码。
错误码 | 错误信息 | 错误描述 |
---|---|---|
AI_OP_400001 | 请求路径错误 | 请求路径错误 |
AI_OP_400002 | 请求方法错误 | 请求方法错误,请使用POST请求 |
AI_OP_400003 | 请求内容为空 | 请求体请求数据为空,没有包含内容 |
AI_OP_400004 | 请求体非json格式 | 请求体内容需要符合json要求 |
AI_OP_400005 | 请求体类型错误 | 请求体需为字典,不能为其他类型 |
AI_OP_400006 | 必传的参数未传 | 必传的参数(data)未传 |
AI_OP_400008 | 请求体的参数字段类型错误 | data字段应该是string类型 |
AI_OP_400009 | 请求体的参数字段值为空 | data字段值为空 |
AI_OP_420001 | 文本长度超过限制 | 文本输入过长,请参考接口文档说明 |
AI_OP_420003 | 中文占比过低 | 文本中的中文(仅包含汉字,不包含任何数字、符号)占比不低于50% |
AI_OP_500001 | 服务接口异常,请联系管理员 | 需要联系管理员处理 |