应用平台 APPSTAGE-华为云

应用平台 APPSTAGE-分页查询资产中心Agent列表:请求示例

请求示例分页查询Agent资产列表，每页10条，查询第1页。 http://xxx.x.x.x:xxxx/v1/routes/open/queryApplicationDetailList { "isPublic" : "Y", "filter" : { "type" : "agent", "tags" : [ ] }, "page" : { "currentPage" : 1, "pageSize" : 10 } }

应用平台 APPSTAGE

应用平台 APPSTAGE-分页查询资产中心Agent列表:响应示例

响应示例状态码：200 调用接口成功。 { "data" : { "total" : 1, "applicationDeployList" : [ { "id" : "6011120231120194500011", "appSettings" : "", "appUri" : null, "webUri" : null, "settings" : null, "description" : "问数是基于大模型与数据分析核心技术的AI智能应用，用户无需掌握复杂的SQL知识，通过自然语言文字或语音对话即可完成深入数据挖掘、辅助提供决策建议，轻松完成多种业务场景下的数据查询、数据分析以及结果的可视化输出；体验版提供了基于测试数据的功能体验，欢迎试用。", "isPublic" : "Y", "logoUrl" : "/v1/obs/image/application/interfaceDef/assertQuestioningTrialVersion.png", "type" : "agent", "industry" : "internet", "ownerType" : "other", "ownerId" : "", "extInfo" : "{\"mode\":\"thirdParty\",\"url\":\"https://hwcd.jointpilot.com\"}", "tenantId" : null, "tags" : [ "通用", "问数" ], "hasApikey" : false, "apiInfo" : "", "ext2Info" : "", "deleted" : false, "deptCode" : null, "documentUrl" : "", "createDate" : "2024/12/31 00:00:00", "createdDate" : "2024/12/31 00:00:00", "videoUrl" : null, "hyperlinkUrl" : null, "imageUrl" : null, "iconUrl" : "https://wise-agent-1.obs.cn-north-5.myhuaweicloud.com:443/application/interfaceDef/assertQuestioningTrialVersion.png?AccessKeyId=WBKUD4EGREIAL7UN4KV2&Expires=1739365207&x-obs-security-token=ggpjbi1ub3J0aC01TqJ7ImFjY2VzcyI6Ild CS 1VENEVHUkVJQUw3VU40S1YyIiwibWV0aG9kcyI6WyJ0b2tlbiJdLCJyb2xlIjpbXSwicm9sZXRhZ2VzIjpbXSwidGltZW91dF9hdCI6MTczOTI3OTcwNzM4MCwidXNlciI6eyJkb21haW4iOnsiaWQiOiIyMDU0YmRlMDI4MTc0MzQyODQ4YTFkMDVlOTUxMDQ4YSIsIm5hbWUiOiJISVNfV2lzZUNsb3VkX2RldiJ9LCJpZCI6ImNiNzllMGY1YThkOTQ0YTZiZDY4YWFiNmNmZGY3OWJhIiwibmFtZSI6InowMDc3MTE4NCIsInBhc3N3b3JkX2V4cGlyZXNfYXQiOiIiLCJ1c2VyX3R5cGUiOjE2fX084pGeu6B3ngytwBJX93IDWjFolzhjnbGQFxonBCjDw_sYcDUgx17RQKtHGE2JV7iXZ24JVx6j_ijPAIgjfcwQ7Jk4SopzOX-9SJ6BRfv8LxvgFtqUloa_8BH1ylyIOb9u-6HMGb8TZHqiQve2hfssIbx2jzj9i9aejXLtBIQwgQt1pNUoQ-4lNP_HZK-dkYS2eJuXWrUQIBmGIRp_cERuxi_4py7aDGk5dhD_12zXvoTA044ChCMg1Q1Yk9Io_bPi-fNVu4pxArPW_sWWSARKCBfmNVJbbNyKgOpIPGzZWKdJqfPXMwoD_DVQjixP17I1R_mSZLWQgjFywvSseIGE&Signature=ZIZfH%2F%2Fykp4%2Fm25cb9xVSxvnFQw%3D", "lastUpdateDate" : "2024/06/16 08:00:00", "lastUpdatedDate" : "2024/06/16 08:00:00", "createdByUserId" : "Admin_Admin_Admin", "createdByUserName" : null, "lastUpdatedByUserId" : "Admin_Admin_Admin", "lastUpdatedByUserName" : null, "status" : "released", "isFavourite" : "N", "notebookDto" : null, "orchestrationEntityVo" : null, "swaggerAnalysisFileDto" : null, "name" : "问数体验版" } ] } } 状态码：400 缺少请求体。 { "error_code" : "AIAE.00001400", "error_msg" : "Request body is missing" } 状态码：500 服务器内部错误或三方服务器内部错误。 { "error_code" : "AIAE.00001500", "error_msg" : "Internal Server Error." }

应用平台 APPSTAGE

应用平台 APPSTAGE-分页查询资产中心Agent列表:响应参数

响应参数状态码：200 表5 响应Body参数参数参数类型描述 data data object 参数解释：查询成功时接口返回数据。取值范围：不涉及。 error_msg String 参数解释：错误描述。取值范围：不涉及。 error_code String 参数解释：错误码。取值范围：不涉及。表6 data 参数参数类型描述 applicationDeployList BatchQueryList object 参数解释：批量查询总数和Agent列表。取值范围：不涉及。表7 BatchQueryList 参数参数类型描述 total Integer 参数解释：查询总数。取值范围：不涉及。 applicationDeployList Array of ApplicationSingleInfoDto objects 参数解释：查询返回Agent列表。取值范围：不涉及。表8 ApplicationSingleInfoDto 参数参数类型描述 id String 参数解释：主键ID。取值范围：不涉及。 appSettings String 参数解释： Agent设置。取值范围：不涉及。 appUri String 参数解释：发布的Agent OpenAPI。取值范围：不涉及。 webUri String 参数解释：发布的Agent访问URL。取值范围：不涉及。 settings String 参数解释：已废弃。取值范围：不涉及。 description String 参数解释： Agent描述。取值范围：不涉及。 isPublic String 参数解释：是否公共资产。取值范围：不涉及。 logoUrl String 参数解释： Agent icon路径。取值范围：不涉及。 type String 参数解释：资产类型。取值范围：不涉及。 industry String 参数解释：所属行业，预留字段。取值范围：不涉及。 ownerType String 参数解释：开发模式，预留字段。取值范围：不涉及。 ownerId String 参数解释：子表ID，已废弃。取值范围：不涉及。 extInfo String 参数解释：扩展字段。取值范围：不涉及。 tenantId String 参数解释：租户ID。取值范围：不涉及。 tags Array of strings 参数解释：标签。取值范围：不涉及。 hasApikey Boolean 参数解释：已废弃。取值范围：不涉及。 apiInfo String 参数解释：已废弃。取值范围：不涉及。 ext2Info String 参数解释：已废弃。取值范围：不涉及。 deleted Boolean 参数解释：是否删除。取值范围：不涉及。 deptCode String 参数解释：部门Code。取值范围：不涉及。 documentUrl String 参数解释：预置文件OBS路径。取值范围：不涉及。 createDate String 参数解释：已废弃。取值范围：不涉及。 createdDate String 参数解释：创建时间。取值范围：不涉及。 videoUrl String 参数解释：视频路径。取值范围：不涉及。 hyperlinkUrl String 参数解释：门户访问路径。取值范围：不涉及。 imageUrl String 参数解释： Agent描述图片。取值范围：不涉及。 iconUrl String 参数解释：可下载的icon URL。取值范围：不涉及。 lastUpdateDate String 参数解释：已废弃。取值范围：不涉及。 lastUpdatedDate String 参数解释：最后更新时间。取值范围：不涉及。 createdByUserId String 参数解释：创建用户ID。取值范围：不涉及。 createdByUserName String 参数解释：创建用户名称。取值范围：不涉及。 lastUpdatedByUserId String 参数解释：最后更新用户ID。取值范围：不涉及。 lastUpdatedByUserName String 参数解释：最后更新用户名称。取值范围：不涉及。 status String 参数解释：发布状态。取值范围：不涉及。 isFavourite String 参数解释：是否收藏。取值范围：不涉及。 notebookDto String 参数解释：已废弃。取值范围：不涉及。 orchestrationEntityVo String 参数解释：已废弃。取值范围：不涉及。 swaggerAnalysisFileDto String 参数解释：已废弃。取值范围：不涉及。 name String 参数解释： Agent名称。取值范围：不涉及。状态码：400 表9 响应Body参数参数参数类型描述 error_code String 参数解释：错误码。取值范围：不涉及。 error_msg String 参数解释：错误信息。取值范围：不涉及。状态码：500 表10 响应Body参数参数参数类型描述 error_code String 参数解释：错误码。取值范围：不涉及。 error_msg String 参数解释：错误信息。取值范围：不涉及。

应用平台 APPSTAGE

应用平台 APPSTAGE-分页查询资产中心Agent列表:请求参数

请求参数表1 请求Header参数参数是否必选参数类型描述 Authorization 是 String 参数解释：鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。表2 请求Body参数参数是否必选参数类型描述 status 否 String 参数解释：根据Agent状态筛选，预留字段，可不填。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。 isPublic 是 String 参数解释：查询对外开放资产。约束限制：不涉及。取值范围： Y。默认取值：不涉及。 filter 是 Filter object 参数解释：查询过滤条件。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。 page 是 Page object 参数解释：分页条件。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。表3 Filter 参数是否必选参数类型描述 type 是 String 参数解释：应用广场类型过滤字段。约束限制：不涉及。取值范围： agent。默认取值：不涉及。 industry 否 String 参数解释：行业筛选字段，预留字段，可不填。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。 name 否 String 参数解释：按名称搜索，预留字段，可不填。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。 tags 否 Array of strings 参数解释：根据标签筛选，预留字段，可不填。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。 status 否 String 参数解释：根据Agent状态筛选，预留字段，可不填。约束限制：不涉及。取值范围： released。默认取值：不涉及。表4 Page 参数是否必选参数类型描述 pageSize 是 Integer 参数解释：分页每页大小。约束限制：不涉及。取值范围： [1-1000]。默认取值：不涉及。 currentPage 是 Integer 参数解释：当前页数。约束限制：不涉及。取值范围： [1-10000]。默认取值：不涉及。

应用平台 APPSTAGE

应用平台 APPSTAGE-分页查询Agent调用情况:响应示例

响应示例状态码：200 请求响应成功。 { "data" : { "notExistAgentIds" : "[\"362de749046e40de95650fa6b9d677eb\",\"362de749046e40de95650fa6b9d677eb\"]", "pageInfos" : { "total" : 3, "list" : { "id" : "149fd3a992c044d7960f15e5c09aa6af", "tenant_id" : "9190086000001247361", "dept_code" : "d491985550b34b1c901aff363d030c4f", "agent_id" : "CFEUYYIX6d", "user_id" : "1008600000300604420", "agent_work_type" : "agent_llm", "invoke_count" : 7, "invoke_succeed_count" : 1, "invoke_failed_count" : 6, "prompt_tokens" : 10, "completion_tokens" : 20, "total_tokens" : 30, "duration" : 398.3, "statistics_time" : "2025/02/27 11:33:39" } } } } 状态码：400 缺少请求体。 { "error_code" : "AIAE.00001400", "error_msg" : "Request body is missing" } 状态码：500 服务器内部错误或三方服务器内部错误。 { "error_code" : "AIAE.00001500", "error_msg" : "Internal Server Error." }

应用平台 APPSTAGE

应用平台 APPSTAGE-分页查询Agent调用情况:请求参数

请求参数表1 请求Header参数参数是否必选参数类型描述 Authorization 是 String 参数解释：鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。表2 请求Body参数参数是否必选参数类型描述 agentIds 否 Array of strings 参数解释：需要查询的Agent ID的列表。约束限制：格式为uuid列表,；列表数量不超过100。取值范围：不涉及。默认取值：不涉及。 startTime 是 Number 参数解释：需要查询的Agent ID的统计开始时间。约束限制：毫秒级别时间戳。取值范围：不涉及。默认取值：目前最多查询近一个月的数据。 endTime 是 Number 参数解释：需要查询的Agent ID的统计结束时间。约束限制：毫秒级别时间戳。取值范围：不涉及。默认取值：目前最多查询近一个月的数据。 current 是 Integer 参数解释：当前页号。约束限制：数字。取值范围：大于0。默认取值： 1。 pageSize 是 Integer 参数解释：每页数量。约束限制：数字。取值范围： (0,999]。默认取值： 10。

应用平台 APPSTAGE

应用平台 APPSTAGE-分页查询Agent调用情况:响应参数

响应参数状态码：200 表3 响应Body参数参数参数类型描述 pageInfos RecordsStatisticsVo object 参数解释：查询成功时接口返回的分页数据列表。取值范围：不涉及。 notExistAgentIds Array of strings 参数解释：不存在的Agent ID列表。取值范围：不涉及。表4 RecordsStatisticsVo 参数参数类型描述 id String 参数解释：主键ID。取值范围：不涉及。 agentId String 参数解释： Agent ID。取值范围：不涉及。 userId String 参数解释：用户 ID。取值范围：不涉及。 agentWorkType String 参数解释： Agent 工作类型。取值范围：不涉及。 invokeCount Number 参数解释：调用总次数。取值范围：不涉及。 invokeSucceedCount Number 参数解释：调用成功次数。取值范围：不涉及。 invokeFailedCount Number 参数解释：调用失败次数。取值范围：不涉及。 promptTokens Number 参数解释：提示tokens。取值范围：不涉及。 completionTokens Number 参数解释：输出tokens。取值范围：不涉及。 totalTokens Number 参数解释：总tokens。取值范围：不涉及。 duration Number 参数解释：时延。取值范围：不涉及。 tenantName String 参数解释：租户名称。取值范围：不涉及。 statisticsTime Number 参数解释：统计时间。取值范围：不涉及。状态码：400 表5 响应Body参数参数参数类型描述 error_code String 参数解释：错误码。取值范围：不涉及。 error_msg String 参数解释：错误信息。取值范围：不涉及。状态码：500 表6 响应Body参数参数参数类型描述 error_code String 参数解释：错误码。取值范围：不涉及。 error_msg String 参数解释：错误信息。取值范围：不涉及。

应用平台 APPSTAGE

应用平台 APPSTAGE-分页查询Agent调用情况:请求示例

请求示例分页查询Agent调用情况，每页10条，查询第1页。 https://xxx.x.x.x:xxxx/v1/routes/open/queryAgentInvokeStatistics { "agentIds" : "[\"362de749046e40de95650fa6b9d677eb\",\"362de749046e40de95650fa6b9d677eb\"]", "startTime" : 1740588223000, "endTime" : 1740714223000, "current" : 1, "pageSize" : 10 }

应用平台 APPSTAGE

应用平台 APPSTAGE-状态码

状态码状态码如表1所示表1 状态码状态码编码错误码说明 100 Continue 继续请求。这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。例如，切换到HTTP的新版本协议。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。父主题：附录

应用平台 APPSTAGE

应用平台 APPSTAGE-创建知识库并进行检索:步骤三：查询数据集版本和索引信息

步骤三：查询数据集版本和索引信息知识数据集创建成功后，调用查询知识数据集详情接口，查询数据集版本和索引信息，响应示例如下： { "data" : { "data_set_versions" : [ { "id" : "askdjh28e62-xxxxxxxxx-a15be0d63812", "version" : "v2024-11-21T11:36:55Z", "created_date" : "2024-11-11 19:36:57", "last_updated_date" : "2024-11-21 19:36:57" } ], "index_configs" : [ { "id" : "d3f28e62-xxxxxxx-a15be0d638a2", "name" : "索引配置名称", "description" : "索引配置", "data_set_id" : "d3f28e62-3a81-4018-a48f-a15be0d638a2", "vector_model_service_key" : "service_key", "index_vector_config" : { "long_text_solution" : "TRUNCATE_MODE" } } ] } } 保存创建知识库对应的数据集版本id、版本号、索引配置id。数据集版本和索引可能有多个，可以任意组合。

应用平台 APPSTAGE

应用平台 APPSTAGE-创建知识库并进行检索:步骤四：创建知识库

步骤四：创建知识库调用创建知识库接口创建知识库。根据保存的数据集id，数据集版本号，索引配置id，构建请求体，创建知识库即可。请求体如下： { "name": "知识库名称", "description": "知识库描述", "retrieval_status": "ENABLE", "rag_type": "VECTOR_RAG", "retrieval_config": { "retrieval_modes": [ "SEMANTIC_RETRIEVAL", "FULL_TEXT_RETRIEVAL" ], "retrieval_hybrid_mode": "RRF" }, "knowledge_data_sets": [ { "data_set_id": "djh28e62-xxxxxxxxx-a15be0d63812", "data_set_version": "v2024-11-21T11:36:55Z", "index_config_id": "d3f28e62-xxxxxxx-a15be0d638a2" } ] } 注意：retrieval_status字段设置知识库是否启用检索，如果启用，则检索前不需要再调用修改知识库召回状态接口启用知识库。将创建接口响应内容保存起来，该内容为知识库id： { "data" : "3f28e62-xxxxxxxx-a15be0d638a2" }

应用平台 APPSTAGE

应用平台 APPSTAGE-创建知识库并进行检索:步骤七：检索知识库数据

步骤七：检索知识库数据调用检索知识库数据接口检索知识库（知识库召回状态需为启用），请求体示例如下： { "keyword" : "什么是", "similarity_min" : "0.78", "limit" : 10, "filter" : { "group_type" : "AND", "expressions" : [ { "field" : "metadata.answer", "field_type" : "STRING", "operator" : "EQUAL", "values" : [ "一种利用量子力学原理进行信息处理的计算方式。" ] } ] }, "order_by" : { "order_items" : [ { "field" : "metadata.order", "field_type" : "INT", "order_type" : "DESC" } ] }, "data_sets" : [ { "data_set_id" : "a31ed909-xxxx-xxxx-xxxx-10958c90b3f7" } ] } 根据索引配置，返回结果为： { "data" : [ { "id" : "812857ef-xxxx-xxxx-xxxx-24ba9fd5e95c", "document" : "什么是量子计算？它是一种利用量子力学原理进行信息处理的计算方式。", "chunk" : "什么是量子计算？它是一种利用量子力学原理进行信息处理的计算方式。", "chunk_fragments" : { "question" : "什么是量子计算。", "answer" : "一种利用量子力学原理进行信息处理的计算方式" }, "similarity" : 0.87, "metadata" : { "order" : 10, "file_name" : "问题.txt", "path" : "问题.txt ", "question" : "什么是量子计算。", "answer" : "一种利用量子力学原理进行信息处理的计算方式。" }, "download_addresses" : { "xxx.png" : "https://xxxx" }, "download_address" : null, "data_set_id" : "3967c49d-xxxx-xxxx-xxxx-5eda056a1f1b" } ] } 响应参数解释： document：表示向量化检索内容，索引配置时选择某个字段为向量化字段，检索命中时返回该字段内容，即vector_retrieval为true。 chunk：表示完整切片，索引配置时配置chunk作为附加字段返回时，该字段有内容，即索引配置中category为FULL_CHUNK，retrieval_return为true。 chunk_fragments：表示切片提取字段，索引配置时配置所提取的字段作为附加字段返回时，该字段有内容，即索引配置中category为CHUNK_FRAGMENT，retrieval_return为true。 metadata：默认包含order、file_name、path三个字段，若索引配置时配置所提取的字段作为文本过滤字段时，即索引配置中category为CHUNK_FRAGMENT，text_filter为true时，metadata下会新增该字段及其内容。

应用平台 APPSTAGE

应用平台 APPSTAGE-创建知识库并进行检索:步骤五：查询知识库创建结果

步骤五：查询知识库创建结果调用查询知识库最新执行记录接口查询创建结果。该接口所需的知识库id为步骤四：创建知识库返回的内容。返回结果响应如下： { "data" : { "id" : "djh28e62-3a81-4018-a48f-a15be0d63812", "result" : "SUC CES S", "progress" : 100.0, "run_time" : 27684, "start_time" : "2024-11-22T03:15:49.000+00:00", "end_time" : "2024-11-22T03:16:17.000+00:00", "log_detail" : "开始任务......结束任务" } } 如果result字段值为SUCCESS，则表明知识库创建成功。如果result字段值为RUNNING，则表明知识库正在创建，请稍候。如果result字段值为FALIURE，则表明知识库创建失败，请检查文件是否符合要求。

应用平台 APPSTAGE

应用平台 APPSTAGE-创建知识库并进行检索:步骤一：创建数据集

步骤一：创建数据集调用创建知识数据集接口创建数据集，示例如下： { "name": "测试", "description": "测试", "data_type": "TEXT", "tags": [ "对话问答", "文案生成" ], "ingestion_config": { "data_source": "FILE_UPLOAD", "file_types": [ "txt" ] }, "schedule_config": { "schedule_type": "ONCE" }, "preprocess_config": { "cleaning_methods": [ "invisible" ], "pdf_preprocess_type": "NO_PREPROCESS" }, "chunk_config": { "slicing_configs": { "txt": { "slicing_method": "sentence", "sentence_slicing_config": { "slicing_strategy": "equivalent", "spec_symbols": [ "====" ], "contain_separator": false, "chunk_size": 26, "chunk_overlap": 0 } } } }, "extraction_config": { "extraction_example": "今天天气如何？答：还不错哦。", "extraction_mode": "RULE_EXTRACTION", "rule_extraction_configs": [ { "extraction_rule": "SEPARATOR", "field_name": "question", "separator_extraction": { "contain_separator": false, "extraction_code": 2, "separator": "？" } }, { "extraction_rule": "TEMPLATE", "field_name": "answer", "template_extraction": { "contain_end": true, "contain_start": false, "end_with": "。", "extraction_code": 1, "start_with": "它是" } } ] }, "index_config": { "description": "索引配置", "long_text_solution": "TRUNCATE_MODE", "name": "索引配置", "rag_type": "VECTOR_RAG", "retrieval_configs": [ { "category": "FULL_CHUNK", "name": "chunk", "retrieval_return": false, "text_filter": false, "vector_retrieval": false }, { "category": "CHUNK_FRAGMENT", "name": "question", "retrieval_return": true, "text_filter": true, "vector_retrieval": true }, { "category": "CHUNK_FRAGMENT", "name": "answer", "retrieval_return": true, "text_filter": true, "vector_retrieval": false } ], "vector_model_service_key": "GPT-4" } } 在创建知识数据集中，有几个参数需要注意： ingestion_config内的data_source：表明数据来源，FILE_UPLOAD为文件上传，您需上传文件；OBS_INGESTTION表示OBS接入，您需添加OBS信息的配置。 chunk_config：表示如何对文本进行切分。 extraction_config：表明要对切片做提取操作，切片提取出的字段可以在索引配置中使用。 index_config：索引配置，其中retrieval_configs配置完整切片内容，以及提取出的字段内容，在知识库检索时如何使用。记录下接口返回的内容，该内容为知识数据集id。 { "data" : "3f28e62-xxxxxxxx-a15be0d638a2" }

应用平台 APPSTAGE

应用平台 APPSTAGE-创建知识库并进行检索:步骤二：查询知识数据集创建结果

步骤二：查询知识数据集创建结果调用查询知识数据集最新执行记录接口查询创建结果，该接口所需的知识数据集id为步骤一：创建数据集返回的内容。根据返回结果响应： { "data" : { "id" : "djh28e62-3a81-4018-a48f-a15be0d63812", "result" : "SUCCESS", "progress" : 100.0, "run_time" : 27684, "start_time" : "2024-11-22T03:15:49.000+00:00", "end_time" : "2024-11-22T03:16:17.000+00:00", "log_detail" : "开始任务......结束任务" } } 如果result字段值为SUCCESS，则表明数据集创建成功。如果result字段值为RUNNING，则表明数据集正在创建，请稍候。如果result字段值为FALIURE，则表明数据集创建失败，请检查文件是否符合要求。

应用平台 APPSTAGE

云服务器内容精选

应用平台 APPSTAGE

7*24

备案

专业服务

退订

建议反馈

售前咨询热线