Skip to content

API

Jump to bottom
foxueyuan edited this page Aug 15, 2018 · 17 revisions

语音输入API

接口定义

POST

  • 请求地址：

http://dev-foai.foschool.cn/ai/speech/asr

  • Header：
参数 是否必须 值
Content-Type 是 application/json
  • 请求参数：
参数 是否必须 类型 说明
speech 否 string 16k采样率语音的二进制数据 ，需要进行base64编码。与len参数连一起使用
len 否 int 语音数据的字节数，单位字节

返回示例：

{
   "errcode" : 0,
   "errmsg" : "ok",
   "content" : ""
}

对话API

接口定义

  • 请求方式：

POST

  • 请求地址：

http://dev-foai.foschool.cn/chat

  • Header：
参数 是否必须 值
Content-Type 是 application/json
  • 请求参数：
参数 是否必须 类型 说明
sid 否 int 初次会话不用提供，默认-1
text 否 string 待分析文本
speech 否 string 16k采样率语音的二进制数据 ，需要进行base64编码。与len参数连一起使用
source 否 int 0：虚拟机器人 1：实体机器人 默认：0
len 否 int 语音数据的字节数，单位字节

text与speech必须选择一种

返回示例：

{
   "errcode" : 0,
   "errmsg" : "ok",
   "sid" : -1,
   "data" : {}
}

data的具体格式参考以下文档。

指令消息

参数 是否必须 类型 说明
msgtype 是 string 消息类型，此时固定为：instruction
content 是 object 指令内容 
{
   "msgtype" : "instruction",
   "content" : {"action":"","resource":""}
}

content

参数 是否必须 类型 说明
action 是 string redirect:页面跳转 system:系统指令 shop:商城检索
resource 是 object/string 详细指令 
{"action":"redirect","resource":{"link_type":20,"category_id":6,"extra_params":{},"in_app":0}}
{"action":"system","resource":{"operation":"VOLUME_UP"}}
{"action":"system","resource":{"operation":"VOLUME_DOWN"}}
{"action":"system","resource":{"operation":"PLAY"}}
{"action":"system","resource":{"operation":"STOP"}}
{"action":"system","resource":{"operation":"PAUSE"}}
{"action":"system","resource":{"operation":"PLAY_PREV"}}
{"action":"system","resource":{"operation":"PLAY_NEXT"}}
{"action":"system","resource":{"operation":"PLAY_ON_LOOP"}}
{"action":"system","resource":{"operation":"PLAY_IN_ORDER"}}
{"action":"shop","resource":{"keyword":"法商三步曲"}}

文本消息

参数 是否必须 类型 说明
msgtype 是 string 消息类型，此时固定为：text
content 是 string 消息内容，最长不超过2048个字节 
{
   "msgtype" : "text",
   "content" : {"text": ""}
}

语音消息

参数 是否必须 类型 说明
msgtype 是 string 消息类型，此时固定为：voice
voiceurl 是 string 语音链接 
{
   "msgtype" : "voice",
   "content" : {"voiceurl" : ""}
}

视频消息

参数 是否必须 类型 说明
msgtype 是 string 消息类型，此时固定为：video
title 否 string 视频消息的标题，不超过128个字节，超过会自动截断
description 否 string 视频消息的描述，不超过512个字节，超过会自动截断
picurl 否 string 视频封面图片链接
url 是 string 视频链接 
{
    "msgtype" : "video",
    "content" : {
        "video" : {
            "url" : "",
            "picurl" : "",
            "title" : "",
            "description" : ""
        }
    }
}

图文消息

参数 是否必须 类型 说明
msgtype 是 string 消息类型，此时固定为：news
articles 是 string 图文消息，一个图文消息支持1到8条图文
title 是 string 标题，不超过128个字节，超过会自动截断
description 否 string 描述，不超过512个字节，超过会自动截断
url 是 string 点击后跳转的链接
picurl 否 string 图文消息的图片链接
btntxt 否 string 按钮文字，仅在图文数为1条时才生效。 默认为“阅读全文” 
{
    "msgtype" : "news",
    "content" : {
        "news" : {
            "articles" : [
                {
                    "title" : "",
                    "description" : "",
                    "url" : "",
                    "picurl" : "",
                    "btntxt":"更多"
                }
            ]
        }
   }
}

CMS API

接口定义

content management system api

  • 请求方式：

GET

  • 请求地址：

http://dev-foai.foschool.cn/cms/v1/questions?tag=<tag_string>&reviewed=<reviewed>&scroll_id=<scroll_id>

  • 说明 如果律师review过后，增加reviewed字段，查询逻辑会过滤掉reviewed=true的问题 分页为深分页，由于条数过多浅分页会造成OOM，深分页不能回退。分页参数scroll_id,默认分页是20，目前不开放修改

  • Header：

参数 是否必须 值
Content-Type 是 application/json
  • 请求参数：
参数 是否必须 类型 说明
tag 否 string 问题类型
reviewed 否 boolean 是否评论过 true/false
scroll_id 否 string 用作ES分页，第一次请求时不需要加此参数，下一页开始每次都需要加上该属性

请求示例：

1.初始化： http://dev-foai.foschool.cn/cms/v1/questions?tag=刑事辩护

返回示例：

{
    "questions": [
        {
            "_id": "AWIyyRtn7YT7ZlJSzG5h",
            "answers": [
                "故意杀人的，处死刑、无期徒刑或者十年以上有期徒刑；情节较轻的，处三年以上十年以下有期徒刑",
                "你好，故意杀人罪，三年以上有期徒刑，如需帮助来电免费咨询。",
                "没有了解案情无法给出回答。涉及很多具体情节，要会见、阅卷后再谈。需要帮助可与本律师联系。",
                "十年以上有期徒刑，若需帮助请致电本律师。",
                "可以判处十年以上，无期徒刑，死刑。"
            ],
            "question": "我的朋友几个人喝了酒打架把人打死现在自首一个被抓一个其他都在逃，我想知道他们能判多少年？",
            "tag": "刑事辩护",
            "title": "故意杀人罪.我想知道他们能判多少年？"
        },
        {
            "_id": "AWIyyRtn7YT7ZlJSzG5m",
            "answers": [
                "再无其他犯罪情形的情况下，三年以上七年以下，五万元当在5-6年左右。",
                "处三年以下有期徒刑。",
                "根据司法解释的规定，盗窃五万的，属“数额巨大”，会处三年以上十年以下有期徒刑，并处罚金。但是最终的宣告刑是多少还需视具体案情而定。"
            ],
            "question": "盗窃罪五万左右判多久",
            "tag": "刑事辩护",
            "title": "盗窃罪五万左右判多久"
        }
    ],
    "scroll_id": "DnF1ZXJ5VGhlbkZldGNoBgAAAAAAAt15FlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAALdehZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAC3XsWWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQAAAAAAAt18FlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAALdfRZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAC3X4WWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQ==",
    "total": 8058
}

2.下一页： http://dev-foai.foschool.cn/cms/v1/questions?tag=刑事辩护&scroll_id=DnF1ZXJ5VGhlbkZldGNoBgAAAAAAAt15FlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAALdehZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAC3XsWWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQAAAAAAAt18FlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAALdfRZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAC3X4WWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQ==

返回示例：

{
    "questions": [
        {
            "_id": "AWIyySuo7YT7ZlJSzHXs",
            "answers": [
                "明显不合理的低价，未按规定登记身份证，可能构成掩饰隐瞒犯罪所得罪，也就是通俗的销脏罪，",
                "不知者不罪。",
                "你好，不知情的话不构成犯罪的。",
                "这个归还被收缴的，一般是不构成犯罪的。"
            ],
            "question": "人民法律,在不知情的情况下而收购了抢劫来的黄金怎么定罪?",
            "tag": "刑事辩护",
            "title": "在不知情的情况下而收购了抢劫来的黄金怎么定罪?"
        },
        {
            "_id": "AWIyySuo7YT7ZlJSzHYn",
            "answers": [
                "是否判处死刑与案发时间无关，主要看手段是否残忍、后果是否严重、主观恶意大小，认罪态度、被害人是否谅解等因素。",
                "要看犯罪的情节、后果和社会影响来定罪量刑的。",
                "一般是不会的，但是可以判处无期",
                "一般不会判死刑的",
                "要看具体的案情。"
            ],
            "question": "我97年的杀人了,法律会给我判死刑吗",
            "tag": "刑事辩护",
            "title": "我97年的杀人了,法律会给我判死刑吗"
        }
    ],
    "scroll_id": "DnF1ZXJ5VGhlbkZldGNoBgAAAAAAAt15FlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAALdehZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAC3XsWWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQAAAAAAAt18FlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAALdfRZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAC3X4WWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQ==",
    "total": 8058
}
  • 请求方式：

GET

  • 请求地址：

http://dev-foai.foschool.cn/cms/v1/tags

  • Header：
参数 是否必须 值
Content-Type 是 application/json
  • 请求参数：
参数 是否必须 类型 说明

请求示例：http://dev-foai.foschool.cn/cms/v1/tags 返回示例：

[
"劳动纠纷",
"婚姻家庭"
]
  • 请求方式：

POST（**HTTPS**）

  • 请求地址：

http://dev-foai.foschool.cn/cms/v1/questions/<_id>

  • Header：
参数 是否必须 值
Content-Type 是 application/json
  • body：
参数 是否必须 类型 说明
final_answer 是 string 律师给出的最终答案
reviewed 是 boolean 是否评论过
updated_tag 否 string 修改后的tag

请求示例： http://dev-foai.foschool.cn/cms/v1/questions/AWIyuqeG7YT7ZlJSzFnD

{
"final_answer": "根据合同约定处理，发生争议不能协商解决，可以申请劳动仲裁。",
"reviewed": true,
"updated_tag": "劳动纠纷--可以为空"
}

Clone this wiki locally