1. askxbot-openapi使用说明
askxbot开放API
  • askxbot-openapi使用说明
    • 概述
    • 交互技术说明
    • Agent会话调用接口流程
  • agent
    • agent查询
      GET
    • Agent对话-session创建
      POST
    • Agent对话-智能会话
      POST
    • Agent对话-知识检索
      POST
    • Agent对话-自定义
      POST
    • Agent对话-信息收集
      POST
    • Agent对话-对话流
      POST
    • agent统计日志
      GET
    • agent日志详情
      GET
    • 会话消息点赞/踩
      POST
    • 会话消息修正
      POST
    • 会话消息重试-智能会话
      POST
    • 会话消息重试-知识检索
      POST
    • Agent对话-更新用户定义的变量值
      POST
  • 工作流
    • 工作流查询
      GET
    • 工作运行记录
      GET
    • 工作流输入变量查询
      GET
    • 工作流运行
      POST
  • 知识库
    • 文档知识库
      • v2-多级文档知识库目录
        • 创建子目录文档
        • 子级目录文档树形结构
        • 更新子级文档知识库
        • 删除子级文档知识库
      • 文档知识库列表
      • 文档知识库详情
      • 创建文档知识库
      • 更新文档知识库
      • 删除文档知识库
      • 重试失败文档知识
      • 查询指定文档知识库全部知识
      • 向文档知识库添加知识
      • 更新指定文档知识库指定知识
      • 查询指定文档知识库指定知识
      • 删除指定文档知识库指定知识
    • 问答知识库
      • 问答知识库列表
      • 问答知识库详情
      • 创建问答知识库
      • 更新问答知识库
      • 删除文档知识库
      • 重试失败问答知识
      • 导出问答知识库所有问答知识
      • 查询指定问答知识库全部问答
      • 向问答知识库添加问答
      • 更新指定问答知识库指定问答
      • 删除指定问答知识库指定问答
  • 数据模型
    • Knowledge
      • FaqInventoryCreateDto
      • DocumentInventoryDocumentUpdateDto
      • PageFaqInventorySearchVo
      • DocumentInventoryDocumentDetailVo
      • EmbeddingConfig
      • UpdateEmbeddingConfig
      • FaqInventoryCreateVo
      • FaqInventoryCreateWrapper
      • FaqInventoryFaqSearchVo
      • FaqInventorySearchVo
      • DocumentInventorySearchWrapper
      • PageDocumentInventoryDocumentSearch
      • DocumentInventoryDetailVo
      • PageFaqInventoryFaqSearchVo
      • DocumentInventoryDocumentSearchVo
      • DocumentInventoryDetailWrapper
      • AgentInfo
      • PageDocumentInventorySearchVo
      • DocumentInventorySearchVo
      • DocumentInventoryCreateDto
      • StringResultVo
      • DocumentInventoryDocumentSearchWrapper
      • DocumentInventoryDocumentDetailWrapper
      • FaqInventorySearchWrapper
      • FaqInventoryDetailVo
      • FaqInventoryDetailWrapper
      • FaqInventoryUpdateDto
      • FaqInventoryFaqSearchWrapper
      • FaqInventoryFaqAddDto
      • FaqInventoryFaqUpdateDto
  1. askxbot-openapi使用说明

概述

1.概述#

1.1 目的范围#

本文档的主要目的在于描述澜码科技向合作客户提供的数据接口,用于外部合作客户通过系统接口与澜码大模型应用平台进行正常数据交互操作,满足合作客户自身产品/系统整合澜码LLM&AI能力,是合作客户的系统开发人员作为接口对接的开发指导。本文档仅描述与定义了澜码大模型应用平台对外公开的数据接口部分,包含接口验证及请求参数、请求处理与返回结果等标准定义,不包括针对个别客户系统进行定制增加的特殊功能。

1.2 文档导读#

a. 为了便于开发者快速理解接口相关内容,建议重点阅读理解
b. 接口技术描述章节并注意以下内容:
i. 接口类型:数据接口。
ii. 接口通讯协议及请求方式:基于HTTPS的Restful方式。
iii. 接口参数分类:系统级参数和应用级参数。
iv. 接口请求有效性:接口请求的有效时间范围是1200秒。
v. 接口ApiKey获取:通过澜码应用平台创建与生成。
vi. 接口服务地址/URL的获得:参见2.2接口服务地址。

1.3 术语定义#

1.3.1 数据接口:指以数据交换为目的接口形式,澜码大模型应用平台支持以JSON格式的数据交换。
修改于 2024-12-18 08:45:52
下一页
交互技术说明
Built with