华为云用户手册

API概览 Koosearch提供的接口为符合RESTful API设计规范的自研接口。通过Koosearch的自研接口，您可以使用Koosearch的表1 接口说明所示的功能。 表1 接口说明 类型 说明 知识库管理接口 知识库管理等相关接口。 结构化数据接口 将结构化数据文件纳入系统进行管理接口。 文件管理接口 用户纳入系统的文档管理接口。 FAQ管理接口 用户自定义的FAQ相关管理接口。 FAQ批量管理接口 用户自定义的批量FAQ相关管理接口。 搜索与问答接口 Koosearch的搜索与模型问答接口。 对话历史接口 用户对话历史接口。 图片管理接口 图片管理相关接口。 模型管理接口 模型管理的相关接口。 用户的文档解析规则定义接口 用户文档解析自定义规则配置接口。 表2 知识库管理接口 API 说明 创建知识库 创建名称为xxx的知识库。 修改知识库配置 修改知识库配置。包括： 解析设置：是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页。 文档拆分设置： 自动分段 长度分段（按文本长度分段） 层级分段（按小标题分段，可自定义小标题解析规则 搜索模型设置：rerank模型配置。 NLP模型设置。 其他设置：召回数量、参考文档数量、精排开关、Query改写开关、意图分类。 设置知识库搜索问答prompt 设置知识库搜索问答prompt，该prompt包括参考文档占位符{0}和搜索query占位符{1}。可以根据不同的使用场景，配置不同的prompt，例如增加人设、限定条件、答案格式要求等，帮助模型生成更优的结果。 设置通用问答prompt 设置通用问答prompt。该prompt包含问题占位符{0}，和对回答的要求。 开启知识库 根据ID开启知识库，知识库开启后为可检索状态。 关闭知识库 根据ID关闭知识库，知识库关闭后为不可检索状态。 获取知识库列表 获取当前账号下所有知识库列表。包括知识库ID、知识库名称、知识库状态、创建人、创建时间、更新时间等。 查询知识库详情 根据知识库ID获取当前知识库下的所有文件list，包括文档名称、文档类型、文档大小、文档状态、创建人、创建时间等。 删除知识库 根据ID删除知识库。 表3 结构化数据接口 API 说明 结构化数据上传 将结构化数据文件上传到 对象存储服务 OBS中进行结构化数据批处理功能。 下载失败的条目 下载一个JSON文件，该文件包含给定上传Field的失败条目。 结构化数据文件搜索 根据文件名搜索目标文件。 表4 文件管理接口 API 说明 上传文件 上传文件至某个知识库。 查询文件 在当前知识库查询名称为xx的文件。 下载文件 下载指定ID的文件。 删除文件 删除指定ID的文件。 表5 FAQ管理接口 API 说明 创建FAQ 输入问题、相似问题、答案，创建单条FAQ。 更新FAQ 更新指定ID的FAQ的问题、答案、相似问题。 获取FAQ 根据ID获取FAQ详情，包括问题、答案。 查询FAQ列表 获取FAQ列表，包括ID、问题、答案、创建人、创建时间等。可以根据问题关键字过滤出需要查看的FAQ。 删除FAQ 根据知识库ID和FAQ的ID，删除FAQ。 批量删除FAQ 选择多个需要删除的FAQ，根据ID批量删除。 表6 FAQ批量管理接口 API 说明 批量FAQ上传 上传xlsx/xls文件，用于FAQ的批量导入。 下载上传失败的FAQ 下载给定上传的批量FAQ文件中，上传失败的条目。 列举批量上传faq文件 列举批量上传faq文件。 下载批量导入FAQ原文件 下载批量导入FAQ的原始文件。 删除批量导入FAQ文件 删除指定的FAQ文件。 表7 搜索与问答接口 API 说明 搜索知识库 根据query，在指定知识库中搜索得到topN相关的结果。 生成答案 将content输入给模型，使用模型能力生成答案。 表8 对话历史接口 API 说明 查询对话历史列表 查询历史问题列表。包含对话ID、对话问题、用户名、对话开始时间。 获取对话历史 根据chat_id获取对话历史，返回历史的question和answer数据。 删除对话历史 根据指定ID，删除对应的对话历史。 批量删除对话历史 根据多个ID，批量删除对话历史信息。 表9 图片管理接口 API 说明 上传图片 上传图片入库。 获取图片内容 根据ID获取图片内容。 表10 模型管理接口 API 说明 新增模型 新增配置模型，包括模型名称、模型描述、模型endpoint、模型配置。 修改模型配置 修改模型。 列举模型 列举模型。 删除模型 删除模型。 表11 用户的文档解析规则定义接口 API 说明 创建用户解析规则 列用于创建用户自定义的解析规则，解析规则用于解析需要作为subtitle的文本，规则由上而下依次校验。 修改用户解析规则 用于修改已配置的解析规则。 列举用户规则列表 列举用户配置的所有解析规则列表。 删除用户定义规则解析接口 用于删除用户定义的某种规则。

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作 用户 由账号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在API凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 Checkpoint：消费检查点。应用程序消费数据时，记录已消费数据的最新序列号作为检查点。当重新消费数据时，可根据此检查点继续消费。 APP：应用程序标识符。当多个应用程序分别消费同一通道的数据时，为区分不同应用程序的消费检查点，使用APP作为标识。 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 父主题： 使用前必读

URI POST /v1/koosearch/repos/{repo_id}/structured-data 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录 KooSearch 体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 file_id String 文件ID 最小长度：1 最大长度：64 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI POST /v1/koosearch/repos/{repo_id}/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 file_id String 文件ID 最小长度：1 最大长度：64 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI POST /v1/koosearch/repos/{repo_id}/faqs/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token 最小长度：1 最大长度：1000000 表3 FormData参数 参数 是否必选 参数类型 描述 file 是 File 仅支持JSON文件上传 rule 否 String 问题匹配规则 最小长度：0 最大长度：64

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 file_id String 文件ID 最小长度：1 最大长度：64 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

请求示例 https://console.ulanqab.huawei.com/elasticsearch/unisearch-dev/v1/729cbd739854470da5426ed26bd900ca/unisearch-dev/v1/1ed40ceefc8d40f8b884edb6a84e7768/applications/fb9731ab-7085-474f-b6c7-64473586f0f3/uni-search/e8196714-3e6b-454e-8c23-61baff601ec9/faq/batch/upload file

请求示例 /v1/111/applications/222/uni-search/models { "detail" : "pangu_38b", "endpoint" : "http://10.0.0.169:31010", "extend_config" : { "deployment_id" : "123", "iam_info" : { "iam_enabled" : false, "agency_enabled" : false } } }

响应参数 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI PUT /v1/koosearch/repos/{repo_id}/faqs 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI PUT /v1/koosearch/repos/{repo_id}/disable 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI PUT /v1/koosearch/repos/{repo_id}/enable 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64

响应示例 状态码： 200 知识库详情响应体 { "id" : "1234545", "name" : "知识库123", "detail" : "金融知识库", "status" : "OPEN", "create_user" : "", "create_time" : "", "update_time" : "1693921595857", "fields" : [ { "name" : "id", "field_type" : "keyword", "name_zh" : "id" } ] }

URI GET /v1/koosearch/repos/{repo_id} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of ErrorRsp objects 请求错误 表4 ErrorRsp 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 404 表5 响应Body参数 参数 参数类型 描述 [数组元素] Array of ErrorRsp objects 图片不存在 表6 ErrorRsp 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表7 响应Body参数 参数 参数类型 描述 [数组元素] Array of ErrorRsp objects 内部异常 表8 ErrorRsp 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

响应示例 状态码： 200 成功 { "id" : "5323205cfa9244b385ff5968ece0cd9a", "repo_id" : "123", "question" : "问题", "answer" : "答案", "status" : 0, "create_time" : "1716284755573", "update_time" : "1716284755573" }

URI GET /v1/koosearch/repos/{repo_id}/faqs/{faq_id} 表1 路径参数 参数 是否必选 参数类型 描述 faq_id 是 String FAQ ID，1～64个字符，只能包含数字、字母、中划线和下划线，且必须以字母开头。 获取方式： 账号登录KooSearch体验平台 左侧导航栏选择："KooSearch-KooSearch文档问答" 根据"名称/ID"，选择购买的服务，单击"问答"，进入KooSearch文档问答管理页面 左侧导航栏选择："知识库管理" ，在知识库列表中，选择目标知识库，单击其ID进入 单击"FAQ管理"，即可查看FAQ列表，获取某条FAQ的ID 最小长度：1 最大长度：64 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 chat_id String 会话ID，会话的唯一标识 最小长度：1 最大长度：64 knowledge_repo_id String 知识库ID，当前会话参考的知识库ID 最小长度：1 最大长度：64 create_date_time String 会话发生的时间戳 最小长度：1 最大长度：13 is_del Integer 当前对话是否删除标记，0：未删除，1：已删除 枚举值： 0 1 question_models Array of QuestionModel objects 当前会话详情，包括问题、答案、参考分片信息等 数组长度：0 - 65535 表4 QuestionModel 参数 参数类型 描述 question_id String 问题ID 最小长度：1 最大长度：64 chat_id String 会话ID 最小长度：1 最大长度：64 question String 问题 最小长度：1 最大长度：65535 answer String 答案 最小长度：1 最大长度：65535 create_date_time String 对话发生时间 最小长度：1 最大长度：13 feedback_status Integer 是否有问题反馈 枚举值： 0 1 question_reference_models Array of QuestionReferenceModel objects 当前答案的参考文件和分片详情 数组长度：0 - 65535 表5 QuestionReferenceModel 参数 参数类型 描述 id Integer 参考分片ID 最小值：0 最大值：2147483647 reference_id String 参考文件ID 最小长度：1 最大长度：64 doc_title String 参考文件名称 最小长度：1 最大长度：65535 subtitle String 参考分片子标题 最小长度：1 最大长度：65535 doc_content String 参考分片内容 最小长度：1 最大长度：65535 score Float 参考分片与问题的相关性得分 最小值：0.0 最大值：200.0

响应示例 状态码： 200 成功 { "chat_id" : "9eafef43-0fc5-4f62-891a-34810ada9f20", "knowledge_repo_id" : "2e1524cc-cf40-4607-9134-1204f320b868", "create_date_time" : "1717641946646", "is_del" : 0, "question_models" : [ { "question_id" : "7ae2d834-591a-4a2b-bba5-53802c93998f", "chat_id" : "9eafef43-0fc5-4f62-891a-34810ada9f20", "question" : "人身保险业务包括哪些子业务？", "answer" : "根据提供的文档内容，人身保险业务包括以下子业务:\n\n-人寿保险: 这是指在被保险人生存期间，保险人按照合同约定的时间，向被保险人或者其指定的受益人支付保险金的保险。 \n-健康保险: 这类保险主要是为了减轻因疾病、意外伤害或其他健康问题导致的个人或家庭的经济负担。 \n-意外伤害保险: 这种保险是为了保障被保险人因意外伤害导致身体损害或死亡时，保险人给予的经济补偿。 \n\n文档中还提到，经营财产保险业务的保险公司经国务院保险监督管理机构批准，可以经营短期健康保险业务和意外伤害保险业务。这意味着在特定条件下，健康保险和意外伤害保险可以与财产保险业务相结合。", "create_date_time" : "1717641952936", "feedback_status" : 0, "question_reference_models" : [ { "id" : 2141249532, "reference_id" : "aa1298dfe8a2cfd3f4392019231137d2", "doc_title" : "中国人民共和国保险法.pdf", "subtitle" : "中国人民共和国保险法\n中华人民共和国保险法 第四章 保险经营规则(1)", "doc_content" : "第九十五条 保险公司的业务范围:\n（一）人身保险业务，包括人寿保险、健康保险、意外伤害保险等保险业务；\n（二）财产保险业务，包括财产损失保险、责任保险、信用保险、保证保险等保险业务；\n(三)国务院保险监督管理机构批准的与保险有关的其他业务。\n保险人不得兼营人身保险业务和财产保险业务。但是，经营财产保险业务的保险公司经国务院保险监督管理机构批准,可以经营短期健康保险业务和意外伤害保险业务。\n保险公司应当在国务院保险监督管理机构依法批准的业务范围内从事保险经营活动。\n第九十六条 经国务院保险监督管理机构批准,保险公司可以经营本法第九十五条规定的保险业务的下列再保险业务:\n（一）分出保险；\n（二）分入保险。\n第九十七条 保险公司应当按照其注册资本总额的百分之二十提取保证金，存入国务院保险监督管理机构指定的银行，除公司清算时用于清偿债务外，不得动用。\n第九十八条 保险公司应当根据保障被保险人利益、保证偿付能力的原则，提取各项责任准备金。\n保险公司提取和结转责任准备金的具体办法,由国务院保险监督管理机构制定。\n第九十九条 保险公司应当依法提取公积金。\n第一百条 保险公司应当缴纳保险保障基金。", "score" : 0.478392 }, { "id" : 2141249533, "reference_id" : "aa1298dfe8a2cfd3f4392019231137d2", "doc_title" : "中国人民共和国保险法.pdf", "subtitle" : "中国人民共和国保险法\n中华人民共和国保险法 第一节 一般规定(3)", "doc_content" : "保险人在合同订立时已经知道投保人未如实告知的情况的，保险人不得解除合同；发生保险事故的，保险人应当承担赔偿或者给付保险金的责任。\n保险事故是指保险合同约定的保险责任范围内的事故。\n第十七条 订立保险合同，采用保险人提供的格式条款的，保险人向投保人提供的投保单应当附格式条款,保险人应当向投保人说明合同的内容。\n对保险合同中免除保险人责任的条款,保险人在订立合同时应当在投保单、保险单或者其他保险凭证上作出足以引起投保人注意的提示,并对该条款的内容以书面或者口头形式向投保人作出明确说明；未作提示或者明确说明的，该条款不产生效力。\n第十八条 保险合同应当包括下列事项:\n（一）保险人的名称和住所；\n(二）投保人、被保险人的姓名或者名称、住所，以及人身保险的受益人的姓名或者名称、住所；\n（三）保险标的；\n（四）保险责任和责任免除；\n（五）保险期间和保险责任开始时间；\n（六）保险金额；\n（七）保险费以及支付办法；\n（八）保险金赔偿或者给付办法；\n（九）违约责任和争议处理；\n（十）订立合同的年、月、日。\n投保人和保险人可以约定与保险有关的其他事项。\n受益人是指人身保险合同中由被保险人或者投保人指定的", "score" : 0.0246569 }, { "id" : 2141249534, "reference_id" : "aa1298dfe8a2cfd3f4392019231137d2", "doc_title" : "中国人民共和国保险法.pdf", "subtitle" : "中国人民共和国保险法\n中华人民共和国保险法 第一章 总则", "doc_content" : "第一条 为了规范保险活动,保护保险活动当事人的合法权益，加强对保险业的监督管理，维护社会经济秩序和社会公共利益，促进保险事业的健康发展，制定本法。\n第二条 本法所称保险，是指投保人根据合同约定，向保险人支付保险费,保险人对于合同约定的可能发生的事故因其发生所造成的财产损失承担赔偿保险金责任，或者当被保险人死亡、伤残、疾病或者达到合同约定的年龄、期限等条件时承担给付保险金责任的商业保险行为。\n第三条 在中华人民共和国境内从事保险活动，适用本法。\n第四条 从事保险活动必须遵守法律、行政法规，尊重社会公德，不得损害社会公共利益。\n第五条 保险活动当事人行使权利、履行义务应当遵循诚实信用原则。\n第六条 保险业务由依照本法设立的保险公司以及法律﹑行政法规规定的其他保险组织经营,其他单位和个人不得经营保险业务。\n第七条 在中华人民共和国境内的法人和其他组织需要办理境内保险的，应当向中华人民共和国境内的保险公司投保。\n第八条 保险业和银行业、证券业、信托业实行分业经营、分业管理，保险公司与银行、证券、信托业务机构分别设立。国家另有规定的除外。\n第九条 国务院保险监督管理机构依法对保险业实施监督管理。\n国务院保险监督管理机构根据履行职责的需要设立派出机构。派出机构按照国务院保险监督管理机构的授权履行监督管理职责。", "score" : 0.014672 } ] } ] }

请求示例 配置示例 /v1/koosearch/repos/919e8b10-b0c4-4bcd-9d5a-8ebb69594514/search-prompt { "prompt" : "你是一名问题回答助手，请参考以下给出的文章回答问题。在回答问题之前，请你先仔细判给出的文章是否可以回答问题。如果给出的文章与问题不相关，则直接输出“抱歉，我无法回答此次问题“；如果给出的文章与问题相关，则参考给出的文章回答问题。\n给出的文章：\n{0}\n问题：{1}\n请你按照要求进行仔细判断后，给出你的回答：}" }

URI POST /v1/koosearch/repos/{repo_id}/search-prompt 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 repo_id String 响应字段 最小长度：1 最大长度：64 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI POST /v1/koosearch/repos/{repo_id}/common-prompt 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 repo_id String 响应字段 最小长度：1 最大长度：64 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

请求示例 配置示例 /v1/koosearch/repos/919e8b10-b0c4-4bcd-9d5a-8ebb69594514/common-prompt { "prompt" : "你是一名问题回答助手，请参考以下给出的文章回答问题。在回答问题之前，请你先仔细判给出的文章是否可以回答问题。如果给出的文章与问题不相关，则直接输出“抱歉，我无法回答此次问题“；如果给出的文章与问题相关，则参考给出的文章回答问题。\n给出的文章：\n{0}\n问题：{1}\n请你按照要求进行仔细判断后，给出你的回答：}" }