API介绍

什么是API

Knowledge Works以REST API的方式对外提供服务。一站式解决您的语义分析诉求。从多个维度为您的应用场景提供海量背景知识。 API包括CN-dbpedia的知识图谱服务,CN-Probase的概念关系服务,智能验证码服务等,支持任何编程语言调用。

CN-DBpedia API

申明

If you want to cite our work, please use this publication:

Bo Xu, Yong Xu, Jiaqing Liang, Chenhao Xie, Bin Liang, Wanyun Cui, and Yanghua Xiao. CN-DBpedia: A Never-Ending Chinese Knowledge Extraction System. In International Conference on Industrial, Engineering and Other Applications of Applied Intelligent Systems, pp. 428-438. Springer, Cham, 2017.
api/cndbpedia/ment2ent
输入实体指称项名称(mention name),返回对应实体(entity)的列表,json格式。

请求参数

q:实体指称项名称(mention name);必填项
apikey:开发者的访问密钥;可选项(注:不加访问密钥会存在访问限制)

返回字段

status:本次API访问状态,如果成功返回“ok”,如果失败返回“fail”
ret: 返回entity name list

URL

http://shuyantech.com/api/cndbpedia/ment2ent?q=**
http://shuyantech.com/api/cndbpedia/ment2ent?q=**&apikey=**

Example

http://shuyantech.com/api/cndbpedia/ment2ent?q=红楼梦
api/cndbpedia/avpair
输入实体名,返回实体全部的三元组知识

请求参数

q:实体名称(entity name);必填项
apikey:开发者的访问密钥;可选项(注:不加访问密钥会存在访问限制)

返回字段

status:本次API访问状态,如果成功返回“ok”,如果失败返回“fail”
ret: 返回attribute-value pair list, 每个pair也是一个list ([attribute, value])

URL

http://shuyantech.com/api/cndbpedia/avpair?q=**
http://shuyantech.com/api/cndbpedia/avpair?q=**&apikey=**

Example

http://shuyantech.com/api/cndbpedia/avpair?q=复旦大学
api/cndbpedia/value
给定实体名和属性名,返回属性值

请求参数

q:实体名称(entity name);必填项
attr:属性名称(attribute name);必填项
apikey:开发者的访问密钥;可选项(注:不加访问密钥会存在访问限制

返回字段

status:本次API访问状态,如果成功返回“ok”,如果失败返回“fail”
ret: 返回value list

URL

http://shuyantech.com/api/cndbpedia/value?q=**&attr=**
http://shuyantech.com/api/cndbpedia/value?q=**&attr=**apikey=**

Example

http://shuyantech.com/api/cndbpedia/value?q=复旦大学&attr=英文名称

CN-Probase API

api/mention2entity
输入实体名称(mention),返回对应实体(entity)的列表,json格式。

请求参数

q:实体指称项名称(mention name);必填项
apikey:开发者的访问密钥;可选项(注:不加访问密钥会存在访问限制)

返回字段

status:本次API访问状态,如果成功返回“ok”,如果失败返回“fail”
ret: 返回entity name list

URL

http://shuyantech.com/api/cndbpedia/ment2ent?q=**
http://shuyantech.com/api/cndbpedia/ment2ent?q=**&apikey=**

Example

http://shuyantech.com/api/cnprobase/ment2ent?q=刘德华
api/getConcept
输入实体,返回实体对应概念列表,json格式。

请求参数

q:实体名称(entity name);必填项
apikey:开发者的访问密钥;可选项(注:不加访问密钥会存在访问限制)

返回字段

status:本次API访问状态,如果成功返回“ok”,如果失败返回“fail”
count:概念数量
pagesize:每次请求最多返回的概念数量
ret: 返回concept list,list中每个元素的格式[概念, 权重]

URL

http://shuyantech.com/api/cnprobase/concept?q=**
http://shuyantech.com/api/cnprobase/concept?q=**&apikey=**

Example

http://shuyantech.com/api/cnprobase/concept?q=刘德华
api/getEntity
输入概念,返回概念对应实体列表,json格式。默认返回前50个。

请求参数

q:概念(concept);必填项
start:控制翻页;可选项
apikey:开发者的访问密钥;可选项(注:不加访问密钥会存在访问限制)

返回字段

status:本次API访问状态,如果成功返回“ok”,如果失败返回“fail”
count:实体数量
pagesize:每次请求最多返回的实体数量
ret: 返回entity list,list中每个元素的格式[实体, 权重]

URL

http://shuyantech.com/api/cnprobase/entity?q=**
http://shuyantech.com/api/cnprobase/entity?q=**&apikey=**

Example

http://shuyantech.com/api/cnprobase/entity?q=男演员

Super V Code API

简介

知识工场强势推出“超级验证码”:一款基于机器语言认知和知识图谱的新一代验证码。以自然语言理解和问答为呈现形式,超级验证码给出常识性文本描述和对应问题,让用户在限定时间内在文本中找出答案,答对即验证通过。
(目前版本仅供测试使用,正式调用请联系徐波博士xubo@fudan.edu.cn)
验证码流程图
api/newquest
向验证码服务提供方请求验证码服务,验证码服务提供方提供JSON格式的验证码

请求参数说明:

返回参数说明:

名称 类型 说明
qid String 验证码问题ID
qtext string 验证码问题
optionlist List 选项列表,列表从0开始计数

URL

http://shuyantech.com:8866/api/newquest
api/answer
请求验证码服务提供方验证用户提交的答案是否正确,验证码服务提供方以JSON格式返回答案的相关信息。

请求参数说明:

名称 类型 必填 说明
qid string Yes 验证码问题ID
option int Yes 从optionlist中选择一个答案,用答案在列表的位置表示(从0开始计数)

返回参数说明:

名称 类型 说明
qresult int {0, 1},1为正确,0为错误
errortype string 当qresult为0时,返回验证码错误类型
qcertificate string 当qresult为1时,返回正确的证书

URL

http://shuyantech.com:8866/api/answer?qid=****&option=****
api/verify
请求验证码服务提供方验证用户提交的证书是否正确,验证码服务提供方以JSON格式返回证书的相关信息。

请求参数说明:

名称 类型 必填 说明
qid string Yes 验证码问题ID
qcertificate string Yes 验证码问题的证书

返回参数说明:

名称 类型 说明
certificatecode int {0, 1},1为正确,0为错误

URL

http://shuyantech.com:8866/api/verify?qid=****&qcertificate=****