'1.0', 'info' => [ 'style' => 'ROA', 'product' => 'DianJin', 'version' => '2024-06-28', ], 'directories' => [ [ 'id' => 194986, 'title' => null, 'type' => 'directory', 'children' => [ 'UpdateDocumentChunk', 'GetAppConfig', 'CreateLibrary', 'GetLibraryList', 'GetLibrary', 'UploadDocument', 'GetDocumentUrl', 'PreviewDocument', 'GetFilterDocumentList', 'GetDocumentList', 'DeleteDocument', 'UpdateDocument', 'CreatePredefinedDocument', 'GetDocumentChunkList', 'RecallDocument', 'GetParseResult', 'ReIndex', 'UpdateLibrary', 'DeleteLibrary', 'RunLibraryChatGeneration', 'GetHistoryListByBizType', 'InvokePlugin', ], ], [ 'id' => 195037, 'title' => null, 'type' => 'directory', 'children' => [ 'EndToEndRealTimeDialog', 'RunDialogAnalysis', 'RunAgent', 'CreateDialog', 'RealTimeDialog', 'RealtimeDialogAssist', 'GetDialogDetail', 'GetDialogLog', 'GetDialogAnalysisResult', 'CreateDialogAnalysisTask', 'RebuildTask', 'EvictTask', 'GetTaskStatus', 'CreateDocsSummaryTask', 'CreateAnnualDocSummaryTask', 'CreatePdfTranslateTask', 'CreateFinReportSummaryTask', 'GetSummaryTaskResult', 'GetTaskResult', 'CreateQualityCheckTask', 'GetQualityCheckTaskResult', 'RecognizeIntention', 'GenDocQaResult', 'UpdateQaLibrary', 'SubmitChatQuestion', 'GetChatQuestionResp', 'RunChatResultGeneration', ], ], [ 'id' => 361341, 'title' => null, 'type' => 'directory', 'children' => [ 'DashscopeAsyncTaskFinishEvent', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'UpdateDocumentChunk' => [ 'summary' => '更新文档的chunk', 'path' => '/{workspaceId}/api/library/updateDocumentChunk', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'libraryId' => [ 'title' => '文档库ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'sjdgdsfg', ], 'chunks' => [ 'title' => '文档块列表', 'description' => '', 'type' => 'array', 'items' => [ 'title' => '文档块', 'description' => '', 'type' => 'object', 'properties' => [ 'chunkId' => [ 'title' => '文档块ID', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '1987834755763847', ], 'chunkText' => [ 'title' => '文档块文本', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], ], 'required' => true, ], 'required' => true, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode', 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'time' => [ 'title' => '时间戳', 'description' => '', 'type' => 'string', 'example' => '2024-01-01 00:00:00', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'data' => [ 'title' => '响应数据', 'description' => '', 'type' => 'string', 'example' => 'SUCCESS', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '003D019A-1BB3-53EC-A0D2-CE76DA5D73B1', ], 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true,\\n \\"dataType\\": \\"null\\",\\n \\"time\\": \\"2024-01-01 00:00:00\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"data\\": \\"SUCCESS\\",\\n \\"requestId\\": \\"003D019A-1BB3-53EC-A0D2-CE76DA5D73B1\\",\\n \\"cost\\": 0\\n}","type":"json"}]', ], 'GetAppConfig' => [ 'summary' => '获取app配置', 'path' => '/{workspaceId}/api/app/config', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode', 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', ], 'data' => [ 'title' => '响应数据', 'description' => '', 'type' => 'object', 'properties' => [ 'embeddingTypeList' => [ 'title' => 'embedding类型列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'description' => 'value', 'example' => 'DashScope', ], ], ], 'frontendConfig' => [ 'title' => '前端配置', 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'boolean', 'example' => 'true', 'description' => '', ], ], 'libraryDocumentStatusList' => [ 'title' => '文档状态列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'description' => 'value', 'example' => 'Completed', ], ], ], 'llmHelperTypeList' => [ 'title' => '大模型类型列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => 'qwen-max', 'description' => 'value', ], ], ], 'textIndexCategoryList' => [ 'title' => '文本索引类型列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'ElasticSearch', ], ], 'vectorIndexCategoryList' => [ 'title' => '向量索引类型列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'ADB', ], ], ], ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => 'None', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => 'EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258', ], 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'True', ], 'time' => [ 'title' => '时间戳', 'description' => '', 'type' => 'string', 'example' => '2024-04-24 11:54:34', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"embeddingTypeList\\": [\\n {\\n \\"key\\": \\"DashScope\\"\\n }\\n ],\\n \\"frontendConfig\\": {\\n \\"key\\": true\\n },\\n \\"libraryDocumentStatusList\\": [\\n {\\n \\"key\\": \\"Completed\\"\\n }\\n ],\\n \\"llmHelperTypeList\\": [\\n {\\n \\"key\\": \\"qwen-max\\"\\n }\\n ],\\n \\"textIndexCategoryList\\": [\\n \\"ElasticSearch\\"\\n ],\\n \\"vectorIndexCategoryList\\": [\\n \\"ADB\\"\\n ]\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"None\\",\\n \\"requestId\\": \\"EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', ], 'CreateLibrary' => [ 'summary' => '创建文档库', 'path' => '/{workspaceId}/api/library/create', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-ik******RVYCKzt', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'description' => [ 'title' => '文档库的描述', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], 'indexSetting' => [ 'title' => '文档库的索引设置', 'description' => '', 'type' => 'object', 'properties' => [ 'chunkStrategy' => [ 'title' => '分段策略', 'description' => '', 'type' => 'object', 'properties' => [ 'docTreeSplit' => [ 'title' => '版面切分', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'docTreeSplitSize' => [ 'title' => '版面切分大小', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300', ], 'enhanceGraph' => [ 'title' => '是否增强图片', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'enhanceTable' => [ 'title' => '是否增强表格', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'overlap' => [ 'title' => 'chunk重叠长度', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], 'sentenceSplit' => [ 'title' => '按句子切分', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'sentenceSplitSize' => [ 'title' => '按句子切分大小', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300', ], 'size' => [ 'title' => 'chunk大小', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300', ], 'split' => [ 'title' => '是否切块', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], 'required' => false, ], 'modelConfig' => [ 'title' => '模型配置', 'description' => '', 'type' => 'object', 'properties' => [ 'temperature' => [ 'title' => '温度', 'description' => '', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.8', ], 'topP' => [ 'title' => 'topP', 'description' => '', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.8', ], ], 'required' => false, ], 'promptRoleStyle' => [ 'title' => 'prompt角色风格', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], 'queryEnhancer' => [ 'title' => 'query增强配置', 'description' => '', 'type' => 'object', 'properties' => [ 'enableFollowUp' => [ 'title' => '多轮增强', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'enableMultiQuery' => [ 'title' => '是否利用大模型知识拆解问题', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'enableOpenQa' => [ 'title' => '是否利用大模型知识回答问题', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'enableQueryRewrite' => [ 'title' => '是否开启query改写', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'enableSession' => [ 'title' => '记录session', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'localKnowledgeId' => [ 'title' => '知识改写使用的文档库id', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'xxxx', ], 'withDocumentReference' => [ 'title' => '是否带文档引用', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], 'required' => false, ], 'recallStrategy' => [ 'title' => '召回策略', 'description' => '', 'type' => 'object', 'properties' => [ 'documentRankType' => [ 'title' => '合并&排序策略', 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'linear' => 'linear', 'model' => 'model', ], 'example' => 'model', ], 'limit' => [ 'title' => '两路合并总结的结果数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], 'required' => false, ], 'textIndexSetting' => [ 'title' => '文本索引配置', 'description' => '', 'type' => 'object', 'properties' => [ 'category' => [ 'title' => '文本索引类型', 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'ElasticSearch' => 'ElasticSearch', ], 'example' => 'ElasticSearch', 'pattern' => '^ElasticSearch$', 'default' => 'ElasticSearch', ], 'enable' => [ 'title' => '文本索引是否开启', 'description' => '', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], 'indexAnalyzer' => [ 'title' => 'Standard: *, IkMaxWord, Whitespace, IkSmart', 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'IkSmart' => 'IkSmart', 'IkMaxWord' => 'IkMaxWord', 'Standard' => 'Standard', ], 'example' => 'Standard', ], 'rankThreshold' => [ 'title' => '文本索引排序阈值', 'description' => '', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.5', ], 'searchAnalyzer' => [ 'title' => 'Standard: *, IkMaxWord, Whitespace, IkSmart', 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'IkSmart' => 'IkSmart', 'IkMaxWord' => 'IkMaxWord', 'Standard' => 'Standard', ], 'example' => 'Standard', ], 'topK' => [ 'title' => '文本索引最后总结结果数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', ], ], 'required' => false, ], 'vectorIndexSetting' => [ 'title' => '向量索引设置', 'description' => '', 'type' => 'object', 'properties' => [ 'category' => [ 'title' => '向量索引来源：建议填写 ADB', 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'ADB' => 'ADB', ], 'example' => 'ADB', 'pattern' => '^ADB$', 'default' => 'ADB', ], 'embeddingType' => [ 'title' => '向量索引文本Embedding模型', 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'DashScope' => 'DashScope', ], 'example' => 'DashScope', ], 'enable' => [ 'title' => '是否开启', 'description' => '', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], 'rankThreshold' => [ 'title' => '向量索引排序阈值', 'description' => '', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.5', ], 'topK' => [ 'title' => '向量索引最后总结结果数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', ], ], 'required' => false, ], ], 'required' => false, ], 'libraryName' => [ 'title' => '文档库的名称', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode', 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '300', ], 'data' => [ 'title' => '响应数据', 'description' => '', 'type' => 'string', 'example' => 'a1b2c3', ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => '', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxx', ], 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'time' => [ 'title' => '时间戳', 'description' => '', 'type' => 'string', 'example' => 'null', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 300,\\n \\"data\\": \\"a1b2c3\\",\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"成功\\",\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxx\\",\\n \\"success\\": true,\\n \\"time\\": \\"null\\"\\n}","type":"json"}]', ], 'GetLibraryList' => [ 'summary' => '分页查询文档库列表', 'path' => '/{workspaceId}/api/library/list', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', ], ], [ 'name' => 'page', 'in' => 'query', 'schema' => [ 'title' => '页码', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'title' => '每页记录的数量', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10', ], ], [ 'name' => 'query', 'in' => 'query', 'schema' => [ 'title' => '搜索的关键词，支持文档库名称和描述', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode>', 'description' => 'ResultCode>', 'type' => 'object', 'properties' => [ 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', ], 'data' => [ 'title' => '返回数据', 'description' => '', 'type' => 'object', 'properties' => [ 'currentPage' => [ 'title' => '页码', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'pageSize' => [ 'title' => '页面记录数', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'records' => [ 'title' => '记录数', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'description' => [ 'title' => '文档库描述', 'description' => '', 'type' => 'string', 'example' => '', ], 'documentCount' => [ 'title' => '文档数量', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'gmtCreate' => [ 'title' => '创建时间', 'description' => '', 'type' => 'string', 'example' => '2024-01-01 00:00:00'."\n", ], 'gmtModified' => [ 'title' => '修改时间', 'description' => '', 'type' => 'string', 'example' => '2024-01-01 00:00:00'."\n", ], 'id' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'example' => '24vs4aa42jv1rg7', ], 'indexSetting' => [ 'title' => '文档库索引设置', 'description' => '', 'type' => 'object', 'properties' => [ 'chunkStrategy' => [ 'title' => '分块策略', 'description' => '', 'type' => 'object', 'properties' => [ 'docTreeSplit' => [ 'title' => '版面切分', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'docTreeSplitSize' => [ 'title' => '版面切分大小', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '160', ], 'enhanceGraph' => [ 'title' => '是否增强图片', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'enhanceTable' => [ 'title' => '是否增强表格', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'overlap' => [ 'title' => 'chunk重叠长度', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '40', ], 'sentenceSplit' => [ 'title' => '按句子切分', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'sentenceSplitSize' => [ 'title' => '按句子切分大小', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '160', ], 'size' => [ 'title' => 'chunk大小', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '256', ], 'split' => [ 'title' => '是否切块', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], 'modelConfig' => [ 'title' => '模型配置', 'description' => '', 'type' => 'object', 'properties' => [ 'temperature' => [ 'title' => '温度', 'description' => '', 'type' => 'number', 'format' => 'double', 'example' => '0.8', ], 'topP' => [ 'title' => 'topP', 'description' => 'topP', 'type' => 'number', 'format' => 'double', 'example' => '0.8', ], ], ], 'promptRoleStyle' => [ 'title' => 'prompt角色风格', 'description' => '', 'type' => 'string', 'example' => '', ], 'queryEnhancer' => [ 'title' => 'query增强', 'description' => '', 'type' => 'object', 'properties' => [ 'enableFollowUp' => [ 'title' => '多轮增强', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'enableMultiQuery' => [ 'title' => '是否利用大模型知识拆解问题', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'enableOpenQa' => [ 'title' => '是否利用大模型知识回答问题', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'enableQueryRewrite' => [ 'title' => '是否根据领域知识改写问题', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'enableSession' => [ 'title' => '记录session', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'localKnowledgeId' => [ 'title' => '知识改写使用的文档库id', 'description' => '', 'type' => 'string', 'example' => 'sdbcjsbc', ], 'withDocumentReference' => [ 'title' => '是否带文档引用', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], 'recallStrategy' => [ 'title' => '召回策略', 'description' => '', 'type' => 'object', 'properties' => [ 'documentRankType' => [ 'title' => '合并&排序策略', 'description' => '', 'type' => 'string', 'example' => 'model', ], 'limit' => [ 'title' => '两路合并总结的结果数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'textIndexSetting' => [ 'title' => '文本索引设置', 'description' => '', 'type' => 'object', 'properties' => [ 'category' => [ 'title' => '文本索引类型', 'description' => '', 'type' => 'string', 'example' => 'ElasticSearch', ], 'enable' => [ 'title' => '文本索引是否开启', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'indexAnalyzer' => [ 'title' => '文本索引索引分析器: (Standard: *, IkMaxWord, Whitespace, IkSmart)', 'description' => '', 'type' => 'string', 'example' => 'Standard', ], 'rankThreshold' => [ 'title' => '文本索引排序阈值', 'description' => '', 'type' => 'number', 'format' => 'double', 'example' => 'null', ], 'searchAnalyzer' => [ 'title' => '文本索引搜索分析器: (Standard: *, IkMaxWord, Whitespace, IkSmart)', 'description' => '', 'type' => 'string', 'example' => 'Standard', ], 'topK' => [ 'title' => '文本索引最后总结结果数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'vectorIndexSetting' => [ 'title' => '向量索引设置', 'description' => '', 'type' => 'object', 'properties' => [ 'category' => [ 'title' => '向量索引来源：建议填写 ADB', 'description' => '', 'type' => 'string', 'example' => 'ADB', ], 'embeddingType' => [ 'title' => '向量索引文本Embedding模型', 'description' => '', 'type' => 'string', 'example' => 'DashScope', ], 'enable' => [ 'title' => '是否开启', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'rankThreshold' => [ 'title' => '向量索引排序阈值', 'description' => '', 'type' => 'number', 'format' => 'double', 'example' => 'null', ], 'topK' => [ 'title' => '向量索引最后总结结果数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], ], ], 'libraryName' => [ 'title' => '文档库名称', 'description' => '', 'type' => 'string', 'example' => '', ], ], ], ], 'totalPages' => [ 'title' => '总页数', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'totalRecords' => [ 'title' => '总记录数', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], ], ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '0a06dfe817156528535968405edce3', ], 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'time' => [ 'title' => '时间戳', 'description' => '', 'type' => 'string', 'example' => '2024-01-01 00:00:00', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"currentPage\\": 1,\\n \\"pageSize\\": 10,\\n \\"records\\": [\\n {\\n \\"description\\": \\"文档库\\",\\n \\"documentCount\\": 10,\\n \\"gmtCreate\\": \\"2024-01-01 00:00:00\\\\n\\",\\n \\"gmtModified\\": \\"2024-01-01 00:00:00\\\\n\\",\\n \\"id\\": \\"24vs4aa42jv1rg7\\",\\n \\"indexSetting\\": {\\n \\"chunkStrategy\\": {\\n \\"docTreeSplit\\": true,\\n \\"docTreeSplitSize\\": 160,\\n \\"enhanceGraph\\": true,\\n \\"enhanceTable\\": true,\\n \\"overlap\\": 40,\\n \\"sentenceSplit\\": true,\\n \\"sentenceSplitSize\\": 160,\\n \\"size\\": 256,\\n \\"split\\": true\\n },\\n \\"modelConfig\\": {\\n \\"temperature\\": 0.8,\\n \\"topP\\": 0.8\\n },\\n \\"promptRoleStyle\\": \\"你是一个信息处理专家。\\\\n\\",\\n \\"queryEnhancer\\": {\\n \\"enableFollowUp\\": true,\\n \\"enableMultiQuery\\": true,\\n \\"enableOpenQa\\": true,\\n \\"enableQueryRewrite\\": true,\\n \\"enableSession\\": true,\\n \\"localKnowledgeId\\": \\"sdbcjsbc\\",\\n \\"withDocumentReference\\": true\\n },\\n \\"recallStrategy\\": {\\n \\"documentRankType\\": \\"model\\",\\n \\"limit\\": 10\\n },\\n \\"textIndexSetting\\": {\\n \\"category\\": \\"ElasticSearch\\",\\n \\"enable\\": true,\\n \\"indexAnalyzer\\": \\"Standard\\",\\n \\"rankThreshold\\": 0,\\n \\"searchAnalyzer\\": \\"Standard\\",\\n \\"topK\\": 10\\n },\\n \\"vectorIndexSetting\\": {\\n \\"category\\": \\"ADB\\",\\n \\"embeddingType\\": \\"DashScope\\",\\n \\"enable\\": true,\\n \\"rankThreshold\\": 0,\\n \\"topK\\": 10\\n }\\n },\\n \\"libraryName\\": \\"测试文档库\\"\\n }\\n ],\\n \\"totalPages\\": 10,\\n \\"totalRecords\\": 100\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"0a06dfe817156528535968405edce3\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-01-01 00:00:00\\"\\n}","type":"json"}]', ], 'GetLibrary' => [ 'summary' => '获取文档库配置详情', 'path' => '/{workspaceId}/api/library/get', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'llm-xxxxx', ], ], [ 'name' => 'libraryId', 'in' => 'query', 'schema' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'cjshcxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode', 'description' => '', 'type' => 'object', 'properties' => [ 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', ], 'data' => [ 'title' => '返回数据', 'description' => '', 'type' => 'object', 'properties' => [ 'description' => [ 'title' => '文档库描述', 'description' => '', 'type' => 'string', 'example' => '', ], 'documentCount' => [ 'title' => '文档数量', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'gmtCreate' => [ 'title' => '创建时间', 'description' => '', 'type' => 'string', 'example' => '2024-01-01 00:00:00', ], 'gmtModified' => [ 'title' => '修改时间', 'description' => '', 'type' => 'string', 'example' => '2024-01-01 00:00:00'."\n", ], 'id' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'example' => '19386728376', ], 'indexSetting' => [ 'title' => '文档库索引设置', 'description' => '', 'type' => 'object', 'properties' => [ 'chunkStrategy' => [ 'title' => '分块策略', 'description' => '', 'type' => 'object', 'properties' => [ 'docTreeSplit' => [ 'title' => '版面切分', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'docTreeSplitSize' => [ 'title' => '版面切分大小', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '160', ], 'enhanceGraph' => [ 'title' => '是否增强图片', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'enhanceTable' => [ 'title' => '是否增强表格', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'overlap' => [ 'title' => 'chunk重叠长度', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '40', ], 'sentenceSplit' => [ 'title' => '按句子切分', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'sentenceSplitSize' => [ 'title' => '按句子切分大小', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '160', ], 'size' => [ 'title' => 'chunk大小', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '256', ], 'split' => [ 'title' => '是否切块', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], 'modelConfig' => [ 'title' => '模型配置', 'description' => '', 'type' => 'object', 'properties' => [ 'temperature' => [ 'title' => '温度', 'description' => '', 'type' => 'number', 'format' => 'double', 'example' => '0.8', ], 'topP' => [ 'title' => 'topP', 'description' => 'topP', 'type' => 'number', 'format' => 'double', 'example' => '0.8', ], ], ], 'promptRoleStyle' => [ 'title' => 'prompt角色风格', 'description' => '', 'type' => 'string', 'example' => '', ], 'queryEnhancer' => [ 'title' => 'query增强', 'description' => '', 'type' => 'object', 'properties' => [ 'enableFollowUp' => [ 'title' => '多轮增强', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'enableMultiQuery' => [ 'title' => '是否利用大模型知识拆解问题', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'enableOpenQa' => [ 'title' => '是否利用大模型知识回答问题', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'enableQueryRewrite' => [ 'title' => '是否根据领域知识改写问题', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'enableSession' => [ 'title' => '记录session', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'localKnowledgeId' => [ 'title' => '知识改写使用的文档库id', 'description' => '', 'type' => 'string', 'example' => '2836482634', ], 'withDocumentReference' => [ 'title' => '是否带文档引用', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], 'recallStrategy' => [ 'title' => '召回策略', 'description' => '', 'type' => 'object', 'properties' => [ 'documentRankType' => [ 'title' => '合并&排序策略', 'description' => '', 'type' => 'string', 'example' => 'model', ], 'limit' => [ 'title' => '两路合并总结的结果数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'textIndexSetting' => [ 'title' => '文本索引设置', 'description' => '', 'type' => 'object', 'properties' => [ 'category' => [ 'title' => '文本索引类型', 'description' => '', 'type' => 'string', 'example' => 'ElasticSearch', ], 'enable' => [ 'title' => '文本索引是否开启', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'indexAnalyzer' => [ 'title' => '文本索引索引分析器: (Standard: *, IkMaxWord, Whitespace, IkSmart)', 'description' => '', 'type' => 'string', 'example' => 'IkMaxWord', ], 'rankThreshold' => [ 'title' => '文本索引排序阈值', 'description' => '', 'type' => 'number', 'format' => 'double', 'example' => 'null', ], 'searchAnalyzer' => [ 'title' => '文本索引搜索分析器: (Standard: *, IkMaxWord, Whitespace, IkSmart)', 'description' => '', 'type' => 'string', 'example' => 'Standard', ], 'topK' => [ 'title' => '文本索引最后总结结果数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'vectorIndexSetting' => [ 'title' => '向量索引设置', 'description' => '', 'type' => 'object', 'properties' => [ 'category' => [ 'title' => '向量索引来源：建议填写 ADB', 'description' => '', 'type' => 'string', 'example' => 'ADB', ], 'embeddingType' => [ 'title' => '向量索引文本Embedding模型', 'description' => '', 'type' => 'string', 'example' => 'DashScope', ], 'enable' => [ 'title' => '是否开启', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'rankThreshold' => [ 'title' => '向量索引排序阈值', 'description' => '', 'type' => 'number', 'format' => 'double', 'example' => 'null', ], 'topK' => [ 'title' => '向量索引最后总结结果数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], ], ], 'libraryName' => [ 'title' => '文档库名称', 'description' => '', 'type' => 'string', 'example' => '', ], ], ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误类型', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '44BD277A-87F9-5310-8D63-3E6645F1DA85', ], 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'time' => [ 'title' => '时间戳', 'description' => '', 'type' => 'string', 'example' => '2024-01-01 00:00:00', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"description\\": \\"文档库的描述\\",\\n \\"documentCount\\": 10,\\n \\"gmtCreate\\": \\"2024-01-01 00:00:00\\",\\n \\"gmtModified\\": \\"2024-01-01 00:00:00\\\\n\\",\\n \\"id\\": \\"19386728376\\",\\n \\"indexSetting\\": {\\n \\"chunkStrategy\\": {\\n \\"docTreeSplit\\": true,\\n \\"docTreeSplitSize\\": 160,\\n \\"enhanceGraph\\": true,\\n \\"enhanceTable\\": true,\\n \\"overlap\\": 40,\\n \\"sentenceSplit\\": true,\\n \\"sentenceSplitSize\\": 160,\\n \\"size\\": 256,\\n \\"split\\": true\\n },\\n \\"modelConfig\\": {\\n \\"temperature\\": 0.8,\\n \\"topP\\": 0.8\\n },\\n \\"promptRoleStyle\\": \\"你是一个信息处理专家。\\",\\n \\"queryEnhancer\\": {\\n \\"enableFollowUp\\": true,\\n \\"enableMultiQuery\\": true,\\n \\"enableOpenQa\\": true,\\n \\"enableQueryRewrite\\": true,\\n \\"enableSession\\": true,\\n \\"localKnowledgeId\\": \\"2836482634\\",\\n \\"withDocumentReference\\": true\\n },\\n \\"recallStrategy\\": {\\n \\"documentRankType\\": \\"model\\",\\n \\"limit\\": 10\\n },\\n \\"textIndexSetting\\": {\\n \\"category\\": \\"ElasticSearch\\",\\n \\"enable\\": true,\\n \\"indexAnalyzer\\": \\"IkMaxWord\\",\\n \\"rankThreshold\\": 0,\\n \\"searchAnalyzer\\": \\"Standard\\",\\n \\"topK\\": 10\\n },\\n \\"vectorIndexSetting\\": {\\n \\"category\\": \\"ADB\\",\\n \\"embeddingType\\": \\"DashScope\\",\\n \\"enable\\": true,\\n \\"rankThreshold\\": 0,\\n \\"topK\\": 10\\n }\\n },\\n \\"libraryName\\": \\"测试文档库\\"\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"44BD277A-87F9-5310-8D63-3E6645F1DA85\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-01-01 00:00:00\\"\\n}","type":"json"}]', ], 'UploadDocument' => [ 'summary' => '上传文档到文档库', 'path' => '/{workspaceId}/api/library/document/upload', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'data' => [ 'title' => '文档元数据', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], 'fileName' => [ 'title' => '完整文件名（包含后缀）', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'test.pdf', ], 'fileUrl' => [ 'title' => '文件Oss地址', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'https://oss-xxx.hangzhou.com/test.pdf', 'isFileTransferUrl' => true, ], 'libraryId' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'sjdhbcsj', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode', 'description' => '', 'type' => 'object', 'properties' => [ 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', ], 'data' => [ 'title' => '响应数据', 'description' => '', 'type' => 'string', 'example' => '1782981430906818562', ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => 'ff3fef67-48d9-4379-a237-9ba8143fe739', ], 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'time' => [ 'title' => '时间戳', 'description' => '', 'type' => 'string', 'example' => '2024-04-24 11:54:34', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"1782981430906818562\\",\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"ff3fef67-48d9-4379-a237-9ba8143fe739\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', ], 'GetDocumentUrl' => [ 'summary' => '获取文档URL', 'path' => '/{workspaceId}/api/library/document/url', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', ], ], [ 'name' => 'documentId', 'in' => 'query', 'schema' => [ 'title' => '文档id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '12681367362', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode', 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', ], 'data' => [ 'title' => '响应数据', 'description' => '', 'type' => 'string', 'example' => 'https://path_to_file', ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '66249B43-8C2B-5EE7-AE78-B382306621C6', ], 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'time' => [ 'title' => '时间戳', 'description' => '', 'type' => 'string', 'example' => '2024-01-01 00:00:00', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"https://path_to_file\\",\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"66249B43-8C2B-5EE7-AE78-B382306621C6\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-01-01 00:00:00\\"\\n}","type":"json"}]', ], 'PreviewDocument' => [ 'summary' => '获取文档预览', 'path' => '/{workspaceId}/api/library/document/preview', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'title' => '业务空间', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', ], ], [ 'name' => 'documentId', 'in' => 'query', 'schema' => [ 'title' => '文档id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '8326472354762354', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode', 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', ], 'data' => [ 'title' => '返回数据', 'description' => '', 'type' => 'object', 'properties' => [ 'previewType' => [ 'title' => '预览类型', 'description' => '', 'type' => 'string', 'example' => 'pdf', ], 'title' => [ 'title' => '文档标题', 'description' => '', 'type' => 'string', 'example' => 'test', ], 'uploadTime' => [ 'title' => '上传时间', 'description' => '', 'type' => 'string', 'example' => '2024-01-01 00:00:00', ], 'url' => [ 'title' => '文档url', 'description' => '', 'type' => 'string', 'example' => 'https://agi.alicdn.com/user/d0o/d3c1f50d-a6c2-49b3-b0c8-3e613c3f20ee_16872_3236784461.png', ], ], ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'requestId' => [ 'title' => '请求ID', 'description' => '', 'type' => 'string', 'example' => 'ff551395-1c8a-4f30-8ffd-ef7e87c70b4c', ], 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'time' => [ 'title' => '时间', 'description' => '', 'type' => 'string', 'example' => '2024-04-24 11:54:34', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"previewType\\": \\"pdf\\",\\n \\"title\\": \\"test\\",\\n \\"uploadTime\\": \\"2024-01-01 00:00:00\\",\\n \\"url\\": \\"https://agi.alicdn.com/user/d0o/d3c1f50d-a6c2-49b3-b0c8-3e613c3f20ee_16872_3236784461.png\\"\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"ff551395-1c8a-4f30-8ffd-ef7e87c70b4c\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', ], 'GetFilterDocumentList' => [ 'summary' => '带条件的分页查询文档库的文档列表', 'path' => '/{workspaceId}/api/library/filterDocument', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'and' => [ 'title' => 'and表达式，用于筛选文档/文档块', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'boost' => [ 'description' => '', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1', ], 'key' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'company', ], 'operator' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'eq', ], 'value' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'alibaba', ], ], 'required' => false, ], 'required' => false, ], 'docIdList' => [ 'title' => '文档id列表，用于筛选文档/文档块', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '3553835752369972270', ], 'required' => false, ], 'libraryId' => [ 'title' => '文档库id用于筛选文档/文档块', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'cjshcxxxx', ], 'or' => [ 'title' => 'or表达式，用于筛选文档/文档块', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'boost' => [ 'description' => '', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1', ], 'key' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'company', ], 'operator' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'contains', ], 'value' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'alibaba', ], ], 'required' => false, ], 'required' => false, ], 'page' => [ 'title' => '页码，用于分页', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'pageSize' => [ 'title' => '每页大小，用于分页', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], 'status' => [ 'title' => '文档状态，用于筛选文档', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Completed', ], 'required' => false, 'enumValueTitles' => [ 'InQueue' => 'InQueue', 'WaitRefresh' => 'WaitRefresh', 'FetchingData' => 'FetchingData', 'Completed' => 'Completed', 'Error' => 'Error', 'Embedding' => 'Embedding', ], ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode>', 'description' => '', 'type' => 'object', 'properties' => [ 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', ], 'data' => [ 'title' => '响应数据', 'description' => '', 'type' => 'object', 'properties' => [ 'currentPage' => [ 'title' => '当前页', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'pageSize' => [ 'title' => '每页记录数', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'records' => [ 'title' => '记录', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'docId' => [ 'title' => '文档id', 'description' => '', 'type' => 'string', 'example' => '29368126816', ], 'documentMeta' => [ 'title' => '文档元数据', 'description' => '', 'type' => 'object', 'example' => '{"a": "1"}', ], 'fileType' => [ 'title' => '文档类型', 'description' => '', 'type' => 'string', 'example' => 'pdf', ], 'gmtCreate' => [ 'title' => '创建时间', 'description' => '', 'type' => 'string', 'example' => '2024-01-01 00:00:00', ], 'gmtModified' => [ 'title' => '修改时间', 'description' => '', 'type' => 'string', 'example' => '2024-01-01 00:00:00', ], 'libraryId' => [ 'title' => '文档所属库id', 'description' => '', 'type' => 'string', 'example' => 'sdfgsjdfg', ], 'statusCode' => [ 'title' => '文档状态 (WaitRefresh: 等待刷新, InQueue: 待处理, FetchingData: 数据获取中, Embedding: 文档处理中, Error: 错误, Completed: 可用, Null: 未知)', 'description' => '', 'type' => 'string', 'example' => 'WaitRefresh', ], 'title' => [ 'title' => '文档标题', 'description' => '', 'type' => 'string', 'example' => '', ], 'url' => [ 'title' => '文档链接', 'description' => '', 'type' => 'string', 'example' => 'null', ], ], ], ], 'totalPages' => [ 'title' => '总页数', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'totalRecords' => [ 'title' => '总记录数', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], ], ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '7ADF010C-FD89-569D-A079-2D4D5247E943', ], 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'time' => [ 'title' => '时间戳', 'description' => '', 'type' => 'string', 'example' => '2024-01-01 00:00:00', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"currentPage\\": 1,\\n \\"pageSize\\": 10,\\n \\"records\\": [\\n {\\n \\"docId\\": \\"29368126816\\",\\n \\"documentMeta\\": {\\n \\"a\\": \\"1\\"\\n },\\n \\"fileType\\": \\"pdf\\",\\n \\"gmtCreate\\": \\"2024-01-01 00:00:00\\",\\n \\"gmtModified\\": \\"2024-01-01 00:00:00\\",\\n \\"libraryId\\": \\"sdfgsjdfg\\",\\n \\"statusCode\\": \\"WaitRefresh\\",\\n \\"title\\": \\"公司文档\\",\\n \\"url\\": \\"null\\"\\n }\\n ],\\n \\"totalPages\\": 10,\\n \\"totalRecords\\": 100\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"7ADF010C-FD89-569D-A079-2D4D5247E943\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-01-01 00:00:00\\"\\n}","type":"json"}]', ], 'GetDocumentList' => [ 'summary' => '分页查询文档库的文档列表', 'path' => '/{workspaceId}/api/library/listDocument', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx', ], ], [ 'name' => 'page', 'in' => 'query', 'schema' => [ 'title' => '页码', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'title' => '页数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10', ], ], [ 'name' => 'status', 'in' => 'query', 'schema' => [ 'title' => '文档状态', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], [ 'name' => 'libraryId', 'in' => 'query', 'schema' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '3akzl28vap', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode>', 'description' => '', 'type' => 'object', 'properties' => [ 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', ], 'data' => [ 'title' => '响应数据', 'description' => '', 'type' => 'object', 'properties' => [ 'currentPage' => [ 'title' => '当前页', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'pageSize' => [ 'title' => '每页记录数', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'records' => [ 'title' => '记录', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'docId' => [ 'title' => '文档id', 'description' => '', 'type' => 'string', 'example' => '8326748346', ], 'documentMeta' => [ 'title' => '文档元数据', 'description' => '', 'type' => 'object', ], 'fileType' => [ 'title' => '文档类型', 'description' => '', 'type' => 'string', 'example' => 'pdf', ], 'gmtCreate' => [ 'title' => '创建时间', 'description' => '', 'type' => 'string', 'example' => '2024-01-01 00:00:00', ], 'gmtModified' => [ 'title' => '修改时间', 'description' => '', 'type' => 'string', 'example' => '2024-01-01 00:00:00', ], 'libraryId' => [ 'title' => '文档所属库id', 'description' => '', 'type' => 'string', 'example' => 'skjdhshbv', ], 'statusCode' => [ 'title' => '文档状态 (WaitRefresh: 等待刷新, InQueue: 待处理, FetchingData: 数据获取中, Embedding: 文档处理中, Error: 错误, Completed: 可用, Null: 未知)', 'description' => '', 'type' => 'string', 'example' => 'WaitRefresh', ], 'title' => [ 'title' => '文档标题', 'description' => '', 'type' => 'string', 'example' => 'test', ], 'url' => [ 'title' => '文档链接', 'description' => '', 'type' => 'string', 'example' => 'null', ], ], ], ], 'totalPages' => [ 'title' => '总页数', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'totalRecords' => [ 'title' => '总记录数', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], ], ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658', ], 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'time' => [ 'title' => '时间戳', 'description' => '', 'type' => 'string', 'example' => '2024-04-24 11:54:34', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"currentPage\\": 1,\\n \\"pageSize\\": 10,\\n \\"records\\": [\\n {\\n \\"docId\\": \\"8326748346\\",\\n \\"documentMeta\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"fileType\\": \\"pdf\\",\\n \\"gmtCreate\\": \\"2024-01-01 00:00:00\\",\\n \\"gmtModified\\": \\"2024-01-01 00:00:00\\",\\n \\"libraryId\\": \\"skjdhshbv\\",\\n \\"statusCode\\": \\"WaitRefresh\\",\\n \\"title\\": \\"test\\",\\n \\"url\\": \\"null\\"\\n }\\n ],\\n \\"totalPages\\": 10,\\n \\"totalRecords\\": 100\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', ], 'DeleteDocument' => [ 'summary' => '删除文档', 'path' => '/{workspaceId}/api/library/document/delete', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx'."\n", ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'docIds' => [ 'title' => '文档的id列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '1782981430906818562', ], 'required' => true, ], 'libraryId' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '3akzl28vap', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode', 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', ], 'data' => [ 'title' => '响应数据', 'description' => '', 'type' => 'boolean', 'example' => 'True', ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '67C7021A-D268-553D-8C15-A087B9604028', ], 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'time' => [ 'title' => '时间戳', 'description' => '', 'type' => 'string', 'example' => '2024-04-24 11:54:34', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": true,\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"67C7021A-D268-553D-8C15-A087B9604028\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', ], 'UpdateDocument' => [ 'summary' => '更新文档', 'path' => '/{workspaceId}/api/library/document/updateDocument', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'docId' => [ 'title' => '文档id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '123', ], 'libraryId' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'abc123', ], 'meta' => [ 'title' => '文档meta数据', 'description' => '', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "businessId": "12321"'."\n" .' }', ], 'title' => [ 'title' => '文档标题', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode', 'description' => '', 'type' => 'object', 'properties' => [ 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', ], 'data' => [ 'title' => '响应数据', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => 'eb2b6139-ddf1-91a0-a47f-df7617ae9032', ], 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'time' => [ 'title' => '时间戳', 'description' => '', 'type' => 'string', 'example' => '2024-04-24 11:54:34', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"null\\",\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"eb2b6139-ddf1-91a0-a47f-df7617ae9032\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', ], 'CreatePredefinedDocument' => [ 'summary' => '创建预定义文档', 'path' => '/{workspaceId}/api/library/document/createPredefinedDocument', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'title' => '路径参数，业务空间id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'chunks' => [ 'title' => '文档块列表', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'chunkMeta' => [ 'title' => '文档块元信息', 'description' => '', 'type' => 'object', 'required' => false, 'example' => '{"a": "1"}', ], 'chunkOrder' => [ 'title' => '顺序，可以不填', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'chunkText' => [ 'title' => '文档块文本', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '这是一段测试文本', ], 'chunkType' => [ 'title' => '文档块类型', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'text', 'default' => 'text', 'enum' => [ 'text', 'table', 'faq', 'graph', ], ], ], 'required' => false, ], 'required' => false, ], 'libraryId' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'a1b2c3', ], 'metadata' => [ 'title' => '元数据', 'description' => '', 'type' => 'object', 'required' => false, 'example' => '{"a": "1"}', ], 'title' => [ 'title' => '文档标题', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '测试文档', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode', 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', ], 'data' => [ 'title' => '响应数据', 'description' => '', 'type' => 'string', 'example' => '1782981430906818562', ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '0a06dfe617018288881568684e2937', ], 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'time' => [ 'title' => '时间戳', 'description' => '', 'type' => 'string', 'example' => '2024-04-24 11:54:34', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"1782981430906818562\\",\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"0a06dfe617018288881568684e2937\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', ], 'GetDocumentChunkList' => [ 'summary' => '获取文档的chunk列表', 'path' => '/{workspaceId}/api/library/getDocumentChunk', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'chunkIdList' => [ 'title' => '文档块id列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '83648326438746', ], 'required' => false, ], 'docId' => [ 'title' => '文档id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '182364872346', ], 'libraryId' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'dsjgfdjgfxxx', ], 'order' => [ 'title' => '排序方式', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'desc', ], 'orderBy' => [ 'title' => '排序字段', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'gmtCreate', ], 'page' => [ 'title' => '页码', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'pageSize' => [ 'title' => '每页大小', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], 'searchQuery' => [ 'title' => '搜索查询关键词', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode>', 'description' => 'ResultCode>', 'type' => 'object', 'properties' => [ 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', ], 'data' => [ 'title' => '响应数据', 'description' => '', 'type' => 'object', 'properties' => [ 'currentPage' => [ 'title' => '当前页', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'pageSize' => [ 'title' => '每页记录数', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'records' => [ 'title' => '记录', 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'chunkId' => [ 'title' => '文档块id', 'description' => '', 'type' => 'string', 'example' => '28377468263482764', ], 'chunkMeta' => [ 'title' => '文档块元数据', 'description' => '', 'type' => 'object', 'example' => '{"a":"1"}', ], 'chunkOssUrl' => [ 'title' => '文档块oss地址', 'description' => '', 'type' => 'string', 'example' => 'oss-xxxx-hangzhou.com/test.pdf', ], 'chunkText' => [ 'title' => '文档块文本', 'description' => '', 'type' => 'string', 'example' => '', ], 'chunkType' => [ 'title' => '文档块类型', 'description' => '', 'type' => 'string', 'enumValueTitles' => [ 'faq' => 'faq', 'text' => 'text', 'graph' => 'graph', 'table' => 'table', 'structure' => 'structure', ], 'example' => 'text', ], 'docId' => [ 'title' => '文档id', 'description' => '', 'type' => 'string', 'example' => '8947387648356', ], 'fileType' => [ 'title' => '文档类型', 'description' => '', 'type' => 'string', 'example' => 'pdf', ], 'libraryId' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'example' => 'jhsdvne', ], 'libraryName' => [ 'title' => '文档库名称', 'description' => '', 'type' => 'string', 'example' => '', ], 'nextChunkId' => [ 'title' => '后一个文档块id', 'description' => '', 'type' => 'string', 'example' => '947538465', ], 'pos' => [ 'title' => '文档块位置', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'axisArray' => [ 'title' => '坐标', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'number', 'format' => 'double', 'example' => '394.3', ], ], 'page' => [ 'title' => '页码', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'textHighlightArea' => [ 'title' => '文本高亮区域，用于文本类型的文件高亮', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '38', ], ], ], ], ], 'preChunkId' => [ 'title' => '前一个文档块id', 'description' => '', 'type' => 'string', 'example' => '9848346548365', ], 'score' => [ 'title' => '文档块分数', 'description' => '', 'type' => 'number', 'format' => 'float', 'example' => '0.5', ], 'title' => [ 'title' => '文档标题', 'description' => '', 'type' => 'string', 'example' => 'test', ], ], ], ], 'totalPages' => [ 'title' => '总页数', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'totalRecords' => [ 'title' => '总记录数', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], ], ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '2B8F6DC9-6FAF-576F-9095-CCD90FB2BDDF', ], 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'time' => [ 'title' => '时间戳', 'description' => '', 'type' => 'string', 'example' => '2024-04-24 11:54:34', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"currentPage\\": 1,\\n \\"pageSize\\": 10,\\n \\"records\\": [\\n {\\n \\"chunkId\\": \\"28377468263482764\\",\\n \\"chunkMeta\\": {\\n \\"a\\": \\"1\\"\\n },\\n \\"chunkOssUrl\\": \\"oss-xxxx-hangzhou.com/test.pdf\\",\\n \\"chunkText\\": \\"这是一段测试文本\\",\\n \\"chunkType\\": \\"text\\",\\n \\"docId\\": \\"8947387648356\\",\\n \\"fileType\\": \\"pdf\\",\\n \\"libraryId\\": \\"jhsdvne\\",\\n \\"libraryName\\": \\"测试文档库\\",\\n \\"nextChunkId\\": \\"947538465\\",\\n \\"pos\\": [\\n {\\n \\"axisArray\\": [\\n 394.3\\n ],\\n \\"page\\": 1,\\n \\"textHighlightArea\\": [\\n 38\\n ]\\n }\\n ],\\n \\"preChunkId\\": \\"9848346548365\\",\\n \\"score\\": 0.5,\\n \\"title\\": \\"test\\"\\n }\\n ],\\n \\"totalPages\\": 10,\\n \\"totalRecords\\": 100\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"2B8F6DC9-6FAF-576F-9095-CCD90FB2BDDF\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', ], 'RecallDocument' => [ 'summary' => '文档召回。', 'path' => '/{workspaceId}/api/library/recallDocument', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'filters' => [ 'title' => '元信息过滤条件', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'and' => [ 'title' => 'and表达式，用于筛选文档/文档块', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'boost' => [ 'description' => '', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '20', ], 'key' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'docType', ], 'operator' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'contains', ], 'value' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], 'required' => false, ], 'required' => false, ], 'chunkType' => [ 'title' => '文档块类型 用于筛选文档块 (Text: *, Graph, Table, FAQ)', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Text', ], 'docIdList' => [ 'title' => '文档id列表，用于筛选文档/文档块', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '8372458573692819933', ], 'required' => false, ], 'libraryId' => [ 'title' => '文档库id用于筛选文档/文档块', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'sdbjhvs', ], 'or' => [ 'title' => 'or表达式，用于筛选文档/文档块', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'boost' => [ 'description' => '', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '30', ], 'key' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'researcher', ], 'operator' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'eq', ], 'value' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'zhangsan', ], ], 'required' => false, ], 'required' => false, ], 'status' => [ 'title' => '文档状态，用于筛选文档', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'WaitRefresh', ], 'required' => false, ], ], 'required' => false, ], 'required' => false, ], 'query' => [ 'title' => '文本', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], 'rearrangement' => [ 'title' => '是否开启父子文档块召回', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'topK' => [ 'title' => '为召回文档块的数量', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode', 'description' => '', 'type' => 'object', 'properties' => [ 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'data' => [ 'title' => '响应数据', 'description' => '', 'type' => 'object', 'properties' => [ 'chunkList' => [ 'title' => 'chunk列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => 'chunk', 'type' => 'object', 'properties' => [ 'chunkId' => [ 'title' => '文档块id', 'description' => '', 'type' => 'string', 'example' => '823746762354', ], 'chunkMeta' => [ 'title' => '文档块元数据', 'description' => '', 'type' => 'object', 'example' => '{"a":"1"}', ], 'chunkOssUrl' => [ 'title' => '文档块oss地址', 'description' => '', 'type' => 'string', 'example' => 'http://oss-xxx-hangzhou.com/xxx', ], 'chunkText' => [ 'title' => '文档块文本', 'description' => '', 'type' => 'string', 'example' => '', ], 'chunkType' => [ 'title' => '文档块类型', 'description' => '', 'type' => 'string', 'example' => 'text', ], 'docId' => [ 'title' => '文档id', 'description' => '', 'type' => 'string', 'example' => '839468263472', ], 'fileType' => [ 'title' => '文档类型', 'description' => '', 'type' => 'string', 'example' => 'pdf', ], 'libraryId' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'example' => 'dscsbdsk', ], 'libraryName' => [ 'title' => '文档库名称', 'description' => '', 'type' => 'string', 'example' => '', ], 'nextChunkId' => [ 'title' => '后一个文档块id', 'description' => '', 'type' => 'string', 'example' => '982374872364', ], 'pos' => [ 'title' => '文档块位置', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'axisArray' => [ 'title' => '坐标', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'number', 'format' => 'double', 'example' => '20.8', ], ], 'page' => [ 'title' => '页码', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'textHighlightArea' => [ 'title' => '文本高亮区域，用于文本类型的文件高亮', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'preChunkId' => [ 'title' => '前一个文档块id', 'description' => '', 'type' => 'string', 'example' => '827364827364832', ], 'score' => [ 'title' => '文档块分数', 'description' => '', 'type' => 'number', 'format' => 'float', 'example' => '0.5', ], 'title' => [ 'title' => '文档标题', 'description' => '', 'type' => 'string', 'example' => 'test', ], ], ], ], 'chunkPartList' => [ 'title' => 'chunk part（版面识别结果）列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'chunkId' => [ 'title' => '文档块id', 'description' => '', 'type' => 'string', 'example' => '98327482364', ], 'chunkMeta' => [ 'title' => '文档块元数据', 'description' => '', 'type' => 'object', 'example' => '{"a":"1"}', ], 'chunkOssUrl' => [ 'title' => '文档块oss地址', 'description' => '', 'type' => 'string', 'example' => 'http://oss-xxx-hangzhou.com/xxx'."\n", ], 'chunkText' => [ 'title' => '文档块文本', 'description' => '', 'type' => 'string', 'example' => '', ], 'chunkType' => [ 'title' => '文档块类型', 'description' => '', 'type' => 'string', 'example' => 'text', ], 'docId' => [ 'title' => '文档id', 'description' => '', 'type' => 'string', 'example' => '92837482364', ], 'fileType' => [ 'title' => '文档类型', 'description' => '', 'type' => 'string', 'example' => 'pdf', ], 'libraryId' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'example' => 'sjdhgjsd', ], 'libraryName' => [ 'title' => '文档库名称', 'description' => '', 'type' => 'string', 'example' => '', ], 'nextChunkId' => [ 'title' => '后一个文档块id', 'description' => '', 'type' => 'string', 'example' => '2387648263542', ], 'pos' => [ 'title' => '文档块位置', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'axisArray' => [ 'title' => '坐标', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'number', 'format' => 'double', 'example' => '1', ], ], 'page' => [ 'title' => '页码', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'textHighlightArea' => [ 'title' => '文本高亮区域，用于文本类型的文件高亮', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'preChunkId' => [ 'title' => '前一个文档块id', 'description' => '', 'type' => 'string', 'example' => '32874682764', ], 'score' => [ 'title' => '文档块分数', 'description' => '', 'type' => 'number', 'format' => 'float', 'example' => '0.5', ], 'title' => [ 'title' => '文档标题', 'description' => '', 'type' => 'string', 'example' => '', ], ], ], ], 'chunkTextList' => [ 'title' => 'chunk text列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => '', ], ], 'documents' => [ 'title' => '文档列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'docId' => [ 'title' => '文档id', 'description' => '', 'type' => 'string', 'example' => '92837482364', ], 'documentMeta' => [ 'title' => '文档元数据', 'description' => '', 'type' => 'object', 'example' => '{"a":"1"}'."\n", ], 'fileType' => [ 'title' => '文档类型', 'description' => '', 'type' => 'string', 'example' => 'pdf', ], 'gmtCreate' => [ 'title' => '创建时间', 'description' => '', 'type' => 'string', 'example' => '2024-01-01 00:00:00', ], 'libraryId' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'example' => 'sjdhgjsd'."\n", ], 'title' => [ 'title' => '文档标题', 'description' => '', 'type' => 'string', 'example' => 'test', ], 'url' => [ 'title' => '文档链接', 'description' => '', 'type' => 'string', 'example' => 'http://oss-xxx-hangzhou.com/test.pdf', ], ], ], ], 'embeddingElapsedMs' => [ 'title' => '向量计算耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'textChunkList' => [ 'title' => '从文本索引召回的chunk列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'chunkId' => [ 'title' => '文档块id', 'description' => '', 'type' => 'string', 'example' => '32874682364', ], 'chunkMeta' => [ 'title' => '文档块元数据', 'description' => '', 'type' => 'object', 'example' => '{"a":"1"}'."\n", ], 'chunkOssUrl' => [ 'title' => '文档块oss地址', 'description' => '', 'type' => 'string', 'example' => 'http://oss-xxx-hangzhou.com/xxx'."\n", ], 'chunkText' => [ 'title' => '文档块文本', 'description' => '', 'type' => 'string', 'example' => '', ], 'chunkType' => [ 'title' => '文档块类型', 'description' => '', 'type' => 'string', 'example' => 'text', ], 'docId' => [ 'title' => '文档id', 'description' => '', 'type' => 'string', 'example' => '8372467263542', ], 'fileType' => [ 'title' => '文档类型', 'description' => '', 'type' => 'string', 'example' => 'pdf', ], 'libraryId' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'example' => 'djsgfsjd', ], 'libraryName' => [ 'title' => '文档库名称', 'description' => '', 'type' => 'string', 'example' => '', ], 'nextChunkId' => [ 'title' => '后一个文档块id', 'description' => '', 'type' => 'string', 'example' => '23874682432', ], 'pos' => [ 'title' => '文档块位置', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'axisArray' => [ 'title' => '坐标', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'number', 'format' => 'double', 'example' => '10', ], ], 'page' => [ 'title' => '页码', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'textHighlightArea' => [ 'title' => '文本高亮区域，用于文本类型的文件高亮', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'preChunkId' => [ 'title' => '前一个文档块id', 'description' => '', 'type' => 'string', 'example' => '89473868346', ], 'score' => [ 'title' => '文档块分数', 'description' => '', 'type' => 'number', 'format' => 'float', 'example' => '0.5', ], 'title' => [ 'title' => '文档标题', 'description' => '', 'type' => 'string', 'example' => '', ], ], ], ], 'textSearchElapsedMs' => [ 'title' => '文本搜索耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'totalElapsedMs' => [ 'title' => '总耗时 包括向量计算耗时、向量搜索耗时、文本搜索耗时等（取决于召回参数）', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '400', ], 'vectorChunkList' => [ 'title' => '从向量索引召回的chunk列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'chunkId' => [ 'title' => '文档块id', 'description' => '', 'type' => 'string', 'example' => '8723642345276', ], 'chunkMeta' => [ 'title' => '文档块元数据', 'description' => '', 'type' => 'object', 'example' => '{"a":"1"}', ], 'chunkOssUrl' => [ 'title' => '文档块oss地址', 'description' => '', 'type' => 'string', 'example' => 'https://oss-xxxx-hangzhou.com/test.pdf', ], 'chunkText' => [ 'title' => '文档块文本', 'description' => '', 'type' => 'string', 'example' => '', ], 'chunkType' => [ 'title' => '文档块类型', 'description' => '', 'type' => 'string', 'example' => 'text', ], 'docId' => [ 'title' => '文档id', 'description' => '', 'type' => 'string', 'example' => '78326476235675372', ], 'fileType' => [ 'title' => '文档类型', 'description' => '', 'type' => 'string', 'example' => 'pdf', ], 'libraryId' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'example' => 'djsgfsjd', ], 'libraryName' => [ 'title' => '文档库名称', 'description' => '', 'type' => 'string', 'example' => '', ], 'nextChunkId' => [ 'title' => '后一个文档块id', 'description' => '', 'type' => 'string', 'example' => '293846872343', ], 'pos' => [ 'title' => '文档块位置', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'axisArray' => [ 'title' => '坐标', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'number', 'format' => 'double', 'example' => '48.8', ], ], 'page' => [ 'title' => '页码', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'textHighlightArea' => [ 'title' => '文本高亮区域，用于文本类型的文件高亮', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], ], ], 'preChunkId' => [ 'title' => '前一个文档块id', 'description' => '', 'type' => 'string', 'example' => '873647326542', ], 'score' => [ 'title' => '文档块分数', 'description' => '', 'type' => 'number', 'format' => 'float', 'example' => '0.5', ], 'title' => [ 'title' => '文档标题', 'description' => '', 'type' => 'string', 'example' => 'test', ], ], ], ], 'vectorSearchElapsedMs' => [ 'title' => '向量搜索耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], ], ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '0bc13a9517168617617186457e401f', ], 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'time' => [ 'title' => '时间戳', 'description' => '', 'type' => 'string', 'example' => '2024-04-24 11:54:34', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"chunkList\\": [\\n {\\n \\"chunkId\\": \\"823746762354\\",\\n \\"chunkMeta\\": {\\n \\"a\\": \\"1\\"\\n },\\n \\"chunkOssUrl\\": \\"http://oss-xxx-hangzhou.com/xxx\\",\\n \\"chunkText\\": \\"测试文档块\\",\\n \\"chunkType\\": \\"text\\",\\n \\"docId\\": \\"839468263472\\",\\n \\"fileType\\": \\"pdf\\",\\n \\"libraryId\\": \\"dscsbdsk\\",\\n \\"libraryName\\": \\"测试文档库\\",\\n \\"nextChunkId\\": \\"982374872364\\",\\n \\"pos\\": [\\n {\\n \\"axisArray\\": [\\n 20.8\\n ],\\n \\"page\\": 1,\\n \\"textHighlightArea\\": [\\n 1\\n ]\\n }\\n ],\\n \\"preChunkId\\": \\"827364827364832\\",\\n \\"score\\": 0.5,\\n \\"title\\": \\"test\\"\\n }\\n ],\\n \\"chunkPartList\\": [\\n {\\n \\"chunkId\\": \\"98327482364\\",\\n \\"chunkMeta\\": {\\n \\"a\\": \\"1\\"\\n },\\n \\"chunkOssUrl\\": \\"http://oss-xxx-hangzhou.com/xxx\\\\n\\",\\n \\"chunkText\\": \\"测试文档块\\\\n\\",\\n \\"chunkType\\": \\"text\\",\\n \\"docId\\": \\"92837482364\\",\\n \\"fileType\\": \\"pdf\\",\\n \\"libraryId\\": \\"sjdhgjsd\\",\\n \\"libraryName\\": \\"测试文档库\\",\\n \\"nextChunkId\\": \\"2387648263542\\",\\n \\"pos\\": [\\n {\\n \\"axisArray\\": [\\n 1\\n ],\\n \\"page\\": 1,\\n \\"textHighlightArea\\": [\\n 1\\n ]\\n }\\n ],\\n \\"preChunkId\\": \\"32874682764\\",\\n \\"score\\": 0.5,\\n \\"title\\": \\"测试文档标题\\"\\n }\\n ],\\n \\"chunkTextList\\": [\\n \\"这是一段测试文档块\\"\\n ],\\n \\"documents\\": [\\n {\\n \\"docId\\": \\"92837482364\\",\\n \\"documentMeta\\": {\\n \\"a\\": \\"1\\"\\n },\\n \\"fileType\\": \\"pdf\\",\\n \\"gmtCreate\\": \\"2024-01-01 00:00:00\\",\\n \\"libraryId\\": \\"sjdhgjsd\\\\n\\",\\n \\"title\\": \\"test\\",\\n \\"url\\": \\"http://oss-xxx-hangzhou.com/test.pdf\\"\\n }\\n ],\\n \\"embeddingElapsedMs\\": 100,\\n \\"textChunkList\\": [\\n {\\n \\"chunkId\\": \\"32874682364\\",\\n \\"chunkMeta\\": {\\n \\"a\\": \\"1\\"\\n },\\n \\"chunkOssUrl\\": \\"http://oss-xxx-hangzhou.com/xxx\\\\n\\",\\n \\"chunkText\\": \\"这是一段测试文档块\\\\n\\",\\n \\"chunkType\\": \\"text\\",\\n \\"docId\\": \\"8372467263542\\",\\n \\"fileType\\": \\"pdf\\",\\n \\"libraryId\\": \\"djsgfsjd\\",\\n \\"libraryName\\": \\"测试文档库\\",\\n \\"nextChunkId\\": \\"23874682432\\",\\n \\"pos\\": [\\n {\\n \\"axisArray\\": [\\n 10\\n ],\\n \\"page\\": 1,\\n \\"textHighlightArea\\": [\\n 1\\n ]\\n }\\n ],\\n \\"preChunkId\\": \\"89473868346\\",\\n \\"score\\": 0.5,\\n \\"title\\": \\"测试文档标题\\"\\n }\\n ],\\n \\"textSearchElapsedMs\\": 100,\\n \\"totalElapsedMs\\": 400,\\n \\"vectorChunkList\\": [\\n {\\n \\"chunkId\\": \\"8723642345276\\",\\n \\"chunkMeta\\": {\\n \\"a\\": \\"1\\"\\n },\\n \\"chunkOssUrl\\": \\"https://oss-xxxx-hangzhou.com/test.pdf\\",\\n \\"chunkText\\": \\"这是一段测试文本\\",\\n \\"chunkType\\": \\"text\\",\\n \\"docId\\": \\"78326476235675372\\",\\n \\"fileType\\": \\"pdf\\",\\n \\"libraryId\\": \\"djsgfsjd\\",\\n \\"libraryName\\": \\"测试文档库\\",\\n \\"nextChunkId\\": \\"293846872343\\",\\n \\"pos\\": [\\n {\\n \\"axisArray\\": [\\n 48.8\\n ],\\n \\"page\\": 1,\\n \\"textHighlightArea\\": [\\n 10\\n ]\\n }\\n ],\\n \\"preChunkId\\": \\"873647326542\\",\\n \\"score\\": 0.5,\\n \\"title\\": \\"test\\"\\n }\\n ],\\n \\"vectorSearchElapsedMs\\": 100\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"0bc13a9517168617617186457e401f\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', ], 'GetParseResult' => [ 'summary' => '获取解析结果', 'path' => '/{workspaceId}/api/library/document/getParseResult', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'docId' => [ 'title' => '文档id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '873648346573245', ], 'libraryId' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'sjdgdsfg', ], 'useUrlResult' => [ 'type' => 'boolean', 'default' => 'false', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode', 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'time' => [ 'title' => '时间戳', 'description' => '', 'type' => 'string', 'example' => '2024-04-24 11:54:34', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'data' => [ 'title' => '响应数据', 'description' => '', 'type' => 'object', 'properties' => [ 'fileType' => [ 'title' => '文件类型', 'description' => '', 'type' => 'string', 'example' => 'pdf', ], 'providerType' => [ 'title' => '供应商类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => 'b0a202e2-5031-4589-a6d7-39185f0d8d01', ], 'result' => [ 'title' => '解析结果', 'description' => '', 'type' => 'object', 'example' => '{'."\n" .' "Status": "Success",'."\n" .' "Data": {},'."\n" .' "Message": null,'."\n" .' "TaskId": "docmind-20240601-123abc"'."\n" .' }', ], 'status' => [ 'title' => '文档解析状态', 'description' => '', 'type' => 'string', 'example' => 'WaitRefresh', ], 'resultUrl' => [ 'type' => 'string', ], ], ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '0abb793617204049360065953ec6dd', ], 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"success\\": true,\\n \\"dataType\\": \\"null\\",\\n \\"time\\": \\"2024-04-24 11:54:34\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"data\\": {\\n \\"fileType\\": \\"pdf\\",\\n \\"providerType\\": \\"null\\",\\n \\"requestId\\": \\"b0a202e2-5031-4589-a6d7-39185f0d8d01\\",\\n \\"result\\": {\\n \\"Status\\": \\"Success\\",\\n \\"Data\\": {},\\n \\"Message\\": null,\\n \\"TaskId\\": \\"docmind-20240601-123abc\\"\\n },\\n \\"status\\": \\"WaitRefresh\\",\\n \\"resultUrl\\": \\"https://xxx.oss-cn-beijing.aliyuncs.com/library/3mjeoywx7z/1826661605606129665.json\\"\\n },\\n \\"requestId\\": \\"0abb793617204049360065953ec6dd\\",\\n \\"cost\\": 0\\n}","type":"json"}]', ], 'ReIndex' => [ 'summary' => '重新索引', 'path' => '/{workspaceId}/api/library/document/reIndex', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'title' => '业务空间', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', ], ], [ 'name' => 'documentId', 'in' => 'query', 'schema' => [ 'title' => '文档id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '8326472354762354', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode', 'description' => '', 'type' => 'object', 'properties' => [ 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', ], 'data' => [ 'title' => '响应数据', 'description' => '', 'type' => 'string', 'example' => 'True', ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '32FFC91D-0A9F-585A-B84F-8A54C5187035', ], 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'time' => [ 'title' => '时间戳', 'description' => '', 'type' => 'string', 'example' => '2024-04-24 11:54:34', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"True\\",\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"32FFC91D-0A9F-585A-B84F-8A54C5187035\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', ], 'UpdateLibrary' => [ 'summary' => '更新文档库配置', 'path' => '/{workspaceId}/api/library/update', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'description' => [ 'title' => '文档库描述', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], 'indexSetting' => [ 'title' => '文档库索引配置', 'description' => '', 'type' => 'object', 'properties' => [ 'chunkStrategy' => [ 'title' => '分块策略', 'description' => '', 'type' => 'object', 'properties' => [ 'docTreeSplit' => [ 'title' => '版面切分', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'docTreeSplitSize' => [ 'title' => '版面切分大小', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '160', ], 'enhanceGraph' => [ 'title' => '是否增强图片', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'enhanceTable' => [ 'title' => '是否增强表格', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'overlap' => [ 'title' => 'chunk重叠长度', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], 'sentenceSplit' => [ 'title' => '按句子切分', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'sentenceSplitSize' => [ 'title' => '版面切分大小', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '160', ], 'size' => [ 'title' => 'chunk大小', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '256', ], 'split' => [ 'title' => '是否切块', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], 'required' => false, ], 'modelConfig' => [ 'title' => '模型配置', 'description' => '', 'type' => 'object', 'properties' => [ 'temperature' => [ 'title' => '温度', 'description' => '', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.8', ], 'topP' => [ 'title' => 'topP', 'description' => 'topP', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.8', ], ], 'required' => false, ], 'promptRoleStyle' => [ 'title' => 'prompt角色风格', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], 'queryEnhancer' => [ 'title' => 'query增强', 'description' => '', 'type' => 'object', 'properties' => [ 'enableFollowUp' => [ 'title' => '多轮增强', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'enableMultiQuery' => [ 'title' => '是否利用大模型知识拆解问题', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'enableOpenQa' => [ 'title' => '是否利用大模型知识回答问题', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'enableQueryRewrite' => [ 'title' => '是否根据领域知识改写问题', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'enableSession' => [ 'title' => '记录session', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'localKnowledgeId' => [ 'title' => '知识改写使用的文档库id', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'sjdhgfc', ], 'withDocumentReference' => [ 'title' => '是否带文档引用', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], 'required' => false, ], 'recallStrategy' => [ 'title' => '召回策略', 'description' => '', 'type' => 'object', 'properties' => [ 'documentRankType' => [ 'title' => '合并&排序策略', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'model', ], 'limit' => [ 'title' => '两路合并总结的结果数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], 'required' => false, ], 'textIndexSetting' => [ 'title' => '文本索引设置', 'description' => '', 'type' => 'object', 'properties' => [ 'category' => [ 'title' => '文本索引类型', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ElasticSearch', 'pattern' => '^ElasticSearch$', 'default' => 'ElasticSearch', ], 'enable' => [ 'title' => '文本索引是否开启', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'indexAnalyzer' => [ 'title' => '文本索引索引分析器: (Standard: *, IkMaxWord, Whitespace, IkSmart)', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Standard', ], 'rankThreshold' => [ 'title' => '文本索引排序阈值', 'description' => '', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.5', ], 'searchAnalyzer' => [ 'title' => '文本索引搜索分析器: (Standard: *, IkMaxWord, Whitespace, IkSmart)', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Standard', ], 'topK' => [ 'title' => '文本索引最后总结结果数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', ], ], 'required' => false, ], 'vectorIndexSetting' => [ 'title' => '向量索引设置', 'description' => '', 'type' => 'object', 'properties' => [ 'category' => [ 'title' => '向量索引来源：建议填写 ADB', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ADB', 'pattern' => '^ADB$', 'default' => 'ADB', ], 'embeddingType' => [ 'title' => '向量索引文本Embedding模型', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'DashScope', ], 'enable' => [ 'title' => '是否开启', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'rankThreshold' => [ 'title' => '向量索引排序阈值', 'description' => '', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.5', ], 'topK' => [ 'title' => '向量索引最后总结结果数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], 'required' => false, ], ], 'required' => false, ], 'libraryId' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'dsfbashdbb', ], 'libraryName' => [ 'title' => '文档库名称', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode', 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ 'cost' => [ 'title' => '耗时', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', ], 'data' => [ 'title' => '响应数据', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'dataType' => [ 'title' => '数据类型', 'description' => '', 'type' => 'string', 'example' => 'null', ], 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => 'eb2b6139-ddf1-91a0-a47f-df7617ae9032', ], 'success' => [ 'title' => '是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'time' => [ 'title' => '时间戳', 'description' => '', 'type' => 'string', 'example' => '2024-04-24 11:54:34', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"null\\",\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"eb2b6139-ddf1-91a0-a47f-df7617ae9032\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', ], 'DeleteLibrary' => [ 'summary' => '删除文档库', 'path' => '/{workspaceId}/api/library/delete', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'title' => '业务空间', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', ], ], [ 'name' => 'libraryId', 'in' => 'query', 'schema' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'skdfefxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'errCode' => [ 'title' => '错误码', 'description' => '', 'type' => 'string', 'example' => '0', ], 'message' => [ 'title' => '错误信息', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'requestId' => [ 'title' => '请求id', 'description' => '', 'type' => 'string', 'example' => '30F6AD44-F078-540D-B5A5-1E519C8E9E6D', ], 'success' => [ 'title' => '请求是否成功', 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"30F6AD44-F078-540D-B5A5-1E519C8E9E6D\\",\\n \\"success\\": true\\n}","type":"json"}]', ], 'RunLibraryChatGeneration' => [ 'summary' => '获取生成式对话结果', 'path' => '/{workspaceId}/api/run/library/chat/generation', 'methods' => [ 'post', ], 'schemes' => [ 'https', 'sse', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'docIdList' => [ 'title' => '文档列表', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '1273827636xxx', ], 'required' => false, ], 'enableFollowUp' => [ 'title' => '是否开启多轮增强', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'enableMultiQuery' => [ 'title' => '是否开启query拆分', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'enableOpenQa' => [ 'title' => '是否开启openQA', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'followUpLlm' => [ 'title' => 'query多轮增强使用的llm', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'qwen-max', ], 'libraryId' => [ 'title' => '文档库id', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '3akzl28vap', ], 'llmType' => [ 'title' => '大模型类型', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'qwen-max', ], 'multiQueryLlm' => [ 'title' => 'query拆分使用的llm', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'qwen-max', ], 'query' => [ 'title' => '用户输入的query', 'description' => '', 'type' => 'string', 'required' => true, 'example' => '', ], 'queryCriteria' => [ 'title' => '属性过滤器', 'description' => '', 'type' => 'object', 'properties' => [ 'and' => [ 'title' => 'and表达式，用于筛选文档/文档块', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'boost' => [ 'title' => '标签的权重', 'description' => '', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.5', ], 'key' => [ 'title' => '标签的key', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'city', ], 'operator' => [ 'title' => '标签的操作符：文档库元信息key存储的value和您输入的value之间的关系', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'eq', ], 'value' => [ 'title' => '标签的值', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], 'required' => false, ], 'required' => false, ], 'or' => [ 'title' => 'or表达式，用于筛选文档/文档块', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'boost' => [ 'title' => '标签的权重', 'description' => '', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.5', ], 'key' => [ 'title' => '标签的key', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'city', ], 'operator' => [ 'title' => '标签的操作符：文档库元信息key存储的value和您输入的value之间的关系', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'eq', ], 'value' => [ 'title' => '标签的值', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'rerankType' => [ 'title' => '排序策略类型：linear/model (linear: 基于规则排序, model: 模型排序, llm)', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'linear', ], 'sessionId' => [ 'title' => 'sessionId', 'description' => 'sessionId', 'type' => 'string', 'required' => false, 'example' => 'null', ], 'stream' => [ 'title' => '流式/非流式', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], 'subQueryList' => [ 'title' => '子查询query', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '', ], 'required' => false, ], 'textSearchParameter' => [ 'title' => '搜索引擎参数--文本搜索参数', 'description' => '', 'type' => 'object', 'properties' => [ 'limit' => [ 'title' => '返回行数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], 'searchAnalyzerType' => [ 'title' => '搜索分词器，根据业务需求灵活配置，如果留空，使用文档库绑定的搜索分词器', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'IkMaxWord', ], ], 'required' => false, ], 'topK' => [ 'title' => '最终召回的语料数量', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'vectorSearchParameter' => [ 'title' => '搜索引擎参数--向量搜索参数', 'description' => '', 'type' => 'object', 'properties' => [ 'limit' => [ 'title' => '返回行数', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], 'required' => false, ], 'withDocumentReference' => [ 'title' => '是否返回文档引用', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'ResultCode