1. keyword
DataAgent
  • schema
    • 基于数据表推导 schema 配置
      POST
    • 列出所有非内部 Schema
      POST
    • 查询单个 YiAsk Schema 记录
      POST
  • project
    • 通过上传 JSON 文件批量导入配置
      POST
    • 导出 YiAsk 关键集合数据
      POST
    • 初始化 LLM、Embedding、向量库与知识库
      POST
  • database
    • 使用 SemanticDB 连接器测试数据库连通性
      POST
    • 针对指定数据源执行加密 SQL
      POST
    • 调用 sql-formatter 美化 SQL
      POST
    • 获取指定数据源的所有表名
      POST
  • custom-metric
    • 通过自然语言表达式创建自定义指标
      POST
  • scene
    • 导入场景市场数据
      POST
  • logicform
    • 以当前用户身份执行 Logicform
      POST
    • 将 Logicform 转换为自然语言描述
      POST
    • 创建 Logicform 大数据导出任务
      POST
    • 根据执行日志 ID 获取 Logicform 调试信息
      GET
    • 运行 Logicform Analyze 流程(归因分析)
      POST
  • auth
    • 删除角色
      POST
    • 删除用户
      POST
    • 将账号移出空间
      POST
    • 删除数据范围
      POST
    • 删除资源权限范围
      POST
    • 将账号加入空间
      POST
    • 获取指定用户在 yiask 数据源中的权限信息
      POST
    • 为角色添加桌面路由
      POST
    • 更新用户
      POST
    • 用户登录获取 Token
      POST
    • 更新角色
      POST
    • 获取飞书应用机器人可见的群聊列表
      POST
    • 创建角色
      POST
    • API key 为角色范围内用户签发 JWT Token
      POST
    • 根据用户 ID 获取用户完整信息
      GET
    • 批量创建用户
      POST
    • 创建或更新单个用户并同步 YiAsk 用户级权限
      POST
    • 创建或更新角色并同步权限
      POST
    • 更新数据范围
      POST
    • 获取角色权限
      POST
    • 配置数据源角色权限
      POST
    • 创建数据范围
      POST
    • 更新资源权限范围
      POST
    • 配置表的权限范围
      POST
  • agent
    • 对指定 AI 员工发起或继续会话
    • 直接调用已注册的 AI 工具
    • 检索 Nora 向量语料
    • 重建并同步 Nora 语料到向量存储
    • 触发 SemanticDB 学习,可选流式日志
  • resource
    • 删除 Schema 记录
    • 删除 Property 记录
    • 删除自定义指标记录
    • 更新 Schema 记录
    • 查询单个 Property 记录
    • 创建 Property 记录
    • 更新 Property 记录
    • 查询单个自定义指标记录
    • 更新自定义指标记录
    • 查询所有 Schema 记录
    • 查询所有 Property 记录
    • 查询所有自定义指标记录
    • 创建 Schema 记录
    • 查询单个 Schema 记录
  • metric
    • 获取当前空间的指标视图列表
    • 按指标 code 更新指标定义
  • ai-employee
    • 获取当前用户在 YiAsk 聊天页可见的 AI 员工列表
    • 获取 AI 员工市场页列表
  • keyword
    • 补全当前用户有权访问的业务关键词
      POST
  • 数据模型
    • InitConfigRequest
    • RunSQLRequest
    • KeywordCompleteErrorResponse
    • UserRole
    • SpaceUserMembershipRequest
    • SignInRequest
    • IssueUserTokenRequest
    • ChatMessage
    • LogicformExportCreateResponse
    • KeywordSuggestion
    • LLMServiceConfig
    • KeywordCompleteCursorResponse
    • YiaskCustomMetricCreate
    • YiaskCustomMetricUpdate
    • ResourceErrorResponse
    • SearchVisibleFeishuChatsRequest
    • DBConnectionRequest
    • DBConnectionResponse
    • FormatSQLRequest
    • KeywordCompleteResponse
    • MetricUpdateRequest
    • LogicformExecutionRecord
    • SpaceUserMembership
    • GenerateSchemaFromTableRequest
    • WordSegmentItem
    • YiaskSchema
    • YiaskPropertyUpdate
    • ChatRequest
    • YiaskMarketAIEmployee
    • FeishuVisibleChatItem
    • MetricViewItem
    • MetricUpdateResponse
    • UserDetail
    • YiaskSchemaUpdate
    • YiaskCustomMetric
    • GenerateSchemaFromTableResponse
    • SyncCorpusResponse
    • IssueUserTokenResponse
    • YiaskPropertyCreate
    • ChatResponse
    • SearchVisibleFeishuChatsResponse
    • SignInResponse
    • YiaskProperty
    • QueryCorpusResponse
    • KeywordCompleteRequest
    • LogicformExecutionResult
    • KeywordCompleteMetadataFilter
    • SceneImportResponse
    • YiaskSchemaCreate
    • ResourceListResponse
    • YiaskChatAIEmployee
    • LogicformRequest
    • LogicformExecutionGetResponse
    • UserPermissionsResponse
    • LogicformExportCreateRequest
  1. keyword

补全当前用户有权访问的业务关键词

POST
/yiask_keywords:complete
从 yiask_learned 搜索关键词候选,并根据当前用户的空间、模型、字段和行级权限过滤结果。
传入 dataFilter 时,服务端不会复制或读取完整底表记录,而是根据 learned 结果中的 schema + field 自动分组,将候选分批回查底表,仅保留满足底表条件的候选值。可以分别在 filter.schema 和 filter.field 下使用 $in 提前缩小搜索范围,但不是必填。指标及没有来源字段的关键词不会返回。
不传 dataFilter 时使用普通分页:page 从 1 开始,并返回精确的 count 和 totalPage。传入 dataFilter 时使用游标分页:首次请求不传 cursor,后续请求保持其他条件不变并传入上次响应的 nextCursor。游标模式返回 hasNext,不计算精确总数。
游标模式每批最多扫描 500 个 learned 候选并回查底表,持续扫描直到填满当前页或达到单次 10,000 个候选的扫描上限。达到扫描上限时可通过 nextCursor 在下一请求继续,不会把全部候选加载到内存。pageSize 默认为 20,最大为 50。sort 使用 NocoBase 排序格式,字段名前的 - 表示降序。
curl 示例:筛选生产部员工名称
curl 示例:继续读取下一页

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Header 参数

Body 参数application/json必填

示例
{
    "keyword": "销售",
    "page": 1,
    "pageSize": 10
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
cURL
curl --location '/yiask_keywords:complete' \
--header 'X-SPACES: default' \
--header 'X-SPACES: {{space}}' \
--header 'Referer: https://example.com' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "keyword": "销售",
    "page": 1,
    "pageSize": 10
}'

返回响应

🟢200
application/json
普通分页或底表过滤游标分页结果
Bodyapplication/json

示例
{
    "pageSize": 20,
    "hasNext": true,
    "nextCursor": "eyJ2ZXJzaW9uIjoxLCJvZmZzZXQiOjUwMCwiZmluZ2VycHJpbnQiOiIuLi4ifQ",
    "data": [
        {
            "value": "张三",
            "type": "dimension",
            "schema": "employees",
            "field": "名称"
        }
    ]
}
🟠400
修改于 2026-08-23 08:09:35
上一页
获取 AI 员工市场页列表
下一页
InitConfigRequest
Built with