Skip to content

回答卡片

本接口在 v25.9 版本中引入

  • 本接口用于成员查询问题,返回问题直接对应的回答卡片的网页链接,用于直接嵌入或者进一步处理
  • 在调用本接口前,确保你已经创建了工作区,并且用户加入了工作区成为了成员

请求方式

Request Method: POST
Request URL:    /openapi/v1/workspaces/{workspaceId}/data/card/
Request Header:
  Authorization: "{连接密钥}"

请求参数

{
  "memberUid": "{memberUid}",
  "text": "{text}",
  "autoLogin": 0,
  "skip_pre_rule": false
}

autoLogin 默认为 0,不做操作。设置成 1 后,返回的网址中会自带用户的登录信息,即直接打开网址自动登录查看数据。但是此种方式,每次都会重新生成用户的登录 Session,会导致之前的 Session 失效。请根据实际情况使用。

您可以通过接口生成用户的登录信息,然后自行拼接到网址后,也可以实现网址免登录,参见 获取用户的登录Token。

相关参数说明

参数 类型 必填 说明
workspaceId string 是 用户工作区的 id,需要放在请求的 URL 中
[连接密钥][api] string 是 API密钥。需要放在请求的 Header 中
memberUid string 是 工作区中成员的 uid,需要放在请求体内
text string 是 成员提的问题,比如“今年GMV”,需要放在请求体内
autoLogin int 否 是否自动登录。默认为 0 不做操作。可以设置成 1,但是需要注意此操作每次会刷新用户 Session 导致旧 Session 失效
skip_pre_rule boolean 否 是否跳过分词前规则,默认为 false(不跳过)

返回结果

如果问题被正确处理并成功返回,返回结果的 data 内包含如下字段:

参数 类型 说明
url string 卡片网址,可以直接嵌入网页中,也可以通过该网址直接打开网页查看数据
title string 简单的卡片标题
tokens string 问题的分词结果
cardType string 卡片类型
cardTokens string 卡片 Tokens
explanations list 该问题对应的解析解释
{
  "errcode": 200,
  "errmsg": "success",
  "data": {
    "url": "https://datarc.cn/#/singleQuery?question=W3siZW5kIjoiMjAyNC0xMC0wNiIsInByb3AiOiJkYXRlQmVmb3JlXzEwMGQiLCJzdGFydCI6IjIwMjQtMDYtMjkiLCJ3b3JkIjoi5YmNMTAw5aSpIn0seyJwcm9wIjoiZDgwIiwid29yZCI6IumXqOW6lyJ9LHsicHJvcCI6ImQ3OSIsIndvcmQiOiLnnIEifSx7InByb3AiOiJkNzciLCJ3b3JkIjoi5biCIn0seyJwcm9wIjoibTEiLCJ3b3JkIjoi6JCl5Lia6aKdIn1d&headless=1",
    "title": "门店省市营业额",
    "cardType": 7,
    "sentenceType": 3,
    "explanations": []
  }
}
  • 假如无法查的数据,会返回 400 错误
{
  "errcode": 400,
  "errmsg": "用户问题无法搜索出有效结果"
}