短语挖掘

一、接口描述

1. 功能描述

短语挖掘API主要用于语料中的新词识别,领域关键词抽取等工作。使用者可以传入一段待抽取的文本,API结果将返回从文本中识别的短语。

2. 能力说明

语言只支持中文,对于长文本的挖掘效果较好,适用于新闻,论文,专业著作等文本的短语术语挖掘。

3. 接口使用

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

二、请求说明

1. 接口地址

https://aiapi.jd.com/fagougou/phrase_extract

2. 请求方式

 get

3. 请求参数

(1) query请求参数

公共请求参数

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

业务请求参数

名称 类型 必填 示例值 描述
document string 算法工程师的算法能力特别重要 待挖掘的文本语料

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) 业务返回参数

名称 类型 字段说明 描述
err int 0 HTTP返回结果,0表示请求成功。错误号对应错误详情请看下文。
data dict 返回的主体信息,详情见下文。

data字段中的结构:

字段 类型 字段说明
phrases array 抽取出的短语构成的数组,如果未抽出短语,则为空数组。
msg string 返回的错误信息,如果为'ok'则表示返回正常。

2、返回示例

{
    "code": "10000",
    "charge": false,
    "remainTimes": 4998,
    "remainSeconds": -1,
    "msg": "查询成功",
    "result": {
        "data": {
            "msg": "ok",
            "phrases": [
                "算法工程师"
            ]
        },
        "err": 0,
    }
}

四、错误码

1.系统级错误码

详见返回码

Copyright © JD AI Platform all right reserved,powered by GitbookFile Modify: 2020-11-26 03:27:29

results matching ""

    No results matching ""