观远chatbi public-api 接口说明
  1. 会话
观远chatbi public-api 接口说明
  • public-api 使用文档
  • public-api
    • 知识库
      • public-api 获取问答知识库
    • 反馈
      • public-api 消息收藏列表
      • public-api 常用问题列表
      • public-api 添加常用问题
      • public-api 更新常用问题
      • public-api 删除常用问题
      • public-api 收藏消息
      • public-api 重命名收藏标题
      • public-api 取消收藏消息
      • public-api 点赞踩
    • 主题
      • public-api 主题列表
      • public-api 获取主题的使用者和所有者
      • public-api 获取主题配置
      • public-api 查询 theme_info
      • 获取分析专家列表
    • 会话
      • public-api 会话列表
        GET
      • public-api 获取会话状态
        GET
      • public-api 发送消息
        POST
      • public-api L1发送消息(同步版)
        POST
      • public-api 停止生成
        POST
      • public-api L1单条消息详情
        GET
      • public-api L1会话消息列表
        GET
      • public-api L2单组回复消息v3
        GET
      • public-api L2会话消息列表v3
        GET
      • public-api L2单条回复内容
        GET
      • public-api L2会话报告列表
        GET
      • public-api 删除会话
        POST
      • public-api 重命名会话
        POST
      • public-api 触发SQL查询的解释说明
        POST
      • public-api 引导问题
        POST
      • public-api L1推荐问题
        POST
  1. 会话

public-api L1会话消息列表

GET
/public-api/chat/list-message

请求参数

Query 参数

Header 参数

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/public-api/chat/list-message?theme_id&session_id' \
--header 'Timestamp;' \
--header 'Cookie: uIdToken=xxx' \
--header 'Content-Type: application/json'

返回响应

🟢200成功
application/json
Body

示例
{
    "code": 200,
    "data": [
        {
            "theme_id": "3d9bc079-74c4-4aae-bee1-550beec6f0fa",
            "session_id": "b338272b-e020-4d1e-bc33-3d25c8ac16f8",
            "message_id": "6b6f5ba0-390a-44a7-93d4-6dcab72cb70f",
            "question": "销售增长率Top10的城市",
            "rewritten_question": "销售增长率Top10的城市",
            "answer": {
                "action": "query",
                "explain": "该查询旨在找出销售增长率最高的前十个城市,通过计算每个城市每月的销售额,并与上月销售额进行比较,最终得出平均增长率。",
                "thoughts": "To find the top 10 cities with the highest sales growth rate, I need to calculate the growth rate for each city and then order them by this rate.",
                "query": "WITH `CityMonthlySales` AS (SELECT `终端市`, `年`, `月`, SUM(`金额`) AS `月销售额` FROM `明细表` WHERE `终端市` <> '' GROUP BY `终端市`, `年`, `月`), `CityGrowthRates` AS (SELECT `终端市`, `年`, `月`, `月销售额`, LAG(`月销售额`) OVER (PARTITION BY `终端市` ORDER BY `年`, `月`) AS `上月销售额` FROM `CityMonthlySales`), `CityGrowthCalculations` AS (SELECT `终端市`, `年`, `月`, (`月销售额` - `上月销售额`) / `上月销售额` AS `增长率` FROM `CityGrowthRates` WHERE NOT `上月销售额` IS NULL) SELECT `终端市`, AVG(`增长率`) AS `平均增长率` FROM `CityGrowthCalculations` GROUP BY `终端市` ORDER BY `平均增长率` DESC LIMIT 10"
            },
            "sql": "WITH `CityMonthlySales` AS (SELECT `终端市`, `年`, `月`, SUM(`金额`) AS `月销售额` FROM `明细表` WHERE `终端市` <> '' GROUP BY `终端市`, `年`, `月`), `CityGrowthRates` AS (SELECT `终端市`, `年`, `月`, `月销售额`, LAG(`月销售额`) OVER (PARTITION BY `终端市` ORDER BY `年`, `月`) AS `上月销售额` FROM `CityMonthlySales`), `CityGrowthCalculations` AS (SELECT `终端市`, `年`, `月`, (`月销售额` - `上月销售额`) / `上月销售额` AS `增长率` FROM `CityGrowthRates` WHERE NOT `上月销售额` IS NULL) SELECT `终端市`, AVG(`增长率`) AS `平均增长率` FROM `CityGrowthCalculations` GROUP BY `终端市` ORDER BY `平均增长率` DESC LIMIT 10",
            "card": {
                "dimensions": [
                    "终端市"
                ],
                "metrics": [
                    {
                        "name": "平均增长率",
                        "formatType": "PERCENTAGE"
                    }
                ],
                "viz_config": {
                    "xAxis": [
                        {
                            "type": "category"
                        }
                    ],
                    "yAxis": [
                        {
                            "type": "value"
                        }
                    ],
                    "series": [
                        {
                            "type": "bar",
                            "encode": {
                                "x": "终端市",
                                "y": "平均增长率",
                                "value": null,
                                "itemName": null
                            },
                            "yAxisIndex": null,
                            "label": true
                        }
                    ]
                }
            },
            "recommended_cards": [
                {
                    "card_id": "p3316b9dbf8ed4b479500962",
                    "card_name": "用户访问次数",
                    "page_id": "sfaa1c3306db24e2e8ba1d14",
                    "page_name": "BI平台用户行为分析",
                    "recommend_id": "ab5dc6e4-83df-4100-a026-40750abe126d",
                    "relevance_score": 6.466653,
                    "is_relevant_feedback": true
                }
            ],
            "table": [
                {
                    "table_id": "n46c4d92b623041ada6c209c",
                    "table_name": "明细表"
                }
            ],
            "user_info": {
                "user_id": "bWF0YW9AZ3VhbmRhdGEuY29t",
                "username": null
            },
            "feedback": {
                "is_collected": false,
                "vote": {
                    "vote_type": null,
                    "comment": null
                }
            },
            "answer_status": "success",
            "created_at": "2024-10-08 17:35:11",
            "query_status": "success",
            "query_result": {
                "columns": [
                    {
                        "name": "终端市",
                        "fdType": "STRING",
                        "seqNo": 0
                    },
                    {
                        "name": "平均增长率",
                        "fdType": "DOUBLE",
                        "seqNo": 1
                    }
                ],
                "preview": [
                    [
                        "桂林市",
                        "32.409091"
                    ],
                    [
                        "石家庄市",
                        "21.696739"
                    ],
                    [
                        "呼和浩特市",
                        "8.650959"
                    ],
                    [
                        "郑州市",
                        "5.961451"
                    ],
                    [
                        "神农架林区",
                        "5.760847"
                    ],
                    [
                        "恩施市",
                        "5.396952"
                    ],
                    [
                        "南昌市",
                        "1.935376"
                    ],
                    [
                        "张家界市",
                        "1.039843"
                    ],
                    [
                        "抚州市",
                        "0.641807"
                    ],
                    [
                        "鄂州市",
                        "0.622905"
                    ]
                ]
            }
        }
    ]
}
修改于 2026-03-03 06:31:35
上一页
public-api L1单条消息详情
下一页
public-api L2单组回复消息v3
Built with