{ "name": "lke", "display_name": "腾讯云智能体开发平台", "description": "腾讯云智能体开发平台（Tencent Cloud Agent Development Platform）深度整合 LLM+RAG 增强检索、自动化工作流、多 Agent 协作架构等核心能力，助力企业高效搭建稳定、安全、符合业务场景的智能体应用。API接口可提供腾讯云智能体开发平台通过接口完成配置的能力。", "domain": "ai", "api_version": "2023-11-30", "endpoint": "lke.tencentcloudapi.com", "actions": [ { "name": "CallbackWorkflowToolNode", "description": "工作流工具节点异步回调", "status": "online", "parameters": [ { "name": "CallbackToken", "type": "string", "required": true, "description": "ADP调用外部API时,通过HTTP Header(X-ADP-Callback-Token)传递回调CallbackToken", "example": "wfrun.app.node.ts.sig..." }, { "name": "Result", "type": "string", "required": true, "description": "回调结果,可选,为JSON字符串", "example": "{\"approval_result\":\"approved\",\"approver\":\"张三\",\"comment\":\"同意\"}" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" }, { "name": "AppBizId", "type": "string", "required": false, "description": "应用ID", "example": "1432" } ], "required": [ "CallbackToken", "Result" ] }, { "name": "CheckAttributeLabelExist", "description": "检查属性下的标签名是否存在", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID，获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1696822786072117248" }, { "name": "LabelName", "type": "string", "required": true, "description": "标签名称", "example": "标签修改" }, { "name": "AttributeBizId", "type": "string", "required": true, "description": "标签ID", "example": "208" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LastLabelBizId", "type": "string", "required": false, "description": "最后一个标签ID。用于滚动加载：是一种分批、滚动式的存在性检查机制。客户端需要持续调用接口，并每次传入上一次返回的最后一个记录的ID，直到接口明确返回“存在”或“已检查全部数据且不存在”为止。", "example": "204" } ], "required": [ "BotBizId", "LabelName", "AttributeBizId" ] }, { "name": "CheckAttributeLabelRefer", "description": "检查属性标签引用", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID,获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1922557****89446528" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LabelBizId", "type": "string", "required": false, "description": "属性标签ID", "example": "19229118842****0208" }, { "name": "AttributeBizId", "type": "array", "required": false, "description": "标签ID", "example": "[\"19229118842****0208\"]", "item_type": "string" } ], "required": [ "BotBizId" ] }, { "name": "CreateApp", "description": "创建知识引擎应用。", "status": "online", "parameters": [ { "name": "AppType", "type": "string", "required": true, "description": "应用类型；knowledge_qa-知识问答管理", "example": "knowledge_qa" }, { "name": "BaseConfig", "type": "object", "required": true, "description": "应用基础配置", "example": "无", "children": [ { "name": "Name", "type": "string", "required": true, "description": "应用名称", "example": "无" }, { "name": "Avatar", "type": "string", "required": true, "description": "应用头像url，在CreateApp和ModifyApp中作为入参必填。 作为入参传入说明： 1. 传入的url图片限制为jpeg和png，大小限制为500KB，url链接需允许head请求。 2. 如果用户没有对象存储，可使用“获取文件上传临时密钥”(DescribeStorageCredential)接口，获取cos临时密钥和上传路径，自行上传头像至cos中并获取访问链接。", "example": "https://cdn.xiaowei.qq.com/static/lke/app-icon-knowledge_qa.png" }, { "name": "Desc", "type": "string", "required": false, "description": "应用描述", "example": "无" } ] }, { "name": "Pattern", "type": "string", "required": false, "description": "应用模式 standard:标准模式, agent: agent模式，single_workflow：单工作流模式", "example": "standard" }, { "name": "AgentType", "type": "string", "required": false, "description": "智能体类型 dialogue 对话式智能体，wechat 公众号智能体", "example": "dialogue" } ], "required": [ "AppType", "BaseConfig" ] }, { "name": "CreateAttributeLabel", "description": "创建标签", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID，获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1954559753310423232" }, { "name": "AttrName", "type": "string", "required": true, "description": "标签名", "example": "汽车类型" }, { "name": "Labels", "type": "array", "required": true, "description": "标签值", "example": "无", "item_type": "object", "children": [ { "name": "LabelBizId", "type": "string", "required": false, "description": "标准词ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "LabelName", "type": "string", "required": false, "description": "标准词名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SimilarLabels", "type": "array", "required": false, "description": "同义词名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "AttrKey", "type": "string", "required": false, "description": "标签标识（不生效，无需填写） 已作废", "example": "hRbTRndC" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" } ], "required": [ "BotBizId", "AttrName", "Labels" ] }, { "name": "CreateDocCate", "description": "创建Doc分类", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "无" }, { "name": "ParentBizId", "type": "string", "required": true, "description": "父级业务ID", "example": "无" }, { "name": "Name", "type": "string", "required": true, "description": "分类名称", "example": "无" } ], "required": [ "BotBizId", "ParentBizId", "Name" ] }, { "name": "CreateQA", "description": "录入问答 知识库相关背景知识介绍 “知识库检索范围”文档：https://cloud.tencent.com/document/product/1759/112704 “标签”文档：https://cloud.tencent.com/document/product/1759/112956", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID 若要操作共享知识库，传KnowledgeBizId", "example": "1963543972205658048" }, { "name": "Question", "type": "string", "required": true, "description": "问题", "example": "你是谁" }, { "name": "Answer", "type": "string", "required": true, "description": "答案", "example": "我是AI小助手" }, { "name": "AttrRange", "type": "integer", "required": true, "description": "标签适用范围 1：全部，2：按条件", "example": "1" }, { "name": "CustomParam", "type": "string", "required": false, "description": "自定义参数", "example": "{\"key\":\"CustomParam\"}" }, { "name": "AttrLabels", "type": "array", "required": false, "description": "标签引用", "example": "无", "item_type": "object", "children": [ { "name": "Source", "type": "integer", "required": false, "description": "标签来源，1：标签", "example": "1" }, { "name": "AttributeBizId", "type": "string", "required": false, "description": "标签ID", "example": "1" }, { "name": "LabelBizIds", "type": "array", "required": false, "description": "标签值ID", "example": "[1,2]", "item_type": "string" } ] }, { "name": "DocBizId", "type": "string", "required": false, "description": "文档ID", "example": "1963543972205658048" }, { "name": "CateBizId", "type": "string", "required": false, "description": "分类ID", "example": "1963543972205658048" }, { "name": "ExpireStart", "type": "string", "required": false, "description": "有效开始时间，单位是unix时间戳。默认值为0，表示问答为永久有效.", "example": "1766038604" }, { "name": "ExpireEnd", "type": "string", "required": false, "description": "有效结束时间，unix时间戳，0代表永久有效", "example": "1766038604" }, { "name": "SimilarQuestions", "type": "array", "required": false, "description": "相似问内容", "example": "[\"ques\"]", "item_type": "string" }, { "name": "QuestionDesc", "type": "string", "required": false, "description": "问题描述", "example": "desc" }, { "name": "EnableScope", "type": "integer", "required": false, "description": "问答生效域: 1-不生效；2-仅开发域生效；3-仅发布域生效；4-开发域和发布域均生效 默认值：应用内默认知识库为2，共享知识库为4。", "example": "1" } ], "required": [ "BotBizId", "Question", "Answer", "AttrRange" ] }, { "name": "CreateQACate", "description": "创建QA分类 知识库相关背景知识介绍 “知识库检索范围”文档：https://cloud.tencent.com/document/product/1759/112704 “标签”文档：https://cloud.tencent.com/document/product/1759/112956", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID 若要操作共享知识库，传KnowledgeBizId", "example": "1714970520775950336" }, { "name": "ParentBizId", "type": "string", "required": true, "description": "父级业务ID，创建顶级分类时传字符串\"0\"", "example": "1733053612030808064" }, { "name": "Name", "type": "string", "required": true, "description": "创建的分类名称", "example": "分类一" } ], "required": [ "BotBizId", "ParentBizId", "Name" ] }, { "name": "CreateRejectedQuestion", "description": "创建拒答问题", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID, 获取方式参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1844287616635371520" }, { "name": "Question", "type": "string", "required": true, "description": "拒答问题", "example": "您是谁" }, { "name": "BusinessSource", "type": "integer", "required": true, "description": "拒答问题来源， 1- 来源于不满意回复; 2 - 来源于手动添加", "example": "2" }, { "name": "BusinessId", "type": "string", "required": false, "description": "拒答问题来源的数据源唯一id", "example": "18781034349007" } ], "required": [ "BotBizId", "Question", "BusinessSource" ] }, { "name": "CreateRelease", "description": "创建发布", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "1727231073371148288" }, { "name": "Desc", "type": "string", "required": false, "description": "发布描述", "example": "第一次发布" }, { "name": "ChannelBizIds", "type": "array", "required": false, "description": "渠道业务ID，从ListChannel接口的响应字段ChannelId获取", "example": "[\"2\"]", "item_type": "string" } ], "required": [ "BotBizId" ] }, { "name": "CreateSharedKnowledge", "description": "创建共享知识库。", "status": "online", "parameters": [ { "name": "KnowledgeName", "type": "string", "required": true, "description": "共享知识库名称，字符数量范围：[1, 50]", "example": "共享知识库1" }, { "name": "KnowledgeDescription", "type": "string", "required": false, "description": "共享知识库描述，字符数量上限2000", "example": "计算机基础理论知识库" }, { "name": "KnowledgeType", "type": "integer", "required": false, "description": "共享知识库类型，0普通，1公众号", "example": "0" } ], "required": [ "KnowledgeName" ] }, { "name": "CreateVar", "description": "创建变量", "status": "online", "parameters": [ { "name": "AppBizId", "type": "string", "required": true, "description": "应用ID", "example": "1793260396881641472" }, { "name": "VarName", "type": "string", "required": true, "description": "变量名称，不允许重复，最大支持50个字符", "example": "TimeID" }, { "name": "VarDesc", "type": "string", "required": false, "description": "变量描述，最大支持120个字符", "example": "TimeID变量表示时间" }, { "name": "VarType", "type": "string", "required": false, "description": "变量类型定义，支持类型如下：(STRING,INT,FLOAT,BOOL,OBJECT,ARRAY_STRING,ARRAY_INT,ARRAY_FLOAT,ARRAY_BOOL,ARRAY_OBJECT,FILE,DOCUMENT,IMAGE,AUDIO);传输过程是json字符串，标签中仅支持\"STRING\"类型使用", "example": "STRING" }, { "name": "VarDefaultValue", "type": "string", "required": false, "description": "自定义变量默认值", "example": "2025-05-14" }, { "name": "VarDefaultFileName", "type": "string", "required": false, "description": "自定义变量文件默认名称", "example": "无" }, { "name": "VarModuleType", "type": "integer", "required": false, "description": "参数类型", "example": "0" } ], "required": [ "AppBizId", "VarName" ] }, { "name": "CreateWorkflowRun", "description": "本接口用来创建工作流的异步运行实例，创建成功后工作流会在后台异步运行，接口返回工作流运行实例ID（WorkflowRunId）等信息。后面可通过调用DescribeWorkflowRun接口查工作流运行的详情。 注意：工作流的异步运行是基于应用的，需要先把对应的应用配置成“单工作流模式”，并且打开“异步调用”的开关，才能创建成功。", "status": "online", "parameters": [ { "name": "AppBizId", "type": "string", "required": true, "description": "应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1854548189164339200" }, { "name": "RunEnv", "type": "integer", "required": false, "description": "运行环境。0: 测试环境； 1: 正式环境", "example": "1" }, { "name": "Query", "type": "string", "required": false, "description": "用户输入的内容", "example": "我想订明天的酒店" }, { "name": "CustomVariables", "type": "array", "required": false, "description": "API参数配置", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "参数名称", "example": "name" }, { "name": "Value", "type": "string", "required": false, "description": "参数的值", "example": "张三" } ] } ], "required": [ "AppBizId" ] }, { "name": "DeleteAgent", "description": "删除Agent", "status": "online", "parameters": [ { "name": "AgentId", "type": "string", "required": true, "description": "Agent的ID", "example": "349b2172-9a22-460b-b14c-5996bf0891f0" }, { "name": "AppBizId", "type": "string", "required": false, "description": "应用ID", "example": "1889221097956048896" } ], "required": [ "AgentId" ] }, { "name": "DeleteApp", "description": "删除应用", "status": "online", "parameters": [ { "name": "AppBizId", "type": "string", "required": true, "description": "应用ID，获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)。", "example": "1924829923747190" }, { "name": "AppType", "type": "string", "required": false, "description": "应用类型；`\"knowledge_qa\"` 知识问答应用（包含标准模式 单工作流 Multi-Agent 等模式）", "example": "knowledge_qa" } ], "required": [ "AppBizId" ] }, { "name": "DeleteAttributeLabel", "description": "删除属性标签", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID，获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1696822786072117248" }, { "name": "AttributeBizIds", "type": "array", "required": true, "description": "标签ID", "example": "[\"110\"]", "item_type": "string" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" } ], "required": [ "BotBizId", "AttributeBizIds" ] }, { "name": "DeleteDoc", "description": "删除文档", "status": "online", "parameters": [ { "name": "DocBizIds", "type": "array", "required": true, "description": "文档业务ID列表", "example": "[\"1727266196004143104\"]", "item_type": "string" }, { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "1714970520775950336" } ], "required": [ "DocBizIds", "BotBizId" ] }, { "name": "DeleteDocCate", "description": "Doc分类删除", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "无" }, { "name": "CateBizId", "type": "string", "required": true, "description": "分类业务ID", "example": "无" } ], "required": [ "BotBizId", "CateBizId" ] }, { "name": "DeleteQA", "description": "删除问答", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "1727231073371148288" }, { "name": "QaBizIds", "type": "array", "required": true, "description": "问答ID", "example": "[\"1728997020814671872\"]", "item_type": "string" } ], "required": [ "BotBizId", "QaBizIds" ] }, { "name": "DeleteQACate", "description": "分类删除", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "无" }, { "name": "CateBizId", "type": "string", "required": true, "description": "分类业务ID", "example": "无" } ], "required": [ "BotBizId", "CateBizId" ] }, { "name": "DeleteRejectedQuestion", "description": "删除拒答问题", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)。", "example": "1714970520775950336" }, { "name": "RejectedBizIds", "type": "array", "required": true, "description": "拒答问题来源的数据源唯一id", "example": "[ \"1732953678087585792\" ]", "item_type": "string" } ], "required": [ "BotBizId", "RejectedBizIds" ] }, { "name": "DeleteSharedKnowledge", "description": "删除共享知识库。", "status": "online", "parameters": [ { "name": "KnowledgeBizId", "type": "string", "required": true, "description": "共享知识库业务ID", "example": "1908652910168703294" } ], "required": [ "KnowledgeBizId" ] }, { "name": "DeleteVar", "description": "删除变量", "status": "online", "parameters": [ { "name": "AppBizId", "type": "string", "required": true, "description": "应用ID", "example": "1793260396881641472" }, { "name": "VarId", "type": "string", "required": true, "description": "变量ID", "example": "b7f9ef77-caa1-49c5-a693-075a2ba3eeb4" }, { "name": "VarModuleType", "type": "integer", "required": false, "description": "参数类型", "example": "0" } ], "required": [ "AppBizId", "VarId" ] }, { "name": "DescribeApp", "description": "获取企业下应用详情", "status": "online", "parameters": [ { "name": "AppBizId", "type": "string", "required": true, "description": "应用ID", "example": "无" }, { "name": "AppType", "type": "string", "required": false, "description": "应用类型；knowledge_qa-知识问答管理；summary-知识摘要；classifys-知识标签提取", "example": "无" }, { "name": "IsRelease", "type": "boolean", "required": false, "description": "是否发布后的配置", "example": "无" } ], "required": [ "AppBizId" ] }, { "name": "DescribeAppAgentList", "description": "查询指定应用下的Agent列表", "status": "online", "parameters": [ { "name": "AppBizId", "type": "string", "required": false, "description": "应用ID", "example": "1906600044720291840" } ], "required": [] }, { "name": "DescribeAttributeLabel", "description": "查询属性标签详情", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID，获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1696822786072117248" }, { "name": "AttributeBizId", "type": "string", "required": true, "description": "标签ID", "example": "1734549420823662592" }, { "name": "Limit", "type": "integer", "required": true, "description": "每次请求返回的最大标签数量​，限制单次接口返回的标签数量，避免数据量过大。取值范围：大于0。", "example": "1" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" }, { "name": "Query", "type": "string", "required": false, "description": "搜索关键词，用于查询标签标准词或相似词", "example": "相似标签" }, { "name": "LastLabelBizId", "type": "string", "required": false, "description": "滚动加载游标，上一次请求返回的最后一个标签ID", "example": "1734549420823662593" }, { "name": "QueryScope", "type": "string", "required": false, "description": "查询范围 all(或者传空):标准词和相似词 standard:标准词 similar:相似词", "example": "standard" } ], "required": [ "BotBizId", "AttributeBizId", "Limit" ] }, { "name": "DescribeCallStatsGraph", "description": "接口调用折线图", "status": "online", "parameters": [ { "name": "UinAccount", "type": "array", "required": false, "description": "子账号标识列表，支持批量查询多个子账号。不填时查询主账号下所有子账号的汇总数据", "example": "[\"uin:6000005624511\"]", "item_type": "string" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" }, { "name": "SubBizType", "type": "string", "required": false, "description": "子业务类型，用于筛选不同业务场景的调用统计", "example": "\"biztype\"" }, { "name": "ModelName", "type": "string", "required": false, "description": "模型标识", "example": "\"hunyuan\"" }, { "name": "AppBizIds", "type": "array", "required": false, "description": "应用id列表", "example": "[\"appid\"]", "item_type": "string" }, { "name": "SubScenes", "type": "array", "required": false, "description": "筛选子场景(文档解析场景使用)", "example": "[\"scene\"]", "item_type": "string" }, { "name": "AppType", "type": "string", "required": false, "description": "应用类型(knowledge_qa应用管理， shared_knowlege 共享知识库)", "example": "knowledge_qa" }, { "name": "SpaceId", "type": "string", "required": false, "description": "空间ID，用于限定查询范围。不填时查询所有空间的数据", "example": "space_1" }, { "name": "StatStartTime", "type": "integer", "required": false, "description": "开始时间。Unix 时间戳，单位是秒，默认为空。", "example": "1754816440" }, { "name": "StatEndTime", "type": "integer", "required": false, "description": "结束时间。Unix 时间戳，单位是秒，默认为空。", "example": "1754816440" } ], "required": [] }, { "name": "DescribeConcurrencyUsage", "description": "并发调用响应", "status": "online", "parameters": [ { "name": "ModelName", "type": "string", "required": true, "description": "模型标识", "example": "\"hunyuan\"" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间戳, 单位为秒(废弃)", "example": "1754817316" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间戳, 单位为秒(废弃)", "example": "1754817316" }, { "name": "AppBizIds", "type": "array", "required": false, "description": "应用id列表", "example": "[\"appid\"]", "item_type": "string" }, { "name": "SpaceId", "type": "string", "required": false, "description": "空间id", "example": "space1" }, { "name": "StatStartTime", "type": "integer", "required": false, "description": "开始时间戳, 单位为秒", "example": "1754817316" }, { "name": "StatEndTime", "type": "integer", "required": false, "description": "结束时间戳, 单位为秒", "example": "1754817316" } ], "required": [ "ModelName" ] }, { "name": "DescribeConcurrencyUsageGraph", "description": "并发调用折线图", "status": "online", "parameters": [ { "name": "ModelName", "type": "string", "required": true, "description": "模型标识", "example": "“hunyuan”" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间戳, 单位为秒(废弃)", "example": "1754817316" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间戳, 单位为秒(废弃)", "example": "1754817316" }, { "name": "UinAccount", "type": "array", "required": false, "description": "uin", "example": "[\"uin:6000005624511\"]", "item_type": "string" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" }, { "name": "SubBizType", "type": "string", "required": false, "description": "子业务类型", "example": "\"biztype\"" }, { "name": "AppBizIds", "type": "array", "required": false, "description": "应用id列表", "example": "[\"appid\"]", "item_type": "string" }, { "name": "SpaceId", "type": "string", "required": false, "description": "空间id", "example": "space1" }, { "name": "StatStartTime", "type": "integer", "required": false, "description": "开始时间戳, 单位为秒", "example": "1758988800" }, { "name": "StatEndTime", "type": "integer", "required": false, "description": "结束时间戳, 单位为秒", "example": "1759075199" } ], "required": [ "ModelName" ] }, { "name": "DescribeDoc", "description": "文档详情", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "195117326502409112" }, { "name": "DocBizId", "type": "string", "required": true, "description": "文档ID", "example": "19517346915356272" } ], "required": [ "BotBizId", "DocBizId" ] }, { "name": "DescribeKnowledgeUsage", "description": "查询知识库用量", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeKnowledgeUsagePieGraph", "description": "查询企业知识库容量饼图", "status": "online", "parameters": [ { "name": "AppBizIds", "type": "array", "required": false, "description": "应用ID数组", "example": "[\"appid\"]", "item_type": "string" }, { "name": "SpaceId", "type": "string", "required": false, "description": "空间ID，用于限定查询范围。不填时查询所有空间的数据", "example": "space_1" } ], "required": [] }, { "name": "DescribeNodeRun", "description": "通过DescribeWorkflowRun接口获取了工作流异步运行的整体内容，其中包含了基本的节点信息，再通过本接口可查看节点的运行详情（包括输入、输出、日志等）。", "status": "online", "parameters": [ { "name": "AppBizId", "type": "string", "required": true, "description": "应用ID", "example": "1963140753734418240" }, { "name": "NodeRunId", "type": "string", "required": true, "description": "节点运行实例ID", "example": "1dcf5a21-6223-4358-b8a0-b4d6571" } ], "required": [ "AppBizId", "NodeRunId" ] }, { "name": "DescribeQA", "description": "问答详情", "status": "online", "parameters": [ { "name": "QaBizId", "type": "string", "required": true, "description": "QA业务ID", "example": "1903999940055016768" }, { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "1887842680054218000" } ], "required": [ "QaBizId", "BotBizId" ] }, { "name": "DescribeRefer", "description": "获取来源详情列表", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "1696822786072117248" }, { "name": "ReferBizIds", "type": "array", "required": true, "description": "引用ID", "example": "[\"1694302461379890134\"]", "item_type": "string" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" } ], "required": [ "BotBizId", "ReferBizIds" ] }, { "name": "DescribeRelease", "description": "发布详情", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID。获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1727231073371148288" }, { "name": "ReleaseBizId", "type": "string", "required": false, "description": "发布ID", "example": "0" } ], "required": [ "BotBizId" ] }, { "name": "DescribeReleaseInfo", "description": "拉取发布按钮状态、最后发布时间", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "无" } ], "required": [ "BotBizId" ] }, { "name": "DescribeRobotBizIDByAppKey", "description": "通过appKey获取应用业务ID", "status": "online", "parameters": [ { "name": "AppKey", "type": "string", "required": true, "description": "应用appkey", "example": "无" } ], "required": [ "AppKey" ] }, { "name": "DescribeSearchStatsGraph", "description": "查询搜索服务调用折线图", "status": "online", "parameters": [ { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" }, { "name": "UinAccount", "type": "array", "required": false, "description": "uin列表", "example": "[\"uin:6000005624511\"]", "item_type": "string" }, { "name": "SubBizType", "type": "string", "required": false, "description": "子业务类型", "example": "\"biztype\"" }, { "name": "ModelName", "type": "string", "required": false, "description": "模型标识", "example": "\"hunyuan\"" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间戳, 单位为秒(废弃)", "example": "1754816440" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间戳, 单位为秒(废弃)", "example": "1754816440" }, { "name": "AppBizIds", "type": "array", "required": false, "description": "应用id列表", "example": "[\"appid\"]", "item_type": "string" }, { "name": "SpaceId", "type": "string", "required": false, "description": "空间id", "example": "space1" }, { "name": "StatStartTime", "type": "integer", "required": false, "description": "开始时间戳, 单位为秒", "example": "1754816440" }, { "name": "StatEndTime", "type": "integer", "required": false, "description": "结束时间戳, 单位为秒", "example": "1754816440" } ], "required": [] }, { "name": "DescribeSegments", "description": "获取片段详情", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "1771107658358063104" }, { "name": "SegBizId", "type": "array", "required": false, "description": "文档片段ID", "example": "[\"17711076583580631041\"]", "item_type": "string" } ], "required": [ "BotBizId" ] }, { "name": "DescribeSharedKnowledge", "description": "查询共享知识库。", "status": "online", "parameters": [ { "name": "KnowledgeBizId", "type": "string", "required": true, "description": "共享知识库业务ID", "example": "1908652910168703294" } ], "required": [ "KnowledgeBizId" ] }, { "name": "DescribeStorageCredential", "description": "获取文件上传临时密钥", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": false, "description": "应用ID，参数非必填不代表不需要填写，下面不同的参数组合会获取到不同的权限，具体请参考 https://cloud.tencent.com/document/product/1759/116238", "example": "177106121651545*****" }, { "name": "FileType", "type": "string", "required": false, "description": "文件类型,正常的文件名类型后缀，支持 docx、doc、pdf、txt、md、wps、pages、html、mhtml、epub、xml、json、log、xlsx、xls、csv、tsv、numbers、pptx、ppt、ppsx、ppsm、key、png、jpg、jpeg、gif、bmp、tiff、webp、heif、heic、jp2、eps、icns、im、pcx、ppm、xbm、xmind", "example": "pdf" }, { "name": "IsPublic", "type": "boolean", "required": false, "description": "IsPublic用于上传文件或图片时选择场景，当上传对话端图片时IsPublic为true，上传文件（包括文档库文件/图片等和对话端文件）时IsPublic为false", "example": "false" }, { "name": "TypeKey", "type": "string", "required": false, "description": "存储类型: offline:离线文件，realtime:实时文件；为空默认为offline", "example": "offline" } ], "required": [] }, { "name": "DescribeTokenUsage", "description": "接口调用token详情", "status": "online", "parameters": [ { "name": "UinAccount", "type": "array", "required": false, "description": "子账号标识列表，用于筛选指定子账号的统计数据，不填时查询主账号下所有子账号的汇总数据", "example": "[\"uin:6000005624511\"]", "item_type": "string" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" }, { "name": "SubBizType", "type": "string", "required": false, "description": "知识引擎子业务类型: FileParse(文档解析)、Embedding、Rewrite(多轮改写)、 Concurrency(并发)、KnowledgeSummary(知识总结) KnowledgeQA(知识问答)、KnowledgeCapacity(知识库容量)、SearchEngine(搜索引擎)", "example": "KonwledgeQA" }, { "name": "ModelName", "type": "string", "required": false, "description": "模型标识", "example": "cs-normal" }, { "name": "AppBizIds", "type": "array", "required": false, "description": "应用id列表", "example": "[\"appid\"]", "item_type": "string" }, { "name": "SubScenes", "type": "array", "required": false, "description": "筛选子场景(文档解析场景使用)", "example": "[\"KnowledgeQA\"]", "item_type": "string" }, { "name": "AppType", "type": "string", "required": false, "description": "应用类型(knowledge_qa应用管理， shared_knowlege 共享知识库)", "example": "knowledge_qa" }, { "name": "SpaceId", "type": "string", "required": false, "description": "空间ID，用于限定查询范围。不填时查询所有空间的数据", "example": "space1" }, { "name": "StatStartTime", "type": "integer", "required": false, "description": "开始时间。Unix 时间戳，单位是秒，默认为空。", "example": "1758988800" }, { "name": "StatEndTime", "type": "integer", "required": false, "description": "结束时间。Unix 时间戳，单位是秒，默认为空。", "example": "1759075199" } ], "required": [] }, { "name": "DescribeTokenUsageGraph", "description": "接口调用token折线图", "status": "online", "parameters": [ { "name": "UinAccount", "type": "array", "required": false, "description": "子账号标识列表，支持批量查询多个子账号。不填时查询主账号下所有子账号的汇总数据", "example": "[\"uin:11111111111\"]", "item_type": "string" }, { "name": "SubBizType", "type": "string", "required": false, "description": "知识引擎子业务类型: FileParse(文档解析)、Embedding、Rewrite(多轮改写)、 Concurrency(并发)、KnowledgeSummary(知识总结) KnowledgeQA(知识问答)、KnowledgeCapacity(知识库容量)、SearchEngine(搜索引擎)", "example": "\"biz_type\"" }, { "name": "ModelName", "type": "string", "required": false, "description": "模型标识", "example": "\"hunyuan\"" }, { "name": "AppBizIds", "type": "array", "required": false, "description": "应用ID列表。不填时：若指定SpaceId则查该空间所有应用；否则查用户下所有应用", "example": "[\"appid\"]", "item_type": "string" }, { "name": "AppType", "type": "string", "required": false, "description": "应用类型。可选值：knowledge_qa(知识问答)/plugin_parsing_qa(插件)/shared_knowledge(知识库)/evaluate_test(评测)。不填时查所有类型", "example": "knowledge_qa" }, { "name": "SubScenes", "type": "array", "required": false, "description": "筛选子场景", "example": "[\"KnowledgeQA\"]", "item_type": "string" }, { "name": "StatStartTime", "type": "integer", "required": false, "description": "开始时间。Unix 时间戳，单位是秒，默认为空。", "example": "1754817316" }, { "name": "StatEndTime", "type": "integer", "required": false, "description": "结束时间。Unix 时间戳，单位是秒，默认为空。", "example": "1754817316" } ], "required": [] }, { "name": "DescribeUnsatisfiedReplyContext", "description": "获取不满意回复上下文", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID，获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1727231073371148288" }, { "name": "ReplyBizId", "type": "string", "required": true, "description": "回复ID", "example": "1996602817111898368" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" } ], "required": [ "BotBizId", "ReplyBizId" ] }, { "name": "DescribeWorkflowRun", "description": "创建了工作流的异步运行实例后，通过本接口可以查询整体的运行详情。", "status": "online", "parameters": [ { "name": "AppBizId", "type": "string", "required": true, "description": "应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)。", "example": "1963140753734418240" }, { "name": "WorkflowRunId", "type": "string", "required": true, "description": "工作流运行实例ID", "example": "1dcf5a21-6223-4358-b8a0-b4d6571" }, { "name": "SubWorkflowNodePath", "type": "string", "required": false, "description": "指定的子工作流对应的NodePath。 格式：`[[].]*[]` - 此路径用于定位一个具体的工作流实例（Workflow Run），可以是主工作流实例或某个子工作流节点产生的子实例。 - 路径由点号（.）分隔的节点标识符组成，每个节点标识符格式为 `节点ID[实例索引]`。 - **节点ID (node_id)**：子工作流所属的节点的ID。 - **实例索引 (index)**：“实例索引” 在工作流节点的时候为空，循环、批处理节点\ufffd...", "example": "8ad82e0553507b4c1ba771fb53029492.kdf8alj11357oupwfaw669164q3b[1]" }, { "name": "IncludeWorkflowGraph", "type": "boolean", "required": false, "description": "是否需要返回工作流的流程图配置", "example": "false" } ], "required": [ "AppBizId", "WorkflowRunId" ] }, { "name": "ExportAttributeLabel", "description": "导出标签", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID，获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1696822786072117248" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" }, { "name": "AttributeBizIds", "type": "array", "required": false, "description": "标签ID", "example": "[\"1734549420823662592\"]", "item_type": "string" }, { "name": "Filters", "type": "object", "required": false, "description": "根据筛选数据导出", "example": "无", "children": [ { "name": "Query", "type": "string", "required": false, "description": "检索，属性或标签名称", "example": "无" } ] } ], "required": [ "BotBizId" ] }, { "name": "ExportQAList", "description": "导出QA列表 知识库相关背景知识介绍 “知识库检索范围”文档：https://cloud.tencent.com/document/product/1759/112704 “标签”文档：https://cloud.tencent.com/document/product/1759/112956", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID 若要操作共享知识库，传KnowledgeBizId", "example": "1714970520775950336" }, { "name": "QaBizIds", "type": "array", "required": true, "description": "QA业务ID", "example": "[\"162587\"]", "item_type": "string" }, { "name": "Filters", "type": "object", "required": false, "description": "查询参数 Filters.pageNumber范围是\u003e0,0\u003cFilters.pageSize\u003c=200 Filters.query用于内容检索，模糊匹配 Filters.AcceptStatus默认值是0，表示不筛选，返回所有状态 Filters.ReleaseStatus默认值是0，表示不筛选，返回所有状态 Filters.Source默认值是0，表示不筛选，返回所有来源。表示来源(1 文档生成 2 批量导入 3 手动添加)。 Filter.QueryType默认值是\"filename\"，表示查询类型。 ShowCurrCate表示，是否只展示当前分...", "example": "无", "children": [ { "name": "PageNumber", "type": "integer", "required": true, "description": "页码 从1开始", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "页大小 默认15 最大100", "example": "15" }, { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "\"1952993275700732800\"" }, { "name": "Query", "type": "string", "required": false, "description": "查询内容", "example": "\"name\"" }, { "name": "CateBizId", "type": "string", "required": false, "description": "分类ID", "example": "\"1734144647474577408\"" }, { "name": "AcceptStatus", "type": "array", "required": false, "description": "校验状态的枚举值", "example": "[1,2,3]", "item_type": "integer" }, { "name": "ReleaseStatus", "type": "array", "required": false, "description": "发布状态的枚举值", "example": "[2,3,4,7,8,9,11]", "item_type": "integer" }, { "name": "DocBizId", "type": "string", "required": false, "description": "文档ID", "example": "\"19517346915356272\"" }, { "name": "QaBizId", "type": "string", "required": false, "description": "QAID", "example": "\"19517346915356272\"" }, { "name": "Source", "type": "integer", "required": false, "description": "来源", "example": "1" }, { "name": "QueryAnswer", "type": "string", "required": false, "description": "查询答案", "example": "\"name\"" }, { "name": "QueryType", "type": "string", "required": false, "description": "查询类型 filename 名称、 attribute 标签", "example": "\"filename\"" }, { "name": "EnableScope", "type": "integer", "required": false, "description": "问答生效域检索，不检索不传。枚举值如下： 1-不生效；2-仅开发域生效；3-仅发布域生效；4-开发域和发布域均生效。", "example": "1" } ] } ], "required": [ "BotBizId", "QaBizIds" ] }, { "name": "ExportUnsatisfiedReply", "description": "导出不满意回复 知识库相关背景知识介绍 “知识库检索范围”文档：https://cloud.tencent.com/document/product/1759/112704 “标签”文档：https://cloud.tencent.com/document/product/1759/112956", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID 若要操作共享知识库，传KnowledgeBizId", "example": "1696822786072117248" }, { "name": "ReplyBizIds", "type": "array", "required": true, "description": "勾选导出不满意回复的ID列表", "example": "[\"29\"]", "item_type": "string" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" }, { "name": "Filters", "type": "object", "required": false, "description": "检索过滤器", "example": "无", "children": [ { "name": "Query", "type": "string", "required": false, "description": "检索，用户问题或答案", "example": "不好" }, { "name": "Reasons", "type": "array", "required": false, "description": "错误类型检索", "example": "[\"不满意\"]", "item_type": "string" }, { "name": "HandlingStatuses", "type": "array", "required": false, "description": "处理状态 0-待处理 1-已拒答 2-已忽略 3-已添加为新问答 4-已添加为相似问", "example": "[0,1,2,3,4]", "item_type": "integer" } ] } ], "required": [ "BotBizId", "ReplyBizIds" ] }, { "name": "GenerateQA", "description": "文档生成问答", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID,获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1727231073371148288" }, { "name": "DocBizIds", "type": "array", "required": true, "description": "文档ID", "example": "[\"1729099536210460672\"]", "item_type": "string" } ], "required": [ "BotBizId", "DocBizIds" ] }, { "name": "GetAnswerTypeDataCount", "description": "回答类型数据统计", "status": "online", "parameters": [ { "name": "StartTime", "type": "integer", "required": true, "description": "开始日期", "example": "1716368386" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束日期", "example": "1716454119" }, { "name": "AppBizId", "type": "array", "required": false, "description": "应用id", "example": "1747088166522585088", "item_type": "string" }, { "name": "Type", "type": "integer", "required": false, "description": "消息来源(1、分享用户端 2、对话API 3、对话测试 4、应用评测)", "example": "1" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "GetAppKnowledgeCount", "description": "获取模型列表", "status": "online", "parameters": [ { "name": "Type", "type": "string", "required": true, "description": "类型：doc-文档；qa-问答对", "example": "无" }, { "name": "AppBizId", "type": "string", "required": true, "description": "应用ID", "example": "无" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" } ], "required": [ "Type", "AppBizId" ] }, { "name": "GetAppSecret", "description": "获取应用密钥", "status": "online", "parameters": [ { "name": "AppBizId", "type": "string", "required": true, "description": "应用ID", "example": "1801166480814637056" } ], "required": [ "AppBizId" ] }, { "name": "GetDocPreview", "description": "获取文档预览信息", "status": "online", "parameters": [ { "name": "DocBizId", "type": "string", "required": true, "description": "文档BizID", "example": "1965693036992505600" }, { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "1952993275700732800" }, { "name": "TypeKey", "type": "string", "required": false, "description": "存储类型: offline:离线文件，realtime:实时文件；为空默认为offline", "example": "offline" } ], "required": [ "DocBizId", "BotBizId" ] }, { "name": "GetLikeDataCount", "description": "点赞点踩数据统计", "status": "online", "parameters": [ { "name": "StartTime", "type": "integer", "required": true, "description": "开始日期", "example": "1716368386" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束日期", "example": "1716454119" }, { "name": "AppBizId", "type": "array", "required": false, "description": "应用id", "example": "1747088166522585088", "item_type": "string" }, { "name": "Type", "type": "integer", "required": false, "description": "消息来源(1、分享用户端 2、对话API)", "example": "1" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "GetMsgRecord", "description": "获取聊天历史 根据会话session id获取聊天历史（仅保留180天内的历史对话数据）", "status": "online", "parameters": [ { "name": "Type", "type": "integer", "required": true, "description": "接入类型， 5-API 访客，目前仅支持传5", "example": "5" }, { "name": "Count", "type": "integer", "required": true, "description": "数量, 数量需大于2, 最大1000", "example": "2" }, { "name": "SessionId", "type": "string", "required": true, "description": "会话sessionid。", "example": "27-ec29-441f-96c9-ec4fe463058c" }, { "name": "BotAppKey", "type": "string", "required": false, "description": "应用AppKey, 当Type=5[API访客]时, 该字段必填 : 获取方式: 1、应用发布后在应用页面[发布管理]-[调用信息]-[API管理]处获取 2、参考 https://cloud.tencent.com/document/product/1759/109469 第二项", "example": "BTNhWsYypGqzBiZqBPW" }, { "name": "Scene", "type": "integer", "required": false, "description": "场景, 体验: 1; 正式: 2 。 体验用于创建应用测试的时候使用，正式是应用发布后对外的时候使用", "example": "1" }, { "name": "LastRecordId", "type": "string", "required": false, "description": "最后一条记录ID， 消息从后往前获取 MidRecordId与LastRecordId只能选择一个 LastRecordId 和MidRecordId都不填的时候，默认从最新的消息ID开始取。", "example": "GqT_20250908_17005" }, { "name": "MidRecordId", "type": "string", "required": false, "description": "传该值，代表拉取该记录id的前后总共count条消息记录 MidRecordId与LastRecordId只能选择一个 LastRecordId 和MidRecordId都不填的时候，默认从最新的消息Id开始取", "example": "MdM_202" } ], "required": [ "Type", "Count", "SessionId" ] }, { "name": "GetTaskStatus", "description": "获取任务状态", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID", "example": "无" }, { "name": "TaskType", "type": "string", "required": true, "description": "任务类型", "example": "编辑标签任务类型：ModifyAttributeLabel 导出标签任务类型：ExportAttributeLabel" }, { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "无" } ], "required": [ "TaskId", "TaskType", "BotBizId" ] }, { "name": "GetVarList", "description": "查询自定义变量列表", "status": "online", "parameters": [ { "name": "AppBizId", "type": "string", "required": true, "description": "应用ID", "example": "1793260396881641472" }, { "name": "VarIds", "type": "array", "required": false, "description": "变量ID数组", "example": "[\"d125c28b-55db-4478-9066-6115ab97ee17\"]", "item_type": "string" }, { "name": "Keyword", "type": "string", "required": false, "description": "按变量名称关键词搜索", "example": "UserID" }, { "name": "Offset", "type": "integer", "required": false, "description": "起始偏移量（默认0）", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限定数量（默认15）", "example": "15" }, { "name": "VarType", "type": "string", "required": false, "description": "按变量类型过滤，默认查询所有类型(STRING,INT,FLOAT,BOOL,OBJECT,ARRAY_STRING,ARRAY_INT,ARRAY_FLOAT,ARRAY_BOOL,ARRAY_OBJECT,FILE,DOCUMENT,IMAGE,AUDIO)", "example": "STRING" }, { "name": "NeedInternalVar", "type": "boolean", "required": false, "description": "是否需要内部变量(默认false)", "example": "false" }, { "name": "VarModuleType", "type": "integer", "required": false, "description": "变量类型", "example": "0" } ], "required": [ "AppBizId" ] }, { "name": "GetWsToken", "description": "获取ws token", "status": "online", "parameters": [ { "name": "Type", "type": "integer", "required": true, "description": "接入类型， 5-API 访客，目前仅支持传5", "example": "5" }, { "name": "BotAppKey", "type": "string", "required": false, "description": "应用AppKey 获取方式: 1、应用发布后在应用页面[发布管理]-[调用信息]-[API管理]处获取 2、参考 https://cloud.tencent.com/document/product/1759/109469 第二项", "example": "YourAppKey" }, { "name": "VisitorBizId", "type": "string", "required": false, "description": "访客ID（外部输入，建议唯一，标识当前接入会话的用户） 长度限制： string(64)，即最长不超过64个字符", "example": "K18PFhu16oZe0rnxesOomORA7omXwrri" } ], "required": [ "Type" ] }, { "name": "GroupDoc", "description": "Doc分组", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "无" }, { "name": "BizIds", "type": "array", "required": true, "description": "操作对象的业务ID列表", "example": "无", "item_type": "string" }, { "name": "CateBizId", "type": "string", "required": true, "description": "分组 ID", "example": "无" } ], "required": [ "BotBizId", "BizIds", "CateBizId" ] }, { "name": "GroupQA", "description": "用户将多个问答批量的分类到知识库的具体分类 知识库相关背景知识介绍 “知识库检索范围”文档：https://cloud.tencent.com/document/product/1759/112704 “标签”文档：https://cloud.tencent.com/document/product/1759/112956", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID 若要操作共享知识库，传KnowledgeBizId", "example": "1714970520775950336" }, { "name": "QaBizIds", "type": "array", "required": true, "description": "QaBizID列表", "example": "[\"17341635094137912292\"]", "item_type": "string" }, { "name": "CateBizId", "type": "string", "required": true, "description": "分组 ID", "example": "1734163509413793792" } ], "required": [ "BotBizId", "QaBizIds", "CateBizId" ] }, { "name": "IgnoreUnsatisfiedReply", "description": "忽略不满意回复", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "1696822786072117248" }, { "name": "ReplyBizIds", "type": "array", "required": true, "description": "不满意回复ID", "example": "[\"29\"]", "item_type": "string" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" } ], "required": [ "BotBizId", "ReplyBizIds" ] }, { "name": "IsTransferIntent", "description": "是否意图转人工", "status": "online", "parameters": [ { "name": "Content", "type": "string", "required": true, "description": "内容", "example": "人工" }, { "name": "BotAppKey", "type": "string", "required": true, "description": "应用appKey", "example": "LYQCTv" } ], "required": [ "Content", "BotAppKey" ] }, { "name": "ListApp", "description": "获取企业下应用列表", "status": "online", "parameters": [ { "name": "AppType", "type": "string", "required": false, "description": "应用类型；knowledge_qa - 知识问答管理", "example": "knowledge_qa" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页数目，整型", "example": "1" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "页码，整型", "example": "15" }, { "name": "Keyword", "type": "string", "required": false, "description": "关键词：应用/修改人", "example": "关键词" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" }, { "name": "AgentType", "type": "string", "required": false, "description": "智能体类型 dialogue：对话智能体，wechat：公众号智能体", "example": "dialogue" }, { "name": "AppStatus", "type": "string", "required": false, "description": "应用状态 1:未上线 2：运行中", "example": "1" } ], "required": [] }, { "name": "ListAppKnowledgeDetail", "description": "列表查询知识库容量详情", "status": "online", "parameters": [ { "name": "PageNumber", "type": "integer", "required": true, "description": "页码", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "页面大小", "example": "10" }, { "name": "AppBizIds", "type": "array", "required": false, "description": "应用ID列表", "example": "[\"appid\"]", "item_type": "string" }, { "name": "SpaceId", "type": "string", "required": false, "description": "空间列表", "example": "space1" } ], "required": [ "PageNumber", "PageSize" ] }, { "name": "ListAttributeLabel", "description": "查询属性标签列表", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID，获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1696822786072117248" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "页码，取值范围：大于0", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页数量，取值范围：大于0", "example": "15" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" }, { "name": "Query", "type": "string", "required": false, "description": "查询内容，同时匹配标签内容和标签值内容", "example": "标签一" }, { "name": "LabelSize", "type": "integer", "required": false, "description": "每个标签同步拉取的标签值数量。即在展示标签列表时，为每一个标签加载多少个具体的标签值。", "example": "1" } ], "required": [ "BotBizId", "PageNumber", "PageSize" ] }, { "name": "ListChannel", "description": "获取发布渠道列表", "status": "online", "parameters": [ { "name": "AppBizId", "type": "string", "required": true, "description": "应用ID（获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)）", "example": "1908652910168703294" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "页码（必须大于0）", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页数量（取值范围为1-200）", "example": "10" }, { "name": "ChannelType", "type": "array", "required": false, "description": "渠道类型, 10000: 微信订阅号，10001: 微信服务号，10002：企微应用，10004：微信客服，10005：小程序，10009：企微智能机器人 。（默认为[]）", "example": "[10000,10001,10002]", "item_type": "integer" }, { "name": "ChannelStatus", "type": "array", "required": false, "description": "渠道状态 1未发布 2运行中 3已下线 （默认为[]）", "example": "[1,2,3]", "item_type": "integer" } ], "required": [ "AppBizId" ] }, { "name": "ListDoc", "description": "文档列表", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID, 获取方式参看 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1727231073371148288" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "页码(必须大于0)", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页数量(取值范围1-200)", "example": "15" }, { "name": "Query", "type": "string", "required": false, "description": "查询内容 输入特定标识 lke:system:untagged 将查询所有未关联标签的文档", "example": "\"我的文档\"" }, { "name": "Status", "type": "array", "required": false, "description": "文档状态： 1-未生成 2-生成中 3-生成成功 4-生成失败 5-删除中 6-删除成功 7-审核中 8-审核失败 9-审核成功 10,12-导入成功 13-学习中 14-学习失败 15-更新中 16-更新失败 17-解析中 18-解析失败 19-导入失败 20-已过期 21-超量失效 22-超量失效恢复", "example": "[1]", "item_type": "integer" }, { "name": "QueryType", "type": "string", "required": false, "description": "查询类型 filename 文档、 attribute 标签", "example": "filename" }, { "name": "CateBizId", "type": "string", "required": false, "description": "分类ID, 可以通过调用ListDocCate接口,查看其返回结果获取", "example": "0" }, { "name": "FileTypes", "type": "array", "required": false, "description": "文件类型分类筛选", "example": "[\"txt\",\"jpg\"]", "item_type": "string" }, { "name": "FilterFlag", "type": "array", "required": false, "description": "文档列表筛选标识位", "example": "无", "item_type": "object", "children": [ { "name": "Flag", "type": "string", "required": false, "description": "标识位", "example": "is_created_qa" }, { "name": "Value", "type": "boolean", "required": false, "description": "标识值", "example": "true" } ] }, { "name": "ShowCurrCate", "type": "integer", "required": false, "description": "是否只展示当前分类的数据 0不是，1是", "example": "0" }, { "name": "EnableScope", "type": "integer", "required": false, "description": "文档生效域；不检索默认为0。检索枚举值如下： 1-不生效；2-仅开发域生效；3-仅发布域生效；4-开发域和发布域均生效", "example": "1" } ], "required": [ "BotBizId", "PageNumber", "PageSize" ] }, { "name": "ListDocCate", "description": "获取Doc分类", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "1951173265057644542" }, { "name": "QueryType", "type": "integer", "required": false, "description": "分类查询类型：0-全量查询整棵标签树，1-根据父节点BizId分页查询子节点，2-关键词检索所有匹配的分类链路", "example": "1" }, { "name": "ParentCateBizId", "type": "string", "required": false, "description": "QueryType=1时，父节点分类ID", "example": "1951173265057644545" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "QueryType=1时，页码（从1开始）", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页数量（默认10）", "example": "10" }, { "name": "Query", "type": "string", "required": false, "description": "QueryType=2时，搜索内容", "example": "我搜索的分类" } ], "required": [ "BotBizId" ] }, { "name": "ListModel", "description": "获取模型列表", "status": "online", "parameters": [ { "name": "AppType", "type": "string", "required": true, "description": "应用类型；knowledge_qa-知识问答管理；summary-知识摘要；classifys-知识标签提取", "example": "knowledge_qa" }, { "name": "Pattern", "type": "string", "required": false, "description": "应用模式 standard:标准模式, agent: agent模式，single_workflow：单工作流模式", "example": "standard" }, { "name": "ModelCategory", "type": "string", "required": false, "description": "模型类别 generate：生成模型，thought：思考模型,embedding模型，rerank：rerank模型", "example": "thought" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" } ], "required": [ "AppType" ] }, { "name": "ListQA", "description": "问答列表 知识库相关背景知识介绍 “知识库检索范围”文档：https://cloud.tencent.com/document/product/1759/112704 “标签”文档：https://cloud.tencent.com/document/product/1759/112956", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID 若要操作共享知识库，传KnowledgeBizId", "example": "1952993275700732800" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "页码（取值范围\u003e0）", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页大小(取值范围1-200)", "example": "15" }, { "name": "Query", "type": "string", "required": false, "description": "查询问题 输入特定标识 lke:system:untagged 将查询所有未关联标签的问答", "example": "name" }, { "name": "AcceptStatus", "type": "array", "required": false, "description": "校验状态(1未校验2采纳3不采纳) 如果不填默认值为空数组，表示不筛选，返回所有状态", "example": "[1]", "item_type": "integer" }, { "name": "ReleaseStatus", "type": "array", "required": false, "description": "发布状态(2,4导入成功 7审核中 8审核失败 9人工申述中 11人工申述失败 12已过期 13超量失效 14超量失效恢复) 如果不填默认值为空数组，表示不筛选返回所有状态", "example": "[2]", "item_type": "integer" }, { "name": "DocBizId", "type": "string", "required": false, "description": "文档ID", "example": "1965693041497188096" }, { "name": "Source", "type": "integer", "required": false, "description": "来源(1 文档生成 2 批量导入 3 手动添加) 不填默认值为0，表示不过滤，返回所有状态", "example": "1" }, { "name": "QueryAnswer", "type": "string", "required": false, "description": "查询答案", "example": "name" }, { "name": "CateBizId", "type": "string", "required": false, "description": "分类ID", "example": "0" }, { "name": "QaBizIds", "type": "array", "required": false, "description": "QA业务ID列表", "example": "[\"1965693041497188096\"]", "item_type": "string" }, { "name": "QueryType", "type": "string", "required": false, "description": "查询类型 filename 名称、 attribute 标签 如果不填默认值为\"filename\"", "example": "filename" }, { "name": "ShowCurrCate", "type": "integer", "required": false, "description": "是否只展示当前分类的数据 0不是，1是", "example": "0" }, { "name": "EnableScope", "type": "integer", "required": false, "description": "问答生效域检索，不检索不传。枚举值如下： 1-不生效；2-仅开发域生效；3-仅发布域生效；4-开发域和发布域均生效。", "example": "1" } ], "required": [ "BotBizId", "PageNumber", "PageSize" ] }, { "name": "ListQACate", "description": "获取QA分类 知识库相关背景知识介绍 “知识库检索范围”文档：https://cloud.tencent.com/document/product/1759/112704 “标签”文档：https://cloud.tencent.com/document/product/1759/112956", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID 若要操作共享知识库，传KnowledgeBizId", "example": "1951173265057644542" }, { "name": "QueryType", "type": "integer", "required": false, "description": "分类查询类型：0-全量查询整棵标签树，1-根据父节点BizId分页查询子节点，2-关键词检索所有匹配的分类链路", "example": "1" }, { "name": "ParentCateBizId", "type": "string", "required": false, "description": "QueryType=1时，父节点分类ID", "example": "1951173265057644545" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "QueryType=1时，页码（从1开始）", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页数量（默认10）", "example": "10" }, { "name": "Query", "type": "string", "required": false, "description": "QueryType=2时，搜索内容", "example": "我搜索的分类" } ], "required": [ "BotBizId" ] }, { "name": "ListReferShareKnowledge", "description": "查看应用引用了哪些共享知识库，可以看到共享知识库的基础信息，包括名称，id等", "status": "online", "parameters": [ { "name": "AppBizId", "type": "string", "required": true, "description": "应用业务id", "example": "1904370549674213379" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" } ], "required": [ "AppBizId" ] }, { "name": "ListRejectedQuestion", "description": "获取拒答问题", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)。", "example": "1963122248037063424" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "页码（必须大于0）", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页数量（取值范围1-200）", "example": "10" }, { "name": "Query", "type": "string", "required": false, "description": "查询内容", "example": "11" } ], "required": [ "BotBizId", "PageNumber", "PageSize" ] }, { "name": "ListRejectedQuestionPreview", "description": "发布拒答问题预览", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID（获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)）", "example": "1798610639288008723" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "页码（必须大于0）", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页数量（取值范围为1-200）", "example": "10" }, { "name": "Query", "type": "string", "required": false, "description": "查询内容关键字，用于模糊查询，若未提供该参数，默认为查询全部。", "example": "拒答问题" }, { "name": "ReleaseBizId", "type": "string", "required": false, "description": "发布单ID（可以通过[ListRelease](https://cloud.tencent.com/document/product/1759/105077)获得）", "example": "179861063928800" }, { "name": "Actions", "type": "array", "required": false, "description": "状态(1新增2更新3删除)", "example": "[1]", "item_type": "integer" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间。Unix 时间戳，单位是秒，默认为空。", "example": "1701566284" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间。Unix 时间戳，单位是秒，默认为空。", "example": "1701766284" } ], "required": [ "BotBizId", "PageNumber", "PageSize" ] }, { "name": "ListRelease", "description": "发布列表", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID（获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)）", "example": "1714970520775950336" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "页码(必须大于0)", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页数量（取值范围为1-200）", "example": "10" } ], "required": [ "BotBizId", "PageNumber", "PageSize" ] }, { "name": "ListReleaseConfigPreview", "description": "发布配置项预览", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID（获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)）", "example": "1747951478630252544" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "页码（必须大于0）", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页数量（取值范围为1-200）", "example": "15" }, { "name": "Query", "type": "string", "required": false, "description": "查询内容关键字，用于模糊查询，若未提供该参数，默认为查询全部。", "example": "第一次发布" }, { "name": "ReleaseBizId", "type": "string", "required": false, "description": "发布单ID（可以通过[ListRelease](https://cloud.tencent.com/document/product/1759/105077)获得）", "example": "1737930252544" }, { "name": "Actions", "type": "array", "required": false, "description": "状态(1新增2更新3删除)", "example": "[1,2]", "item_type": "integer" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间。Unix 时间戳，单位是秒，默认为空。", "example": "\"1709614760\"" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间。Unix 时间戳，单位是秒，默认为空。", "example": "\"1709694760\"" }, { "name": "ReleaseStatus", "type": "array", "required": false, "description": "发布状态(2 待发布 3 发布中 4 已发布 5 发布失败)，默认为空", "example": "[2]", "item_type": "integer" } ], "required": [ "BotBizId", "PageNumber", "PageSize" ] }, { "name": "ListReleaseDocPreview", "description": "发布文档预览", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID（获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)）", "example": "1798610639288008723" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "页码（必须大于0）", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页数量（取值范围为1-200）", "example": "15" }, { "name": "Query", "type": "string", "required": false, "description": "查询内容关键字，用于模糊查询，若未提供该参数，默认为查询全部。", "example": "内容" }, { "name": "ReleaseBizId", "type": "string", "required": false, "description": "发布单ID（可以通过[ListRelease](https://cloud.tencent.com/document/product/1759/105077)获得）", "example": "发布单ID" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间。Unix 时间戳，单位是秒，默认为空。", "example": "开始时间" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间。Unix 时间戳，单位是秒，默认为空。", "example": "结束时间" }, { "name": "Actions", "type": "array", "required": false, "description": "状态(1新增2修改3删除)，其和ReleaseStatus的区别为： Actions表示的是对数据/内容的操作状态，ReleaseStatus表示数据 / 内容本身的发布状态", "example": "[1]", "item_type": "integer" } ], "required": [ "BotBizId", "PageNumber", "PageSize" ] }, { "name": "ListReleaseQAPreview", "description": "文档列表", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID（获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)）", "example": "1694921462777761792" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "页码（必须大于0）", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页数量（取值范围为1-200）", "example": "15" }, { "name": "Query", "type": "string", "required": false, "description": "查询内容关键字，用于模糊查询，若未提供该参数，默认为查询全部。", "example": "查询内容" }, { "name": "ReleaseBizId", "type": "string", "required": false, "description": "发布单ID（可以通过[ListRelease](https://cloud.tencent.com/document/product/1759/105077)获得）", "example": "发布单ID" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间。Unix 时间戳，单位是秒，默认为空。", "example": "1701422596" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间。Unix 时间戳，单位是秒，默认为空。", "example": "1701422596" }, { "name": "Actions", "type": "array", "required": false, "description": "状态(1新增2修改3删除)，其和ReleaseStatus的区别为：Actions表示的是对数据/内容的操作状态，ReleaseStatus表示数据/内容本身的发布状态", "example": "[1]", "item_type": "integer" }, { "name": "ReleaseStatus", "type": "array", "required": false, "description": "发布状态(4发布成功5发布失败)。其和Actions的区别为：Actions表示的是对数据/内容的操作状态，ReleaseStatus表示数据/内容本身的发布状态", "example": "[1]", "item_type": "integer" } ], "required": [ "BotBizId", "PageNumber", "PageSize" ] }, { "name": "ListSelectDoc", "description": "获取文档下拉列表。", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID,获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1727231073371148288" }, { "name": "FileName", "type": "string", "required": false, "description": "文档名称。可通过文档名称检索支持生成问答的文档，不支持xlsx、xls、csv格式", "example": "文档名称" }, { "name": "Status", "type": "array", "required": false, "description": "文档状态筛选。文档状态对应码为7 审核中、8 审核失败、10 待发布、11 发布中、12 已发布、13 学习中、14 学习失败 20 已过期。其中仅状态为10 待发布、12 已发布的文档支持生成问答（未填写时默认值为空数组）", "example": "[10,12]", "item_type": "integer" } ], "required": [ "BotBizId" ] }, { "name": "ListSharedKnowledge", "description": "列举共享知识库。", "status": "online", "parameters": [ { "name": "PageNumber", "type": "integer", "required": true, "description": "分页序号，编码从1开始", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页大小，有效范围为[1,200]", "example": "10" }, { "name": "Keyword", "type": "string", "required": false, "description": "搜索关键字", "example": "计算机" }, { "name": "KnowledgeTypes", "type": "array", "required": false, "description": "共享知识库类型，0普通，1公众号", "example": "[0,1]", "item_type": "integer" } ], "required": [ "PageNumber", "PageSize" ] }, { "name": "ListUnsatisfiedReply", "description": "查询不满意回复列表", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID，获取方法参看如何获取[BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1933045939331552830" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "页码，取值范围：大于0", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页数量，取值范围：大于0", "example": "10" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "\"600032374291\"" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "\"600032374291\"" }, { "name": "Query", "type": "string", "required": false, "description": "用户请求(问题或答案)，按关键词检索，可匹配用户问题或答案", "example": "你是谁" }, { "name": "Reasons", "type": "array", "required": false, "description": "按错误类型检索", "example": "[\"回答不准确\"]", "item_type": "string" }, { "name": "Status", "type": "integer", "required": false, "description": "按操作状态检索 0-全部 1-待处理 2-已处理【包括答案纠错，拒答，忽略】，不填时默认值为0", "example": "1" }, { "name": "HandlingStatuses", "type": "array", "required": false, "description": "处理状态 0-待处理 1-已拒答 2-已忽略 3-已添加为新问答 4-已添加为相似问", "example": "[0,1,2,3,4]", "item_type": "integer" } ], "required": [ "BotBizId", "PageNumber", "PageSize" ] }, { "name": "ListUsageCallDetail", "description": "列表查询单次调用明细", "status": "online", "parameters": [ { "name": "ModelName", "type": "string", "required": true, "description": "模型标识", "example": "\"hunyuan\"" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "页码（从1开始）", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页数量(最大值1000)", "example": "10" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间(废弃)", "example": "1754817104" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间(废弃)", "example": "1754817104" }, { "name": "UinAccount", "type": "array", "required": false, "description": "uin列表", "example": "[\"uin:6000005624511\"]", "item_type": "string" }, { "name": "AppBizIds", "type": "array", "required": false, "description": "应用ID列表", "example": "[\"appid\"]", "item_type": "string" }, { "name": "CallType", "type": "string", "required": false, "description": "调用类型列表", "example": "\"calltype1\"" }, { "name": "SubScenes", "type": "array", "required": false, "description": "筛选子场景", "example": "[\"scene1\"]", "item_type": "string" }, { "name": "AppType", "type": "string", "required": false, "description": "应用类型(knowledge_qa应用管理， shared_knowlege 共享知识库)", "example": "knowledge_qa" }, { "name": "BillingTag", "type": "string", "required": false, "description": "账单明细对应的自定义tag", "example": "{\"tag1\":\"vlue1\", \"tag2\":\"value2\"}" }, { "name": "SpaceId", "type": "string", "required": false, "description": "空间id", "example": "spaceid1" }, { "name": "StatStartTime", "type": "integer", "required": false, "description": "开始时间戳, 单位为秒", "example": "1754817104" }, { "name": "StatEndTime", "type": "integer", "required": false, "description": "开始时间戳, 单位为秒", "example": "1754817104" } ], "required": [ "ModelName", "PageNumber", "PageSize" ] }, { "name": "ListWorkflowRuns", "description": "此接口可查询已创建的所有工作流异步运行实例。", "status": "online", "parameters": [ { "name": "AppBizId", "type": "string", "required": true, "description": "应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1854548189164339200" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页数量(取值范围1-200)", "example": "20" }, { "name": "RunEnv", "type": "integer", "required": false, "description": "运行环境。0: 测试环境； 1: 正式环境", "example": "1" }, { "name": "Page", "type": "integer", "required": false, "description": "页码(必须大于0)", "example": "1" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" } ], "required": [ "AppBizId", "PageSize" ] }, { "name": "ModifyApp", "description": "修改应用请求结构体", "status": "online", "parameters": [ { "name": "AppBizId", "type": "string", "required": true, "description": "应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)。", "example": "1963140753734418240" }, { "name": "AppType", "type": "string", "required": true, "description": "应用类型；\"knowledge_qa\" 知识问答应用（包含标准模式 单工作流 Multi-Agent 等模式）", "example": "knowledge_qa" }, { "name": "BaseConfig", "type": "object", "required": true, "description": "应用基础配置", "example": "无", "children": [ { "name": "Name", "type": "string", "required": true, "description": "应用名称", "example": "无" }, { "name": "Avatar", "type": "string", "required": true, "description": "应用头像url，在CreateApp和ModifyApp中作为入参必填。 作为入参传入说明： 1. 传入的url图片限制为jpeg和png，大小限制为500KB，url链接需允许head请求。 2. 如果用户没有对象存储，可使用“获取文件上传临时密钥”(DescribeStorageCredential)接口，获取cos临时密钥和上传路径，自行上传头像至cos中并获取访问链接。", "example": "https://cdn.xiaowei.qq.com/static/lke/app-icon-knowledge_qa.png" }, { "name": "Desc", "type": "string", "required": false, "description": "应用描述", "example": "无" } ] }, { "name": "AppConfig", "type": "object", "required": true, "description": "应用配置", "example": "无", "children": [ { "name": "KnowledgeQa", "type": "object", "required": false, "description": "知识问答管理应用配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Greeting", "type": "string", "required": false, "description": "欢迎语，200字符以内 注意：此字段可能返回 null，表示取不到有效值。", "example": "欢迎" }, { "name": "RoleDescription", "type": "string", "required": false, "description": "角色描述，4000字符以内。通过填写描述，设定应用的 #角色名称、 #风格特点 及可达成的#意图。建议按照下面的模板填写，且自定义意图建议不超过5个。 #角色名称： #风格特点： #输出要求： #能力限制： 能够达成以下用户意图 ##意图名称： ##意图描述： ##意图示例： ##意图实现： 注意：此字段可能返回 null，表示取不到有效值。", "example": "这是一个角色提示词" }, { "name": "Model", "type": "object", "required": false, "description": "生成模型配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Name", "type": "string", "required": false, "description": "模型名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Desc", "type": "string", "required": false, "description": "模型描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ContextLimit", "type": "integer", "required": false, "description": "上下文指代轮次 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "AliasName", "type": "string", "required": false, "description": "模型别名 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TokenBalance", "type": "float", "required": false, "description": "token余量 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "IsUseContext", "type": "boolean", "required": false, "description": "是否使用上下文指代轮次 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "HistoryLimit", "type": "integer", "required": false, "description": "上下文记忆轮数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "UsageType", "type": "string", "required": false, "description": "使用类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Temperature", "type": "string", "required": false, "description": "模型温度 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TopP", "type": "string", "required": false, "description": "模型TopP 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ResourceStatus", "type": "integer", "required": false, "description": "模型资源状态 1：资源可用；2：资源已用尽 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ModelParams", "type": "object", "required": false, "description": "模型参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "Search", "type": "array", "required": false, "description": "知识搜索配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": false, "description": "知识来源 doc：文档，qa：问答 taskflow：业务流程，search：搜索增强，database:数据库 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ReplyFlexibility", "type": "integer", "required": false, "description": "问答-回复灵活度 1：已采纳答案直接回复 2：已采纳润色后回复 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "UseSearchEngine", "type": "boolean", "required": false, "description": "搜索增强-搜索引擎状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ShowSearchEngine", "type": "boolean", "required": false, "description": "是否显示搜索引擎检索状态 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "IsEnabled", "type": "boolean", "required": false, "description": "知识来源，是否选择 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "QaTopN", "type": "integer", "required": false, "description": "问答最大召回数量, 默认2，限制5 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "DocTopN", "type": "integer", "required": false, "description": "文档最大召回数量, 默认3，限制5 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Confidence", "type": "float", "required": false, "description": "检索置信度，针对文档和问答有效，最小0.01，最大0.99 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ResourceStatus", "type": "integer", "required": false, "description": "资源状态 1：资源可用；2：资源已用尽 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "Output", "type": "object", "required": false, "description": "知识管理输出配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Method", "type": "integer", "required": false, "description": "输出方式 1：流式 2：非流式 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "UseGeneralKnowledge", "type": "boolean", "required": false, "description": "通用模型回复 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "BareAnswer", "type": "string", "required": false, "description": "未知回复语，300字符以内 注意：此字段可能返回 null，表示取不到有效值。", "example": "当前无法回答" }, { "name": "ShowQuestionClarify", "type": "boolean", "required": false, "description": "是否展示问题澄清开关 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "UseQuestionClarify", "type": "boolean", "required": false, "description": "是否打开问题澄清 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "QuestionClarifyKeywords", "type": "array", "required": false, "description": "问题澄清关键词列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"歧义\"]", "item_type": "string" }, { "name": "UseRecommended", "type": "boolean", "required": false, "description": "是否打开推荐问题开关 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "RecommendedPromptMode", "type": "integer", "required": false, "description": "推荐问模式，0.结合知识库\u0026对话历史推荐问题Prompt(默认) 1.仅结合知识库输出推荐问的prompt 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "InputBoxConfig", "type": "object", "required": false, "description": "输入框按钮配置", "example": "无" } ] }, { "name": "Workflow", "type": "object", "required": false, "description": "工作流程配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "IsEnabled", "type": "boolean", "required": false, "description": "是否启用工作流 注意：此字段可能返回 null，表示取不到有效值。", "example": "true：启用，false：停用" }, { "name": "UsePdl", "type": "boolean", "required": false, "description": "是否启用PDL 注意：此字段可能返回 null，表示取不到有效值。", "example": "true：启用，false：停用" } ] }, { "name": "SearchRange", "type": "object", "required": false, "description": "检索范围 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Condition", "type": "string", "required": false, "description": "检索条件and/or 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ApiVarAttrInfos", "type": "array", "required": false, "description": "自定义变量和标签关系数据 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "Pattern", "type": "string", "required": false, "description": "应用模式，standard:标准模式, agent: agent模式，single_workflow：单工作流模式 注意：此字段可能返回 null，表示取不到有效值。", "example": "standard" }, { "name": "SearchStrategy", "type": "object", "required": false, "description": "检索策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "StrategyType", "type": "integer", "required": false, "description": "检索策略类型 0:混合检索，1：语义检索 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "TableEnhancement", "type": "boolean", "required": false, "description": "Excel检索增强开关, false关闭，true打开 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "EmbeddingModel", "type": "string", "required": false, "description": "向量模型 注意：此字段可能返回 null，表示取不到有效值。", "example": "adp-embedding-model" }, { "name": "RerankModelSwitch", "type": "string", "required": false, "description": "结果重排序开关， on打开，off关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "on" }, { "name": "RerankModel", "type": "string", "required": false, "description": "结果重排序模型 注意：此字段可能返回 null，表示取不到有效值。", "example": "adp-rerank-model" }, { "name": "NatureLanguageToSqlModelConfig", "type": "object", "required": false, "description": "NL2SQL模型配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "GraphRetrieval", "type": "boolean", "required": false, "description": "是否开启图谱检索", "example": "true" } ] }, { "name": "SingleWorkflow", "type": "object", "required": false, "description": "单工作流ID，Pattern为single_workflow时传入 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "WorkflowId", "type": "string", "required": false, "description": "工作流ID", "example": "b97df586-16c4-4795-85fd-705c2b7a8265" }, { "name": "WorkflowName", "type": "string", "required": false, "description": "工作流名称", "example": "工作流" }, { "name": "WorkflowDesc", "type": "string", "required": false, "description": "工作流描述", "example": "这是一个描述" }, { "name": "Status", "type": "string", "required": false, "description": "工作流状态，发布状态(UNPUBLISHED: 待发布 PUBLISHING: 发布中 PUBLISHED: 已发布 FAIL:发布失败)", "example": "UNPUBLISHED" }, { "name": "IsEnable", "type": "boolean", "required": false, "description": "工作流是否启用", "example": "true" }, { "name": "AsyncWorkflow", "type": "boolean", "required": false, "description": "是否开启异步调用工作流", "example": "false" } ] }, { "name": "Plugins", "type": "array", "required": false, "description": "应用关联插件 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "PluginId", "type": "string", "required": false, "description": "插件ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "PluginName", "type": "string", "required": false, "description": "插件名称", "example": "无" }, { "name": "PluginIcon", "type": "string", "required": false, "description": "插件图标", "example": "无" }, { "name": "ToolId", "type": "string", "required": false, "description": "工具ID", "example": "无" }, { "name": "ToolName", "type": "string", "required": false, "description": "工具名称", "example": "无" }, { "name": "ToolDesc", "type": "string", "required": false, "description": "工具描述", "example": "无" }, { "name": "Inputs", "type": "array", "required": false, "description": "工具输入参数", "example": "无", "item_type": "string" }, { "name": "IsBindingKnowledge", "type": "boolean", "required": false, "description": "插件是否和知识库绑定", "example": "无" } ] }, { "name": "ThoughtModel", "type": "object", "required": false, "description": "思考模型配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Name", "type": "string", "required": false, "description": "模型名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Desc", "type": "string", "required": false, "description": "模型描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ContextLimit", "type": "integer", "required": false, "description": "上下文指代轮次 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "AliasName", "type": "string", "required": false, "description": "模型别名 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TokenBalance", "type": "float", "required": false, "description": "token余量 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "IsUseContext", "type": "boolean", "required": false, "description": "是否使用上下文指代轮次 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "HistoryLimit", "type": "integer", "required": false, "description": "上下文记忆轮数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "UsageType", "type": "string", "required": false, "description": "使用类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Temperature", "type": "string", "required": false, "description": "模型温度 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TopP", "type": "string", "required": false, "description": "模型TopP 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ResourceStatus", "type": "integer", "required": false, "description": "模型资源状态 1：资源可用；2：资源已用尽 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ModelParams", "type": "object", "required": false, "description": "模型参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "IntentAchievements", "type": "array", "required": false, "description": "意图达成方式优先级 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "意图达成方式，qa:问答回复、doc：文档回复、workflow：工作流回复，llm：大模型回复", "example": "qa" }, { "name": "Desc", "type": "string", "required": false, "description": "意图达成方式描述", "example": "问答回复" } ] }, { "name": "ImageTextRetrieval", "type": "boolean", "required": false, "description": "是否开启图文检索 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "AiCall", "type": "object", "required": false, "description": "配置语音通话参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "EnableVoiceInteract", "type": "boolean", "required": false, "description": "启用语音互动功能 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "EnableVoiceCall", "type": "boolean", "required": false, "description": "启用语音通话 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "EnableDigitalHuman", "type": "boolean", "required": false, "description": "启用数智人 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "Voice", "type": "object", "required": false, "description": "音色配置 注意：此字段可能返回 null，表示取不到有效值。", "example": " " }, { "name": "DigitalHuman", "type": "object", "required": false, "description": "数智人配置 注意：此字段可能返回 null，表示取不到有效值。", "example": " " } ] }, { "name": "ShareKnowledgeBases", "type": "array", "required": false, "description": "共享知识库关联配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "KnowledgeBizId", "type": "string", "required": false, "description": "共享知识库ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "1942591969559038144" }, { "name": "SearchRange", "type": "object", "required": false, "description": "检索范围 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "KnowledgeModelConfig", "type": "object", "required": false, "description": "知识库模型设置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SearchStrategy", "type": "object", "required": false, "description": "检索策略配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Search", "type": "array", "required": false, "description": "检索配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "ReplyFlexibility", "type": "integer", "required": false, "description": "// 问答-回复灵活度 1：已采纳答案直接回复 2：已采纳润色后回复 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "KnowledgeName", "type": "string", "required": false, "description": "共享知识库名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "小学数据题集" } ] }, { "name": "BackgroundImage", "type": "object", "required": false, "description": "背景图相关信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "LandscapeImageUrl", "type": "string", "required": false, "description": "横图(pc)", "example": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/1753030485940633600/1933045939331552832/image/hehEVqvCbsPmDkURkUUe-1936336152095918144.png" }, { "name": "OriginalImageUrl", "type": "string", "required": false, "description": "原始图", "example": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/1753030485940633600/1933045939331552832/image/hehEVqvCbsPmDkURkUUe-1936336152095918144.png" }, { "name": "PortraitImageUrl", "type": "string", "required": false, "description": "长图(手机)", "example": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/1753030485940633600/1933045939331552832/image/hehEVqvCbsPmDkURkUUe-1936336152095918144.png" }, { "name": "ThemeColor", "type": "string", "required": false, "description": "主题色", "example": "#3B4651" }, { "name": "Brightness", "type": "integer", "required": false, "description": "亮度值", "example": "12" } ] }, { "name": "OpeningQuestions", "type": "array", "required": false, "description": "开场问题 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"开场问题1\",\"开场问题2\",\"开场问题3\"]", "item_type": "string" }, { "name": "LongMemoryOpen", "type": "boolean", "required": false, "description": "长期记忆开关", "example": "false" }, { "name": "LongMemoryDay", "type": "integer", "required": false, "description": "长期记忆时效", "example": "3" }, { "name": "Agent", "type": "object", "required": false, "description": "agent配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "AgentCollaboration", "type": "integer", "required": false, "description": "协同方式，1：自由转交，2：工作流编排，3：Plan-and-Execute 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Workflow", "type": "object", "required": false, "description": "应用配置agent关联的工作流 注意：此字段可能返回 null，表示取不到有效值。", "example": "工作流信息" } ] }, { "name": "KnowledgeModelConfig", "type": "object", "required": false, "description": "知识库模型 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "EmbeddingModel", "type": "string", "required": false, "description": "向量模型，该字段只有共享知识库有，应用知识库没有 注意：此字段可能返回 null，表示取不到有效值。", "example": "adp-embedding-model" }, { "name": "QaExtractModel", "type": "string", "required": false, "description": "问答对生成模型 注意：此字段可能返回 null，表示取不到有效值。", "example": "adp-model" }, { "name": "SchemaModel", "type": "string", "required": false, "description": "schema生成模型 注意：此字段可能返回 null，表示取不到有效值。", "example": "adp-schema-model" } ] }, { "name": "KnowledgeAdvancedConfig", "type": "object", "required": false, "description": "知识库高级设置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "RerankModel", "type": "string", "required": false, "description": "重排序模型 注意：此字段可能返回 null，表示取不到有效值。", "example": "adp-rerank-model" }, { "name": "RerankRecallNum", "type": "integer", "required": false, "description": "召回数量 注意：此字段可能返回 null，表示取不到有效值。", "example": "5" } ] } ] }, { "name": "Summary", "type": "object", "required": false, "description": "知识摘要应用配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Model", "type": "object", "required": false, "description": "模型配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Name", "type": "string", "required": false, "description": "模型名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Desc", "type": "string", "required": false, "description": "模型描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ContextLimit", "type": "integer", "required": false, "description": "上下文指代轮次 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "AliasName", "type": "string", "required": false, "description": "模型别名 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TokenBalance", "type": "float", "required": false, "description": "token余量 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "IsUseContext", "type": "boolean", "required": false, "description": "是否使用上下文指代轮次 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "HistoryLimit", "type": "integer", "required": false, "description": "上下文记忆轮数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "UsageType", "type": "string", "required": false, "description": "使用类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Temperature", "type": "string", "required": false, "description": "模型温度 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TopP", "type": "string", "required": false, "description": "模型TopP 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ResourceStatus", "type": "integer", "required": false, "description": "模型资源状态 1：资源可用；2：资源已用尽 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ModelParams", "type": "object", "required": false, "description": "模型参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "Output", "type": "object", "required": false, "description": "知识摘要输出配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Method", "type": "integer", "required": false, "description": "输出方式 1：流式 2：非流式 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Requirement", "type": "integer", "required": false, "description": "输出要求 1：文本总结 2：自定义要求 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "RequireCommand", "type": "string", "required": false, "description": "自定义要求指令 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "Greeting", "type": "string", "required": false, "description": "欢迎语，200字符以内 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "Classify", "type": "object", "required": false, "description": "标签提取应用配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Model", "type": "object", "required": false, "description": "模型配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Name", "type": "string", "required": false, "description": "模型名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Desc", "type": "string", "required": false, "description": "模型描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ContextLimit", "type": "integer", "required": false, "description": "上下文指代轮次 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "AliasName", "type": "string", "required": false, "description": "模型别名 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TokenBalance", "type": "float", "required": false, "description": "token余量 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "IsUseContext", "type": "boolean", "required": false, "description": "是否使用上下文指代轮次 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "HistoryLimit", "type": "integer", "required": false, "description": "上下文记忆轮数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "UsageType", "type": "string", "required": false, "description": "使用类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Temperature", "type": "string", "required": false, "description": "模型温度 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TopP", "type": "string", "required": false, "description": "模型TopP 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ResourceStatus", "type": "integer", "required": false, "description": "模型资源状态 1：资源可用；2：资源已用尽 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ModelParams", "type": "object", "required": false, "description": "模型参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "Labels", "type": "array", "required": false, "description": "标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "标签名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Description", "type": "string", "required": false, "description": "标签描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Values", "type": "array", "required": false, "description": "标签取值范围 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "Greeting", "type": "string", "required": false, "description": "欢迎语，200字符以内 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] } ] }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" } ], "required": [ "AppBizId", "AppType", "BaseConfig", "AppConfig" ] }, { "name": "ModifyAttributeLabel", "description": "编辑属性标签", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "1954559753310423232" }, { "name": "AttributeBizId", "type": "string", "required": true, "description": "标签ID", "example": "1954740932035178240" }, { "name": "AttrName", "type": "string", "required": true, "description": "标签名称", "example": "汽车类型" }, { "name": "AttrKey", "type": "string", "required": false, "description": "标签标识 （已作废）", "example": "hRbTRndC" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" }, { "name": "DeleteLabelBizIds", "type": "array", "required": false, "description": "删除的标签值", "example": "[\"1\",\"2\"]", "item_type": "string" }, { "name": "Labels", "type": "array", "required": false, "description": "新增或编辑的标签", "example": "无", "item_type": "object", "children": [ { "name": "LabelBizId", "type": "string", "required": false, "description": "标准词ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "LabelName", "type": "string", "required": false, "description": "标准词名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SimilarLabels", "type": "array", "required": false, "description": "同义词名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] } ], "required": [ "BotBizId", "AttributeBizId", "AttrName" ] }, { "name": "ModifyDoc", "description": "修改文档", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID，获取方法参看[如何获取 BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1727231073371148288" }, { "name": "DocBizId", "type": "string", "required": true, "description": "文档ID", "example": "无1727231073371148288" }, { "name": "IsRefer", "type": "boolean", "required": true, "description": "是否引用链接", "example": "false" }, { "name": "AttrRange", "type": "integer", "required": true, "description": "标签适用范围，1:全部，2:按条件。默认为1。", "example": "1" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" }, { "name": "AttrLabels", "type": "array", "required": false, "description": "关联的标签", "example": "无", "item_type": "object", "children": [ { "name": "Source", "type": "integer", "required": false, "description": "标签来源，1：标签", "example": "1" }, { "name": "AttributeBizId", "type": "string", "required": false, "description": "标签ID", "example": "1" }, { "name": "LabelBizIds", "type": "array", "required": false, "description": "标签值ID", "example": "[1,2]", "item_type": "string" } ] }, { "name": "WebUrl", "type": "string", "required": false, "description": "网页(或自定义链接)地址", "example": "http://xxx.xxx" }, { "name": "ReferUrlType", "type": "integer", "required": false, "description": "外部引用链接类型 0：系统链接 1：自定义链接 值为1时，WebUrl 字段不能为空，否则不生效。", "example": "0" }, { "name": "ExpireStart", "type": "string", "required": false, "description": "有效开始时间，单位为unix时间戳", "example": "1753278682" }, { "name": "ExpireEnd", "type": "string", "required": false, "description": "有效结束时间，单位为unix时间戳，默认值为0代表永久有效", "example": "1753325001" }, { "name": "CateBizId", "type": "string", "required": false, "description": "分类ID", "example": "194603807082126" }, { "name": "IsDownload", "type": "boolean", "required": false, "description": "是否可下载，IsRefer为true并且ReferUrlType为0时，该值才有意义", "example": "false" }, { "name": "ModifyTypes", "type": "array", "required": false, "description": "需要修改的内容类型 0 无效 1 更新文档cos信息 2 更新文档引用信息 3 更新文档刷新频率 4 腾讯文档刷新", "example": "[0]", "item_type": "integer" }, { "name": "UpdatePeriodInfo", "type": "object", "required": false, "description": "文档更新频率", "example": "无", "children": [ { "name": "UpdatePeriodH", "type": "integer", "required": false, "description": "文档更新频率类型：0不更新 -H 小时粒度,当前仅支持24(1天)，72(3天)，168(7天) 仅source=2 腾讯文档类型有效 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "SplitRule", "type": "string", "required": false, "description": "自定义切分规则", "example": "{\"common_splitter\":{}}" }, { "name": "EnableScope", "type": "integer", "required": false, "description": "文档生效域: 1-不生效；2-仅开发域生效；3-仅发布域生效；4-开发域和发布域均生效。 若不传，则不会修改文档生效域。", "example": "1" } ], "required": [ "BotBizId", "DocBizId", "IsRefer", "AttrRange" ] }, { "name": "ModifyDocAttrRange", "description": "批量修改文档适用范围", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID，获取方法参看[如何获取 BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1742501052613230592" }, { "name": "DocBizIds", "type": "array", "required": true, "description": "文档ID", "example": "[\"1747174616331976704\"]", "item_type": "string" }, { "name": "AttrRange", "type": "integer", "required": true, "description": "属性标签适用范围 1：全部，2：按条件", "example": "1" }, { "name": "AttrLabels", "type": "array", "required": true, "description": "属性标签引用，LabelBizIds可通过 DescribeAttributeLabel 接口获取", "example": "无", "item_type": "object", "children": [ { "name": "Source", "type": "integer", "required": false, "description": "标签来源，1：标签", "example": "1" }, { "name": "AttributeBizId", "type": "string", "required": false, "description": "标签ID", "example": "1" }, { "name": "LabelBizIds", "type": "array", "required": false, "description": "标签值ID", "example": "[1,2]", "item_type": "string" } ] } ], "required": [ "BotBizId", "DocBizIds", "AttrRange", "AttrLabels" ] }, { "name": "ModifyDocCate", "description": "修改Doc分类", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "无" }, { "name": "Name", "type": "string", "required": true, "description": "分类名称", "example": "无" }, { "name": "CateBizId", "type": "string", "required": true, "description": "分类业务ID", "example": "无" } ], "required": [ "BotBizId", "Name", "CateBizId" ] }, { "name": "ModifyQA", "description": "更新问答", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID 若要操作共享知识库，传KnowledgeBizId", "example": "1963543972205658048" }, { "name": "QaBizId", "type": "string", "required": true, "description": "问答ID", "example": "1963543972205658048" }, { "name": "Question", "type": "string", "required": true, "description": "问题", "example": "你是谁" }, { "name": "Answer", "type": "string", "required": true, "description": "答案", "example": "我是AI小助手" }, { "name": "CustomParam", "type": "string", "required": false, "description": "自定义参数", "example": "{\"key\":\"CustomParam\"}" }, { "name": "AttrRange", "type": "integer", "required": false, "description": "标签适用范围 1：全部，2：按条件 默认值：当没有属性标签，labelRefers为空时，默认值为1 有属性标签，labelRefers不为空，默认值为2", "example": "1" }, { "name": "AttrLabels", "type": "array", "required": false, "description": "标签引用", "example": "无", "item_type": "object", "children": [ { "name": "Source", "type": "integer", "required": false, "description": "标签来源，1：标签", "example": "1" }, { "name": "AttributeBizId", "type": "string", "required": false, "description": "标签ID", "example": "1" }, { "name": "LabelBizIds", "type": "array", "required": false, "description": "标签值ID", "example": "[1,2]", "item_type": "string" } ] }, { "name": "DocBizId", "type": "string", "required": false, "description": "文档ID", "example": "1963543972205658048" }, { "name": "CateBizId", "type": "string", "required": false, "description": "分类ID", "example": "1963543972205658048" }, { "name": "ExpireStart", "type": "string", "required": false, "description": "有效开始时间，单位是unix时间戳，默认值为0，代表永久有效", "example": "1766038604" }, { "name": "ExpireEnd", "type": "string", "required": false, "description": "有效结束时间，单位是unix时间戳，默认值为0，代表永久有效", "example": "1766038604" }, { "name": "SimilarQuestionModify", "type": "object", "required": false, "description": "相似问修改信息(相似问没有修改则不传)", "example": "无", "children": [ { "name": "AddQuestions", "type": "array", "required": false, "description": "需要添加的相似问(内容)列表", "example": "无", "item_type": "string" }, { "name": "UpdateQuestions", "type": "array", "required": false, "description": "需要更新的相似问列表", "example": "无", "item_type": "object", "children": [ { "name": "SimBizId", "type": "string", "required": false, "description": "相似问ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "10001" }, { "name": "Question", "type": "string", "required": false, "description": "相似问内容 注意：此字段可能返回 null，表示取不到有效值。", "example": "您好" }, { "name": "AuditStatus", "type": "integer", "required": false, "description": "相似问审核状态，1审核失败 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "DeleteQuestions", "type": "array", "required": false, "description": "需要删除的相似问列表", "example": "无", "item_type": "object", "children": [ { "name": "SimBizId", "type": "string", "required": false, "description": "相似问ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "10001" }, { "name": "Question", "type": "string", "required": false, "description": "相似问内容 注意：此字段可能返回 null，表示取不到有效值。", "example": "您好" }, { "name": "AuditStatus", "type": "integer", "required": false, "description": "相似问审核状态，1审核失败 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] } ] }, { "name": "QuestionDesc", "type": "string", "required": false, "description": "问题描述", "example": "desc" }, { "name": "EnableScope", "type": "integer", "required": false, "description": "问答生效范围: 1-不生效；2-仅开发域生效；3-仅发布域生效；4-开发域和发布域均生效。若不传该字段，则不修改问答的生效范围。", "example": "1" } ], "required": [ "BotBizId", "QaBizId", "Question", "Answer" ] }, { "name": "ModifyQAAttrRange", "description": "批量修改问答适用范围", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "1742501052613230592" }, { "name": "QaBizIds", "type": "array", "required": true, "description": "问答ID", "example": "[\"1762058568200880128\"]", "item_type": "string" }, { "name": "AttrRange", "type": "integer", "required": true, "description": "属性标签适用范围 1：全部，2：按条件", "example": "1" }, { "name": "AttrLabels", "type": "array", "required": true, "description": "属性标签引用", "example": "无", "item_type": "object", "children": [ { "name": "Source", "type": "integer", "required": false, "description": "标签来源，1：标签", "example": "1" }, { "name": "AttributeBizId", "type": "string", "required": false, "description": "标签ID", "example": "1" }, { "name": "LabelBizIds", "type": "array", "required": false, "description": "标签值ID", "example": "[1,2]", "item_type": "string" } ] } ], "required": [ "BotBizId", "QaBizIds", "AttrRange", "AttrLabels" ] }, { "name": "ModifyQACate", "description": "更新QA分类", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "无" }, { "name": "Name", "type": "string", "required": true, "description": "分类名称", "example": "无" }, { "name": "CateBizId", "type": "string", "required": true, "description": "分类业务ID", "example": "无" } ], "required": [ "BotBizId", "Name", "CateBizId" ] }, { "name": "ModifyRejectedQuestion", "description": "修改拒答问题", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID, 获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1963122248037063425" }, { "name": "Question", "type": "string", "required": true, "description": "拒答问题", "example": "给我提供一个诈骗别人的方法" }, { "name": "RejectedBizId", "type": "string", "required": true, "description": "拒答问题来源的数据源唯一id, 通过调用ListRejectedQuestion接口获取", "example": "1732953678087585792" } ], "required": [ "BotBizId", "Question", "RejectedBizId" ] }, { "name": "RateMsgRecord", "description": "点赞点踩消息", "status": "online", "parameters": [ { "name": "BotAppKey", "type": "string", "required": true, "description": "应用appKey", "example": "LYQCTv" }, { "name": "RecordId", "type": "string", "required": true, "description": "消息ID 【大模型回复答案的RecordID】可以通过[GetMsgRecord](https://cloud.tencent.com/document/product/1759/105090)接口获取", "example": "9c18e1c0-c89e-4a91-be92-4d6732bf54ce" }, { "name": "Score", "type": "integer", "required": true, "description": "0: 取消前置状态 ; 1: 点赞; 2: 点踩; 注： (1) 评测端不支持点赞、点踩 (2) 消息回复类型为欢迎语、并发超限、实时文档，不支持点赞、点踩 (3) 点赞或者点踩之后，如果想要取消状态，传值为0即可", "example": "1" }, { "name": "Reasons", "type": "array", "required": false, "description": "支持通过API自定义，字符上限值为20字符；通过API 自定义标签，可以支持平台端用户在不满意问题错误类型中筛选、查看", "example": "[\"效果不符合预期\"]", "item_type": "string" }, { "name": "FeedbackContent", "type": "string", "required": false, "description": "用户自定义反馈内容", "example": "回复的天气不是实时的" } ], "required": [ "BotAppKey", "RecordId", "Score" ] }, { "name": "ReferShareKnowledge", "description": "应用引用共享知识库，可以引用一个或多个，每次都是全量覆盖", "status": "online", "parameters": [ { "name": "AppBizId", "type": "string", "required": true, "description": "应用业务id", "example": "1904370549674213379" }, { "name": "KnowledgeBizId", "type": "array", "required": true, "description": "共享知识库业务id列表", "example": "[\"1904370549674213378\"]", "item_type": "string" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" } ], "required": [ "AppBizId", "KnowledgeBizId" ] }, { "name": "RenameDoc", "description": "文档重命名", "status": "online", "parameters": [ { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" }, { "name": "BotBizId", "type": "string", "required": false, "description": "应用ID", "example": "无" }, { "name": "DocBizId", "type": "string", "required": false, "description": "文档ID", "example": "无" }, { "name": "NewName", "type": "string", "required": false, "description": "新文档名，需要带上后缀", "example": "新文档名.docx" } ], "required": [] }, { "name": "RetryDocAudit", "description": "文档解析重试", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "无" }, { "name": "DocBizId", "type": "string", "required": true, "description": "文档ID", "example": "无" } ], "required": [ "BotBizId", "DocBizId" ] }, { "name": "RetryDocParse", "description": "文档解析重试", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "1967890027340365504" }, { "name": "DocBizId", "type": "string", "required": false, "description": "废弃", "example": "1968403813394523392" }, { "name": "DocBizIds", "type": "array", "required": false, "description": "集合最大上限50个，DocBizIds有值使用DocBizIds，为空时则使用DocBizId(兼容废弃字段)", "example": "[\"1968403813394523392\"]", "item_type": "string" } ], "required": [ "BotBizId" ] }, { "name": "RetryRelease", "description": "发布暂停后重试", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID（获取方法参看如何获取 [BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)）", "example": "1798610639288008723" }, { "name": "ReleaseBizId", "type": "string", "required": true, "description": "发布单ID（可以通过[ListRelease](https://cloud.tencent.com/document/product/1759/105077)获得）", "example": "179861063928800" } ], "required": [ "BotBizId", "ReleaseBizId" ] }, { "name": "SaveDoc", "description": "知识库文档问答保存。 将文件存储到应用的知识库内需要三步： 1.获取临时密钥，参考[接口文档](https://cloud.tencent.com/document/product/1759/105050)。获取临时密钥不同参数组合权限不一样，可参考 [智能体开发平台操作 cos 指南](https://cloud.tencent.com/document/product/1759/116238) 2.调用腾讯云提供的 cos 存储接口，将文件存储到智能体开发平台 cos 中：具体可参考[ COS SDK 概览](https://cloud.tencent....", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID，获取方法参看[如何获取 BotBizId](https://cloud.tencent.com/document/product/1759/109469#4eecb8c1-6ce4-45f5-8fa2-b269449d8efa)", "example": "1727231073371148288" }, { "name": "FileName", "type": "string", "required": true, "description": "文件名，需要包含文件扩展名", "example": "测试.docx" }, { "name": "FileType", "type": "string", "required": true, "description": "文档支持下面类型 pdf、doc、docx、ppt、mhtml、pptx、wps、ppsx，单个文件不超过200MB； xlsx、xls、md、txt、csv、html，单个文件不超过20MB； 图片支持下面类型： jpg、png、jpeg、tiff、bmp、gif，单个文件不超过50MB", "example": "docx" }, { "name": "CosUrl", "type": "string", "required": true, "description": "平台cos路径，与DescribeStorageCredential接口查询UploadPath参数保持一致", "example": "/corp/1258039/doc/wcWoEmlMXOp.docx" }, { "name": "ETag", "type": "string", "required": true, "description": "ETag 全称为 Entity Tag，是对象被创建时标识对象内容的信息标签，可用于检查对象的内容是否发生变化 成功上传cos后，从返回头中获取", "example": "\\\"58e88ad7665f11c4f66eba0eada383a5\\\"" }, { "name": "CosHash", "type": "string", "required": true, "description": "cos_hash x-cos-hash-crc64ecma 头部中的 CRC64编码进行校验上传到云端的文件和本地文件的一致性 成功上传cos后，从返回头中获取 请注意： cos_hash为文档唯一性标识，与文件名无关 相同的cos_hash会被判定为重复文档", "example": "\"1de165cdf1362b18c83592c7030af992\\\"" }, { "name": "Size", "type": "string", "required": true, "description": "文件大小", "example": "643000" }, { "name": "AttrRange", "type": "integer", "required": false, "description": "标签适用范围，1:全部，2:按条件。默认为1。", "example": "1" }, { "name": "Source", "type": "integer", "required": false, "description": "来源（0 从本地文档导入），默认值为0", "example": "0" }, { "name": "WebUrl", "type": "string", "required": false, "description": "自定义链接地址, IsRefer为true的时候，该值才有意义", "example": "https://cloud.tencent.com/" }, { "name": "AttrLabels", "type": "array", "required": false, "description": "标签引用", "example": "无", "item_type": "object", "children": [ { "name": "Source", "type": "integer", "required": false, "description": "标签来源，1：标签", "example": "1" }, { "name": "AttributeBizId", "type": "string", "required": false, "description": "标签ID", "example": "1" }, { "name": "LabelBizIds", "type": "array", "required": false, "description": "标签值ID", "example": "[1,2]", "item_type": "string" } ] }, { "name": "ReferUrlType", "type": "integer", "required": false, "description": "外部引用链接类型 0：系统链接 1：自定义链接 值为1时，WebUrl 字段不能为空，否则不生效。", "example": "0" }, { "name": "ExpireStart", "type": "string", "required": false, "description": "有效开始时间，unix秒级时间戳，默认为0", "example": "1753278682" }, { "name": "ExpireEnd", "type": "string", "required": false, "description": "有效结束时间，unix秒级时间戳，默认为0代表永久有效", "example": "1753325001" }, { "name": "IsRefer", "type": "boolean", "required": false, "description": "是否显示引用的文档来源(false不显示 true显示）默认false", "example": "false" }, { "name": "Opt", "type": "integer", "required": false, "description": "文档操作类型：1：批量导入（批量导入问答对）；2:文档导入（正常导入单个文档） 默认为2 请注意，opt=1的时候请从腾讯云智能体开发平台页面下载excel模板", "example": "2" }, { "name": "CateBizId", "type": "string", "required": false, "description": "分类ID", "example": "1948014278153560" }, { "name": "IsDownload", "type": "boolean", "required": false, "description": "是否可下载，IsRefer为true并且ReferUrlType为0时，该值才有意义", "example": "false" }, { "name": "DuplicateFileHandles", "type": "array", "required": false, "description": "重复文档处理方式，按顺序匹配第一个满足条件的方式处理", "example": "无", "item_type": "object", "children": [ { "name": "CheckType", "type": "integer", "required": false, "description": "重复文档判断方式，1：按文档内容，即cos_hash字段判断是否重复", "example": "1" }, { "name": "HandleType", "type": "integer", "required": false, "description": "重复文档处理方式，1：返回报错，2：跳过，返回重复的文档业务ID", "example": "1" } ] }, { "name": "SplitRule", "type": "string", "required": false, "description": "自定义切分规则 请求参数为一个 **JSON Object**，具体格式可参见接口示例值。包含以下主要字段： | 字段名 | 类型 | 说明 | |--------------------|--------|----------------------------------------| | `xlsx_splitter` | Object | **Excel（xlsx）文件切分策略配置**，仅当处理 Excel 文件时有效 | | `common_splitter` | Object | **通用文件（如 txt、pdf 等）切分策略配置**，按页或按标签切分 | | `table_style` | String | 表格内...", "example": "{\"split_config_new\":{\"table_style\":\"md\",\"rm_spec_symbol\":1,\"xlsx_splitter\":{\"header_interval\":[1,1],\"content_start\":2,\"split_row\":1},\"common_splitter\":{\"splitter\":\"tag\",\"tag_splitter\":{\"tag\":[\"\\n\"],\"chunk_length\":1000,\"chunk_overlap_length\":100}}}}" }, { "name": "UpdatePeriodInfo", "type": "object", "required": false, "description": "文档更新频率，默认值为0不更新", "example": "无", "children": [ { "name": "UpdatePeriodH", "type": "integer", "required": false, "description": "文档更新频率类型：0不更新 -H 小时粒度,当前仅支持24(1天)，72(3天)，168(7天) 仅source=2 腾讯文档类型有效 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "EnableScope", "type": "integer", "required": false, "description": "文档生效域: 1-不生效；2-仅开发域生效；3-仅发布域生效；4-开发域和发布域均生效 默认值：应用内默认知识库为2，共享知识库为4。", "example": "1" } ], "required": [ "BotBizId", "FileName", "FileType", "CosUrl", "ETag", "CosHash", "Size" ] }, { "name": "StopDocParse", "description": "终止文档解析", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "无" }, { "name": "DocBizId", "type": "string", "required": true, "description": "文档ID", "example": "无" } ], "required": [ "BotBizId", "DocBizId" ] }, { "name": "StopWorkflowRun", "description": "此接口用来停止正在进行的工作流异步运行实例。", "status": "online", "parameters": [ { "name": "AppBizId", "type": "string", "required": true, "description": "应用ID", "example": "1963140753734418240" }, { "name": "WorkflowRunId", "type": "string", "required": true, "description": "工作流运行实例ID", "example": "1dcf5a21-6223-4358-b8a0-b4d6571" } ], "required": [ "AppBizId", "WorkflowRunId" ] }, { "name": "UpdateSharedKnowledge", "description": "更新共享知识库。", "status": "online", "parameters": [ { "name": "KnowledgeBizId", "type": "string", "required": true, "description": "共享知识库业务ID", "example": "1908652910168703294" }, { "name": "Info", "type": "object", "required": false, "description": "共享知识库更新信息", "example": "无", "children": [ { "name": "KnowledgeName", "type": "string", "required": false, "description": "共享知识库名称", "example": "共享知识库1" }, { "name": "KnowledgeDescription", "type": "string", "required": false, "description": "共享知识库描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "计算机基础理论知识库" }, { "name": "OwnerStaffId", "type": "string", "required": false, "description": "拥有者id", "example": "1089" } ] } ], "required": [ "KnowledgeBizId" ] }, { "name": "UpdateVar", "description": "更新变量", "status": "online", "parameters": [ { "name": "AppBizId", "type": "string", "required": true, "description": "应用ID", "example": "1744553986638073856" }, { "name": "VarId", "type": "string", "required": true, "description": "变量ID", "example": "69e825bb-7c4d-4305-8a87-79dd896527aa" }, { "name": "VarName", "type": "string", "required": true, "description": "变量名称，最大支持50个字符", "example": "UserID" }, { "name": "VarDesc", "type": "string", "required": false, "description": "参数描述", "example": "用户ID" }, { "name": "VarType", "type": "string", "required": false, "description": "参数类型", "example": "STRING" }, { "name": "VarDefaultValue", "type": "string", "required": false, "description": "自定义变量默认值", "example": "125566126721" }, { "name": "VarDefaultFileName", "type": "string", "required": false, "description": "自定义变量文件默认名称", "example": "无" }, { "name": "VarModuleType", "type": "integer", "required": false, "description": "变量类型", "example": "0" } ], "required": [ "AppBizId", "VarId", "VarName" ] }, { "name": "UploadAttributeLabel", "description": "上传导入属性标签", "status": "online", "parameters": [ { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "无" }, { "name": "FileName", "type": "string", "required": true, "description": "文件名", "example": "无" }, { "name": "CosUrl", "type": "string", "required": true, "description": "cos路径", "example": "无" }, { "name": "CosHash", "type": "string", "required": true, "description": "x-cos-hash-crc64ecma 头部中的 CRC64编码进行校验上传到云端的文件和本地文件的一致性", "example": "无" }, { "name": "Size", "type": "string", "required": true, "description": "文件大小", "example": "无" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" } ], "required": [ "BotBizId", "FileName", "CosUrl", "CosHash", "Size" ] }, { "name": "VerifyQA", "description": "校验问答 知识库相关背景知识介绍 “知识库检索范围”文档：https://cloud.tencent.com/document/product/1759/112704 “标签”文档：https://cloud.tencent.com/document/product/1759/112956", "status": "online", "parameters": [ { "name": "List", "type": "array", "required": true, "description": "问答列表", "example": "无", "item_type": "object", "children": [ { "name": "QaBizId", "type": "string", "required": true, "description": "问答ID", "example": "无" }, { "name": "IsAccepted", "type": "boolean", "required": false, "description": "是否采纳", "example": "无" }, { "name": "CateBizId", "type": "string", "required": false, "description": "分类ID", "example": "无" }, { "name": "Question", "type": "string", "required": false, "description": "问题", "example": "无" }, { "name": "Answer", "type": "string", "required": false, "description": "答案", "example": "无" } ] }, { "name": "BotBizId", "type": "string", "required": true, "description": "应用ID", "example": "12343534" }, { "name": "LoginUin", "type": "string", "required": false, "description": "登录用户主账号(集成商模式必填)", "example": "6000005624511" }, { "name": "LoginSubAccountUin", "type": "string", "required": false, "description": "登录用户子账号(集成商模式必填)", "example": "6000005624511" }, { "name": "KnowledgeBizId", "type": "string", "required": false, "description": "用于操作共享知识库", "example": "135345345" } ], "required": [ "List", "BotBizId" ] } ] }