{
  "name": "lkeap",
  "display_name": "知识引擎原子能力",
  "description": "知识引擎原子能力（LLM Knowledge Engine Basic API）基于知识引擎研发的知识问答全链路能力，面向企业及开发者，提供灵活组建及开发模型应用的能力。您可通过多款原子能力组建您专属的模型服务，调用大模型对话、文档解析、拆分、embedding、多轮改写等服务进行组装，定制企业专属 AI 业务。支持直接通过API调用大模型能力。",
  "domain": "other",
  "api_version": "2024-05-22",
  "endpoint": "lkeap.tencentcloudapi.com",
  "actions": [
    {
      "name": "CancelTask",
      "description": "文档解析任务取消",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "取消任务的任务ID",
          "example": "09acd0b71761213495865"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "ChatCompletions",
      "description": "### 接口功能 调用接口，发起一次对话请求。默认该接口下的单账号QPM上限为15000 ，TPM上限为1200000 如需使用OpenAI兼容接口， 请参考文档：[Deepseek OpenAI对话接口](https://cloud.tencent.com/document/product/1772/115969) #### 在线体验 如您希望在网页内直接体验 DeepSeek 模型对话，推荐您前往[腾讯云智能体开发平台](https://cloud.tencent.com/product/lke)，使用[ DeepSeek 联网助手](https://lke.cloud.tencent.com/web...",
      "status": "online",
      "parameters": [
        {
          "name": "Model",
          "type": "string",
          "required": true,
          "description": "模型名称",
          "example": "deepseek-r1"
        },
        {
          "name": "Messages",
          "type": "array",
          "required": true,
          "description": "聊天上下文信息。 说明： 1. 长度最多为 40，按对话时间从旧到新在数组中排列。 2. Message.Role 可选值：system、user、assistant。 其中，system 角色可选，如存在则必须位于列表的最开始。user 和 assistant 需交替出现，以 user 提问开始，user 提问结束，Content 不能为空。Role 的顺序示例：[system（可选） user assistant user assistant user ...]。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Role",
              "type": "string",
              "required": false,
              "description": "角色",
              "example": "user"
            },
            {
              "name": "Content",
              "type": "string",
              "required": false,
              "description": "内容",
              "example": "content"
            },
            {
              "name": "ReasoningContent",
              "type": "string",
              "required": false,
              "description": "思维链内容。 ReasoningConent参数仅支持出参，且只有deepseek-r1模型会返回。",
              "example": "无"
            },
            {
              "name": "SearchResults",
              "type": "array",
              "required": false,
              "description": "搜索结果",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "Index",
                  "type": "integer",
                  "required": false,
                  "description": "索引",
                  "example": "1"
                },
                {
                  "name": "Url",
                  "type": "string",
                  "required": false,
                  "description": "链接地址",
                  "example": "https://www.qq.com/"
                },
                {
                  "name": "Name",
                  "type": "string",
                  "required": false,
                  "description": "标题",
                  "example": "筑牢压舱石、澎湃新动能 一季度经济大省稳增长再提速_腾讯新闻"
                },
                {
                  "name": "Snippet",
                  "type": "string",
                  "required": false,
                  "description": "摘要",
                  "example": "经济大省是国家经济发展的顶梁柱。 "
                },
                {
                  "name": "Icon",
                  "type": "string",
                  "required": false,
                  "description": "图标",
                  "example": "https://mat1.gtimg.com/qqcdn/qqindex2021/favicon.ico"
                },
                {
                  "name": "Site",
                  "type": "string",
                  "required": false,
                  "description": "站点",
                  "example": "腾讯网"
                },
                {
                  "name": "PublishedTime",
                  "type": "integer",
                  "required": false,
                  "description": "1740412800",
                  "example": "发布时间"
                }
              ]
            }
          ]
        },
        {
          "name": "Stream",
          "type": "boolean",
          "required": false,
          "description": "是否流式输出",
          "example": "true"
        },
        {
          "name": "Temperature",
          "type": "float",
          "required": false,
          "description": "控制生成的随机性，较高的值会产生更多样化的输出。",
          "example": "0.6"
        },
        {
          "name": "MaxTokens",
          "type": "integer",
          "required": false,
          "description": "模型最大输出长度（单位 token），不包含思维链内容。 默认为4096，取值范围：各个模型不同，参考各个模型最大输出长度（示例：4k，即4096）。 输出 token 的总长度受模型的上下文长度限制。",
          "example": "8192"
        },
        {
          "name": "EnableSearch",
          "type": "boolean",
          "required": false,
          "description": "是否启用联网搜索",
          "example": "false"
        },
        {
          "name": "Thinking",
          "type": "object",
          "required": false,
          "description": "思维链开关，本参数仅在deepseek v3.1时生效",
          "example": "无",
          "children": [
            {
              "name": "Type",
              "type": "string",
              "required": false,
              "description": "控制开启思维链，默认disabled enabled：开启思维链 disabled：关闭思维链",
              "example": "disabled"
            }
          ]
        }
      ],
      "required": [
        "Model",
        "Messages"
      ]
    },
    {
      "name": "CreateAttributeLabel",
      "description": "用于为问答对创建属性标签，以便对内容进行分类和管理。 使用场景：当需要为问答对添加分类标签和属性标记时使用，比如为问答对添加“售后”标签。",
      "status": "online",
      "parameters": [
        {
          "name": "KnowledgeBaseId",
          "type": "string",
          "required": true,
          "description": "知识库ID",
          "example": "4901991032"
        },
        {
          "name": "AttributeKey",
          "type": "string",
          "required": true,
          "description": "属性标识，最大40个英文字符，如style",
          "example": "style"
        },
        {
          "name": "AttributeName",
          "type": "string",
          "required": true,
          "description": "属性名称，最大80个英文字符，如风格",
          "example": "风格"
        },
        {
          "name": "Labels",
          "type": "array",
          "required": false,
          "description": "属性标签信息",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "LabelId",
              "type": "string",
              "required": false,
              "description": "标签id 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无"
            },
            {
              "name": "LabelName",
              "type": "string",
              "required": false,
              "description": "标签名称，最大80个英文字符 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无"
            }
          ]
        }
      ],
      "required": [
        "KnowledgeBaseId",
        "AttributeKey",
        "AttributeName"
      ]
    },
    {
      "name": "CreateKnowledgeBase",
      "description": "用于在系统中创建一个新的知识库。知识库是一个用于存储和管理知识条目的集合，可以包括文档、问答对、属性标签等。创建知识库后，可以向其中添加各种知识条目，以便在后续的知识检索中使用。 使用场景：当需要在系统中建立一个新的知识库以存储和管理特定领域或项目的知识条目时使用。例如，一个用户可能需要创建一个知识库，以存储用户指南、常见问题解答和\ufffd...",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "CreateQA",
      "description": "用于创建新的问答对。问答对可以在SearchKnowledge接口知识检索时提供匹配的答案。 使用场景：当需要添加新的知识点和对应的问答对时使用，比如为产品添加新的常见问题解答。",
      "status": "online",
      "parameters": [
        {
          "name": "KnowledgeBaseId",
          "type": "string",
          "required": true,
          "description": "知识库ID",
          "example": "4901991032"
        },
        {
          "name": "Question",
          "type": "string",
          "required": true,
          "description": "问题，最大1000个英文字符",
          "example": "你是谁"
        },
        {
          "name": "Answer",
          "type": "string",
          "required": true,
          "description": "答案，最大4000个英文字符",
          "example": "我是腾讯大模型知识引擎"
        },
        {
          "name": "AttributeLabels",
          "type": "array",
          "required": false,
          "description": "属性标签",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "AttributeId",
              "type": "string",
              "required": false,
              "description": "属性id 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无"
            },
            {
              "name": "LabelIds",
              "type": "array",
              "required": false,
              "description": "标签id 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "string"
            }
          ]
        }
      ],
      "required": [
        "KnowledgeBaseId",
        "Question",
        "Answer"
      ]
    },
    {
      "name": "CreateReconstructDocumentFlow",
      "description": "本接口为异步接口的发起请求接口，用于发起文档解析任务。 文档解析支持将图片或PDF、DOCX、PPTX、EXCEL等文件转换成Markdown格式文件，可解析包括表格、公式、图片、标题、段落、页眉、页脚等内容元素，并将内容智能转换成阅读顺序。具体支持文件类型请查看下方输入参数列表。 体验期间单账号限制qps仅为1，若有正式接入需要请与产研团队沟通开放。",
      "status": "online",
      "parameters": [
        {
          "name": "FileType",
          "type": "string",
          "required": true,
          "description": "文件类型。**支持的文件类型：**- `WPS、PDF`、`DOC`、`DOCX`、`XLS`、`XLSX`、`PPT`、`PPTX`、`MD`、`TXT`、`PNG`、`JPG`、`JPEG`、`CSV`、`HTML`、`EPUB`、`BMP`、`GIF`、`WEBP`、`HEIC`、`EPS`、`ICNS`、`IM`、`PCX`、`PPM`、`TIFF`、`XBM`、`HEIF`、`JP2`**支持的文件大小：** - `PDF` 最大300M - `WPS`、`DOCX`、`DOC`、`PPT`、`PPTX` 最大 200M - `TXT`、`MD` 最大10M - 其他 最大20M",
          "example": "PDF"
        },
        {
          "name": "FileUrl",
          "type": "string",
          "required": false,
          "description": "说明：文件的 URL 地址。 备注：文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，建议文件存储于腾讯云。 非腾讯云存储的 URL 速度和稳定性可能受一定影响。 参考：[腾讯云COS文档](https://cloud.tencent.com/document/product/436/7749)",
          "example": "http://examplebucket-1250000000.cos.ap-beijing.myqcloud.com/example.jpg"
        },
        {
          "name": "FileBase64",
          "type": "string",
          "required": false,
          "description": "文件的 Base64 值。 支持的文件类型： PNG、JPG、JPEG、PDF、GIF、BMP、TIFF 支持的文件大小：所下载文件经Base64编码后不超过 8M。文件下载时间不超过 3 秒。 支持的图片像素：单边介于20-10000px之间。 文件的 FileUrl、FileBase64 必须提供一个，如果都提供，只使用 FileUrl。",
          "example": "文件base64值"
        },
        {
          "name": "FileStartPageNumber",
          "type": "integer",
          "required": false,
          "description": "说明：文档的起始页码。 备注：当传入文件是PDF、PDF、PPT、PPTX、DOC类型时，用来指定识别的起始页码，识别的页码包含当前值。 默认值：无",
          "example": "1"
        },
        {
          "name": "FileEndPageNumber",
          "type": "integer",
          "required": false,
          "description": "说明：文档的结束页码。 备注：当传入文件是PDF、PDF、PPT、PPTX、DOC类型时，用来指定识别的结束页码，识别的页码包含当前值。 默认值：无",
          "example": "100"
        },
        {
          "name": "Config",
          "type": "object",
          "required": false,
          "description": "说明：创建文档解析任务配置信息。 备注：可设置结果的返回格式 默认值：无",
          "example": "无",
          "children": [
            {
              "name": "TableResultType",
              "type": "string",
              "required": false,
              "description": "Markdown文件中表格返回的形式 0，表格以MD形式返回 1，表格以HTML形式返回 默认为0",
              "example": "1"
            },
            {
              "name": "ResultType",
              "type": "string",
              "required": false,
              "description": "智能文档解析返回结果的格式 0：只返回全文MD； 1：只返回每一页的OCR原始Json； 2：只返回每一页的MD， 3：返回全文MD + 每一页的OCR原始Json； 4：返回全文MD + 每一页的MD 5: 返回全文md，每一页ocr原始json，每一页md 默认值为0",
              "example": "3"
            },
            {
              "name": "IgnoreFailedPage",
              "type": "boolean",
              "required": false,
              "description": "是否忽略失败页，返回已成功的页数据。默认为true。",
              "example": "true"
            }
          ]
        }
      ],
      "required": [
        "FileType"
      ]
    },
    {
      "name": "CreateSplitDocumentFlow",
      "description": "用于创建一个文档拆分任务，支持多种文件类型，具备mllm能力，能够解析并深入理解图表中的信息。",
      "status": "online",
      "parameters": [
        {
          "name": "FileType",
          "type": "string",
          "required": true,
          "description": "文件类型。**支持的文件类型：**- `WPS`、`PDF`、`DOC`、`DOCX`、`XLS`、`XLSX`、`PPT`、`PPTX`、`MD`、`TXT`、`PNG`、`JPG`、`JPEG`、`CSV`、`HTML`、`EPUB`**支持的文件大小：** - `PDF` 最大300M - `WPS`、`DOCX`、`DOC`、`PPT`、`PPTX` 最大 200M - `TXT`、`MD` 最大10M - 其他 最大20M",
          "example": "PDF"
        },
        {
          "name": "FileUrl",
          "type": "string",
          "required": true,
          "description": "文件的 URL 地址。 文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，建议文件存储于腾讯云。 非腾讯云存储的 URL 速度和稳定性可能受一定影响。 参考：[腾讯云COS文档](https://cloud.tencent.com/document/product/436/7749)",
          "example": "https://example.com/example.pdf"
        },
        {
          "name": "FileName",
          "type": "string",
          "required": false,
          "description": "文件名，可选。 **需带文件类型后缀**，当文件名无法从传入的`FileUrl`获取时需要通过该字段来明确。",
          "example": "example.pdf"
        },
        {
          "name": "FileStartPageNumber",
          "type": "integer",
          "required": false,
          "description": "文档的起始页码。 当传入文件是PDF、PDF、PPT、PPTX、DOC类型时，用来指定识别的起始页码，识别的页码包含当前值。",
          "example": "1"
        },
        {
          "name": "FileEndPageNumber",
          "type": "integer",
          "required": false,
          "description": "文档的结束页码。 当传入文件是PDF、PDF、PPT、PPTX、DOC类型时，用来指定识别的结束页码，识别的页码包含当前值。",
          "example": "100"
        },
        {
          "name": "Config",
          "type": "object",
          "required": false,
          "description": "文档拆分任务的配置信息。",
          "example": "无",
          "children": [
            {
              "name": "EnableMllm",
              "type": "boolean",
              "required": false,
              "description": "是否开启mllm",
              "example": "true"
            },
            {
              "name": "MaxChunkSize",
              "type": "integer",
              "required": false,
              "description": "最大分片长度",
              "example": "4800"
            },
            {
              "name": "IgnoreFailedPage",
              "type": "boolean",
              "required": false,
              "description": "是否忽略返回失败页码",
              "example": "true"
            },
            {
              "name": "SplitResultType",
              "type": "string",
              "required": false,
              "description": "智能文档解析返回结果的格式 0：只返回全文MD； 1：只返回每一页的OCR原始Json； 2：只返回每一页的MD； 3：返回全文MD + 每一页的OCR原始Json； 4：返回全文MD + 每一页的MD； 5：返回全文md，每一页ocr原始json，每一页md。",
              "example": "0"
            },
            {
              "name": "SplitTableResultType",
              "type": "string",
              "required": false,
              "description": "Markdown文件中表格返回的形式 0，表格以MD形式返回 1，表格以HTML形式返回 默认为",
              "example": "0"
            }
          ]
        }
      ],
      "required": [
        "FileType",
        "FileUrl"
      ]
    },
    {
      "name": "DeleteAttributeLabels",
      "description": "用于删除不再需要的属性标签。 使用场景：当某个标签不再使用时，可以将其删除以保持标签系统的整洁。",
      "status": "online",
      "parameters": [
        {
          "name": "KnowledgeBaseId",
          "type": "string",
          "required": true,
          "description": "知识库ID",
          "example": "4901991032"
        },
        {
          "name": "AttributeIds",
          "type": "array",
          "required": true,
          "description": "属性ID",
          "example": "[\"1830996257455365986\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "KnowledgeBaseId",
        "AttributeIds"
      ]
    },
    {
      "name": "DeleteDocs",
      "description": "用于删除已有的文档。 使用场景：当某个文档不再需要时，可以将其删除以保持文档库的整洁。",
      "status": "online",
      "parameters": [
        {
          "name": "KnowledgeBaseId",
          "type": "string",
          "required": true,
          "description": "知识库ID",
          "example": "4901991032"
        },
        {
          "name": "DocIds",
          "type": "array",
          "required": true,
          "description": "文档ID列表。支持批量删除，数量不超过100",
          "example": "[\"1830996256553674598\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "KnowledgeBaseId",
        "DocIds"
      ]
    },
    {
      "name": "DeleteKnowledgeBase",
      "description": "用于从系统中删除一个现有的知识库。删除知识库将移除该知识库及其所有关联的知识条目（如文档、问答对、属性标签等）。该操作是不可逆的，请在执行前确认是否需要删除。**使用场景**：当某个知识库不再需要时，可以使用此接口将其从系统中删除。例如，一个项目结束后，其相关的知识库可能不再需要存储，可以使用该接口进行删除。",
      "status": "online",
      "parameters": [
        {
          "name": "KnowledgeBaseId",
          "type": "string",
          "required": true,
          "description": "知识库ID",
          "example": "41019910164"
        }
      ],
      "required": [
        "KnowledgeBaseId"
      ]
    },
    {
      "name": "DeleteQAs",
      "description": "用于删除已有的问答对。 使用场景：当某个问答对不再适用或需要移除时使用。",
      "status": "online",
      "parameters": [
        {
          "name": "KnowledgeBaseId",
          "type": "string",
          "required": true,
          "description": "知识库ID",
          "example": "4901991032"
        },
        {
          "name": "QaIds",
          "type": "array",
          "required": true,
          "description": "问答对ID列表。支持批量删除，数量不超过100",
          "example": "[\"1830996257459865536\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "KnowledgeBaseId",
        "QaIds"
      ]
    },
    {
      "name": "DescribeDoc",
      "description": "用于查询特定文档的详细信息。 使用场景：当需要查看某个文档的具体内容和属性时使用。",
      "status": "online",
      "parameters": [
        {
          "name": "KnowledgeBaseId",
          "type": "string",
          "required": true,
          "description": "知识库ID",
          "example": "4901991032"
        },
        {
          "name": "DocId",
          "type": "string",
          "required": true,
          "description": "文档ID",
          "example": "1830994598655366257"
        }
      ],
      "required": [
        "KnowledgeBaseId",
        "DocId"
      ]
    },
    {
      "name": "GetCharacterUsage",
      "description": "获取字符使用量统计",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "GetEmbedding",
      "description": "本接口（GetEmbedding）调用文本表示模型，将文本转化为用数值表示的向量形式，可用于文本检索、信息推荐、知识挖掘等场景。 本接口（GetEmbedding）有单账号调用上限控制，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。",
      "status": "online",
      "parameters": [
        {
          "name": "Model",
          "type": "string",
          "required": true,
          "description": "说明：选择生成向量的模型备注：可选[lke-text-embedding-v1,lke-text-embedding-v2,youtu-embedding-llm-v1]",
          "example": "lke-text-embedding-v1"
        },
        {
          "name": "Inputs",
          "type": "array",
          "required": true,
          "description": "说明：需要 embedding 的文本 备注：单条query最多2000个字符，总条数最多7条",
          "example": "[\"hello\", \"world\"]",
          "item_type": "string"
        },
        {
          "name": "TextType",
          "type": "string",
          "required": false,
          "description": "说明：文本向量化的类型，为使得检索任务有更好的检索效果，建议区分查询文本（query）和文档文本（document）类型, 聚类、分类等对称任务可以不用特殊指定，采用系统默认值document即可。",
          "example": "document"
        },
        {
          "name": "Instruction",
          "type": "string",
          "required": false,
          "description": "说明：自定义任务指令词，当且仅当TextType=query且Model为youtu-embedding-llm-v1时，生效",
          "example": "问题："
        }
      ],
      "required": [
        "Model",
        "Inputs"
      ]
    },
    {
      "name": "GetReconstructDocumentResult",
      "description": "本接口为异步接口的查询结果接口，用于获取文档解析处理结果。",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "说明：解析任务ID 备注：仅支持单个任务ID",
          "example": "25adcef61750343903609"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "GetSplitDocumentResult",
      "description": "查询文档拆分任务结果",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "拆分任务ID",
          "example": "236e51fd-827b-41cb-b303-56003a817ce5"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "ImportQAs",
      "description": "用于批量导入问答对，最多支持50,000条数据导入。通过此接口，可以将多个问答对一次性导入系统中，以便在后续的知识检索中使用。导入的问答对可以来自外部系统、文件或其他数据源。使用场景：当需要一次性导入大量的问答对时使用。例如，一个公司可能需要将其产品的常见问题解答从一个文档或外部系统批量导入到知识库中，以便用户可以通过知识检索系统进行查询\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "KnowledgeBaseId",
          "type": "string",
          "required": true,
          "description": "知识库ID",
          "example": "4901991032"
        },
        {
          "name": "FileName",
          "type": "string",
          "required": true,
          "description": "文件名",
          "example": "qa_import.xlsx"
        },
        {
          "name": "FileUrl",
          "type": "string",
          "required": true,
          "description": "文件的 Url 地址。文件存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议文件存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。 导入模板：https://cdn.xiaowei.qq.com/lke/assets//static/批量导入问答模板v6.xlsx",
          "example": "https://xxx.cos.ap-shanghai.myqcloud.com/file/qa_import.xlsx"
        },
        {
          "name": "FileType",
          "type": "string",
          "required": false,
          "description": "文件类型，仅支持XLSX格式，请使用模板",
          "example": "XLSX"
        }
      ],
      "required": [
        "KnowledgeBaseId",
        "FileName",
        "FileUrl"
      ]
    },
    {
      "name": "ListAttributeLabels",
      "description": "用于获取所有属性标签的列表。 使用场景：用于查看当前系统中所有已有的属性标签，方便进行管理和维护。",
      "status": "online",
      "parameters": [
        {
          "name": "KnowledgeBaseId",
          "type": "string",
          "required": true,
          "description": "知识库ID",
          "example": "4901991032"
        },
        {
          "name": "PageNumber",
          "type": "integer",
          "required": false,
          "description": "页码，默认1",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": false,
          "description": "每页数目，最大50，默认20",
          "example": "50"
        }
      ],
      "required": [
        "KnowledgeBaseId"
      ]
    },
    {
      "name": "ListDocs",
      "description": "用于获取所有文档的列表。 使用场景：用于查看当前系统中所有已有的文档，方便进行管理和维护。",
      "status": "online",
      "parameters": [
        {
          "name": "KnowledgeBaseId",
          "type": "string",
          "required": true,
          "description": "知识库ID",
          "example": "4901991032"
        },
        {
          "name": "PageNumber",
          "type": "integer",
          "required": false,
          "description": "页码，默认1",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": false,
          "description": "每页数目，最大50，默认20",
          "example": "50"
        }
      ],
      "required": [
        "KnowledgeBaseId"
      ]
    },
    {
      "name": "ListQAs",
      "description": "用于获取所有问答对的列表。 使用场景：用于查看当前系统中所有已有的问答对，方便进行管理和维护。",
      "status": "online",
      "parameters": [
        {
          "name": "KnowledgeBaseId",
          "type": "string",
          "required": true,
          "description": "知识库ID",
          "example": "4901991032"
        },
        {
          "name": "PageNumber",
          "type": "integer",
          "required": false,
          "description": "页码，默认1",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": false,
          "description": "每页数目，最大50，默认20",
          "example": "50"
        }
      ],
      "required": [
        "KnowledgeBaseId"
      ]
    },
    {
      "name": "ModifyAttributeLabel",
      "description": "用于修改已有的属性标签。 使用场景：当需要更改属性标签的名称或描述时使用，比如将“售后”标签改为“售前”。",
      "status": "online",
      "parameters": [
        {
          "name": "KnowledgeBaseId",
          "type": "string",
          "required": true,
          "description": "说明：知识库ID 备注：通过创建知识库接口（DeleteKnowledgeBase）得到知识库ID（KnowledgeBaseId）",
          "example": "34b46fe81750343723503"
        },
        {
          "name": "AttributeId",
          "type": "string",
          "required": true,
          "description": "说明：属性ID 备注：通过CreateAttributeLabel接口创建属性时会生成AttributeId，通过ListAttributeLabels接口可查询得到AttributeId、AttributeKey、AttributeName以及LabelId、LabelName的对应关系",
          "example": "1830996257459865531"
        },
        {
          "name": "AttributeKey",
          "type": "string",
          "required": true,
          "description": "说明：属性标识， 备注：仅支持英文字符，不支持数字，支持下划线。最大支持40个英文字符，如style",
          "example": "stlye"
        },
        {
          "name": "AttributeName",
          "type": "string",
          "required": true,
          "description": "说明：属性名称 备注：支持中英文字符。最大支持80个中英文字符，如风格",
          "example": "风格"
        },
        {
          "name": "Labels",
          "type": "array",
          "required": false,
          "description": "说明：标签ID（LabelId）以及标签名（LabelName） 备注： - 不填写LabelId，默认在当前AttributeId下新增标签值（LabelName）； - 若填写该AttributeId下的LabelId以及LabelName，则为修改该LabelId对应的标签值",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "LabelId",
              "type": "string",
              "required": false,
              "description": "标签id 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无"
            },
            {
              "name": "LabelName",
              "type": "string",
              "required": false,
              "description": "标签名称，最大80个英文字符 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无"
            }
          ]
        },
        {
          "name": "DeleteLabelIds",
          "type": "array",
          "required": false,
          "description": "说明：删除的标签id",
          "example": "[\"157622\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "KnowledgeBaseId",
        "AttributeId",
        "AttributeKey",
        "AttributeName"
      ]
    },
    {
      "name": "ModifyQA",
      "description": "用于修改已有的问答对。 使用场景：当需要更新问答对的内容或答案时使用。",
      "status": "online",
      "parameters": [
        {
          "name": "KnowledgeBaseId",
          "type": "string",
          "required": true,
          "description": "知识库ID",
          "example": "4901991032"
        },
        {
          "name": "QaId",
          "type": "string",
          "required": true,
          "description": "问答对ID",
          "example": "1830995120618932160"
        },
        {
          "name": "Question",
          "type": "string",
          "required": true,
          "description": "问题，最大1000个英文字符",
          "example": "你是谁"
        },
        {
          "name": "Answer",
          "type": "string",
          "required": true,
          "description": "答案，最大4000个英文字符",
          "example": "我是您的智能助手"
        },
        {
          "name": "AttributeLabels",
          "type": "array",
          "required": false,
          "description": "属性标签",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "AttributeId",
              "type": "string",
              "required": false,
              "description": "属性id 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无"
            },
            {
              "name": "LabelIds",
              "type": "array",
              "required": false,
              "description": "标签id 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "string"
            }
          ]
        }
      ],
      "required": [
        "KnowledgeBaseId",
        "QaId",
        "Question",
        "Answer"
      ]
    },
    {
      "name": "QueryRewrite",
      "description": "多轮改写（QueryRewrite）主要用于多轮对话中，进行指代消解和省略补全。使用本接口，无需输入prompt描述，根据对话历史即可生成更精确的用户查询。在应用场景上，本接口可应用于智能问答、对话式搜索等多种场景。 开通[产品体验](https://lke.cloud.tencent.com/lke/#/trialProduct)后可获得50wtoken体验额度。本接口（QueryRewrite）有单账号调用上限控制，如您有提高并发限制的需求请 [联\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Messages",
          "type": "array",
          "required": true,
          "description": "说明：需要改写的多轮历史会话，每轮历史对话需要包含user（问）和assistant（答）成对输入 备注：由于模型字符限制，最多提供4轮对话。针对最后一轮对话进行改写。四轮对话最多包含3600个字符。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Role",
              "type": "string",
              "required": false,
              "description": "角色",
              "example": "user"
            },
            {
              "name": "Content",
              "type": "string",
              "required": false,
              "description": "内容",
              "example": "content"
            },
            {
              "name": "ReasoningContent",
              "type": "string",
              "required": false,
              "description": "思维链内容。 ReasoningConent参数仅支持出参，且只有deepseek-r1模型会返回。",
              "example": "无"
            },
            {
              "name": "SearchResults",
              "type": "array",
              "required": false,
              "description": "搜索结果",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "Index",
                  "type": "integer",
                  "required": false,
                  "description": "索引",
                  "example": "1"
                },
                {
                  "name": "Url",
                  "type": "string",
                  "required": false,
                  "description": "链接地址",
                  "example": "https://www.qq.com/"
                },
                {
                  "name": "Name",
                  "type": "string",
                  "required": false,
                  "description": "标题",
                  "example": "筑牢压舱石、澎湃新动能 一季度经济大省稳增长再提速_腾讯新闻"
                },
                {
                  "name": "Snippet",
                  "type": "string",
                  "required": false,
                  "description": "摘要",
                  "example": "经济大省是国家经济发展的顶梁柱。 "
                },
                {
                  "name": "Icon",
                  "type": "string",
                  "required": false,
                  "description": "图标",
                  "example": "https://mat1.gtimg.com/qqcdn/qqindex2021/favicon.ico"
                },
                {
                  "name": "Site",
                  "type": "string",
                  "required": false,
                  "description": "站点",
                  "example": "腾讯网"
                },
                {
                  "name": "PublishedTime",
                  "type": "integer",
                  "required": false,
                  "description": "1740412800",
                  "example": "发布时间"
                }
              ]
            }
          ]
        },
        {
          "name": "Model",
          "type": "string",
          "required": false,
          "description": "说明：模型名称 备注：仅一个模型可选 默认值：lke-query-rewrite-base",
          "example": "lke-query-rewrite-base"
        }
      ],
      "required": [
        "Messages"
      ]
    },
    {
      "name": "ReconstructDocumentSSE",
      "description": "准实时文档解析接口，使用HTTP SSE 协议通信。 支持将图片或PDF文件转换成Markdown格式文件，可解析包括表格、公式、图片、标题、段落、页眉、页脚等内容元素，并将内容智能转换成阅读顺序。 输入：pdf、ppt、docx、doc、jpg等 输出：正常阅读顺序的md文件、识别结果的json（可选）等",
      "status": "online",
      "parameters": [
        {
          "name": "FileType",
          "type": "string",
          "required": true,
          "description": "支持解析的文件类型。**支持的文件类型**：WPS、PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、IM、PCX、PPM、TIFF、XBM、HEIF、JP2**支持的文件大小**：- WPS、PDF、DOC、DOCX、PPT、PPTX 支持100M- MD、TXT、XLS、XLSX、CSV 支持10M- 其他支持20M",
          "example": "PDF"
        },
        {
          "name": "FileUrl",
          "type": "string",
          "required": false,
          "description": "文件的 URL 地址。文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，建议文件存储于腾讯云。 非腾讯云存储的 URL 速度和稳定性可能受一定影响。文件的 FileUrl、FileBase64 必须提供一个，如果都提供，只使用 FileUrl。 参考：[腾讯云COS文档](https://cloud.tencent.com/document/product/436/7749) 默认值：无",
          "example": "url"
        },
        {
          "name": "FileBase64",
          "type": "string",
          "required": false,
          "description": "说明：文件的 Base64 值。 备注：支持的文件大小：所下载文件经Base64编码后不超过 8M。文件下载时间不超过 3 秒。 支持的图片像素：单边介于20-10000px之间。文件的 FileUrl、FileBase64 必须提供一个，如果都提供，只使用 FileUrl。 默认值：无",
          "example": "base64"
        },
        {
          "name": "FileStartPageNumber",
          "type": "integer",
          "required": false,
          "description": "说明：文档的起始页码。 备注：当传入文件是PDF、PDF、PPT、PPTX、DOC类型时，用来指定识别的起始页码，识别的页码包含当前值。 默认值：无",
          "example": "1"
        },
        {
          "name": "FileEndPageNumber",
          "type": "integer",
          "required": false,
          "description": "说明：文档的结束页码。备注：当传入文件是PDF、PDF、PPT、PPTX、DOC类型时，用来指定识别的结束页码，识别的页码包含当前值，文档页码大于100页建议使用异步解析接入。默认值：无",
          "example": "100"
        },
        {
          "name": "Config",
          "type": "object",
          "required": false,
          "description": "说明：文档解析配置信息 备注：可设置返回markdown结果的格式 默认值：无",
          "example": "无",
          "children": [
            {
              "name": "TableResultType",
              "type": "string",
              "required": false,
              "description": "Markdown文件中表格返回的形式 0，表格以MD形式返回 1，表格以HTML形式返回 默认为0",
              "example": "0"
            },
            {
              "name": "MarkdownImageResponseType",
              "type": "string",
              "required": false,
              "description": "Markdown文件中图片返回的形式 0:markdown中图片以链接形式返回 1:markdown中图片只返回图片中提取的文本内容 默认是0",
              "example": "0"
            },
            {
              "name": "ReturnPageFormat",
              "type": "boolean",
              "required": false,
              "description": "Markdown文件中是否包含页码信息",
              "example": "true"
            },
            {
              "name": "PageFormat",
              "type": "string",
              "required": false,
              "description": "自定义输出页码样式,{{p}}为页码占位符，开启ReturnPageFormat生效。未填默认样式:page {{p}}",
              "example": "\u003cpage_num\u003epage {{p}}\u003c/page_num\u003e"
            },
            {
              "name": "IgnoreFailedPage",
              "type": "boolean",
              "required": false,
              "description": "是否忽略失败页，返回已成功的页数据",
              "example": "true"
            }
          ]
        }
      ],
      "required": [
        "FileType"
      ]
    },
    {
      "name": "RetrieveKnowledge",
      "description": "用于检索知识库中的文档和问答对内容。 使用场景：适用于查询长期存储在知识库中的文档和问答对，比如产品手册、用户指南等内容的检索。",
      "status": "online",
      "parameters": [
        {
          "name": "KnowledgeBaseId",
          "type": "string",
          "required": true,
          "description": "知识库ID。",
          "example": "1840331836752986944"
        },
        {
          "name": "Query",
          "type": "string",
          "required": true,
          "description": "用于检索的文本。",
          "example": "国庆放几天假"
        },
        {
          "name": "RetrievalMethod",
          "type": "string",
          "required": false,
          "description": "检索方法，默认使用`HYBRID`混合检索。 - `SEMANTIC`：语义检索 - `FULL_TEXT`：全文检索 - `HYBRID`：混合检索",
          "example": "SEMANTIC"
        },
        {
          "name": "RetrievalSetting",
          "type": "object",
          "required": false,
          "description": "检索设置。",
          "example": "{\"TopK\":3,\"ScoreThreshold\":0.7}",
          "children": [
            {
              "name": "Type",
              "type": "string",
              "required": false,
              "description": "检索的类型，不填该参数则检索全部。 - `DOC`：文档 - `QA`：QA 仅RetrieveKnowledge接口支持该参数",
              "example": "DOC"
            },
            {
              "name": "TopK",
              "type": "integer",
              "required": false,
              "description": "返回个数",
              "example": "5"
            },
            {
              "name": "ScoreThreshold",
              "type": "float",
              "required": false,
              "description": "分数过滤",
              "example": "0.7"
            }
          ]
        },
        {
          "name": "AttributeLabels",
          "type": "array",
          "required": false,
          "description": "标签过滤。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": false,
              "description": "属性key",
              "example": "key1"
            },
            {
              "name": "Values",
              "type": "array",
              "required": false,
              "description": "标签值",
              "example": "[\"v1\",\"v2\"]",
              "item_type": "string"
            }
          ]
        }
      ],
      "required": [
        "KnowledgeBaseId",
        "Query"
      ]
    },
    {
      "name": "RunRerank",
      "description": "基于知识引擎精调模型技术的rerank模型，支持对多路召回的结果进行重排序，根据query与切片内容的相关性，按照顺序给出每一条结果和query的相关性分数。",
      "status": "online",
      "parameters": [
        {
          "name": "Query",
          "type": "string",
          "required": true,
          "description": "说明：查询内容 备注：用于匹配的query",
          "example": "腾讯知识引擎大模型"
        },
        {
          "name": "Docs",
          "type": "array",
          "required": true,
          "description": "说明：文档列表 备注：最多60个，Query字段和Docs字段的总长度上限为2000字符",
          "example": "[\"腾讯知识引擎\",\"知识引擎大模型\"]",
          "item_type": "string"
        },
        {
          "name": "Model",
          "type": "string",
          "required": false,
          "description": "说明：模型名称 备注：仅一个模型可选 默认值：lke-reranker-base",
          "example": "lke-reranker-base"
        }
      ],
      "required": [
        "Query",
        "Docs"
      ]
    },
    {
      "name": "UploadDoc",
      "description": "用于上传文档内容。上传的文档将存储在知识库中，可以通过RetrieveKnowledge[知识库内容检索接口](https://cloud.tencent.com/document/product/1772/115349)进行检索。 使用场景：适用于需要长期存储和检索的文档内容，如产品手册、用户指南等。",
      "status": "online",
      "parameters": [
        {
          "name": "KnowledgeBaseId",
          "type": "string",
          "required": true,
          "description": "知识库ID",
          "example": "4901991032"
        },
        {
          "name": "FileName",
          "type": "string",
          "required": true,
          "description": "文件名。 **需带文件类型后缀**",
          "example": "example.pdf"
        },
        {
          "name": "FileType",
          "type": "string",
          "required": true,
          "description": "文件类型。 **支持的文件类型：** - `PDF`、`DOC`、`DOCX`、`XLS`、`XLSX`、`PPT`、`PPTX`、`MD`、`TXT`、`PNG`、`JPG`、`JPEG`、`CSV` **支持的文件大小：** - `PDF`、`DOCX`、`DOC`、`PPT`、`PPTX` 最大 200M - `TXT`、`MD` 最大10M - 其他 最大20M",
          "example": "PDF"
        },
        {
          "name": "FileUrl",
          "type": "string",
          "required": true,
          "description": "文件的 URL 地址。 文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，建议文件存储于腾讯云。 非腾讯云存储的 URL 速度和稳定性可能受一定影响。 参考：[腾讯云COS文档](https://cloud.tencent.com/document/product/436/7749)",
          "example": "https://example.com/example.pdf"
        },
        {
          "name": "AttributeLabels",
          "type": "array",
          "required": false,
          "description": "属性标签引用",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "AttributeId",
              "type": "string",
              "required": false,
              "description": "属性id 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无"
            },
            {
              "name": "LabelIds",
              "type": "array",
              "required": false,
              "description": "标签id 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Config",
          "type": "object",
          "required": false,
          "description": "分段信息",
          "example": "{\"MaxChunkSize\":4800}",
          "children": [
            {
              "name": "MaxChunkSize",
              "type": "integer",
              "required": false,
              "description": "最大分片长度",
              "example": "4800"
            }
          ]
        }
      ],
      "required": [
        "KnowledgeBaseId",
        "FileName",
        "FileType",
        "FileUrl"
      ]
    }
  ]
}