# 情感分析 API 文档

# 接口说明

以哈工大社会计算与信息检索研究中心研发的 “语言技术平台（LTP）” 为基础，为用户提供针对 中文（简体） 文本的情感分析服务。情感分析(Sentiment Analysis) 是文本分类的一个分支，是对带有情感色彩（褒义贬义/正向负向）的主观性文本进行分析，以确定该文本的观点、喜好、情感倾向。

该能力是通过HTTP API的方式给开发者提供一个通用的接口，适用于一次性交互数据传输的AI服务场景。相较于SDK，API具有轻量、跨语言的特点，不过请注意该接口使用的HTTP API协议不支持跨域。

该文档展示的情感分析V1旧版，新版接口请参考新版V2。

# 接口Demo

示例demo 请点击 这里 下载。
目前仅提供部分开发语言的demo，其他语言请参照下方接口文档进行开发。
也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo。

# 接口要求

集成情感分析API时，需按照以下要求。

# 接口调用流程

注： 调用接口前需配置IP白名单，IP白名单规则请参照 IP白名单。

1. 通过接口密钥基于MD5计算签名，将签名以及其他参数放在Http Request Header中，详见下方 请求头 。
2. 将文本数据放在Http Request Body中，以POST表单的形式提交，详见下方 请求体 。
3. 向服务器端发送Http请求后，接收服务器端的返回结果，返回结果详见各接口的详细说明。

接口地址示例：

	POST http[s]://ltpapi.xfyun.cn/v1/sa HTTP/1.1
	Content-Type:application/x-www-form-urlencoded; charset=utf-8

# 白名单

在调用该业务接口时，授权认证通过后，服务端会检查调用方IP是否在讯飞开放平台配置的IP白名单中，对于没有配置到白名单中的IP发来的请求，服务端会拒绝服务。
注：

• IP白名单，在 控制台-我的应用-相应服务的应用管理卡片上 编辑，保存后五分钟左右生效；
  
• 不同Appid的不同服务都需要分别设置IP白名单；
  
• IP白名单需设置为外网IP，请勿设置局域网IP；
• 如果服务器返回结果如下所示(illegal client_ip)，则表示由于未配置IP白名单或配置有误，服务端拒绝服务。解决办法请参考 IP白名单问题汇总。

{
    "code":"10105",
    "desc":"illegal access|illegal client_ip",
    "data":"",
    "sid":"xxxxxx"
}

# 接口请求参数

# 请求头

在 Http Request Header 中配置以下参数。

# 授权认证

以下参数用于授权认证：

注：

• APIKey：接口密钥，在讯飞开放平台控制台添加相应服务后即可获取，调用方注意保管，如泄露，可到控制台提交工单联系技术人员重置；
  
• X-CheckSum 有效期：出于安全性考虑，每个 X-CheckSum 的有效期为 5 分钟(用 X-CurTime 计算)，同时 X-CurTime 要与标准时间同步，否则时间相差太大，服务端会直接认为 X-CurTime 无效；
  
• BASE64 编码采用 MIME 格式，字符包括大小写字母各26个，加上10个数字，和加号 + ，斜杠 / ，一共64个字符。
  

*X-CheckSum *生成示例：

String APIKey="abcd1234"; 
String X-CurTime="1502607694";
String X-Param="eyAiYXVmIjogImF1ZGlvL0wxNjtyYXR...";
String X-CheckSum=MD5(apiKey + X-CurTime + X-Param);

# 业务参数

X-Param 为各配置参数组成的 JSON 串经 BASE64 编码之后的字符串，原始 JSON 串各字段说明如下：

X-Param生成示例：

原始JSON串：
{
    "type": "dependent"
}
BASE64编码（即X-Param）：
eyJ0eXBlIjoiZGVwZW5kZW50In0=

# 请求体

以POST表单的形式提交以下参数：

注：
1）一般基础类库会默认进行urlencode处理，请注意不要重复处理

# 接口返回参数

返回值为json串，各字段如下：

data各字段说明如下：

备注：negative_prob、neutral_prob、positive_prob三者累加等于1，三者得分最高的结果决定sentiment值。

结果示例如下：

失败结果：

    {
        "code": "10105",
        "desc": "illegal access|invalid X-Appid",
        "data": {},
        "sid": "ltp0000a744@ch78290eb1e128000100"
    }

成功结果：

    {
        "code": "0",
        "data": {
            "sa": [
                {
                    "negative_prob": 0.015691879079758858,
                    "neutral_prob": 0.03726633179759517,
                    "positive_prob": 0.9470417891226458,
                    "sentiment": 1
                }
            ]
        },
        "desc": "success",
        "sid": "ltp00000002@dx381d0efd452f000100"
    }

# 调用示例

情感分析demo go语言

情感分析demo php语言

情感分析demo java语言

情感分析demo python3语言

情感分析demo c#语言

# 常见问题

# 情感分析的主要功能是什么？

答：情感分析即文本倾向性分析，就是计算机判断人们的看法或评论是属于对事物的积极、消极或中性意见。

# 情感分析报错10105是什么意思？

答：请检查appid，apiKey，ip白名单，checkSum等授权参数是否正确。

# 情感分析如何试用？

答：登录讯飞开放平台后，进入情感分析页面，点击“服务管理”，添加IP白名单，下载相应的demo，填写appid和apikey即可调用Web api接口。