OraAI 智能分析 API

零代码集成
全自动 AI 分析 + PDF 报告

通过简单的 API 调用，传递数据库凭证和自然语言需求，OraAI 自动完成数据连接、元数据生成、AI 洞察与专业报告导出。支持多表关联、跨库联邦，为企业提供即插即用的智能分析能力。

零代码集成自然语言查询多表关联 PDF 报告导出

POST /api/v2/public/auto-analysis

curl -X POST https://api.oraai.com/api/v2/public/auto-analysis \

-H "Authorization: Bearer <token>" \

-H "Content-Type: application/json" \

-d '{

"targetWarehouse": {"id": 1 },

"dataset": {"tableName": "sales" },

"analysis": {"query": "分析本季度销售额趋势"}

}

响应: taskId + 状态轮询异步引擎 2-5min 完成

零代码集成

无需预配数据源，直接传递凭证即可开启智能分析。

自然语言分析

输入业务问题，AI 自动探索数据，生成洞察与可视化。

多表关联

智能推断表间关系，支持跨表联邦查询，统一视图。

PDF 报告导出

专业级报告，可直接下载分享，永久存档。

快速开始

准备工作

获取 API Key：OraAI 控制台 → 设置 → API Key → 生成 JWT（5 年有效）
准备只读数据库账号，确保网络可访问（建议白名单 OraAI 出口 IP）
可选：复制已存在的数据源 ID（UUID）便于复用

# 首次调用示例 (cURL)

curl -X POST https://api.oraai.com/api/v2/public/auto-analysis \

-H "Content-Type: application/json" \

-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \

-d '{

"targetWarehouse": {"id": 1 },

"dataset": {"tableName": "sales_data"},

"analysis": {"query": "分析本季度销售额趋势"}

}

→ 返回 taskId，状态 queued，预估时间 120s

查询分析结果（轮询）

GET /api/v2/public/auto-analysis-status/:taskId

建议每 10 秒轮询一次，完成响应包含 reportUrl (PDF) 和 summary 摘要。

API 详细规范

认证方式 · 请求结构 · 完整字段解析

认证方式

Authorization: Bearer <your_jwt_token>— 所有 API 请求必需，JWT 格式 5 年有效期。

创建分析任务 POST /api/v2/public/auto-analysis

参数	必需	说明
targetWarehouseId	是	目标仓库 ID（来自 /api3/target-warehouses）
dataset.tableName	是	字符串或对象(sources 多表模式)
analysis.query	是	自然语言分析需求，如「分析各区域销售趋势」
output.language	否	zh / en，默认中文

// 多表模式示例

"dataset": {

"tableName": {

"sources": [

"table": "sales", "alias": "销售"},

"table": "customers", "alias": "客户", "prefix": "c_"}

]

}

查询任务状态

GET /api/v2/public/auto-analysis-status/:taskId返回 queued / processing / completed / failed

完成响应:

{"status":"completed","result":{"reportUrl":"https://...","summary":"..."}}

失败响应:

{"status":"failed","error":{"code":"ANALYSIS_FAILED","message":"..."}}

错误处理

HTTP 状态码：202(已接收), 400(参数错误), 401(认证失败), 429(限流)

错误码	说明
INVALID_API_KEY	API Key 无效
DATASET_NOT_FOUND	数据表不存在
CONNECTION_FAILED	数据库连接失败

最佳实践

轮询间隔建议 10 秒/次，避免频繁请求
同一组织并发任务 ≤ 3，单次分析通常 180 秒
使用数据库只读账号，将 OraAI 出口 IP 加入白名单
多表分析提供 alias/prefix，提升报告可读性
API Key 定期轮换，禁止硬编码在前端

性能建议：大型数据集可能需要 3 分钟，可通过轮询机制获取最终报告。

常见问题

Q1: 如何获取 API Key？

Q2: 支持哪些数据库？

PostgreSQL, MySQL, MariaDB, SQL Server

Q3: 分析结果保留多久？

PDF 报告仅保留 1 小时，分析结果摘要仅保留 24 小时。超时后自动清除，数据不落盘不过夜，从源头保障数据安全。

Q4: 是否支持定时任务？

当前为按需调用，定时任务规划中。

企业级安全

您的数据保持私密，永远不会用于训练 AI。符合企业级安全标准，通过多项权威认证。

ISO

27001

信息安全管理

等保

三级

网络安全等级保护

数据加密传输

隐私合规认证

零代码集成全自动 AI 分析 + PDF 报告