页面树结构

版本比较

标识

  • 该行被添加。
  • 该行被删除。
  • 格式已经改变。

...

代码块
languagejava
themeEclipse
titleJAVA示例代码示例代码
linenumberstrue
collapsetrue
public class GradleTest {
	public static void main(String[] args) throws Exception {
		String server = "http://域名:端口/smartbi";
    	String user = "user";
    	String password = "password";

    	ObjectMapper mapper = new ObjectMapper();
    	Map<String, String> cookies = new HashMap<>();
    	boolean useRmiLogin = true;
    	HttpRequest request = null;
    	if (useRmiLogin) {
    		String params = mapper.writeValueAsString(Arrays.asList(user, password));
    		request = HttpRequest.post(server + "/vision/RMIServlet")
    				.form("className", "UserService")
    				.form("methodName", "login")
    				.form("params", params);
	    	try (HttpResponse response = request.execute()) {
		    	for (HttpCookie cookie : response.getCookies()) {
		    		cookies.put(cookie.getName(), cookie.getValue());
		    	}
	    	}
    	} else {
    		// 以下的登录方式为使用openresoruce.jsp 等的URL访问方式
    		// 适用于修改了 Smartbi 的登录方式,不能直接通过 RMIServlet 用户密码登录
    		// I402882c701552f492f49736e01552f4df2c50013 是产品的一个内置报表,可根据需要修改
	    	request = HttpRequest.get(server + "/vision/openresource.jsp?"
	    			+ "resid=I402882c701552f492f49736e01552f4df2c50013&user=" + user
	    			+ "&password=" + URLEncoder.encode(password, "UTF-8"));
	    	try (HttpResponse response = request.execute()) {
		    	for (HttpCookie cookie : response.getCookies()) {
		    		cookies.put(cookie.getName(), cookie.getValue());
		    	}
	    	}
    	}
    	System.out.println(toCookie(cookies));
    	request = HttpRequest.post(server + "/vision/aichat/proxy/api/v1/login")
    			.cookie(toCookie(cookies))
    			.form("userName", user)
    			.form("smartbiServer", server)
    			.form("loginMethod", "login")
    			.form("cookie", toCookie(cookies));
    	String token = null;
    	try (HttpResponse response = request.execute()) {
	    	for (HttpCookie cookie : response.getCookies()) {
	    		cookies.put(cookie.getName(), cookie.getValue());
	    	}
	    	JsonNode tree = mapper.readTree(response.body());
			token = tree.get("token").asText();
    	}
    	// Thread.sleep(5000); // 旧版本由于存在问题,需要 sleep。 新版本后不需要
    	request = HttpRequest.post(server + "/vision/aichat/proxy/api/v3/conv/query_sync")
    			.cookie(toCookie(cookies))
    			.header("token", token)
    			// 数据模型ID
    			.form("datasetId", "Iff808081018354c854c8f0fa018354cbde880001")
    			// 对话ID
    			.form("convId", UUID.randomUUID().toString())
    			// 问句
    			.form("question", "车均价 ")
    			// 分析模式
    			.form("queryType", "analysis")
    			// 问句的ID
    			.form("id", UUID.randomUUID().toString())
    			.form("pageSize", "10000")
    			.form("showRows", "1000")
    			.form("need_inquiry", "false")
    			.form("onlyQueryChart", "false")
    			.form("autoRecommendedChart", "false");    	
		try (HttpResponse response = request.execute()) {
			System.out.println(new String(response.bodyBytes(), "UTF-8"));
		}		
	}

	private static String toCookie(Map<String, String> cookies) throws IOException {
		StringBuilder buff = new StringBuilder();
		for (Entry<String, String> entry : cookies.entrySet()) {
			buff.append(URLEncoder.encode(entry.getKey(), "UTF-8"));
			buff.append('=');
			buff.append(URLEncoder.encode(entry.getValue(), "UTF-8"));
			buff.append(';');
		}
		return buff.toString();
	}
}
	

4.3 查询接口(同步)


名称

描述

默认值

接口路径

http://host:port/aiweb/api/v3/conv/query_sync

接口说明

V3版本查询方法 --

同步方法

同步方法。

header

token

登录key,使用login方法获取;login方法请参考:登录AIChat

接口参数

convId

会话Id

datasetId

数据模型Id

question

用户问题


queryType

查询类型:

  • query(查询模式)

    • analysis(分析模式)

    • expert(专家模式)

    建议使用:analysis

    id

    本次对话id

    从外部传入才能做点赞点踩

    本次对话id,从外部传入用户才能使用“点赞”、“点踩”等功能。


    need_inquiry

    本次查询是否需要使用反问功能

    default(true)

    本次查询是否需要使用反问功能。

    默认值:true

    返回内容

    返回查询结果(JSON),前端处理

    返回查询结果(JSON),前端处理:

    {
        
    "code": 0,
        
    "result": "[\"[{\\\"年月\\\":\\\"2019-01\\\",\\\"销量\\\":132912,\\\"销量环比增长率\\\":\\\"-6.06%\\\",\\\"_销量占比\\\":\\\"8.8272%\\\"},...]",
        
    "message": null
    }

    code=0,表示返回正确(result是返回结果);否则message就是错误提示。

    4.4 中断查询


    名称

    描述

    默认值

    接口路径

    http://host:port/aiweb/api/v3/conv/stop_stream

    接口说明

    异步query方法情况下,中断当前查询

    异步query方法情况下,中断当前查询。

    header

    token

    登录key,使用login方法获取;login方法请参考:登录AIChat

    接口参数

    convId

    会话Id

    返回内容

    {
        
    code: 错误码(0 - 表示正确)
        
    message:错误描述
        
    result:方法执行返回结果 -- 服务端无返回则为空
    }

    4.5 新建查询对话


    名称

    描述

    默认值

    接口路径

    http://host:port/aiweb/api/v3/conv/new

    接口说明

    新建查询对话

    新建查询对话。

    header

    token

    登录key,使用login方法获取;login方法请参考:登录AIChat

    接口参数

    convId

    会话Id

    返回内容

    {
        
    code: 错误码(0 - 表示正确)
        
    message:错误描述
        
    result:方法执行返回结果 -- 服务端无返回则为空
    }

    4.6 关闭查询对话


    名称

    描述

    默认值

    接口路径

    http://host:port/aiweb/api/v3/conv/close

    接口说明

    关闭查询对话 --

    结束本次多轮对话

    结束本次多轮对话。

    header

    token

    登录key,使用login方法获取;login方法请参考:AIChat登录

    接口参数

    convId

    会话Id

    返回内容

    {
        code: 错误码(0 - 表示正确)
        message:错误描述
        result:方法执行返回结果 -- 服务端无返回则为空
    }

    4.7 获取本次对话推荐数据模型


    名称

    描述

    默认值

    接口路径

    http://host:port/aiweb/api/v3/conv/recommend_dataset

    接口说明

    获取本次对话推荐数据模型

    获取本次对话推荐数据模型。

    header

    token

    登录key,使用login方法获取;login方法请参考:登录AIChat

    接口参数

    convId

    会话Id

    question

    用户提问


    datasetId

    当前数据模型id


    返回内容

    {
        code: 错误码(0 - 表示正确)
        message:错误描述
        result:获取推荐的数据模型列表
    }

    4.

    ...

    8 获取本次对话的详细查询步骤和内容


    名称

    描述

    默认值

    接口路径

    http://host:port/aiweb/#/testTool?answerid=${id}

    GET请求

    示例:

    示例: http://10.10.35.110:9070/aiweb/#/testTool2?answerid=01fc76d5-7ec4-4fad-8216-d4b829ac740c

    接口说明

    获取本次对话的详细查询步骤和内容。

    获取本次对话的详细查询步骤和内容
    注意
    这个基本是前端接口,需要前端js辅助解析的,所以无法直接提供给第三方调用

    这个基本是前端接口,需要前端js辅助解析的,所以无法直接提供给第三方调用。


    接口参数

    id

    本次对话Id

    返回内容

    查询步骤说明html页面


    4.9 获取当前用户可以使用的数据模型列表

    名称

    描述

    默认值

    接口路径

    http://host:port/aiweb/proxy/aibus/get_using_themes

    接口说明

    获取当前用户可以使用的数据模型列表

    header

    token

    登录key,使用login方法获取;login方法请参考:登录AIChat

    接口参数



    返回内容

    {

    code: 错误码(0 - 表示正确)

    message:错误描述

    result:[{

    "id":                          数据模型themeID
    "name":                       数据模型名称
    "title":                        数据模型名称别名
    "desc":                      数据模型概览    
    "type":                        数据类型
    "recommendQuestion":           推荐问句
    "lastBuildTime":                 最近构建时间

    }]}

    ...