短文本相似度

一、接口描述

1. 功能描述

短文本相似度API提供不同短文本之间相似度的计算,输出的相似度是一个介于0到1之间的实数值,越大则相似度越高。这个相似度值可以直接用于结果排序,也可以作为一维基础特征作用于更复杂的系统。

2. 接口使用:

平台为每个API提供试用体验服务,您在AI市场选择“免费试用”规格下单后,即可开始体验业内领先的人工智能API服务。 免费试用服务具有调用量、QPS限制,如需更高性能的API服务,可以提交咨询工单,联系京东AI扩容购买。

使用接口前,需要先完成API的下单购买,然后可使用已经封装好的SDK/参照接口鉴权规则进行相应开发,整体流程详见 接入流程

二、请求说明

1. 接口地址 :

https://aiapi.jd.com/jdai/similarity

2. 请求方式:

 get/post

3. 请求参数

(1)query请求参数

公共请求参数

名称 类型 必填 示例值 描述
appkey string 80d2b762ecb86593f9668526920f46c 您的appkey,可在买家中心控制台中获
timestamp long 1541491668060 请求的时间戳,精确到毫秒,timestamp有效期5分钟
sign string 2e148773a0337a8f2200ba90d445f083 签名,根据规则MD5(sectetkey+timestamp)

(2)header请求参数

业务请求参数

名称 类型 必填 示例值 描述
Content-Type string application/json 表示请求JSON格式的文本信息

(3)body请求参数

业务请求参数

名称 类型 必填 示例值 描述
text1 string 克林顿访问中国 输入文本1
text2 string 尼克松访华 输入文本2

4、请求代码示例

建议您使用我们提供的SDK进行调用,SDK获取及调用方式详见本页一接口描述中的4接口使用

三、返回说明

1、返回参数

(1)公共返回参数

名称 类型 示例值 描述
code string 1000 参见下方错误码-系统级错误码
charge boolean false 或 true false:不扣费, true:扣费
remainTimes long 1305 剩余调用次数;免费api:每天剩余调用次数;收费api:剩余次数;无限制时为-1
remainSeconds long 1223456 剩余调用时间(s);免费api:-1;收费api:剩余调用时间;无限制时为-1
msg string 查询成功 参见下方错误码-系统级错误码数
result object {...} 查询结果

(2)业务返回参数

status、message、request_id根据网关定义如下,如不一致请同步给产品经理

名称 类型 示例值 描述
status int 0 参照四、错误码-业务错误码
message string OK 参照四、错误码-业务错误码
request_id string 5893465d31284468a8014de6ee430f8e 便于双方定位问题
similarity object {"score":0.19182715292135427,"text1":"克林顿访问中国","text2":"尼克松访华"} 相似度结果,,详情下面similarity字段说明

similarity字段说明

名称 类型 示例值 描述
text1 string 克林顿访问中国 输入文本1
text2 int 尼克松访华 输入文本2
score double 0.19182715292135427 相似度 0~1,分数越高表示两个文本越相似。

2、返回示例

此处内容为通过网关后返回的结果,包含公共返回参数

{
    "code": "10000",
    "charge": false,
    "remainTimes": 4998,
    "remainSeconds": -1,
    "msg": "查询成功",
    "result": {
         "status": 0,
         "request_id": "8f47d951-34fe-4fac-b96c-d60d0a9bd719",
         "message": "ok",
         "similarity": {
              "score": 0.19182715292135427,
              "text1": "克林顿访问中国",
              "text2": "尼克松访华"
         }
    }
}

四、错误码

1.系统级错误码(固定文案,请保留)

详见返回码

2.业务错误码

业务错误码(status) message 说明
12001 "Invalid parameter" 无效参数
12002 "Missing parameter" 缺少参数
12003 "Error parsing parameter information" 参数解析错误
Copyright © JD AI Platform all right reserved,powered by GitbookFile Modify: 2020-11-26 03:27:29

results matching ""

    No results matching ""