diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/dianjin/2024-06-28 | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/dianjin/2024-06-28')
| -rw-r--r-- | data/en_us/dianjin/2024-06-28/api-docs.php | 17161 |
1 files changed, 6645 insertions, 10516 deletions
diff --git a/data/en_us/dianjin/2024-06-28/api-docs.php b/data/en_us/dianjin/2024-06-28/api-docs.php index d0edef9..798629f 100644 --- a/data/en_us/dianjin/2024-06-28/api-docs.php +++ b/data/en_us/dianjin/2024-06-28/api-docs.php @@ -1,801 +1,820 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'DianJin', - 'version' => '2024-06-28', - ], + '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', + 'UpdateDocumentChunk', 'GetAppConfig', 'CreateLibrary', 'GetLibraryList', 'GetLibrary', 'UploadDocument', 'GetDocumentUrl', 'PreviewDocument', 'GetFilterDocumentList', 'GetDocumentList', 'DeleteDocument', 'UpdateDocument', 'CreatePredefinedDocument', 'GetDocumentChunkList', 'RecallDocument', 'GetParseResult', 'ReIndex', 'UpdateLibrary', 'DeleteLibrary', 'RunLibraryChatGeneration', + 'GetHistoryListByBizType', 'InvokePlugin', ], + 'type' => 'directory', + 'title' => 'Platform capabilities - document library', ], [ - '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', + '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', ], + 'type' => 'directory', + 'title' => 'Platform capabilities - applications', ], [ - 'id' => 361341, - 'title' => null, + 'children' => ['DashscopeAsyncTaskFinishEvent'], 'type' => 'directory', - 'children' => [ - 'DashscopeAsyncTaskFinishEvent', - ], + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'UpdateDocumentChunk' => [ - 'summary' => '更新文档的chunk', - 'path' => '/{workspaceId}/api/library/updateDocumentChunk', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'CreateAnnualDocSummaryTask' => [ + 'summary' => 'Create a task to summarize documents by year.', + 'path' => '/{workspaceId}/api/task/summary/doc/annual', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body', 'type' => 'object', 'properties' => [ - 'libraryId' => [ - 'title' => '文档库ID', - 'description' => '', - 'type' => 'string', + 'anaYears' => [ + 'title' => '', + 'description' => 'List of years to analyze', + 'type' => 'array', + 'items' => ['description' => 'Year to analyze', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2023', 'title' => ''], 'required' => true, - 'example' => 'sjdgdsfg', + 'example' => '', ], - 'chunks' => [ - 'title' => '文档块列表', - 'description' => '', + 'docInfos' => [ + 'title' => '', + 'description' => 'List of document information', 'type' => 'array', 'items' => [ - 'title' => '文档块', - 'description' => '', + 'description' => 'Document information', 'type' => 'object', 'properties' => [ - 'chunkId' => [ - 'title' => '文档块ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1987834755763847', - ], - 'chunkText' => [ - 'title' => '文档块文本', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'docId' => ['description' => 'Document ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '198386463432'], + 'docYear' => ['description' => 'Document year', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '2023'], + 'endPage' => ['description' => 'End page number', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '2'], + 'libraryId' => ['description' => 'Document library ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rdxrmo6amk'], + 'startPage' => ['description' => 'Start page number', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, + 'example' => '', ], + 'enableTable' => ['description' => 'Enable table extraction. Default is true.', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'title' => '', 'example' => 'true'], + 'instruction' => ['description' => 'Instruction', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '你是资深的证券研究员,对xx年上市公司进行业绩分析。根据参考信息从如下方面详细分析:'."\n" + .'1. 整体业绩变化情况,包括营收,利润等详细指标变化情况'."\n" + .'2. 业绩变化情况具体原因,包括各个业务变化情况'."\n" + .'严格只输出xx年情况。'], + 'modelId' => ['description' => 'Model ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'qwen-plus'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<ResultCodeEnum>', - 'description' => 'ResultCode<ResultCodeEnum>', + 'title' => 'ResultCode<String>', + 'description' => 'ResultCode\\<string>', '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', - ], + 'cost' => ['description' => 'Processing time in milliseconds', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => ['description' => 'Response data. This is the task ID.', 'type' => 'string', 'title' => '', 'example' => '3284627354'], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '32FFC91D-0A9F-585A-B84F-8A54C5187035'], + 'success' => ['description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"3284627354\\",\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"32FFC91D-0A9F-585A-B84F-8A54C5187035\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-01-01 00:00:00\\"\\n}","type":"json"}]', + 'title' => 'Create a document summarization job by year', + 'description' => 'Before you use this operation, review the billing methods and pricing for Alibaba Cloud Tongyi Dianjin.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'You have activated Alibaba Cloud Model Studio and Tongyi Dianjin.'."\n" + ."\n" + .'Obtain your [workspace ID](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAnnualDocSummaryTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreateAnnualDocSummaryTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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', - ], + 'CreateDialog' => [ + 'summary' => 'Creates an outbound call session.', + 'path' => '/{workspaceId}/api/virtualHuman/dialog/create', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx'."\n", + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'playCode' => ['description' => 'The playbook code.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'live_broadcast_qa'], + 'channel' => ['description' => 'The channel.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'taobao'], + 'metaData' => ['description' => 'Other information.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => 'null'], + 'qaLibraryList' => [ + 'title' => '', + 'description' => 'A list of Q\\&A library IDs.', + 'type' => 'array', + 'items' => ['description' => 'The Q\\&A library ID.', 'type' => 'string', 'required' => false, 'example' => 'd86a4b9cd3', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ebf83826-dc1c-46f8-9759-0fb6da4c8xxx'."\n"], + 'enableLibrary' => ['title' => 'Whether to enable the intent library. The default value is false. ', 'description' => 'Specifies whether to enable the intent library.', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'example' => 'false'], + 'selfDirected' => ['title' => 'Whether to enable self-directed Q&A. The default value is false. ', 'description' => 'Specifies whether to enable autonomous Q\\&A.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false'], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<AppConfigBO>', - 'description' => 'ResultCode<AppConfigBO>', + 'title' => 'ResultCode<DiaBaseResult>', + 'description' => 'Result code:', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'dataType' => ['description' => 'The data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'time' => ['description' => 'The timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], 'data' => [ - 'title' => '响应数据', - 'description' => '', + 'title' => '', + 'description' => 'The response data.', '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', + 'sessionId' => ['description' => 'The session ID.', 'type' => 'string', 'title' => '', 'example' => '1728545917713234'], + 'openingRemarks' => ['title' => 'Opening remarks', 'description' => 'The opening remarks.', 'type' => 'string', 'example' => '你好,我是XX客服人员。'], + ], + 'example' => '', + ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '003D019A-1BB3-53EC-A0D2-CE76DA5D73B1'], + 'cost' => ['description' => 'The time consumed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + ], + 'example' => '', + ], + ], + ], + '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\\": {\\n \\"sessionId\\": \\"1728545917713234\\",\\n \\"openingRemarks\\": \\"你好,我是XX客服人员。\\"\\n },\\n \\"requestId\\": \\"003D019A-1BB3-53EC-A0D2-CE76DA5D73B1\\",\\n \\"cost\\": 0\\n}","type":"json"}]', + 'title' => 'Create an outbound call session', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '120', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDialog'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreateDialog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateDialogAnalysisTask' => [ + 'summary' => 'Creates a session analysis task. After the task is created, use the session ID with GetDialogAnalysisResult to retrieve the results.', + 'path' => '/{workspaceId}/api/virtualHuman/dialog/analysis/submit', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'metaData' => ['description' => 'The metadata. This includes business-related properties that are used during session analysis. The business system passes these properties in real time when it initiates the analysis task.'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "labels": "XXX", // Tags'."\n" + .' "summaryConstraints": "XXX", // Summary dimensions'."\n" + .' "sopInfo": "XXX" // SOP information'."\n" + .'}'."\n" + .'```', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" + .'"labels": "XXX",'."\n" + .'"summaryConstraints": "XXX",'."\n" + .'"sopInfo": "XXX"'."\n" + .'}'], + 'playCode' => ['description' => 'The session scenario code, which is associated with the session analysis configuration.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'common'], + 'analysisNodes' => [ + 'title' => '', + 'description' => 'A list of analysis nodes. If you leave this parameter empty, all nodes are analyzed. You can specify one or more nodes.', + 'type' => 'array', + 'items' => [ + 'description' => 'An analysis node.', + 'enumValueTitles' => ['DIALOG_EXECUTION_PLAN' => 'The execution plan.', 'DIALOG_SUMMARY' => 'The session summary.', 'DIALOG_SOP' => 'The session SOP.', 'DIALOG_LABEL' => 'The session tag.'], + 'type' => 'string', + 'required' => false, + 'example' => 'DIALOG_LABEL', + 'title' => '', + ], + 'required' => false, + 'example' => '', + ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '0FC6636E-380A-5369-AE01-D1C15BB9B254'], + 'conversationList' => [ + 'description' => 'The session content. You can specify multiple sessions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The session content.', + 'type' => 'object', + 'properties' => [ + 'dialogueList' => [ + 'description' => 'A list of dialogues.', + 'type' => 'array', + 'items' => [ + 'description' => 'A dialogue.', + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'The content of the dialogue.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '您好,我是2001,很高兴为您服务!'], + 'role' => [ + 'description' => 'The role.', + 'enumValueTitles' => ['Customer', 'Agent'], + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => '1', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], - 'textIndexCategoryList' => [ - 'title' => '文本索引类型列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ElasticSearch', - ], - ], - 'vectorIndexCategoryList' => [ - 'title' => '向量索引类型列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ADB', - ], - ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => true, + 'title' => '', + 'example' => '', ], - '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', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResultCode<List<String>>', + 'description' => 'ResultCode\\<List>', + 'type' => 'object', + 'properties' => [ + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'dataType' => ['description' => 'The data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'time' => ['description' => 'The timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'data' => [ + 'title' => '', + 'description' => 'The response data, which is a list of session IDs.', + 'type' => 'array', + 'items' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '1876540295480209409', 'title' => ''], + 'example' => '', ], - 'success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258'], + 'cost' => ['description' => 'The time consumed by the request.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + ], + 'example' => '', + ], + ], + ], + '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 \\"1876540295480209409\\"\\n ],\\n \\"requestId\\": \\"EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258\\",\\n \\"cost\\": 0\\n}","type":"json"}]', + 'title' => 'Create Conversation Analysis Job ', + 'description' => 'Before you use this API, review the billing methods and pricing for DianJin.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'You have activated Alibaba Cloud Model Studio and DianJin.'."\n" + ."\n" + .'Obtain a workspace ID. For more information, see [Get a workspace ID](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDialogAnalysisTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreateDialogAnalysisTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateDocsSummaryTask' => [ + 'summary' => 'Creates a multi-document summary task.', + 'path' => '/{workspaceId}/api/task/summary/docs', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx'."\n", 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'Request body', + 'type' => 'object', + 'properties' => [ + 'docInfos' => [ + 'title' => '', + 'description' => 'Document information list', + 'type' => 'array', + 'items' => [ + 'description' => 'Document information', + 'type' => 'object', + 'properties' => [ + 'docId' => ['description' => 'Document ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '198386463432'], + 'endPage' => ['description' => 'End page number', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '2'], + 'libraryId' => ['description' => 'Document library ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rdxrmo6amk'], + 'startPage' => ['description' => 'Start page number', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', ], - 'time' => [ - 'title' => '时间戳', - 'description' => '', + 'enableTable' => ['description' => 'Enable table parsing. Default is true.', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'title' => '', 'example' => 'true'], + 'instruction' => ['description' => 'Instruction', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '你是资深的证券研究员,对xx年上市公司进行业绩分析。根据参考信息从如下方面详细分析:'."\n" + .'1. 整体业绩变化情况,包括营收,利润等详细指标变化情况'."\n" + .'2. 业绩变化情况具体原因,包括各个业务变化情况'."\n" + .'严格只输出xx年情况。'], + 'modelId' => ['description' => 'Model ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'qwen-plus'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResultCode<String>', + 'description' => 'ResultCode\\<string>', + 'type' => 'object', + 'properties' => [ + 'cost' => ['description' => 'Processing time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => ['description' => 'Response data. Task ID.', 'type' => 'string', 'title' => '', 'example' => '765675376'], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '32FFC91D-0A9F-585A-B84F-8A54C5187035'], + 'success' => ['description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"765675376\\",\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"32FFC91D-0A9F-585A-B84F-8A54C5187035\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-01-01 00:00:00\\"\\n}","type":"json"}]', + 'title' => 'Create a multi-document summarization job', + 'description' => 'Before you use this API, review the billing methods and pricing for Alibaba Cloud Tongyi Dianjin.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'You have activated Alibaba Cloud Model Studio and Tongyi Dianjin.'."\n" + ."\n" + .'You have obtained a [workspace identifier](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDocsSummaryTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreateDocsSummaryTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateFinReportSummaryTask' => [ + 'summary' => 'Creates a financial report summary.', + 'path' => '/{workspaceId}/api/task/summary', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'Request body parameters', + 'type' => 'object', + 'properties' => [ + 'docId' => ['description' => 'Document ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '123'], + 'enableTable' => ['description' => 'Enable table', 'type' => 'boolean', 'required' => true, 'title' => '', 'example' => 'true'], + 'endPage' => ['description' => 'End page', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], + 'instruction' => ['description' => 'Instruction', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '请帮我总结一下。'], + 'libraryId' => ['description' => 'Document library ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '3akzl28vap'], + 'modelId' => ['description' => 'Model ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'qwen-max'], + 'startPage' => ['description' => 'Start page', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], + 'taskType' => [ + 'description' => 'Task type. Optional. Defaults to finance\\_report. If you set this to custom, provide an instruction.', + 'enumValueTitles' => ['custom' => 'custom', 'finance_report' => 'finance\\_report'], 'type' => 'string', - 'example' => '2024-04-24 11:54:34', + 'title' => '', + 'required' => false, + 'example' => 'custom', ], ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResultCode<String>', + 'description' => 'ResultCode\\<string>', + 'type' => 'object', + 'properties' => [ + 'cost' => ['description' => 'Time taken', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => ['description' => 'Response data, task ID. Use this ID to query the task status and results later.', 'type' => 'string', 'title' => '', 'example' => '3284627354'], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658'], + 'success' => ['description' => 'Success', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], + ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"3284627354\\",\\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"}]', + 'title' => 'Create a Financial Report Summary Job', + 'description' => 'Before using this API, review the pricing and billing methods for Alibaba Cloud Gold products.'."\n" + ."\n" + .'**Prerequisites**'."\n" + ."\n" + .'- Enable Alibaba Cloud Model Studio and Alibaba Cloud Gold services.'."\n" + ."\n" + .'- Obtain the workspace ID. For more information, see [workspace identity](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFinReportSummaryTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreateFinReportSummaryTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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' => '创建文档库', + 'summary' => 'Creates a document library. A document library isolates document and index data. If your use case requires frequent natural language search by category, create multiple libraries to isolate different data types. You can customize vector and text indexes by format.', 'path' => '/{workspaceId}/api/library/create', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-ik******RVYCKzt', - ], + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-ik******RVYCKzt', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body', 'type' => 'object', 'properties' => [ - 'description' => [ - 'title' => '文档库的描述', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'description' => ['description' => 'Document library description', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '描述文档库的具体作用'], 'indexSetting' => [ - 'title' => '文档库的索引设置', - 'description' => '', + 'title' => '', + 'description' => 'Index settings for the document library', 'type' => 'object', 'properties' => [ 'chunkStrategy' => [ - 'title' => '分段策略', - 'description' => '', + 'title' => '', + 'description' => 'Chunking strategy', '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', - ], + 'docTreeSplit' => ['description' => 'Layout-based chunking', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'docTreeSplitSize' => ['description' => 'Layout-based chunk size', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '300'], + 'enhanceGraph' => ['description' => 'Parse images in documents', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'enhanceTable' => ['description' => 'Parse tables in documents', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'overlap' => ['description' => 'Chunk overlap length', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '20'], + 'sentenceSplit' => ['description' => 'Split by sentence', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'sentenceSplitSize' => ['description' => 'Sentence-based chunk size', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '300'], + 'size' => ['description' => 'Chunk size', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '300'], + 'split' => ['description' => 'Enable chunking', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], ], 'required' => false, + 'example' => '', ], 'modelConfig' => [ - 'title' => '模型配置', - 'description' => '', + 'title' => '', + 'description' => 'Model configuration', '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', - ], + 'temperature' => ['description' => 'Control the randomness and diversity of model responses. Higher values flatten the probability distribution over candidate tokens, increasing diversity. Lower values sharpen the distribution, increasing determinism.'."\n" + ."\n" + .'Valid range: \\[0, 2). Avoid 0.', 'type' => 'number', 'format' => 'double', 'title' => '', 'required' => false, 'example' => '0.8'], + 'topP' => ['title' => 'topP', 'description' => 'Probability threshold for nucleus sampling. For example, with a value of 0.8, only the smallest set of most likely tokens whose cumulative probability is at least 0.8 is used. Higher values increase randomness. Lower values increase determinism.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.8'], ], 'required' => false, - ], - 'promptRoleStyle' => [ - 'title' => 'prompt角色风格', - 'description' => '', - 'type' => 'string', - 'required' => false, 'example' => '', ], + 'promptRoleStyle' => ['description' => 'Prompt role style. Specify a role and tone to guide response quality. Examples: Document analysis expert, friendly customer service agent, professional financial analyst.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '你是一位信息处理专家,耐心、友好、逻辑清晰。'], 'queryEnhancer' => [ - 'title' => 'query增强配置', - 'description' => '', + 'title' => '', + 'description' => 'Query enhancement configuration', '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', - ], + 'enableFollowUp' => ['description' => 'Rewrite queries using history', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'enableMultiQuery' => ['description' => 'Use Large Language Models (LLMs) to decompose queries', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'enableOpenQa' => ['description' => 'Use LLMs to answer queries', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'enableQueryRewrite' => ['description' => 'Enable query rewriting', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'enableSession' => ['description' => 'Enable multi-turn conversations', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'localKnowledgeId' => ['description' => 'Document library ID for knowledge rewriting', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxxx'], + 'withDocumentReference' => ['description' => 'Include document references in responses', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], ], 'required' => false, + 'example' => '', ], 'recallStrategy' => [ - 'title' => '召回策略', - 'description' => '', + 'title' => '', + 'description' => 'Retrieval strategy', 'type' => 'object', 'properties' => [ 'documentRankType' => [ - 'title' => '合并&排序策略', - 'description' => '', + 'description' => 'Merge and sort policy', + 'enumValueTitles' => ['linear' => 'linear', 'model' => 'Model'], 'type' => 'string', + 'title' => '', 'required' => false, - 'enumValueTitles' => [ - 'linear' => 'linear', - 'model' => 'model', - ], 'example' => 'model', ], - 'limit' => [ - 'title' => '两路合并总结的结果数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'limit' => ['description' => 'Number of results from two-way merge and summarization', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '20'], ], 'required' => false, + 'example' => '', ], 'textIndexSetting' => [ - 'title' => '文本索引配置', - 'description' => '', + 'title' => '', + 'description' => 'Text index configuration', 'type' => 'object', 'properties' => [ 'category' => [ - 'title' => '文本索引类型', - 'description' => '', + 'description' => 'Text index type. Only ElasticSearch is supported.', + 'enumValueTitles' => ['ElasticSearch' => 'Elasticsearch'], 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ElasticSearch' => 'ElasticSearch', - ], 'example' => 'ElasticSearch', 'pattern' => '^ElasticSearch$', 'default' => 'ElasticSearch', + 'title' => '', + 'required' => false, ], 'enable' => [ - 'title' => '文本索引是否开启', - 'description' => '', + 'description' => 'Enable text indexing', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', + 'title' => '', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], 'example' => 'true', ], 'indexAnalyzer' => [ 'title' => 'Standard: *, IkMaxWord, Whitespace, IkSmart', - 'description' => '', + 'description' => 'Text index analyzer: Standard, IkMaxWord, or IkSmart', + 'enumValueTitles' => ['IkSmart' => 'ik-smart', 'IkMaxWord' => 'IkMaxWord', 'Standard' => 'Standard'], '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', - ], + 'rankThreshold' => ['description' => 'Text index ranking threshold', 'type' => 'number', 'format' => 'double', 'title' => '', 'required' => false, 'example' => '0.5'], 'searchAnalyzer' => [ 'title' => 'Standard: *, IkMaxWord, Whitespace, IkSmart', - 'description' => '', + 'description' => 'Text index search analyzer: Standard, IkMaxWord, or IkSmart', + 'enumValueTitles' => ['IkSmart' => 'IkSmart', 'IkMaxWord' => 'IkMaxWord', 'Standard' => 'Standard'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'IkSmart' => 'IkSmart', - 'IkMaxWord' => 'IkMaxWord', - 'Standard' => 'Standard', - ], 'example' => 'Standard', ], - 'topK' => [ - 'title' => '文本索引最后总结结果数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + 'topK' => ['description' => 'Number of final text index results', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '50'], ], 'required' => false, + 'example' => '', ], 'vectorIndexSetting' => [ - 'title' => '向量索引设置', - 'description' => '', + 'title' => '', + 'description' => 'Vector index settings', 'type' => 'object', 'properties' => [ 'category' => [ - 'title' => '向量索引来源:建议填写 ADB', - 'description' => '', + 'description' => 'Vector index source. Only ADB is supported.', + 'enumValueTitles' => ['ADB' => 'ADB'], 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ADB' => 'ADB', - ], 'example' => 'ADB', 'pattern' => '^ADB$', 'default' => 'ADB', + 'title' => '', + 'required' => false, ], 'embeddingType' => [ - 'title' => '向量索引文本Embedding模型', - 'description' => '', + 'description' => 'Text embedding type for vector indexing', + 'enumValueTitles' => ['DashScope' => 'DashScope'], 'type' => 'string', + 'title' => '', 'required' => false, - 'enumValueTitles' => [ - 'DashScope' => 'DashScope', - ], 'example' => 'DashScope', ], 'enable' => [ - 'title' => '是否开启', - 'description' => '', + 'description' => 'Enable vector indexing', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', + 'title' => '', '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', - ], + 'rankThreshold' => ['description' => 'Vector index ranking threshold', 'type' => 'number', 'format' => 'double', 'title' => '', 'required' => false, 'example' => '0.5'], + 'topK' => ['description' => 'Number of final vector index results', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '50'], ], 'required' => false, + 'example' => '', ], ], 'required' => false, - ], - 'libraryName' => [ - 'title' => '文档库的名称', - 'description' => '', - 'type' => 'string', - 'required' => true, 'example' => '', ], + 'libraryName' => ['description' => 'Document library name', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '金融知识文档库'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -803,136 +822,205 @@ 200 => [ 'schema' => [ 'title' => 'ResultCode<String>', - 'description' => 'ResultCode<String>', + 'description' => 'ResultCode\\<string>', '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', - ], + 'cost' => ['description' => 'Processing time in milliseconds', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '300'], + 'data' => ['description' => 'Response data', 'type' => 'string', 'title' => '', 'example' => 'a1b2c3'], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => '成功'], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => 'xxxx-xxxx-xxxx-xxxx'], + 'success' => ['description' => 'Operation success status', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => 'null'], ], + 'example' => '', ], ], ], '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', + 'title' => 'Create a document library', + 'description' => '**Prerequisites**'."\n" + ."\n" + .'- You have activated Alibaba Cloud Model Studio and Tongyi Dianjin.'."\n" + ."\n" + .'- Obtain the workspace ID: Retrieve the [workspace identifier](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLibrary'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreateLibrary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreatePdfTranslateTask' => [ + 'summary' => 'Create a PDF document translation task. Submit the task to start asynchronous translation.', + 'path' => '/{workspaceId}/api/task/pdfTranslate', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-ik******RVYCKzt', 'title' => ''], ], [ - 'name' => 'page', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Request body', + 'type' => 'object', + 'properties' => [ + 'docId' => ['description' => 'Document ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '873648346573245'], + 'knowledge' => ['description' => 'Domain knowledge used as reference during translation', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '净利润 (Net Profit)'."\n" + .'英文:Net Profit'."\n" + .'中文:净利润(通常指扣除所有费用和税后的利润)'], + 'libraryId' => ['description' => 'Document library ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cjshcxxxx'], + 'modelId' => ['description' => 'Model ID', 'type' => 'string', 'required' => true, 'example' => 'qwen-plus', 'title' => ''], + 'translateTo' => ['description' => 'Target language. Default is Chinese', 'type' => 'string', 'example' => '中文', 'default' => '中文', 'title' => '', 'required' => false], + ], 'required' => false, - 'example' => '1', - 'default' => '1', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'pageSize', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '每页记录的数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '10', + 'title' => 'ResultCode<String>', + 'description' => 'ResultCode\\<string>', + 'type' => 'object', + 'properties' => [ + 'cost' => ['description' => 'Response time in milliseconds', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => ['description' => 'Response data. Returns the task ID. Use this ID to query the task status and result.', 'type' => 'string', 'title' => '', 'example' => '3284627354'], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658'], + 'success' => ['description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"3284627354\\",\\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"}]', + 'title' => 'Create a PDF Document Translation Job', + 'description' => 'Before you use this operation, review the billing methods and pricing for Alibaba Cloud Tongyi Dianjin.'."\n" + ."\n" + .'**Prerequisites**'."\n" + ."\n" + .'- You have activated Alibaba Cloud Model Studio and Tongyi Dianjin.'."\n" + ."\n" + .'- You have obtained a workspace ID. To obtain your [workspace ID](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePdfTranslateTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreatePdfTranslateTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'CreatePredefinedDocument' => [ + 'summary' => 'Creates document chunks based on your business scenarios.', + 'path' => '/{workspaceId}/api/library/document/createPredefinedDocument', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'query', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '搜索的关键词,支持文档库名称和描述', - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'chunks' => [ + 'title' => '', + 'description' => 'A list of document chunks.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'chunkMeta' => ['description' => 'The metadata for the document chunk.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{"a": "1"}'], + 'chunkOrder' => ['description' => 'The order of the chunk. This parameter is optional.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], + 'chunkText' => ['description' => 'The text content of the document chunk.', 'type' => 'string', 'example' => '这是一段测试文本', 'title' => '', 'required' => false], + 'chunkType' => [ + 'description' => 'The type of the document chunk.', + 'type' => 'string', + 'example' => 'text', + 'default' => 'text', + 'enum' => ['text', 'table', 'faq', 'graph'], + 'title' => '', + 'required' => false, + ], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'libraryId' => ['description' => 'The ID of the document library.', 'type' => 'string', 'example' => 'a1b2c3', 'title' => '', 'required' => false], + 'metadata' => ['description' => 'The metadata.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{"a": "1"}'], + 'title' => ['description' => 'The title of the document.', 'type' => 'string', 'example' => '测试文档', 'title' => '', 'required' => false], + ], 'required' => false, + 'title' => '', 'example' => '', ], ], @@ -940,6203 +1028,3867 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<PageVO<LibraryVO>>', - 'description' => 'ResultCode<PageVO<LibraryVO>>', + 'title' => 'ResultCode<String>', + 'description' => 'ResultCode\\<string>', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'data' => [ - 'title' => '返回数据', - 'description' => '', + 'cost' => ['description' => 'The time consumed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => ['description' => 'The returned data.', 'type' => 'string', 'title' => '', 'example' => '1782981430906818562'], + 'dataType' => ['description' => 'The data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0a06dfe617018288881568684e2937'], + 'success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'The timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], + ], + 'example' => '', + ], + ], + ], + '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"}]', + 'title' => 'Create a predefined document ', + 'description' => 'Before using this API, review the billing methods and pricing for Tongyi Dianjin.'."\n" + ."\n" + .'**Prerequisites**'."\n" + ."\n" + .'- Activate Alibaba Cloud Model Studio and Tongyi Dianjin.'."\n" + ."\n" + .'- Obtain a workspace ID. For more information, see [Get a workspace identity](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePredefinedDocument'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreatePredefinedDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateQualityCheckTask' => [ + 'summary' => 'Creates a quality check task.', + 'path' => '/{workspaceId}/api/qualitycheck/task/submit', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'conversationList' => [ + 'title' => '', + 'description' => 'The conversation content. If associated with a quality check scenario, pass multiple conversations. Otherwise, pass only one.', 'type' => 'object', 'properties' => [ - 'currentPage' => [ - 'title' => '页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'callType' => [ + 'description' => 'Call type:', + 'enumValueTitles' => [1 => 'Inbound', 'Outbound'], + 'type' => 'string', + 'title' => '', + 'required' => false, 'example' => '1', ], - 'pageSize' => [ - 'title' => '页面记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'records' => [ - 'title' => '记录数', - 'description' => '', + 'customerId' => ['description' => 'The Customer ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'], + 'customerName' => ['description' => 'The customer name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '张三'], + 'customerServiceId' => ['description' => 'The customer service ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxx'], + 'customerServiceName' => ['description' => 'The customer service name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '李四'], + 'dialogueList' => [ + 'title' => '', + 'description' => 'The list of dialogue details.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The dialogue details.', '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' => '', + 'begin' => ['description' => 'The start time of this sentence. This is the offset time in milliseconds from the start of the conversation.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '0'], + 'beginTime' => ['description' => 'The start time of this sentence.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2024-05-23 14:57:50'], + 'content' => ['description' => 'The specific content of the dialogue.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '您好,我是2001,很高兴为您服务!'], + 'customerId' => ['description' => 'The unique identifier of the dialogue role.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2348234'], + 'customerServiceId' => ['description' => 'The customer service ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '23874627346'], + 'customerServiceType' => [ + 'description' => 'Agent type:', + 'enumValueTitles' => ['Robot', 'Human'], 'type' => 'string', - 'example' => '2024-01-01 00:00:00'."\n", + 'title' => '', + 'required' => false, + 'example' => '0', ], - 'id' => [ - 'title' => '文档库id', - 'description' => '', + 'end' => ['description' => 'The end time of this sentence. This is the offset time in milliseconds from the start of the conversation.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '0'], + 'role' => [ + 'description' => 'Role:', + 'enumValueTitles' => ['Customer', 'Agent'], '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', - ], - ], - ], - ], + 'required' => true, + 'title' => '', + 'example' => '1', ], - 'libraryName' => [ - 'title' => '文档库名称', - 'description' => '', + 'type' => [ + 'description' => 'Dialogue content type:', + 'enumValueTitles' => ['IMAGE' => 'Image', 'TEXT' => 'Text', 'AUDIO' => 'Audio'], 'type' => 'string', - 'example' => '', + 'required' => true, + 'title' => '', + 'example' => 'TEXT', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => true, + 'example' => '', ], - 'totalPages' => [ - 'title' => '总页数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'totalRecords' => [ - 'title' => '总记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], + 'gmtService' => ['description' => 'The conversation time.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2024-09-27 11:23:20'], ], + 'required' => true, + 'example' => '', ], - 'dataType' => [ - 'title' => '数据类型', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'errCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => '0', + 'gmtService' => ['description' => 'The business occurrence time. The system uses this to record submission time, make task scheduling priority decisions, and so on.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-09-27 11:23:20'], + 'metaData' => [ + 'title' => '', + 'description' => 'The metadata. These are properties related to business that rules consume during execution. The business system passes these in real-time when initiating a quality check.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The metadata.', 'type' => 'string', 'example' => '{'."\n" + .' "isSpecialArchive": false,'."\n" + .' "hasProcessingWorkOrder": false,'."\n" + .' "primaryArchiveType": "其他",'."\n" + .' "businessType": "预警",'."\n" + .' "workOrderActionType":"业务升级"'."\n" + .' }', 'title' => ''], + 'example' => '', ], - 'message' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'ok', + 'qualityGroup' => [ + 'title' => '', + 'description' => 'The quality check rule group.', + 'type' => 'array', + 'items' => ['description' => 'The quality check rule.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'warning_customers'], + 'required' => false, + 'example' => '', ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '0FC6636E-380A-5369-AE01-D1C15BB9B254'], + 'type' => [ + 'description' => 'Quality check type:', + 'enumValueTitles' => ['Offline text conversation quality check'], 'type' => 'string', - 'example' => '0a06dfe817156528535968405edce3', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'required' => true, + 'title' => '', + 'example' => '0', ], - 'time' => [ - 'title' => '时间戳', - 'description' => '', - 'type' => 'string', - 'example' => '2024-01-01 00:00:00', + 'sceneCode' => ['title' => 'Scene code, similar to playCode. ', 'description' => 'The scenario code.', 'type' => 'string', 'required' => false, 'example' => 'o9c8u8'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResultCode<QualitySubmitResponse>', + 'description' => 'ResultCode', + 'type' => 'object', + 'properties' => [ + 'cost' => ['description' => 'The time consumed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => [ + 'title' => '', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'taskId' => ['title' => 'taskId', 'description' => 'The taskId.', 'type' => 'string', 'example' => '172373500521'], + ], + 'example' => '', ], + 'dataType' => ['description' => 'The data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258'], + 'success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'The timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"taskId\\": \\"172373500521\\"\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', + 'title' => 'Create a quality inspection job ', + 'description' => 'Before using this API, review the pricing and billing methods for the Tongyi Dianjin product.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'Activate Alibaba Cloud Model Studio and Tongyi Dianjin services.'."\n" + ."\n" + .'Obtain the workspaceId: Retrieve the [workspace identity](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [ + ['createdAt' => '2025-12-11T01:42:31.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateQualityCheckTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreateQualityCheckTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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', - ], + 'DashscopeAsyncTaskFinishEvent' => [ + 'summary' => 'A callback event that indicates the completion of a Dashscope asynchronous task.', + 'path' => '/{workspaceId}/event/dashscopeAsyncTaskFinish', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ + 'name' => 'X-Load-Test', + 'in' => 'header', + 'schema' => ['description' => 'Indicates whether the request is part of a stress test', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => ''], + ], + [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'llm-xxxxx', - ], + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx', 'title' => ''], ], [ - 'name' => 'libraryId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '文档库id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cjshcxxxx', + 'title' => '', + 'description' => 'Request body parameters', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'Request body parameters', 'type' => 'any', 'example' => '{}', 'title' => ''], + 'example' => '{}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<LibraryVO>', - 'description' => '', + 'title' => 'WanProdResponse<Void>', + 'description' => 'WanProdResponse\\<void>', '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', - ], + 'code' => ['description' => 'Return code', 'type' => 'string', 'example' => '0', 'title' => ''], + 'message' => ['description' => 'Return message', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'success' => ['description' => 'Indicates whether the operation succeeded', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'retryAble' => ['description' => 'Indicates whether the operation can be retried', 'type' => 'boolean', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"0\\",\\n \\"message\\": \\"成功\\",\\n \\"success\\": false,\\n \\"retryAble\\": false\\n}","type":"json"}]', + 'title' => 'Dashscope asynchronous job completion callback event ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:DashscopeAsyncTaskFinishEvent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteDocument' => [ + 'summary' => 'Deletes a document. After deletion, you cannot view the original document or recall it.', + 'path' => '/{workspaceId}/api/library/document/delete', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + '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', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body parameters.', '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', + 'docIds' => [ + 'title' => '', + 'description' => 'List of document IDs.', + 'type' => 'array', + 'items' => ['description' => 'Document ID.', 'type' => 'string', 'required' => false, 'example' => '1782981430906818562', 'title' => ''], 'required' => true, - 'example' => 'sjdhbcsj', + 'example' => '', ], + 'libraryId' => ['description' => 'Document library ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '3akzl28vap'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<String>', - 'description' => '', + 'title' => 'ResultCode<Boolean>', + 'description' => 'ResultCode\\<boolean>', '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', - ], + 'cost' => ['description' => 'Time consumed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => ['description' => 'Returned data.', 'type' => 'boolean', 'title' => '', 'example' => 'True'], + 'dataType' => ['description' => 'Data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => '67C7021A-D268-553D-8C15-A087B9604028'], + 'success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], ], + 'example' => '', ], ], ], - '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', + '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"}]', + 'title' => 'Delete Document', + 'description' => '**Prerequisites**'."\n" + ."\n" + .'- You have activated Alibaba Cloud Model Studio and Tongyi Dianjin services.'."\n" + ."\n" + .'- Obtain your workspace ID: retrieve your [workspace identifier](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDocument'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:DeleteDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteLibrary' => [ + 'summary' => 'Delete a document library. ⚠️ This operation deletes the library and all its associated documents.', + 'path' => '/{workspaceId}/api/library/delete', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => 'Workspace', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxxxx'], + ], + [ + 'name' => 'libraryId', + 'in' => 'query', + 'schema' => ['description' => 'Document library ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'skdfefxxx'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Response data', + 'type' => 'object', + 'properties' => [ + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '30F6AD44-F078-540D-B5A5-1E519C8E9E6D'], + 'success' => ['description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'title' => '', + 'example' => '', + ], + ], ], - 'produces' => [ - 'application/json', + '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"}]', + 'title' => 'Delete document library', + 'description' => '**Prerequisites**'."\n" + ."\n" + .'- Activate Alibaba Cloud Model Studio and Tongyi Dianjin services.'."\n" + ."\n" + .'- Obtain your workspaceId. For more information, refer to the [workspace identifier](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLibrary'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dianjin:DeleteLibrary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + ], + 'EndToEndRealTimeDialog' => [ + 'summary' => 'This API uses the WebSocket protocol to perform real-time conversational transcription, intent recognition, and speech synthesis. It supports various audio formats for both input and output to ensure real-time performance and high compatibility.', + 'path' => '/{workspaceId}/ws/realtime/dialog', + 'methods' => ['get'], + 'schemes' => ['https', 'websocket'], + 'security' => [ + [ + 'AK' => [], + ], ], + 'consumes' => ['application/json'], + 'produces' => ['text/event-stream', 'application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => false, 'notSupportAutoTestReason' => 'websocket不支持自动化测试'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx'."\n", 'title' => ''], + ], + [ + 'name' => 'asrModelId', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The ID of the speech recognition model. The default value is nls-base. Supported models include paraformer-realtime-v2 and paraformer-realtime-8k-v2.', + 'enumValueTitles' => ['paraformer-realtime-v1' => 'paraformer-realtime-v1', 'nls-base' => 'nls-base'], 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', + 'required' => false, + 'example' => 'nls-base', + 'default' => 'nls-base', + 'title' => '', ], ], [ - 'name' => 'documentId', + 'name' => 'ttsModelId', 'in' => 'query', 'schema' => [ - 'title' => '文档id', - 'description' => '', + 'description' => 'The ID of the speech synthesis model. The default value is nls-base. The cosyvoice-v2 model is supported.', + 'enumValueTitles' => ['cosyvoice-v2' => 'cosyvoice-v2', 'nls-base' => 'nls-base'], 'type' => 'string', - 'required' => true, - 'example' => '12681367362', + 'required' => false, + 'example' => 'nls-base', + 'default' => 'pcm', + 'title' => '', ], ], + [ + 'name' => 'inputFormat', + 'in' => 'query', + 'schema' => ['description' => 'The input audio format. Supported formats are pcm, wav, and mp3.', 'type' => 'string', 'required' => false, 'example' => 'pcm', 'default' => 'pcm', 'title' => ''], + ], + [ + 'name' => 'outputFormat', + 'in' => 'query', + 'schema' => ['description' => 'The output audio format.', 'type' => 'string', 'required' => false, 'example' => 'wav', 'default' => 'wav', 'title' => ''], + ], + [ + 'name' => 'sampleRate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sample rate.', + 'type' => 'string', + 'required' => false, + 'example' => 'SAMPLE_RATE_16K', + 'default' => 'SAMPLE_RATE_16K', + 'enum' => ['SAMPLE_RATE_16K', 'SAMPLE_RATE_8K', 'SAMPLE_RATE_24K', 'SAMPLE_RATE_48K'], + 'title' => '', + ], + ], + [ + 'name' => 'voiceCode', + 'in' => 'query', + 'schema' => ['description' => 'The voice parameter. This is available only for models that support word-level or sentence-level timestamps.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'longxiaochun_v2'], + ], + [ + 'name' => 'volume', + 'in' => 'query', + 'schema' => ['description' => 'The volume. The value ranges from 0 to 100. This parameter is optional. The default value is 50.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'default' => '50', 'title' => '', 'required' => false], + ], + [ + 'name' => 'speechRate', + 'in' => 'query', + 'schema' => ['description' => 'The speech rate.'."\n" + .'● If \\`ttsModelId\\` is \\`nls-base\\`: The value ranges from -500 to 500. The default is 0.'."\n" + .'● If \\`ttsModelId\\` is \\`cosyvoice-v2\\`:'."\n" + .'Specifies the speech rate of the synthesized audio. The value ranges from 0.5 to 2.'."\n" + .'○ 0.5: Half the default speed.'."\n" + .'○ 1: The default speed. The default speed is the model\'s standard output speed and may vary slightly by speaker. It is about four characters per second.'."\n" + .'○ 2: Twice the default speed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => '', 'required' => false], + ], + [ + 'name' => 'pitchRate', + 'in' => 'query', + 'schema' => ['description' => 'The pitch rate.'."\n" + .'● If \\`ttsModelId\\` is \\`nls-base\\`:'."\n" + .'The value ranges from -500 to 500. The default is 0.'."\n" + .'● If \\`ttsModelId\\` is \\`cosyvoice-v2\\`: Specifies the pitch of the synthesized audio. The value ranges from 0.5 to 2.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => '', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<String>', - 'description' => 'ResultCode<String>', + 'title' => 'RealTimeDialogResp', + 'description' => 'RealTimeDialogResp', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '1C98B466-D6E0-5252-A60B-F345CBB33DDB'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1C98B466-D6E0-5252-A60B-F345CBB33DDB\\"\\n}","type":"json"}]', + 'title' => 'Real-time speech dialogue', + 'requestParamsDescription' => '# Client request messages'."\n" + ."\n" + .'## Common fields'."\n" + ."\n" + .'| Field | Description |'."\n" + .'| --------- | ----------------------------------- |'."\n" + .'| type | The message type. |'."\n" + .'| seq | The message serial number. |'."\n" + .'| timestamp | The UNIX timestamp in milliseconds. |'."\n" + ."\n" + .'## StartTranscription (Start real-time transcription)'."\n" + ."\n" + .'### Starts a real-time transcription and creates a real-time session.'."\n" + ."\n" + .'```json'."\n" + .'type:StartTranscription'."\n" + .'seq:1'."\n" + .'timestamp:1719242591197'."\n" + ."\n" + .'{'."\n" + .' "playCode": "c00aa8467a", // The scenario code.'."\n" + .' "metaData": {}, // Metadata. You can add key-value pairs here for placeholders in the opening remarks. For example, if you set the placeholder ${name} in the opening remarks in scenario management, you can pass {"name": "John Doe"} here.'."\n" + .' "selfDirected": true // Specifies whether to enable autonomous Q&A. If intent recognition returns "other", the model\'s autonomous answering capability is used.'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'## ProcessTranscription (Send audio data)'."\n" + ."\n" + .'### Uploads a segment of audio data.'."\n" + ."\n" + .'```json'."\n" + .'type:ProcessTranscription'."\n" + .'seq:1'."\n" + .'timestamp:1719242591197'."\n" + .'ack:required'."\n" + ."\n" + .'{'."\n" + .' "dataSourceType": "customer", // The data source type.'."\n" + .' "data": [0,0,0,0,0] // The binary audio stream.'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- \\`dataSourceType\\` identifies the data source, such as "customer" or "service".'."\n" + ."\n" + .' - \\`customer\\`: Indicates audio data from the customer.'."\n" + ."\n" + .' - \\`service\\`: Indicates audio data from third-party prompts, such as those from a carrier.'."\n" + ."\n" + .' - You must differentiate between the sources. You can send only the customer\'s audio data because this API does not currently process audio data from the \\`service\\` source.'."\n" + ."\n" + .'## StopTranscription (Stop transcription)'."\n" + ."\n" + .'### Actively ends the real-time session.'."\n" + ."\n" + .'```json'."\n" + .'type:StopTranscription'."\n" + .'seq:1'."\n" + .'timestamp:1719242591197'."\n" + ."\n" + .'{}'."\n" + .'```'."\n" + ."\n" + .'The payload is empty.', + 'responseParamsDescription' => '# Server-side response (push) messages'."\n" + ."\n" + .'## TranscriptionStarted (Session/transcription started)'."\n" + ."\n" + .'```json'."\n" + .'type:TranscriptionStarted'."\n" + .'seq:1'."\n" + .'timestamp:1752922002409'."\n" + ."\n" + .'{'."\n" + .' "sessionId": "1752922001S001nojxboa26z", // The unique identifier for the business session.'."\n" + .' "openingRemarks": "Hello, are you Mr. Li?" // The opening remarks text.'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- \\`sessionId\\`: The unique identifier for the business session.'."\n" + ."\n" + .'- \\`openingRemarks\\`: The content of the opening remarks.'."\n" + ."\n" + .'## TranscriptionResultChanged (Transcription text changed \\[Automatic Speech Recognition (ASR) result])'."\n" + ."\n" + .'```json'."\n" + .'type:TranscriptionResultChanged '."\n" + .'seq:29 '."\n" + .'timestamp:1754659632826 '."\n" + ."\n" + .'{'."\n" + .' "content": "Yes, you",'."\n" + .' "messageId":"5da6a7211fd54f7087f74f2f028308e7"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- \\`content\\`: The current transcribed text.'."\n" + ."\n" + .'- \\`messageId\\`: The unique identifier for the message.'."\n" + ."\n" + .'## SentenceEnd (Sentence transcription complete \\[streaming audio data of agent reply])'."\n" + ."\n" + .'```json'."\n" + .'type:SentenceEnd '."\n" + .'seq: 3 '."\n" + .'timestamp: 1754659629166'."\n" + ."\n" + .'{'."\n" + .' "data": [73,68,51,4,0,0,0], // The binary audio data.'."\n" + .' "messageId": "", // The unique message identifier.'."\n" + .' "messageEnd": true // The flag indicating the end of the current message round.'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'## BizProcessing (Business intent recognition result)'."\n" + ."\n" + .'```json'."\n" + .'type:BizProcessing '."\n" + .'seq: 3 '."\n" + .'timestamp: 1754659629166'."\n" + ."\n" + .'{'."\n" + .' "id": "175465963554371b6ffdea5eb446188fc366df451b23b",'."\n" + .' "choices": ['."\n" + .' {'."\n" + .' "index": 0,'."\n" + .' "finishReason": "stop",'."\n" + .' "delta": {'."\n" + .' "intentionCode": "1940679612569849856",'."\n" + .' "intentionScript": "Hello, this is xxx. We see that you have a pre-approved credit line of x0,000, so we are reminding you to check it out on our WeChat mini program or app.",'."\n" + .' "intentionName": "Customer asks about the caller\'s identity",'."\n" + .' "callTime": "819",'."\n" + .' "hangUpDialog": false,'."\n" + .' "interrupt": false'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "created": "1754659635543",'."\n" + .' "success": true'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- This message primarily contains content related to intent recognition. For more information about the output fields, see [RealTimeDialog](https://help.aliyun.com/zh/model-studio/api-dianjin-2024-06-28-realtimedialog?spm=a2c4g.11186623.0.i2#:~:text=%E5%AE%9E%E6%97%B6%E4%BC%9A%E8%AF%9D-,RealTimeDialog%20%2D%20%E5%AE%9E%E6%97%B6%E4%BC%9A%E8%AF%9D,-%E6%9B%B4%E6%96%B0%E6%97%B6%E9%97%B4%EF%BC%9A).'."\n" + ."\n" + .'## SentenceInterrupted (Sentence interrupted \\[audio cache needs to be cleared])'."\n" + ."\n" + .'```json'."\n" + .'type:SentenceInterrupted '."\n" + .'seq: 32 '."\n" + .'timestamp: 1754659635543 '."\n" + ."\n" + .'{}'."\n" + .'```'."\n" + ."\n" + .'- The body of this message is empty. When you receive this message, you must clear the audio cache and stop playing the previous audio content to create an interruption.'."\n" + ."\n" + .'## TranscriptionEnd (Transcription ended \\[session end suggested: agent determines the session can end])'."\n" + ."\n" + .'```json'."\n" + .'type:TranscriptionEnd '."\n" + .'seq: 367 '."\n" + .'timestamp: 1754659669964 '."\n" + ."\n" + .'{}'."\n" + .'```'."\n" + ."\n" + .'## TranscriptionCompleted (Transcription fully complete, WebSocket connection can be closed)'."\n" + ."\n" + .'```json'."\n" + .'type:TranscriptionCompleted'."\n" + .'seq:3'."\n" + .'timestamp:1752922030325'."\n" + ."\n" + .'{}'."\n" + .'```'."\n" + ."\n" + .'## Status codes and error handling'."\n" + ."\n" + .'If an error occurs when connecting or sending a message, the server-side returns a standard Error message:'."\n" + ."\n" + .'```json'."\n" + .'type:Error'."\n" + .'seq:3'."\n" + .'timestamp:1752922030325'."\n" + ."\n" + .'{'."\n" + .' "code": "401",'."\n" + .' "message": "Token is invalid or has expired"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'Common error codes:'."\n" + ."\n" + .'| Code | Description |'."\n" + .'| ---- | -------------------------- |'."\n" + .'| 400 | Invalid request parameter. |'."\n" + .'| 401 | Authentication failed. |'."\n" + .'| 500 | Internal service error. |', + 'extraInfo' => '## Interaction Flow'."\n" + .' pairs from a document. You can use the UpdateQaLibrary API to update the Q&A pairs.', + 'path' => '/{workspaceId}/api/virtualHuman/qa/parse', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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', - ], - ], + 'docId' => ['description' => 'The document ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '182364872346'], + 'libraryId' => ['description' => 'The document library ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'sjdgdsfg'], + 'requestId' => ['description' => 'The request ID. This ID uniquely identifies the request. The first request with this ID starts the Q\\&A pair parsing. Subsequent requests with the same ID query the parsing status and results.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '0FC6636E-380A-5369-AE01-D1C15BB9B254'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<PageVO<LibraryDocumentVO>>', - 'description' => '', + 'title' => '', + 'description' => 'The Q\\&A pair.', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'dataType' => ['description' => 'The data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'time' => ['description' => 'The timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], 'data' => [ - 'title' => '响应数据', - 'description' => '', + 'title' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'currentPage' => [ - 'title' => '当前页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'title' => '每页记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'libraryId' => ['description' => 'The document library ID.', 'type' => 'string', 'title' => '', 'example' => '7wxwrjpabj'], + 'docId' => ['description' => 'The document ID.', 'type' => 'string', 'title' => '', 'example' => '873648346573245'], + 'currentStatus' => [ + 'description' => 'The current status. Valid values: \\`INIT\\`, \\`PROCESSING\\`, \\`COMPLETED\\`, and \\`FAIL\\`.', + 'enumValueTitles' => ['INIT' => 'Initialization', 'COMPLETED' => 'Complete', 'PROCESSING' => 'In progress', 'FAIL' => 'Failed'], + 'type' => 'string', + 'title' => '', + 'example' => 'PROCESSING', ], - 'records' => [ - 'title' => '记录', - 'description' => '', + 'parseQaResults' => [ + 'title' => '', + 'description' => 'The results of the Q\\&A pair parsing.', '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', - ], + 'question' => ['description' => 'The question.', 'type' => 'string', 'title' => '', 'example' => '今天的天气怎么样?'], + 'answer' => ['description' => 'The answer.', 'type' => 'string', 'title' => '', 'example' => '今天的天气不错,多云转晴。'."\n"], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'totalPages' => [ - 'title' => '总页数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'totalRecords' => [ - 'title' => '总记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', + 'example' => '', ], ], + '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' => '7ADF010C-FD89-569D-A079-2D4D5247E943', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'time' => [ - 'title' => '时间戳', - 'description' => '', - 'type' => 'string', - 'example' => '2024-01-01 00:00:00', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '44BD277A-87F9-5310-8D63-3E6645F1DA85'], + 'cost' => ['description' => 'The time consumed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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 \\"libraryId\\": \\"7wxwrjpabj\\",\\n \\"docId\\": \\"873648346573245\\",\\n \\"currentStatus\\": \\"PROCESSING\\",\\n \\"parseQaResults\\": [\\n {\\n \\"question\\": \\"今天的天气怎么样?\\",\\n \\"answer\\": \\"今天的天气不错,多云转晴。\\\\n\\"\\n }\\n ]\\n },\\n \\"requestId\\": \\"44BD277A-87F9-5310-8D63-3E6645F1DA85\\",\\n \\"cost\\": 0\\n}","type":"json"}]', + 'title' => 'Parse Q&A pairs from a document ', + 'description' => 'Before you use this API, make sure you understand the billing methods and pricing of the Tongyi Dianjin product.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'Activate Alibaba Cloud Model Studio and the Tongyi Dianjin service.'."\n" + ."\n" + .'Obtain a workspace ID. For more information, see [Get a workspace ID](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenDocQaResult'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:GenDocQaResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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', - ], + 'GetAppConfig' => [ + 'summary' => 'Retrieve app configuration.', + 'path' => '/{workspaceId}/api/app/config', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + '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-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', - ], + 'schema' => ['description' => 'Path parameter, workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<PageVO<LibraryDocumentVO>>', - 'description' => '', + 'title' => 'ResultCode<AppConfigBO>', + 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'cost' => ['description' => 'Time consumed', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], 'data' => [ - 'title' => '响应数据', - 'description' => '', + 'title' => '', + 'description' => 'Returned data', 'type' => 'object', 'properties' => [ - 'currentPage' => [ - 'title' => '当前页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'embeddingTypeList' => [ + 'title' => '', + 'description' => 'Embedding type list', + 'type' => 'array', + 'items' => [ + 'description' => 'Key-value pair', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Value', 'type' => 'string', 'example' => 'DashScope', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'pageSize' => [ - 'title' => '每页记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'frontendConfig' => [ + 'title' => '', + 'description' => 'Frontend configuration', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Is enabled', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'example' => '', ], - 'records' => [ - 'title' => '记录', - 'description' => '', + 'libraryDocumentStatusList' => [ + 'title' => '', + 'description' => 'Document library status list', 'type' => 'array', 'items' => [ + 'description' => 'Key-value pair', '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', - ], - ], + 'additionalProperties' => ['description' => 'Value', 'type' => 'string', 'example' => 'Completed', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'totalPages' => [ - 'title' => '总页数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'llmHelperTypeList' => [ + 'title' => '', + 'description' => 'Large Language Model (LLM) type list', + 'type' => 'array', + 'items' => [ + 'description' => 'Key-value pair', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Value', 'type' => 'string', 'example' => 'qwen-max', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'totalRecords' => [ - 'title' => '总记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', + 'textIndexCategoryList' => [ + 'title' => '', + 'description' => 'Text index category list', + 'type' => 'array', + 'items' => ['description' => 'Text index category', 'type' => 'string', 'example' => 'ElasticSearch', 'title' => ''], + 'example' => '', + ], + 'vectorIndexCategoryList' => [ + 'title' => '', + 'description' => 'Vector index category list', + 'type' => 'array', + 'items' => ['description' => 'Vector index category', 'type' => 'string', 'example' => 'ADB', 'title' => ''], + 'example' => '', ], ], + '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' => '5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'time' => [ - 'title' => '时间戳', - 'description' => '', - 'type' => 'string', - 'example' => '2024-04-24 11:54:34', - ], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'None'], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => 'EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258'], + 'success' => ['description' => 'Is successful', 'type' => 'boolean', 'title' => '', 'example' => 'True'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Obtain Configuration Information ', + 'description' => '**Prerequisites**'."\n" + ."\n" + .'- You have activated Alibaba Cloud Model Studio and Tongyi Gold services.'."\n" + ."\n" + .'- You can obtain the workspace ID. For details, see [workspace identity](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%E3%80%9DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAppConfig'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetAppConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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', - ], + 'GetChatQuestionResp' => [ + 'summary' => 'Retrieves the Q&A results generated by the SubmitChatQuestion API.', + 'path' => '/{workspaceId}/api/virtualHuman/chat/query', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx'."\n", - ], + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Request body', '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', - ], + 'sessionId' => ['description' => 'Session ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '237645726354'], + 'batchId' => ['description' => 'Question batch ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '1869307330227937280'], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<Boolean>', - 'description' => 'ResultCode<Boolean>', + 'title' => '', + 'description' => 'Result', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], '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', + 'title' => '', + 'description' => 'Response data', + 'type' => 'object', + 'properties' => [ + 'currentState' => [ + 'description' => 'Current state \\[INIT (Initialization), PROCESSING (Processing), COMPLETED (Completed)]', + 'enumValueTitles' => ['INIT' => 'Initialization', 'COMPLETED' => 'Completed', 'PROCESSING' => 'Processing'], + 'type' => 'string', + 'title' => '', + 'example' => 'PROCESSING', + ], + 'questionList' => [ + 'title' => '', + 'description' => 'Question list', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Question', + 'type' => 'object', + 'properties' => [ + 'sessionId' => ['description' => 'Session ID', 'type' => 'string', 'title' => '', 'example' => '1732846760323001'."\n"], + 'userId' => ['description' => 'Unique ID of the user who asked the question in the live channel.', 'type' => 'string', 'title' => '', 'example' => '39847834568436'."\n"], + 'userName' => ['description' => 'Name of the user who asked the question in the live channel.', 'type' => 'string', 'title' => '', 'example' => '张*'], + 'content' => ['description' => 'Question content', 'type' => 'string', 'title' => '', 'example' => '今天天气怎么样'], + 'gmtCreate' => ['description' => 'Original question time', 'type' => 'string', 'title' => '', 'example' => '2024-11-17 10:05:00'], + 'type' => [ + 'description' => 'Question type \\[PRODUCT\\_QA (Audio submission), GOSSIP (Operation submission), UNKNOWN (Unknown)]', + 'enumValueTitles' => ['PRODUCT_QA' => 'Audio submission', 'GOSSIP' => 'Operation submission', 'UNKNOWN' => 'Unknown'], + 'type' => 'string', + 'title' => '', + 'example' => 'PRODUCT_QA', + ], + 'reply' => ['description' => 'Reply content', 'type' => 'string', 'title' => '', 'example' => '感谢您的支持!'], + 'oriContent' => ['title' => 'Original question ', 'description' => 'Original question', 'type' => 'string', 'example' => '今天天气怎么样'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '44BD277A-87F9-5310-8D63-3E6645F1DA85'], + 'cost' => ['description' => 'Time consumed', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": {\\n \\"currentState\\": \\"PROCESSING\\",\\n \\"questionList\\": [\\n {\\n \\"sessionId\\": \\"1732846760323001\\\\n\\",\\n \\"userId\\": \\"39847834568436\\\\n\\",\\n \\"userName\\": \\"张*\\",\\n \\"content\\": \\"今天天气怎么样\\",\\n \\"gmtCreate\\": \\"2024-11-17 10:05:00\\",\\n \\"type\\": \\"PRODUCT_QA\\",\\n \\"reply\\": \\"感谢您的支持!\\",\\n \\"oriContent\\": \\"今天天气怎么样\\"\\n }\\n ]\\n },\\n \\"requestId\\": \\"44BD277A-87F9-5310-8D63-3E6645F1DA85\\",\\n \\"cost\\": 0\\n}","type":"json"}]', + 'title' => 'Retrieve Q&A results ', + 'changeSet' => [ + ['createdAt' => '2025-01-23T07:21:47.000Z', 'description' => 'Response parameters changed'], ], - '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', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatQuestionResp'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:GetChatQuestionResp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetDialogAnalysisResult' => [ + 'summary' => 'Retrieve session analysis results. You can retrieve results in batches by specifying a list of session IDs or a time range.', + 'path' => '/{workspaceId}/api/virtualHuman/dialog/analysis', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Request body parameters', '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', + 'sessionIds' => [ + 'title' => '', + 'description' => 'Session ID list. When useUrl is true, the response includes OSS URLs. You can specify up to 1000 sessions. If you specify more than 1000, only the first 1000 are processed. When useUrl is false, the response includes full analysis results. You can specify up to 10 sessions. If you specify more than 10, only the first 10 are processed. This parameter is optional. If sessionIds is empty, the API retrieves results for sessions created between startTime and endTime. If sessionIds is not empty, the API retrieves results for the specified sessions. You cannot leave both sessionIds and the time range empty.', + 'type' => 'array', + 'items' => ['description' => 'Session ID', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '183764873624'], 'required' => false, - 'example' => 'test', + 'example' => '', ], + 'useUrl' => ['description' => 'Whether to return an OSS URL instead of full analysis results. If true, the response includes an OSS URL that expires in one hour. Default is true. Supports up to 1000 sessions. If you specify more than 1000, only the first 1000 are processed. If false, the response includes full analysis results. Supports up to 10 sessions. If you specify more than 10, only the first 10 are processed.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], + 'startTime' => ['description' => 'Start time in yyyy-MM-dd HH:mm:ss format. If sessionIds is not empty, you can query the session analysis results using the specified session IDs.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2024-09-14 09:11:00'], + 'endTime' => ['description' => 'The end time, which must be in yyyy-MM-dd HH:mm:ss format. If sessionIds are provided, the system queries session analysis results based on these IDs.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2024-09-23 09:20:02'], + 'asc' => ['description' => 'Whether to sort in ascending order. Default is true, which sorts by session creation time in ascending order. If false, sorts in descending order.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'required' => false, 'example' => 'true'], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<String>', - 'description' => '', + 'title' => '', + 'description' => 'Response body parameters', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'success' => ['description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], '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', + 'title' => '', + 'description' => 'Response data', + 'type' => 'object', + 'properties' => [ + 'dialogAnalysisRespList' => [ + 'title' => '', + 'description' => 'List of session analysis results', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Session analysis result', + 'type' => 'object', + 'properties' => [ + 'sessionId' => ['description' => 'Session ID', 'type' => 'string', 'title' => '', 'example' => '183764873624'], + 'gmtCreate' => ['description' => 'Session creation time', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'."\n"], + 'status' => [ + 'description' => 'Task execution status for session analysis.'."\n" + ."\n" + .'- init means the task has not started'."\n" + ."\n" + .'- pending means the task is queued'."\n" + ."\n" + .'- running means the task is in progress'."\n" + ."\n" + .'- error means the task failed'."\n" + ."\n" + .'- success means the task completed successfully', + 'type' => 'string', + 'enum' => ['init', 'pending', 'running', 'error', 'success'], + 'title' => '', + 'example' => 'running', + ], + 'ossUrl' => ['description' => 'OSS URL for the session analysis result. The URL expires in one hour.', 'type' => 'string', 'title' => '', 'example' => 'https://xxx.oss-cn-beijing.aliyuncs.com/dialog-analysis/2024-12-30/2/1826661605606129665'], + 'analysisResp' => [ + 'title' => '', + 'description' => 'Session analysis result', + 'type' => 'object', + 'properties' => [ + 'dialogLabels' => [ + 'title' => '', + 'description' => 'List of session labels', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Session label', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'Label name', 'type' => 'string', 'title' => '', 'example' => '额度不足'], + 'value' => ['description' => 'Label value', 'type' => 'string', 'title' => '', 'example' => '0'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'dialogSummary' => ['description' => 'Session summary', 'type' => 'string', 'title' => '', 'example' => '- 是否有资金需求:不确定,客户未明确表示有无资金需求。\\n- 是否有意向:不确定,客户未明确表达意向。\\n- 是否可营销:不可营销,客户对客服的多次询问未表现出兴趣,且对话中提到因不适希望减少联系。\\n- 待满足需求:客户希望了解具体的预审额度信息。'], + 'dialogExecPlan' => ['description' => 'Session execution plan', 'type' => 'string', 'title' => '', 'example' => '1. 客服应再次确认客户的疑问是否已解决,特别是关于额度的具体数额。\\n2. 如果客户仍有疑问,提供客服热线电话,建议客户直接拨打以获取更详细的帮助。\\n3. 提醒客户检查短信中的链接,以便快速查看和操作。\\n4. 记录此次通话中客户表现出的任何不适或不便,确保后续跟进时更加体贴。\\n5. 发送一条包含操作指南的短信,确保客户能够轻松找到并使用服务。\\n6. 结束通话前,再次感谢客户的支持,并表达希望客户早日康复的愿望。'], + 'dialogSop' => ['title' => 'Session SOP', 'description' => 'Session SOP', 'type' => 'string', 'example' => '产品介绍'], + 'dialogProcessAnalysis' => ['title' => 'Session procedure analysis', 'description' => 'Session process analysis', 'type' => 'object', 'example' => '{'."\n" + .' "dialogues": ['."\n" + .' {'."\n" + .' "round": 1,'."\n" + .' "result": ['."\n" + .' {'."\n" + .' "key": "客服",'."\n" + .' "value": "客服回应标签"'."\n" + .' },'."\n" + .' {'."\n" + .' "key": "客户",'."\n" + .' "value": "客户回应态度标签"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' {'."\n" + .' "round": 2,'."\n" + .' "result": ['."\n" + .' {'."\n" + .' "key": "客服",'."\n" + .' "value": "客服回应标签"'."\n" + .' },'."\n" + .' {'."\n" + .' "key": "客户",'."\n" + .' "value": "客户回应态度标签"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ],'."\n" + .'"dialogProcessAnalysisStr":"第一轮对话:客服-客服回应标签,客户-客户回应态度标签'."\n" + .'第二轮对话:客服-客服回应标签,客户-客户回应态度标签"'."\n" + .'}'], + 'dialogOpenAnalysis' => ['title' => 'Conversation Open Analysis', 'description' => 'Session open analysis', 'type' => 'object', 'example' => '{'."\n" + .' "dialogues": ['."\n" + .' {'."\n" + .' "round": 1,'."\n" + .' "result": ['."\n" + .' {'."\n" + .' "key": "对话主题",'."\n" + .' "value": "XX"'."\n" + .' },'."\n" + .' {'."\n" + .' "key": "客户反应",'."\n" + .' "value": "XXX"'."\n" + .' },'."\n" + .' {'."\n" + .' "key": "客户反应分析",'."\n" + .' "value": "XXX"'."\n" + .' },'."\n" + .' {'."\n" + .' "key": "客服话术",'."\n" + .' "value": "XXX"'."\n" + .' },'."\n" + .' {'."\n" + .' "key": "本轮客服话术修改建议",'."\n" + .' "value": "XXX"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' {'."\n" + .' "round": 2,'."\n" + .' "result": ['."\n" + .' {'."\n" + .' "key": "对话主题",'."\n" + .' "value": "XX"'."\n" + .' },'."\n" + .' {'."\n" + .' "key": "客户反应",'."\n" + .' "value": "XXX"'."\n" + .' },'."\n" + .' {'."\n" + .' "key": "客户反应分析",'."\n" + .' "value": "XXX"'."\n" + .' },'."\n" + .' {'."\n" + .' "key": "客服话术",'."\n" + .' "value": "XXX"'."\n" + .' },'."\n" + .' {'."\n" + .' "key": "本轮客服话术修改建议",'."\n" + .' "value": "XXX"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ],'."\n" + .' "dialogOpenAnalysisStr":"第一轮对话:对话主题-xx##客户反应-xx##客户反应分析-xx##客服话术-xx##本轮客服话术修改建议-xx'."\n" + .'第二轮对话:对话主题-xx##客户反应-xx##客户反应分析-xx##客服话术-xx##本轮客服话术修改建议-xx"'."\n" + .'}'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '88A006F0-B565-53BA-B38A-DBDF9D0B2935'], + 'cost' => ['description' => 'Processing time in milliseconds', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], ], + 'example' => '', ], ], ], - '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', + '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 \\"dialogAnalysisRespList\\": [\\n {\\n \\"sessionId\\": \\"183764873624\\",\\n \\"gmtCreate\\": \\"2024-04-24 11:54:34\\\\n\\",\\n \\"status\\": \\"running\\",\\n \\"ossUrl\\": \\"https://xxx.oss-cn-beijing.aliyuncs.com/dialog-analysis/2024-12-30/2/1826661605606129665\\",\\n \\"analysisResp\\": {\\n \\"dialogLabels\\": [\\n {\\n \\"name\\": \\"额度不足\\",\\n \\"value\\": \\"0\\"\\n }\\n ],\\n \\"dialogSummary\\": \\"- 是否有资金需求:不确定,客户未明确表示有无资金需求。\\\\\\\\n- 是否有意向:不确定,客户未明确表达意向。\\\\\\\\n- 是否可营销:不可营销,客户对客服的多次询问未表现出兴趣,且对话中提到因不适希望减少联系。\\\\\\\\n- 待满足需求:客户希望了解具体的预审额度信息。\\",\\n \\"dialogExecPlan\\": \\"1. 客服应再次确认客户的疑问是否已解决,特别是关于额度的具体数额。\\\\\\\\n2. 如果客户仍有疑问,提供客服热线电话,建议客户直接拨打以获取更详细的帮助。\\\\\\\\n3. 提醒客户检查短信中的链接,以便快速查看和操作。\\\\\\\\n4. 记录此次通话中客户表现出的任何不适或不便,确保后续跟进时更加体贴。\\\\\\\\n5. 发送一条包含操作指南的短信,确保客户能够轻松找到并使用服务。\\\\\\\\n6. 结束通话前,再次感谢客户的支持,并表达希望客户早日康复的愿望。\\",\\n \\"dialogSop\\": \\"产品介绍\\",\\n \\"dialogProcessAnalysis\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"dialogOpenAnalysis\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n }\\n ]\\n },\\n \\"requestId\\": \\"88A006F0-B565-53BA-B38A-DBDF9D0B2935\\",\\n \\"cost\\": 0\\n}","type":"json"}]', + 'title' => 'Retrieve Conversation Analysis Result ', + 'changeSet' => [ + ['createdAt' => '2025-04-02T08:31:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-16T14:50:30.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDialogAnalysisResult'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:GetDialogAnalysisResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetDialogDetail' => [ + 'summary' => 'Retrieve session details.', + 'path' => '/{workspaceId}/api/virtualHuman/dialog/detail', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'title' => '路径参数,业务空间id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxxx'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'sessionId', + 'in' => 'query', + 'schema' => ['description' => 'Session ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '1906623923815534xxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'ResultCode<DialogDetailQueryResponse>', + 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ - 'chunks' => [ - 'title' => '文档块列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'chunkMeta' => [ - 'title' => '文档块元信息', - 'description' => '', + 'success' => ['description' => 'Indicates whether the operation succeeded', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'data' => [ + 'title' => '', + 'description' => 'Response data', + 'type' => 'object', + 'properties' => [ + 'totalDialogTurns' => ['description' => 'Total conversation rounds. Each round counts one exchange between AI and the customer. Multiple consecutive messages from either side count as one round. If the last message is from the AI and is not a hang-up, subtract one from the total round count.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'validDialogTurns' => ['description' => 'Valid conversation rounds. Each valid round counts one question-and-answer pair between AI and the customer. This differs from the total round count method.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], + 'dialogueList' => [ + 'title' => '', + 'description' => 'List of dialogue details', + 'type' => 'array', + 'items' => [ + 'description' => 'Dialogue detail', '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', - ], + 'properties' => [ + 'role' => ['description' => 'Role:'."\n" + ."\n" + .'- 0: Customer'."\n" + ."\n" + .'- 1: Agent', 'type' => 'string', 'title' => '', 'example' => '0'], + 'customerServiceType' => ['description' => 'Agent type:'."\n" + ."\n" + .'- 0: Bot'."\n" + ."\n" + .'- 1: Human', 'type' => 'string', 'title' => '', 'example' => '0'], + 'customerServiceId' => ['description' => 'Agent ID', 'type' => 'string', 'title' => '', 'example' => 'BOT'], + 'customerId' => ['description' => 'Customer ID', 'type' => 'string', 'title' => '', 'example' => '123761283'], + 'content' => ['description' => 'Dialogue content', 'type' => 'string', 'title' => '', 'example' => '请问具体怎么操作呢?'], + 'type' => ['description' => 'Content type: text, audio, or image. Only text is supported.', 'type' => 'string', 'title' => '', 'example' => 'text'], + 'id' => ['description' => 'Unique identifier for this message. Assigned internally. May be empty. Use recordId instead.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1742869659849'], + 'recordId' => ['title' => 'UUID of this utterance, assigned internally, of type String.', 'description' => 'Unique identifier for this message. Assigned internally. String type.', 'type' => 'string', 'example' => '19387872364736xdhcb'], + 'intentCode' => ['description' => 'Intent code', 'type' => 'string', 'title' => '', 'example' => '193874634xxx'], + 'intentName' => ['description' => 'Intent name', 'type' => 'string', 'title' => '', 'example' => '客户询问如何操作'], + 'hangUpDialog' => ['description' => 'Indicates whether the session ended with this message', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'required' => false, + 'status' => [ + 'description' => 'Session status', + 'type' => 'string', + 'enum' => ['INIT', 'PROCESSING', 'COMPLETED', 'ERROR'], + 'title' => '', + 'example' => 'COMPLETED', + ], + 'gmtCreate' => ['description' => 'Session time', 'type' => 'string', 'title' => '', 'example' => '2024-09-27 11:23:20'], ], - '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' => '测试文档', + 'example' => '', ], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658'], + 'cost' => ['description' => 'Processing time in milliseconds', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], ], - 'required' => false, + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ResultCode<String>', - 'description' => 'ResultCode<String>', - '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 \\"success\\": true,\\n \\"dataType\\": \\"null\\",\\n \\"time\\": \\"2024-04-24 11:54:34\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"data\\": {\\n \\"totalDialogTurns\\": 10,\\n \\"validDialogTurns\\": 5,\\n \\"dialogueList\\": [\\n {\\n \\"role\\": \\"0\\",\\n \\"customerServiceType\\": \\"0\\",\\n \\"customerServiceId\\": \\"BOT\\",\\n \\"customerId\\": \\"123761283\\",\\n \\"content\\": \\"请问具体怎么操作呢?\\",\\n \\"type\\": \\"text\\",\\n \\"id\\": 1742869659849,\\n \\"recordId\\": \\"19387872364736xdhcb\\",\\n \\"intentCode\\": \\"193874634xxx\\",\\n \\"intentName\\": \\"客户询问如何操作\\",\\n \\"hangUpDialog\\": true\\n }\\n ],\\n \\"status\\": \\"COMPLETED\\",\\n \\"gmtCreate\\": \\"2024-09-27 11:23:20\\"\\n },\\n \\"requestId\\": \\"5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658\\",\\n \\"cost\\": 0\\n}","type":"json"}]', + 'title' => 'Retrieve session details ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDialogDetail'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetDialogDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - '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', - ], + 'GetDialogLog' => [ + 'summary' => 'Retrieves records of real-time conversations and the results of intent analysis.', + 'path' => '/{workspaceId}/api/dialog/log', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The request body.', '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', - ], + 'id' => ['description' => 'The \\`id\\` field returned by the real-time conversation API.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => '175600129454077743fb03ac54955a4be72ec08f9c216'], + 'sessionId' => ['description' => 'The session ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => '1758010668S001w4paq82azm'], ], 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<PageVO<ChunkModelVO>>', - 'description' => 'ResultCode<PageVO<ChunkModelVO>>', + 'title' => 'ResultCode<IntentRecognize>', + 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'dataType' => ['description' => 'The data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'time' => ['description' => 'The timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], 'data' => [ - 'title' => '响应数据', - 'description' => '', + 'title' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'currentPage' => [ - 'title' => '当前页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'title' => '每页记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'records' => [ - 'title' => '记录', - 'description' => '', + 'recallList' => ['description' => 'The recall list.', 'type' => 'string', 'title' => '', 'example' => '## Example:\\n- 对话内容为:\\"##客服##:您好,请问有什么可以帮到您?\\n ##客户##:暂时没有了。谢谢。\\"时,用户意图为:\\"客户想要挂断电话\\"\\n- 对话内容为:\\"##客服##:您好,请问有什么可以帮到您?\\n ##客户##:哎你好。\\"时,用户意图为:\\"客户询问来电目的\\"\\n- 对话内容为:\\"##客服##:您好,请问有什么可以帮到您?\\n ##客户##:我现在财务状况很好,谢谢关心。\\"时,用户意图为:\\"客户拒绝贷款\\"\\n- 对话内容为:\\"##客服##:您好,请问有什么可以帮到您?\\n ##客户##:不用了,谢谢,不要再打电话了,谢谢。\\"时,用户意图为:\\"投诉/退订/不要打电话/骂人\\"\\n- 对话内容为:\\"##客服##:您好,请问有什么可以帮到您?\\n ##客户##:你好。\\"时,用户意图为:\\"客户询问来电目的\\"'], + 'intentionList' => [ + 'title' => '', + 'description' => 'The intent list.', 'type' => 'array', 'items' => [ + 'title' => '', + 'description' => 'The intent.', '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', - ], + 'intentionName' => ['description' => 'The intent name.', 'type' => 'string', 'title' => '', 'example' => '客户明确表示拒绝营销'], + 'intentionScript' => ['description' => 'The `intentionScript` field contains the service agent\'s reply script for the user\'s intent.', 'type' => 'string', 'title' => '', 'example' => '非常抱歉,给您带来了不好的体验。如您无需再接受我们的官方来电,请回复“我要退订”四个字!'], + 'description' => ['description' => 'The `description` field provides a detailed description of the user\'s intent.', 'type' => 'string', 'title' => '', 'example' => '客户明确表示投诉/退订/不要打电话/骂人等拒绝营销'], ], + 'example' => '', ], + 'example' => '', ], - 'totalPages' => [ - 'title' => '总页数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'totalRecords' => [ - 'title' => '总记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', + 'conversationList' => ['description' => 'The `conversationList` field records the conversation content.', 'type' => 'string', 'title' => '', 'example' => '##客服##:您好,请问是张三先生是吧?\\n ##客户##:人工客服\\n ##客服##:您好,我是2804,很高兴为您服务!\\n ##客服##:您好,请问有什么可以帮到您?\\n ##客户##:好的 谢谢\\n '], + 'hitIntentionList' => [ + 'title' => '', + 'description' => 'The list of hit intents.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The hit intent.', + 'type' => 'object', + 'properties' => [ + 'intentionName' => ['description' => 'The intent name.', 'type' => 'string', 'title' => '', 'example' => '客户要求转人工'], + 'intentionScript' => ['description' => 'The scripted reply based on the customer\'s intent.', 'type' => 'string', 'title' => '', 'example' => '很抱歉,我这里无法直接为您转接,您可以拨打我司客服热线进行咨询。'."\n"], + 'description' => ['description' => 'A description of the customer\'s intent.', 'type' => 'string', 'title' => '', 'example' => '客户希望与真人接触,不想和AI客服继续对话。'], + ], + 'example' => '', + ], + 'example' => '', ], + 'analysisProcess' => ['description' => 'The analysis process. This field has a value if the analysis process is enabled during the real-time conversation.', 'type' => 'string', 'title' => '', 'example' => '客户回答的内容与提供的意图列表描述均不匹配,没有表达出对账单、还款、天气或其他服务的具体需求或问题。'], + 'modelCostTime' => ['description' => 'The model processing time, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1382'], ], + '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' => '2B8F6DC9-6FAF-576F-9095-CCD90FB2BDDF', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'time' => [ - 'title' => '时间戳', - 'description' => '', - 'type' => 'string', - 'example' => '2024-04-24 11:54:34', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '051EEB18-049A-17FF-A5E0-14A5B127C798'], + 'cost' => ['description' => 'The processing time.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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\\": {\\n \\"recallList\\": \\"## Example:\\\\\\\\n- 对话内容为:\\\\\\\\\\\\\\"##客服##:您好,请问有什么可以帮到您?\\\\\\\\n ##客户##:暂时没有了。谢谢。\\\\\\\\\\\\\\"时,用户意图为:\\\\\\\\\\\\\\"客户想要挂断电话\\\\\\\\\\\\\\"\\\\\\\\n- 对话内容为:\\\\\\\\\\\\\\"##客服##:您好,请问有什么可以帮到您?\\\\\\\\n ##客户##:哎你好。\\\\\\\\\\\\\\"时,用户意图为:\\\\\\\\\\\\\\"客户询问来电目的\\\\\\\\\\\\\\"\\\\\\\\n- 对话内容为:\\\\\\\\\\\\\\"##客服##:您好,请问有什么可以帮到您?\\\\\\\\n ##客户##:我现在财务状况很好,谢谢关心。\\\\\\\\\\\\\\"时,用户意图为:\\\\\\\\\\\\\\"客户拒绝贷款\\\\\\\\\\\\\\"\\\\\\\\n- 对话内容为:\\\\\\\\\\\\\\"##客服##:您好,请问有什么可以帮到您?\\\\\\\\n ##客户##:不用了,谢谢,不要再打电话了,谢谢。\\\\\\\\\\\\\\"时,用户意图为:\\\\\\\\\\\\\\"投诉/退订/不要打电话/骂人\\\\\\\\\\\\\\"\\\\\\\\n- 对话内容为:\\\\\\\\\\\\\\"##客服##:您好,请问有什么可以帮到您?\\\\\\\\n ##客户##:你好。\\\\\\\\\\\\\\"时,用户意图为:\\\\\\\\\\\\\\"客户询问来电目的\\\\\\\\\\\\\\"\\",\\n \\"intentionList\\": [\\n {\\n \\"intentionName\\": \\"客户明确表示拒绝营销\\",\\n \\"intentionScript\\": \\"非常抱歉,给您带来了不好的体验。如您无需再接受我们的官方来电,请回复“我要退订”四个字!\\",\\n \\"description\\": \\"客户明确表示投诉/退订/不要打电话/骂人等拒绝营销\\"\\n }\\n ],\\n \\"conversationList\\": \\"##客服##:您好,请问是张三先生是吧?\\\\\\\\n ##客户##:人工客服\\\\\\\\n ##客服##:您好,我是2804,很高兴为您服务!\\\\\\\\n ##客服##:您好,请问有什么可以帮到您?\\\\\\\\n ##客户##:好的 谢谢\\\\\\\\n \\",\\n \\"hitIntentionList\\": [\\n {\\n \\"intentionName\\": \\"客户要求转人工\\",\\n \\"intentionScript\\": \\"很抱歉,我这里无法直接为您转接,您可以拨打我司客服热线进行咨询。\\\\n\\",\\n \\"description\\": \\"客户希望与真人接触,不想和AI客服继续对话。\\"\\n }\\n ],\\n \\"analysisProcess\\": \\"客户回答的内容与提供的意图列表描述均不匹配,没有表达出对账单、还款、天气或其他服务的具体需求或问题。\\",\\n \\"modelCostTime\\": 1382\\n },\\n \\"requestId\\": \\"051EEB18-049A-17FF-A5E0-14A5B127C798\\",\\n \\"cost\\": 0\\n}","type":"json"}]', + 'title' => 'Retrieve conversation logs ', + 'description' => '## Request description'."\n" + ."\n" + .'This API retrieves conversation records between customers and service agents, along with intent analysis results generated by the model.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDialogLog'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:GetDialogLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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', - ], + 'GetDocumentChunkList' => [ + 'summary' => 'Retrieve a list of document chunks. You can filter them by query conditions.', + 'path' => '/{workspaceId}/api/library/getDocumentChunk', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + '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', - ], + 'schema' => ['description' => 'Path parameter, workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body parameters.', 'type' => 'object', 'properties' => [ - 'filters' => [ - 'title' => '元信息过滤条件', - 'description' => '', + 'chunkIdList' => [ + 'title' => '', + 'description' => 'List of document chunk IDs', '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, - ], + 'items' => ['description' => 'Document chunk ID', 'type' => 'string', 'required' => false, 'example' => '83648326438746', 'title' => ''], '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', - ], + 'docId' => ['description' => 'Document ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '182364872346'], + 'libraryId' => ['description' => 'Library ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dsjgfdjgfxxx'], + 'order' => ['description' => 'Sorting method', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'desc'], + 'orderBy' => ['description' => 'Sort field', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'gmtCreate'], + 'page' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], + 'pageSize' => ['description' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], + 'searchQuery' => ['description' => 'Search query keyword', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<LibraryDocumentRecallVO>', - 'description' => '', + 'title' => 'ResultCode<PageVO<ChunkModelVO>>', + 'description' => 'ResultCode\\<PageVO>', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'cost' => ['description' => 'Time consumed', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], 'data' => [ - 'title' => '响应数据', - 'description' => '', + 'title' => '', + 'description' => 'Response data', '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' => '', + 'currentPage' => ['description' => 'Current page', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'pageSize' => ['description' => 'Records per page', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'records' => [ + 'title' => '', + 'description' => 'Records', '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' => '', - ], + 'chunkId' => ['description' => 'Document chunk ID', 'type' => 'string', 'title' => '', 'example' => '28377468263482764'], + 'chunkMeta' => ['description' => 'Document chunk metadata', 'type' => 'object', 'title' => '', 'example' => '{"a":"1"}'], + 'chunkOssUrl' => ['description' => 'Document chunk OSS address', 'type' => 'string', 'title' => '', 'example' => 'oss-xxxx-hangzhou.com/test.pdf'], + 'chunkText' => ['description' => 'Document chunk text', 'type' => 'string', 'title' => '', 'example' => '这是一段测试文本'], 'chunkType' => [ - 'title' => '文档块类型', - 'description' => '', + 'description' => 'Document chunk type', + 'enumValueTitles' => ['faq' => 'FAQ', 'text' => 'Text', 'graph' => 'Graph', 'table' => 'Table', 'structure' => 'Structure'], 'type' => 'string', + 'title' => '', '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', - ], + 'docId' => ['description' => 'Document ID', 'type' => 'string', 'title' => '', 'example' => '8947387648356'], + 'fileType' => ['description' => 'Document type', 'type' => 'string', 'title' => '', 'example' => 'pdf'], + 'libraryId' => ['description' => 'Library ID', 'type' => 'string', 'title' => '', 'example' => 'jhsdvne'], + 'libraryName' => ['description' => 'Library name', 'type' => 'string', 'title' => '', 'example' => '测试文档库'], + 'nextChunkId' => ['description' => 'Next document chunk ID', 'type' => 'string', 'title' => '', 'example' => '947538465'], 'pos' => [ - 'title' => '文档块位置', - 'description' => '', + 'title' => '', + 'description' => 'Document chunk position', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Layout position information', 'type' => 'object', 'properties' => [ 'axisArray' => [ - 'title' => '坐标', - 'description' => '', + 'title' => '', + 'description' => 'Coordinate', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '1', - ], - ], - 'page' => [ - 'title' => '页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'items' => ['description' => 'Coordinate', 'type' => 'number', 'format' => 'double', 'example' => '394.3', 'title' => ''], + 'example' => '', ], + 'page' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'textHighlightArea' => [ - 'title' => '文本高亮区域,用于文本类型的文件高亮', - 'description' => '', + 'title' => '', + 'description' => 'Text highlight area, used for highlighting text-type files', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'items' => ['description' => 'Text highlight area', 'type' => 'integer', 'format' => 'int32', 'example' => '38', 'title' => ''], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - ], - 'preChunkId' => [ - 'title' => '前一个文档块id', - 'description' => '', - 'type' => 'string', - 'example' => '32874682764', - ], - 'score' => [ - 'title' => '文档块分数', - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'title' => [ - 'title' => '文档标题', - 'description' => '', - 'type' => 'string', 'example' => '', ], + 'preChunkId' => ['description' => 'Previous document chunk ID', 'type' => 'string', 'title' => '', 'example' => '9848346548365'], + 'score' => ['description' => 'Document chunk score', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0.5'], + 'title' => ['description' => 'Document title', 'type' => 'string', 'title' => '', 'example' => 'test'], ], - ], - ], - 'chunkTextList' => [ - 'title' => 'chunk text列表', - 'description' => '', - 'type' => 'array', - 'items' => [ 'description' => '', - 'type' => 'string', + 'title' => '', 'example' => '', ], + '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', - ], + 'totalPages' => ['description' => 'Total pages', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'totalRecords' => ['description' => 'Total records', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], ], + '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' => '0bc13a9517168617617186457e401f', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'time' => [ - 'title' => '时间戳', - 'description' => '', - 'type' => 'string', - 'example' => '2024-04-24 11:54:34', - ], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '2B8F6DC9-6FAF-576F-9095-CCD90FB2BDDF'], + 'success' => ['description' => 'Success status', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], ], + 'example' => '', ], ], ], - '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', + '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"}]', + 'title' => 'Retrieve document chunk list ', + 'description' => '**Prerequisites**'."\n" + ."\n" + .'- Activate Alibaba Cloud Model Studio and Tongyi Gold Service.'."\n" + ."\n" + .'- Obtain the workspaceId and the [workspace identity](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%B3).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocumentChunkList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:GetDocumentChunkList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetDocumentList' => [ + 'summary' => 'Retrieves a list of documents from a document library. This operation supports paged queries and filtering by document status.', + 'path' => '/{workspaceId}/api/library/listDocument', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], + 'schema' => ['description' => 'A path parameter that specifies the workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx', 'title' => ''], ], [ - '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, - ], + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'default' => '10', 'title' => '', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => ['description' => 'The document status.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '即将可用'], + ], + [ + 'name' => 'libraryId', + 'in' => 'query', + 'schema' => ['description' => 'The document library ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '3akzl28vap'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<DocumentParseResultVO>', - 'description' => 'ResultCode<DocumentParseResultVO>', + 'title' => 'ResultCode<PageVO<LibraryDocumentVO>>', + 'description' => 'The returned result.', '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', - ], + 'cost' => ['description' => 'The time consumed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], 'data' => [ - 'title' => '响应数据', - 'description' => '', + 'title' => '', + 'description' => 'The response data.', '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', + 'currentPage' => ['description' => 'The current page number. This is a paging parameter.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'pageSize' => ['description' => 'The number of entries per page. This is a paging parameter.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'records' => [ + 'title' => '', + 'description' => 'The records.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'docId' => ['description' => 'The document ID.', 'type' => 'string', 'title' => '', 'example' => '8326748346'], + 'documentMeta' => ['description' => 'The document metadata.', 'type' => 'object', 'title' => '', 'example' => ''], + 'fileType' => ['description' => 'The document type.', 'type' => 'string', 'title' => '', 'example' => 'pdf'], + 'gmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], + 'gmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], + 'libraryId' => ['description' => 'The ID of the library to which the document belongs.', 'type' => 'string', 'title' => '', 'example' => 'skjdhshbv'], + 'statusCode' => ['description' => 'The document status. Valid values: WaitRefresh (waiting for refresh), InQueue (pending), FetchingData (retrieving data), Embedding (processing document), Error (error), Completed (available), and Null (unknown).', 'type' => 'string', 'title' => '', 'example' => 'WaitRefresh'], + 'title' => ['description' => 'The document title.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'url' => ['description' => 'The document URL. This field will be deprecated. The value is empty. To get the document URL, use the GetDocumentUrl operation.', 'type' => 'string', 'title' => '', 'example' => 'null'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'totalPages' => ['description' => 'The total number of pages. This is a paging parameter.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'totalRecords' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], ], + 'example' => '', ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '0abb793617204049360065953ec6dd', - ], - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'dataType' => ['description' => 'The data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'The timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Retrieve Document List', + 'description' => '**Prerequisites**'."\n" + ."\n" + .'- You have activated Alibaba Cloud Model Studio and the Tongyi Gold Point service.'."\n" + ."\n" + .'- You have obtained a workspace ID. For more information, see [Get a workspace ID](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocumentList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetDocumentList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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', - ], + 'GetDocumentUrl' => [ + 'summary' => 'Retrieve a download URL for a document. The URL expires after 1 hour.', + 'path' => '/{workspaceId}/api/library/document/url', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'title' => '业务空间', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], + 'schema' => ['description' => 'Path parameter. The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'documentId', 'in' => 'query', - 'schema' => [ - 'title' => '文档id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '8326472354762354', - ], + 'schema' => ['description' => 'The document ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '12681367362'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<ResultCodeEnum>', - 'description' => '', + 'title' => 'ResultCode<String>', + 'description' => 'ResultCode\\<string>', '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', - ], + 'cost' => ['description' => 'The time spent, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => ['description' => 'The download URL for the document. The URL expires in 1 hour.', 'type' => 'string', 'title' => '', 'example' => 'https://path_to_file'], + 'dataType' => ['description' => 'The data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '66249B43-8C2B-5EE7-AE78-B382306621C6'], + 'success' => ['description' => 'Indicates whether the call succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'The UNIX timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Obtain the document download link', + 'description' => '**Prerequisites**'."\n" + ."\n" + .'- You have activated Alibaba Cloud Model Studio and Tongyi Dianjin.'."\n" + ."\n" + .'- Obtain the workspace ID. For more information, see [Get the workspace ID](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocumentUrl'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetDocumentUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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', - ], + 'GetFilterDocumentList' => [ + 'summary' => 'This operation retrieves a list of documents. You can filter documents by metadata or use paging.', + 'path' => '/{workspaceId}/api/library/filterDocument', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + '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', - ], + 'schema' => ['description' => 'Workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body.', 'type' => 'object', 'properties' => [ - 'description' => [ - 'title' => '文档库描述', - 'description' => '', - 'type' => 'string', + 'and' => [ + 'title' => '', + 'description' => 'AND expression to filter documents or document chunks.', + 'type' => 'array', + 'items' => [ + 'description' => 'A set of constraints in triplet format, joined by AND.', + 'type' => 'object', + 'properties' => [ + 'boost' => ['description' => 'Weight of the value in the text retrieval engine. Default is 1.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1', 'title' => ''], + 'key' => ['description' => 'Metadata key in the document library.', 'type' => 'string', 'required' => false, 'example' => 'company', 'title' => ''], + 'operator' => ['description' => '### Relationship between the stored metadata value and your input value'."\n" + ."\n" + .'- eq: The stored metadata value equals your input value.'."\n" + ."\n" + .'- contains: The stored metadata value list contains your input value.', 'type' => 'string', 'required' => false, 'example' => 'eq', 'title' => ''], + 'value' => ['description' => 'Input metadata value.', 'type' => 'string', 'required' => false, 'example' => 'alibaba', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], '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, + 'docIdList' => [ + 'title' => '', + 'description' => 'List of document IDs to filter documents or document chunks.', + 'type' => 'array', + 'items' => ['description' => 'Document ID.', 'type' => 'string', 'required' => false, 'example' => '3553835752369972270', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'libraryId' => ['description' => 'Document library ID to filter documents or document chunks.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cjshcxxxx'], + 'or' => [ + 'title' => '', + 'description' => 'OR expression to filter documents or document chunks.', + 'type' => 'array', + 'items' => [ + 'description' => 'A set of constraints in triplet format, joined by OR.', + 'type' => 'object', + 'properties' => [ + 'boost' => ['description' => 'Weight of the value in the text retrieval engine. Default is 1.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1', 'title' => ''], + 'key' => ['description' => 'Metadata key in the document library.', 'type' => 'string', 'required' => false, 'example' => 'company', 'title' => ''], + 'operator' => ['description' => '### Relationship between the stored metadata value and your input value'."\n" + ."\n" + .'- eq: The stored metadata value equals your input value.'."\n" + ."\n" + .'- contains: The stored metadata value list contains your input value.', 'type' => 'string', 'required' => false, 'example' => 'contains', 'title' => ''], + 'value' => ['description' => 'Input metadata value.', 'type' => 'string', 'required' => false, 'example' => 'alibaba', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'example' => '', ], - 'libraryId' => [ - 'title' => '文档库id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'dsfbashdbb', - ], - 'libraryName' => [ - 'title' => '文档库名称', - 'description' => '', - 'type' => 'string', + 'page' => ['description' => 'Page number for pagination.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], + 'pageSize' => ['description' => 'Number of records per page for pagination.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], + 'status' => [ + 'title' => '', + 'description' => 'List of document statuses to filter documents.'."\n" + ."\n" + .'### Document parsing status codes'."\n" + ."\n" + .'*Status codes: WaitRefresh, InQueue, FetchingData, Embedding, Completed, FormatError, Error*'."\n" + ."\n" + .'- Completed: Active. Document parsing completed.'."\n" + ."\n" + .'- Error: Inactive. Document parsing failed.'."\n" + ."\n" + .'- FormatError: File format error. Re-upload the file in the correct format if it is encrypted or incomplete.'."\n" + ."\n" + .'- InQueue: Pending. Document is waiting for parsing.'."\n" + ."\n" + .'- Parsed: Parsing completed.'."\n" + ."\n" + .'- Other statuses are internal system states. For example, WaitRefresh means the task is scheduled. FetchingData means parsing is in progress. Embedding means index building is in progress.', + 'type' => 'array', + 'items' => ['description' => 'Document status to filter documents.', 'type' => 'string', 'required' => false, 'example' => 'Completed', 'title' => ''], 'required' => false, + 'enumValueTitles' => ['InQueue' => 'InQueue', 'WaitRefresh' => 'WaitRefresh', 'FetchingData' => 'FetchingData', 'Completed' => 'Completed', 'Error' => 'Error', 'Embedding' => 'Embedding'], 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<String>', - 'description' => 'ResultCode<String>', + 'title' => 'ResultCode<PageVO<LibraryDocumentVO>>', + 'description' => 'Response data.', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'cost' => ['description' => 'Time spent on the request, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', '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', + 'title' => '', + 'description' => 'Response data.', + 'type' => 'object', + 'properties' => [ + 'currentPage' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'pageSize' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'records' => [ + 'title' => '', + 'description' => 'Records.', + 'type' => 'array', + 'items' => [ + 'description' => 'Data.', + 'type' => 'object', + 'properties' => [ + 'docId' => ['description' => 'Document ID.', 'type' => 'string', 'title' => '', 'example' => '29368126816'], + 'documentMeta' => ['description' => 'Document metadata.', 'type' => 'object', 'title' => '', 'example' => '{"a": "1"}'], + 'fileType' => ['description' => 'File type.', 'type' => 'string', 'title' => '', 'example' => 'pdf'], + 'gmtCreate' => ['description' => 'Creation time.', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], + 'gmtModified' => ['description' => 'Modification time.', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], + 'libraryId' => ['description' => 'Document library ID.', 'type' => 'string', 'title' => '', 'example' => 'sdfgsjdfg'], + 'statusCode' => ['description' => 'Document status. Valid values: WaitRefresh (waiting for refresh), InQueue (pending), FetchingData (retrieving data), Embedding (processing document), Error (failed), Completed (active), Null (unknown).', 'type' => 'string', 'title' => '', 'example' => 'WaitRefresh'], + 'title' => ['description' => 'Document title.', 'type' => 'string', 'title' => '', 'example' => '公司文档'], + 'url' => ['description' => 'Document URL.', 'type' => 'string', 'title' => '', 'example' => 'null'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'totalPages' => ['description' => 'Total number of pages.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'totalRecords' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + ], + 'example' => '', ], + 'dataType' => ['description' => 'Data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => '7ADF010C-FD89-569D-A079-2D4D5247E943'], + 'success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Query document list by metadata filters', + 'description' => 'Prerequisites'."\n" + ."\n" + .'You have activated Alibaba Cloud Model Studio and Tongyi Dianjin.'."\n" + ."\n" + .'To obtain the workspace ID, see [the document about obtaining the workspace ID](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFilterDocumentList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:GetFilterDocumentList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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', - ], + 'GetHistoryListByBizType' => [ + 'summary' => 'Retrieve conversation history records by business type.', + 'path' => '/{workspaceId}/api/history/list', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'title' => '业务空间', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ - 'name' => 'libraryId', + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'Number of records per page', 'type' => 'integer', 'format' => 'int32', 'default' => '10', 'title' => '', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'bizType', 'in' => 'query', 'schema' => [ - 'title' => '文档库id', - 'description' => '', + 'description' => 'Business type. Supported values are LlmChat and LibraryChat.', + 'enumValueTitles' => ['LlmChat' => 'LlmChat', 'LibraryChat' => 'LibraryChat'], 'type' => 'string', 'required' => true, - 'example' => 'skdfefxxx', + 'title' => '', + 'example' => 'LibraryChat', ], ], + [ + 'name' => 'bizId', + 'in' => 'query', + 'schema' => ['description' => 'Unique business identifier. When bizType is LibraryChat, bizId is the document library ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'GysYBsxx'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'ResultCode<PageVO<LlmHistoryVO>>', + 'description' => 'ResultCode\\<PageVO\\<LlmHistoryVo>>', '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', + 'cost' => ['description' => 'Response time in milliseconds', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => [ + 'title' => '', + 'description' => 'Response data', + 'type' => 'object', + 'properties' => [ + 'currentPage' => ['description' => 'Current page number', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'pageSize' => ['description' => 'Number of records per page', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'records' => [ + 'title' => '', + 'description' => 'Records', + 'type' => 'array', + 'items' => [ + 'description' => 'Data', + 'type' => 'object', + 'properties' => [ + 'bizId' => ['description' => 'Business ID', 'type' => 'string', 'title' => '', 'example' => 'GysYBsxx'], + 'bizType' => ['description' => 'Business type', 'type' => 'string', 'title' => '', 'example' => 'LibraryChat'], + 'extraMessage' => ['description' => 'Extension information', 'type' => 'any', 'title' => '', 'example' => 'null'], + 'gmtCreate' => ['description' => 'Creation time', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], + 'gmtModified' => ['description' => 'Last modified time', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'."\n"], + 'id' => ['description' => 'History record ID', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '210'], + 'llmAnswer' => ['description' => 'Large Language Model (LLM) response', 'type' => 'string', 'title' => '', 'example' => '你好。'], + 'llmPrompt' => ['description' => 'Prompt for the Large Language Model (LLM)', 'type' => 'string', 'title' => '', 'example' => '请使用以下上下文来回答最后的问题。\\n以下是上下文内容:'], + 'llmType' => ['description' => 'Large Language Model (LLM) type', 'type' => 'string', 'title' => '', 'example' => 'qwen-max'], + 'sessionId' => ['description' => 'Session ID', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'userQuery' => ['description' => 'User query', 'type' => 'string', 'title' => '', 'example' => '你是谁'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'totalPages' => ['description' => 'Total number of pages', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'totalRecords' => ['description' => 'Total number of records', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + ], + 'example' => '', ], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '9DF9B3F3-9FFE-52CB-A8DC-F7BD5F842F0E'], + 'success' => ['description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"currentPage\\": 1,\\n \\"pageSize\\": 10,\\n \\"records\\": [\\n {\\n \\"bizId\\": \\"GysYBsxx\\",\\n \\"bizType\\": \\"LibraryChat\\",\\n \\"extraMessage\\": \\"null\\",\\n \\"gmtCreate\\": \\"2024-01-01 00:00:00\\",\\n \\"gmtModified\\": \\"2024-01-01 00:00:00\\\\n\\",\\n \\"id\\": 210,\\n \\"llmAnswer\\": \\"你好。\\",\\n \\"llmPrompt\\": \\"请使用以下上下文来回答最后的问题。\\\\\\\\n以下是上下文内容:\\",\\n \\"llmType\\": \\"qwen-max\\",\\n \\"sessionId\\": \\"null\\",\\n \\"userQuery\\": \\"你是谁\\"\\n }\\n ],\\n \\"totalPages\\": 10,\\n \\"totalRecords\\": 100\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"9DF9B3F3-9FFE-52CB-A8DC-F7BD5F842F0E\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-01-01 00:00:00\\"\\n}","type":"json"}]', + 'title' => 'Retrieve conversation history by business type ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoryListByBizType'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetHistoryListByBizType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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', - ], + 'GetLibrary' => [ + 'summary' => 'Retrieves the detailed configuration of a document library, including its name, description, and index settings.', + 'path' => '/{workspaceId}/api/library/get', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + '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' => true, - 'example' => 'llm-xxxx', - ], + 'schema' => ['description' => 'Path parameter. The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'llm-xxxxx', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'libraryId', + 'in' => 'query', + 'schema' => ['description' => 'The document library ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cjshcxxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'ResultCode<LibraryVO>', + 'description' => 'The response data.', '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' => '', + 'cost' => ['description' => 'Response time in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => [ + 'title' => '', + 'description' => 'The response data object.', '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', + 'description' => ['description' => 'The document library description.', 'type' => 'string', 'title' => '', 'example' => '文档库的描述'], + 'documentCount' => ['description' => 'The number of documents in the library.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'gmtCreate' => ['description' => 'Creation time', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], + 'gmtModified' => ['description' => 'The last modification time in YYYY-MM-DD HH:MM:SS format.', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'."\n"], + 'id' => ['description' => 'The document library ID.', 'type' => 'string', 'title' => '', 'example' => '19386728376'], + 'indexSetting' => [ + 'title' => '', + 'description' => 'The document library index settings.', + 'type' => 'object', + 'properties' => [ + 'chunkStrategy' => [ + 'title' => '', + 'description' => 'The chunking strategy.', + 'type' => 'object', + 'properties' => [ + 'docTreeSplit' => ['description' => 'Enable layout-based splitting.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'docTreeSplitSize' => ['description' => 'The layout-based splitting size.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '160'], + 'enhanceGraph' => ['description' => 'Enhance images.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'enhanceTable' => ['description' => 'Enhance tables.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'overlap' => ['description' => 'The overlap length between chunks.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '40'], + 'sentenceSplit' => ['description' => 'Split by sentence.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'sentenceSplitSize' => ['description' => 'The sentence-based splitting size.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '160'], + 'size' => ['description' => 'The chunk size.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '256'], + 'split' => ['description' => 'Enable chunking.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], - 'value' => [ - 'title' => '标签的值', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', + 'example' => '', + ], + 'modelConfig' => [ + 'title' => '', + 'description' => 'Model configuration.', + 'type' => 'object', + 'properties' => [ + 'temperature' => ['description' => 'temperature', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.8'], + 'topP' => ['title' => 'topP', 'description' => 'topP', 'type' => 'number', 'format' => 'double', 'example' => '0.8'], ], + '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', + 'promptRoleStyle' => ['description' => 'The prompt role style.', 'type' => 'string', 'title' => '', 'example' => '你是一个信息处理专家。'], + 'queryEnhancer' => [ + 'title' => '', + 'description' => 'Query enhancement settings.', + 'type' => 'object', + 'properties' => [ + 'enableFollowUp' => ['description' => 'Enable multi-turn query enhancement.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'enableMultiQuery' => ['description' => 'Use Large Language Model (LLM) knowledge to decompose queries.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'enableOpenQa' => ['description' => 'Use Large Language Model (LLM) knowledge to answer questions.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'enableQueryRewrite' => ['description' => 'Rewrite queries using domain-specific knowledge.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'enableSession' => ['description' => 'Record session history.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'localKnowledgeId' => ['description' => 'The document library ID used for knowledge rewriting.', 'type' => 'string', 'title' => '', 'example' => '2836482634'], + 'withDocumentReference' => ['description' => 'Include document references in responses.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], - 'key' => [ - 'title' => '标签的key', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'city', + 'example' => '', + ], + 'recallStrategy' => [ + 'title' => '', + 'description' => 'The recall strategy.', + 'type' => 'object', + 'properties' => [ + 'documentRankType' => ['description' => 'The merge and sort policy.', 'type' => 'string', 'title' => '', 'example' => 'model'], + 'limit' => ['description' => 'The number of results returned after merging two recall paths.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], ], - 'operator' => [ - 'title' => '标签的操作符:文档库元信息key存储的value和您输入的value之间的关系', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'eq', + 'example' => '', + ], + 'textIndexSetting' => [ + 'title' => '', + 'description' => 'Text index settings.', + 'type' => 'object', + 'properties' => [ + 'category' => ['description' => 'The text index type.', 'type' => 'string', 'title' => '', 'example' => 'ElasticSearch'], + 'enable' => ['description' => 'Enable text indexing.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'indexAnalyzer' => ['description' => 'The text index analyzer: Standard, IkMaxWord, or IkSmart.', 'type' => 'string', 'title' => '', 'example' => 'IkMaxWord'], + 'rankThreshold' => ['description' => 'The ranking threshold for text indexing.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => 'null'], + 'searchAnalyzer' => ['description' => 'The text index search analyzer: Standard, IkMaxWord, or IkSmart.', 'type' => 'string', 'title' => '', 'example' => 'Standard'], + 'topK' => ['description' => 'The number of final summary results from text indexing.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], ], - 'value' => [ - 'title' => '标签的值', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', + 'example' => '', + ], + 'vectorIndexSetting' => [ + 'title' => '', + 'description' => 'Vector index settings.', + 'type' => 'object', + 'properties' => [ + 'category' => ['description' => 'The vector index source. We recommend ADB.', 'type' => 'string', 'title' => '', 'example' => 'ADB'], + 'embeddingType' => ['description' => 'The text embedding model for the vector index.', 'type' => 'string', 'title' => '', 'example' => 'DashScope'], + 'enable' => ['description' => 'Enable vector indexing.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'rankThreshold' => ['description' => 'The ranking threshold for vector indexing.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => 'null'], + 'topK' => ['description' => 'Number of final results returned by the vector index.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], ], + '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', + 'example' => '', ], + 'libraryName' => ['description' => 'The document library name.', 'type' => 'string', 'title' => '', 'example' => '测试文档库'], ], - 'required' => false, - ], - 'withDocumentReference' => [ - 'title' => '是否返回文档引用', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'example' => '', ], + 'dataType' => ['description' => 'The data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Fault type', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '44BD277A-87F9-5310-8D63-3E6645F1DA85'], + 'success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'UNIX timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], ], - 'required' => false, + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ResultCode<Object>', - 'description' => 'ResultCode<Object>', - 'type' => 'object', - 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'data' => [ - 'title' => '响应数据', - 'description' => '', - 'type' => 'any', - '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' => '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 \\"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"}]', + 'title' => 'Obtain document library details ', + 'description' => '**Prerequisites**'."\n" + ."\n" + .'- Activate the Alibaba Cloud Model Studio and Tongyi Dianjin services.'."\n" + ."\n" + .'- Obtain a [workspace identifier](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLibrary'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetLibrary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"{\\\\n \\\\\\"finish\\\\\\":true,\\\\n \\\\\\"text\\\\\\":\\\\\\"是的,记名预付卡的有效期不得低于3年。\\\\\\",\\\\n \\\\\\"message\\\\\\": \\\\\\"是的,记名预付卡的有效期不得低于3年。\\\\\\",\\\\n \\\\\\"queryResult\\\\\\":{\\\\n \\\\\\"errCode\\\\\\": \\\\\\"0\\\\\\",\\\\t//接口协议层面的错误码,正常为0,未授权,参数错误,服务器异常时会发生变化,可以忽略不处理\\\\n \\\\\\"message\\\\\\": \\\\\\"ok\\\\\\",\\\\t//接口协议层面的消息\\\\n \\\\\\"data\\\\\\":{\\\\n \\\\\\"success\\\\\\": true,\\\\t//有回答true 无回答false\\\\n \\\\\\"answer\\\\\\": null,\\\\t//大模型生成的回答结果\\\\n \\\\\\"embeddingElapsedMs\\\\\\": 127,\\\\n \\\\\\"vectorSearchElapsedMs\\\\\\": 2745,\\\\n \\\\\\"llmElapsedMs\\\\\\": 7911,\\\\n \\\\\\"totalElapsedMs\\\\\\": 10820,\\\\n \\\\\\"chunks\\\\\\": [\\\\t//召回的分块信息,一般为top5或top10,可联系我们调整效果\\\\n {\\\\n \\\\\\"chunkId\\\\\\": \\\\\\"470182177892469799\\\\\\",\\\\t//分块信息的编号\\\\n \\\\\\"docId\\\\\\": \\\\\\"22666332\\\\\\",\\\\t//分块关联的文档编号\\\\n \\\\\\"chunkText\\\\\\": \\\\\\"Profits plummeted in the first quarter, can\'t you bear it? In fact, previous rounds of price cuts have indeed had a certain impact on Tesla\'s financial data. Tesla has just released its financial report for the first quarter of this year. The data shows that in Q1 2023, Tesla achieved revenue of 23.33 billion US dollars, an increase of 24% over the previous year; Tesla delivered more than 422,000 electric vehicles worldwide in the first quarter, an increase of 36% over the previous year\\\\\\",\\\\t//新闻原始内容\\\\n \\\\\\"chunkMeta\\\\\\": {\\\\t// demo数据中的其他metadata\\\\n \\\\\\"language\\\\\\": \\\\\\"en\\\\\\",\\\\n \\\\\\"unique_id\\\\\\": \\\\\\"news_22666332_13\\\\\\",\\\\n \\\\\\"content_type\\\\\\": \\\\\\"news\\\\\\",\\\\n \\\\\\"stock_id_list\\\\\\": []\\\\n }\\\\n }],\\\\n \\\\\\"documents\\\\\\": [{\\\\n \\\\\\"docId\\\\\\": \\\\\\"1686637056086872065\\\\\\",\\\\t//文档编号\\\\n \\\\\\"gmtCreate\\\\\\": \\\\\\"2023-08-02 15:16:25\\\\\\",\\\\t//文档的创建时间\\\\n \\\\\\"libraryId\\\\\\": \\\\\\"a1b2c3\\\\\\",\\\\t//文档关联的知识库编号\\\\n \\\\\\"title\\\\\\": \\\\\\"2023年工银信用卡微信、京东绑卡消费累计积分活动\\\\\\",\\\\t//文档标题\\\\n \\\\\\"url\\\\\\": null\\\\t//文档连接,如有\\\\n }]\\\\t//块文本关联的文档\\\\n },\\\\n \\\\\\"success\\\\\\": true\\\\t//接口协议层面的成功/失败状态 true就是errCode为0\\\\n }\\\\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"}]', ], - 'GetHistoryListByBizType' => [ - 'summary' => '分页查询文档库列表', - 'path' => '/{workspaceId}/api/history/list', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetLibraryList' => [ + 'summary' => 'Retrieve the document library list. The list includes document names, descriptions, and unique identifiers.', + 'path' => '/{workspaceId}/api/library/list', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], + 'schema' => ['description' => 'Path parameter, the workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'page', 'in' => 'query', - 'schema' => [ - 'title' => '页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'title' => '页面大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'Number of records per page', 'type' => 'integer', 'format' => 'int32', 'default' => '10', 'title' => '', 'required' => false, 'example' => '10'], ], [ - 'name' => 'bizType', - 'in' => 'query', - 'schema' => [ - 'title' => '业务类型,目前支持:模型问答(LlmChat)、文档库问答(LibraryChat)', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'LlmChat' => 'LlmChat', - 'LibraryChat' => 'LibraryChat', - ], - 'example' => 'LibraryChat', - ], - ], - [ - 'name' => 'bizId', + 'name' => 'query', 'in' => 'query', - 'schema' => [ - 'title' => '业务唯一标识,当bizType为LibraryChat时,bizId指的是文档库id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'GysYBsxx', - ], + 'schema' => ['description' => 'Search keywords. Supports document library names and descriptions.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '测试文档库'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<PageVO<LlmHistoryVO>>', - 'description' => 'ResultCode<PageVO<LlmHistoryVO>>', + 'title' => 'ResultCode<PageVO<LibraryVO>>', + 'description' => 'ResultCode\\<PageVO>', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'cost' => ['description' => 'Time consumed', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], 'data' => [ - 'title' => '响应数据', - 'description' => '', + 'title' => '', + 'description' => 'Returned data', 'type' => 'object', 'properties' => [ - 'currentPage' => [ - 'title' => '当前页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'pageSize' => [ - 'title' => '每页记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'currentPage' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'pageSize' => ['description' => 'Number of records per page', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'records' => [ - 'title' => '记录', - 'description' => '', + 'title' => '', + 'description' => 'Record list', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Record', 'type' => 'object', 'properties' => [ - 'bizId' => [ - 'title' => '业务id', - 'description' => '', - 'type' => 'string', - 'example' => 'GysYBsxx', - ], - 'bizType' => [ - 'title' => '业务类型', - 'description' => '', - 'type' => 'string', - 'example' => 'LibraryChat', - ], - 'extraMessage' => [ - 'title' => '扩展信息', - 'description' => '', - 'type' => 'any', - 'example' => 'null', - ], - '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' => 'integer', - 'format' => 'int64', - 'example' => '210', - ], - 'llmAnswer' => [ - 'title' => '大模型回答', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'llmPrompt' => [ - 'title' => '大模型提示词', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'llmType' => [ - 'title' => '大模型类型', - 'description' => '', - 'type' => 'string', - 'example' => 'qwen-max', - ], - 'sessionId' => [ - 'title' => '会话id', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'userQuery' => [ - 'title' => '用户问题', - 'description' => '', - 'type' => 'string', + 'description' => ['description' => 'Document library description', 'type' => 'string', 'title' => '', 'example' => '文档库'], + 'documentCount' => ['description' => 'Document count', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'gmtCreate' => ['description' => 'Creation time', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'."\n"], + 'gmtModified' => ['description' => 'Modification time', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'."\n"], + 'id' => ['description' => 'Document library ID', 'type' => 'string', 'title' => '', 'example' => '24vs4aa42jv1rg7'], + 'indexSetting' => [ + 'title' => '', + 'description' => 'Document library index settings', + 'type' => 'object', + 'properties' => [ + 'chunkStrategy' => [ + 'title' => '', + 'description' => 'Chunking strategy', + 'type' => 'object', + 'properties' => [ + 'docTreeSplit' => ['description' => 'Layout chunking', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'docTreeSplitSize' => ['description' => 'Layout chunking size', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '160'], + 'enhanceGraph' => ['description' => 'Enhance images', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'enhanceTable' => ['description' => 'Enhance tables', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'overlap' => ['description' => 'Chunk overlap length', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '40'], + 'sentenceSplit' => ['description' => 'Split by sentence', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'sentenceSplitSize' => ['description' => 'Split by sentence size', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '160'], + 'size' => ['description' => 'Chunk size', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '256'], + 'split' => ['description' => 'Chunking enabled', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'example' => '', + ], + 'modelConfig' => [ + 'title' => '', + 'description' => 'Model Configuration', + 'type' => 'object', + 'properties' => [ + 'temperature' => ['description' => 'Temperature', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '0.8'], + 'topP' => ['title' => 'topP', 'description' => 'topP', 'type' => 'number', 'format' => 'double', 'example' => '0.8'], + ], + 'example' => '', + ], + 'promptRoleStyle' => ['description' => 'Prompt role style', 'type' => 'string', 'title' => '', 'example' => '你是一个信息处理专家。'."\n"], + 'queryEnhancer' => [ + 'title' => '', + 'description' => 'Query enhancement', + 'type' => 'object', + 'properties' => [ + 'enableFollowUp' => ['description' => 'Multi-turn enhancement', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'enableMultiQuery' => ['description' => 'Use Large Language Model (LLM) knowledge to decompose questions', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'enableOpenQa' => ['description' => 'Use Large Language Model (LLM) knowledge to answer questions', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'enableQueryRewrite' => ['description' => 'Rewrite questions based on domain knowledge', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'enableSession' => ['description' => 'Record session', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'localKnowledgeId' => ['description' => 'Document library ID used for knowledge rewriting', 'type' => 'string', 'title' => '', 'example' => 'sdbcjsbc'], + 'withDocumentReference' => ['description' => 'Include document reference', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'example' => '', + ], + 'recallStrategy' => [ + 'title' => '', + 'description' => 'Recall strategy', + 'type' => 'object', + 'properties' => [ + 'documentRankType' => ['description' => 'Merge and sort policy', 'type' => 'string', 'title' => '', 'example' => 'model'], + 'limit' => ['description' => 'Number of results from two-way merge summary', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + ], + 'example' => '', + ], + 'textIndexSetting' => [ + 'title' => '', + 'description' => 'Text index settings', + 'type' => 'object', + 'properties' => [ + 'category' => ['description' => 'Text index type', 'type' => 'string', 'title' => '', 'example' => 'ElasticSearch'], + 'enable' => ['description' => 'Text index enabled', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'indexAnalyzer' => ['description' => 'Index analyzer for text index: (Standard, IkMaxWord, IkSmart)', 'type' => 'string', 'title' => '', 'example' => 'Standard'], + 'rankThreshold' => ['description' => 'Text index sort threshold', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => 'null'], + 'searchAnalyzer' => ['description' => 'Search analyzer for text index: (Standard, IkMaxWord, IkSmart)', 'type' => 'string', 'title' => '', 'example' => 'Standard'], + 'topK' => ['description' => 'Number of final summary results for text index', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + ], + 'example' => '', + ], + 'vectorIndexSetting' => [ + 'title' => '', + 'description' => 'Vector index settings', + 'type' => 'object', + 'properties' => [ + 'category' => ['description' => 'Vector index source. Recommended: ADB', 'type' => 'string', 'title' => '', 'example' => 'ADB'], + 'embeddingType' => ['description' => 'Vector index text embedding model', 'type' => 'string', 'title' => '', 'example' => 'DashScope'], + 'enable' => ['description' => 'Enabled', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'rankThreshold' => ['description' => 'Vector index sort threshold', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => 'null'], + 'topK' => ['description' => 'Number of final summary results for vector index', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + ], + 'example' => '', + ], + ], 'example' => '', ], + 'libraryName' => ['description' => 'Document library name', 'type' => 'string', 'title' => '', 'example' => '测试文档库'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'totalPages' => [ - 'title' => '总页数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'totalRecords' => [ - 'title' => '总记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], + 'totalPages' => ['description' => 'Total pages', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'totalRecords' => ['description' => 'Total records', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], ], + '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' => '9DF9B3F3-9FFE-52CB-A8DC-F7BD5F842F0E', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'time' => [ - 'title' => '时间戳', - 'description' => '', - 'type' => 'string', - 'example' => '2024-01-01 00:00:00', - ], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '0a06dfe817156528535968405edce3'], + 'success' => ['description' => 'Successful', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Retrieve document library list', + 'description' => 'Prerequisites'."\n" + ."\n" + .'- You must activate Alibaba Cloud Model Studio and Tongyi Dianjin services.'."\n" + ."\n" + .'- Obtain the workspaceId. For more information, see [workspace identity](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLibraryList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetLibraryList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"currentPage\\": 1,\\n \\"pageSize\\": 10,\\n \\"records\\": [\\n {\\n \\"bizId\\": \\"GysYBsxx\\",\\n \\"bizType\\": \\"LibraryChat\\",\\n \\"extraMessage\\": \\"null\\",\\n \\"gmtCreate\\": \\"2024-01-01 00:00:00\\",\\n \\"gmtModified\\": \\"2024-01-01 00:00:00\\\\n\\",\\n \\"id\\": 210,\\n \\"llmAnswer\\": \\"你好。\\",\\n \\"llmPrompt\\": \\"请使用以下上下文来回答最后的问题。\\\\\\\\n以下是上下文内容:\\",\\n \\"llmType\\": \\"qwen-max\\",\\n \\"sessionId\\": \\"null\\",\\n \\"userQuery\\": \\"你是谁\\"\\n }\\n ],\\n \\"totalPages\\": 10,\\n \\"totalRecords\\": 100\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"9DF9B3F3-9FFE-52CB-A8DC-F7BD5F842F0E\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-01-01 00:00:00\\"\\n}","type":"json"}]', ], - 'InvokePlugin' => [ - 'summary' => '插件调试接口', - 'path' => '/{workspaceId}/api/plugin/invoke', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetParseResult' => [ + 'summary' => 'Retrieve document parsing results. You can query the document\'s parsing status and obtain the parsing results.', + 'path' => '/{workspaceId}/api/library/document/getParseResult', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + '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', - ], + 'schema' => ['description' => 'Path parameter, the workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'params' => [ - 'title' => '请求参数', - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '', - ], - 'pluginId' => [ - 'title' => '插件标识符', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3mj87da7zr', - ], + 'docId' => ['description' => 'The document ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '873648346573245'], + 'libraryId' => ['description' => 'The document library ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'sjdgdsfg'], + 'useUrlResult' => ['description' => 'Specifies whether to return the result as a URL. If true, the parsing result is in resultUrl, and result is empty. If false, the parsing result is in result, and resultUrl is empty.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<JSONObject>', - 'description' => 'ResultCode<JSONObject>', + 'title' => 'ResultCode<DocumentParseResultVO>', + 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'dataType' => ['description' => 'The data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'time' => ['description' => 'The timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], 'data' => [ - 'title' => '响应数据', - 'description' => '', + 'title' => '', + 'description' => 'The response data.', 'type' => 'object', - 'example' => '{\'jobWaiting\': [0, 0], \'timestamps\': [1713383820, 1713383880], \'jobUsage\': [0, 0], \'quotaUsage\': [123, 32]}', - ], - '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' => '915AAAB9-4908-5224-9E53-9E9D7D0AA94B', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'time' => [ - 'title' => '时间戳', - 'description' => '', - 'type' => 'string', - 'example' => '2024-04-24 11:54:34', + 'properties' => [ + 'fileType' => ['description' => 'The file type.', 'type' => 'string', 'title' => '', 'example' => 'pdf'], + 'providerType' => ['description' => 'The provider type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'b0a202e2-5031-4589-a6d7-39185f0d8d01'], + 'result' => ['description' => 'The parsing result.', 'type' => 'object', 'title' => '', 'example' => '{'."\n" + .' "Status": "Success",'."\n" + .' "Data": {},'."\n" + .' "Message": null,'."\n" + .' "TaskId": "docmind-20240601-123abc"'."\n" + .' }'], + 'status' => ['description' => 'The document parsing status.', 'type' => 'string', 'title' => '', 'example' => 'WaitRefresh'], + 'resultUrl' => ['description' => 'The parsing result returned as a URL. You can download it directly. Note: Only PDF, DOC, DOCX, PPT, and PPTX file types have parsing results.', 'type' => 'string', 'example' => 'https://xxx.oss-cn-beijing.aliyuncs.com/library/3mjeoywx7z/1826661605606129665.json', 'title' => ''], + ], + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0abb793617204049360065953ec6dd'], + 'cost' => ['description' => 'The time consumed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Obtain document parsing result ', + 'description' => '**Prerequisites**'."\n" + ."\n" + .'- You have activated Alibaba Cloud Model Studio and Tongyi Gold services.'."\n" + ."\n" + .'- Obtain the workspace ID. For more information, see [the workspace identity document](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [ + ['createdAt' => '2024-11-14T09:02:12.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetParseResult'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:GetParseResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"915AAAB9-4908-5224-9E53-9E9D7D0AA94B\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', ], - 'EndToEndRealTimeDialog' => [ - 'summary' => '端到端实时对话', - 'path' => '/{workspaceId}/ws/realtime/dialog', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - 'websocket', - ], + 'GetQualityCheckTaskResult' => [ + 'summary' => 'Retrieve quality check results.', + 'path' => '/{workspaceId}/api/qualitycheck/task/query', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'text/event-stream', - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'autoTest' => false, - 'notSupportAutoTestReason' => 'websocket不支持自动化测试', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx'."\n", - ], + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxxxx'], ], [ - 'name' => 'asrModelId', + 'name' => 'taskId', 'in' => 'query', + 'schema' => ['description' => 'Task ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '17071319'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '语音识别模型id。默认为nls-base。目前支持paraformer-realtime-v2、paraformer-realtime-8k-v2等。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'paraformer-realtime-v1' => 'paraformer-realtime-v1', - 'nls-base' => 'nls-base', + 'title' => 'ResultCode<QualityQueryResponse>', + 'description' => 'ResultCode\\<qualityqueryresponse>\\</qualityqueryresponse>', + 'type' => 'object', + 'properties' => [ + 'cost' => ['description' => 'Processing time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => [ + 'title' => '', + 'description' => 'Response data', + 'type' => 'object', + 'properties' => [ + 'conversationList' => [ + 'title' => '', + 'description' => 'Original conversation content', + 'type' => 'object', + 'properties' => [ + 'callType' => [ + 'description' => 'Call type:', + 'enumValueTitles' => [1 => 'Inbound', 'Outbound'], + 'type' => 'string', + 'title' => '', + 'example' => '1', + ], + 'customerId' => ['description' => 'Customer ID', 'type' => 'string', 'title' => '', 'example' => '234234'], + 'customerName' => ['description' => 'Customer name', 'type' => 'string', 'title' => '', 'example' => '张三'], + 'customerServiceId' => ['description' => 'Agent ID', 'type' => 'string', 'title' => '', 'example' => '23984763826'], + 'customerServiceName' => ['description' => 'Agent name', 'type' => 'string', 'title' => '', 'example' => '李四'], + 'dialogueList' => [ + 'title' => '', + 'description' => 'Dialogue details list', + 'type' => 'array', + 'items' => [ + 'description' => 'Dialogue detail', + 'type' => 'object', + 'properties' => [ + 'begin' => ['description' => 'Start time of this utterance, in milliseconds relative to the start of the conversation', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'beginTime' => ['description' => 'Start time of this utterance', 'type' => 'string', 'title' => '', 'example' => '2024-09-27 11:23:20'], + 'content' => ['description' => 'Dialogue content', 'type' => 'string', 'title' => '', 'example' => '您好,我是2001,很高兴为您服务!'], + 'customerId' => ['description' => 'Unique identifier for the dialogue role', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'customerServiceId' => ['description' => 'Agent ID', 'type' => 'string', 'title' => '', 'example' => '李四'], + 'customerServiceType' => [ + 'description' => 'Agent type', + 'enumValueTitles' => ['Bot', 'Human'], + 'type' => 'string', + 'title' => '', + 'example' => '0', + ], + 'end' => ['description' => 'End time of this utterance, in milliseconds relative to the start of the conversation', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'id' => ['description' => 'Unique identifier for this utterance. Assigned internally', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'role' => [ + 'description' => 'Role', + 'enumValueTitles' => ['Customer', 'Agent'], + 'type' => 'string', + 'title' => '', + 'example' => '0', + ], + 'type' => [ + 'description' => 'Content type', + 'enumValueTitles' => ['IMAGE' => 'Image', 'TEXT' => 'Text', 'AUDIO' => 'Voice'], + 'type' => 'string', + 'title' => '', + 'example' => 'TEXT', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'gmtService' => ['description' => 'Conversation time', 'type' => 'string', 'title' => '', 'example' => '2024-09-27 11:23:20'], + ], + 'example' => '', + ], + 'gmtCreate' => ['description' => 'Task creation time. This is when the task was submitted', 'type' => 'string', 'title' => '', 'example' => '2024-09-27 11:23:20'], + 'gmtEnd' => ['description' => 'System execution end time', 'type' => 'string', 'title' => '', 'example' => '2024-09-27 11:23:20'], + 'gmtStart' => ['description' => 'System execution start time', 'type' => 'string', 'title' => '', 'example' => '2024-09-27 11:23:20'], + 'qualityCheckList' => [ + 'title' => '', + 'description' => 'Quality check result set', + 'type' => 'array', + 'items' => [ + 'description' => 'Quality check result', + 'type' => 'object', + 'properties' => [ + 'checkExplanation' => ['description' => 'Reason for passing or failing the quality check', 'type' => 'string', 'title' => '', 'example' => '暂无'], + 'checkPassed' => [ + 'description' => 'Whether the quality check passed', + 'enumValueTitles' => ['NOT_PASSED' => 'Failed', 'PASSED' => 'Passed'], + 'type' => 'string', + 'title' => '', + 'example' => 'PASSED', + ], + 'checkProcess' => ['description' => 'Description of the quality check process', 'type' => 'string', 'title' => '', 'example' => '暂无'], + 'checked' => [ + 'description' => 'Whether the rule matched', + 'enumValueTitles' => ['HIT' => 'Matched', 'NOT_HIT' => 'Not matched'], + 'type' => 'string', + 'title' => '', + 'example' => 'HIT', + ], + 'gmtEnd' => ['description' => 'Quality check completion time', 'type' => 'string', 'title' => '', 'example' => '2024-05-23 14:57:50'], + 'gmtStart' => ['description' => 'Quality check start time', 'type' => 'string', 'title' => '', 'example' => '2024-05-23 14:57:50'], + 'mode' => [ + 'description' => 'Internal quality check mode', + 'enumValueTitles' => ['Large Language Model (LLM) quality check'], + 'type' => 'string', + 'title' => '', + 'example' => '0', + ], + 'originDialogue' => [ + 'title' => '', + 'description' => 'Original dialogue list', + 'type' => 'array', + 'items' => [ + 'description' => 'Original dialogue', + 'type' => 'object', + 'properties' => [ + 'begin' => ['description' => 'Start time of this utterance, in milliseconds relative to the start of the conversation', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'beginTime' => ['description' => 'Start time of this utterance', 'type' => 'string', 'title' => '', 'example' => '2024-05-23 14:57:50'], + 'content' => ['description' => 'Dialogue content', 'type' => 'string', 'title' => '', 'example' => '您好,我是2001,很高兴为您服务!'], + 'customerId' => ['description' => 'Unique identifier for the dialogue role', 'type' => 'string', 'title' => '', 'example' => 'xxx'], + 'customerServiceId' => ['description' => 'Agent ID', 'type' => 'string', 'title' => '', 'example' => '23876432'], + 'customerServiceType' => [ + 'description' => 'Agent type', + 'enumValueTitles' => ['Bot', 'Human'], + 'type' => 'string', + 'title' => '', + 'example' => '0', + ], + 'end' => ['description' => 'End time of this utterance, in milliseconds relative to the start of the conversation', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'id' => ['description' => 'Unique identifier for this utterance. Assigned internally', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'role' => [ + 'description' => 'Role', + 'enumValueTitles' => ['Customer', 'Agent'], + 'type' => 'string', + 'title' => '', + 'example' => '0', + ], + 'type' => [ + 'description' => 'Content type', + 'enumValueTitles' => ['IMAGE' => 'Image', 'TEXT' => 'Text', 'AUDIO' => 'Voice'], + 'type' => 'string', + 'title' => '', + 'example' => 'TEXT', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'qualityGroupId' => ['description' => 'Quality check group ID', 'type' => 'string', 'title' => '', 'example' => 'warning_customers'], + 'ruleDescription' => ['description' => 'Quality check item description', 'type' => 'string', 'title' => '', 'example' => '进入检测预警客户流程'], + 'ruleId' => ['description' => 'Quality check item ID', 'type' => 'string', 'title' => '', 'example' => 'wcm_start'], + 'bizType' => ['title' => 'Rule business type ', 'description' => 'Rule business type', 'type' => 'string', 'example' => 'No'], + 'ruleType' => ['title' => 'Rule polarity type. 0: negative, 1: positive. ', 'description' => 'Rule direction. 0: negative, 1: positive', 'type' => 'string', 'example' => '0'], + 'subNodeCol' => [ + 'description' => 'Child node', + 'title' => 'Child node ', + 'type' => 'array', + 'items' => ['description' => 'Quality check result for the child node. Structure matches qualityCheckList', 'type' => 'any', 'example' => '{'."\n" + .' "ruleId": "wxx_regulatory_authorities",'."\n" + .' "ruleDescription": "具体某机构预警",'."\n" + .' "checked": "HIT",'."\n" + .' "checkProcess": "通过审查对话记录,客户主要询问了关于贷款资方信息和结清证明的问题,并表达了想要注销账户的意愿。在整个对话过程中,客户并未提及任何具体的部门名称,也没有明确表示要向部门投诉的意图。",'."\n" + .' "originDialogue": null,'."\n" + .' "checkPassed": "NOT_PASSED",'."\n" + .' "checkExplanation": null,'."\n" + .' "mode": "0",'."\n" + .' "gmtStart": "2024-12-02 10:38:39",'."\n" + .' "gmtEnd": "2024-12-02 10:38:43",'."\n" + .' "qualityGroupId": "warning_customers",'."\n" + .' "bizType": null,'."\n" + .' "ruleType": "0",'."\n" + .' "subNodeCol": null'."\n" + .' }', 'title' => ''], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'status' => [ + 'description' => 'Task status', + 'enumValueTitles' => ['CANCELLED' => 'Cancelled', 'INIT' => 'Initializing', 'COMPLETED' => 'Completed', 'PROCESSING' => 'In progress', 'FAIL' => 'Failed'], + 'type' => 'string', + 'title' => '', + 'example' => 'INIT', + ], + 'taskId' => ['description' => 'Task ID', 'type' => 'string', 'title' => '', 'example' => '1703557101831'], + ], + 'example' => '', + ], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '67C7021A-D268-553D-8C15-A087B9604028'], + 'success' => ['description' => 'Whether the request succeeded', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], ], - 'example' => 'nls-base', - 'default' => 'nls-base', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"conversationList\\": {\\n \\"callType\\": \\"1\\",\\n \\"customerId\\": \\"234234\\",\\n \\"customerName\\": \\"张三\\",\\n \\"customerServiceId\\": \\"23984763826\\",\\n \\"customerServiceName\\": \\"李四\\",\\n \\"dialogueList\\": [\\n {\\n \\"begin\\": 0,\\n \\"beginTime\\": \\"2024-09-27 11:23:20\\",\\n \\"content\\": \\"您好,我是2001,很高兴为您服务!\\",\\n \\"customerId\\": \\"null\\",\\n \\"customerServiceId\\": \\"李四\\",\\n \\"customerServiceType\\": \\"0\\",\\n \\"end\\": 0,\\n \\"id\\": 1,\\n \\"role\\": \\"0\\",\\n \\"type\\": \\"TEXT\\"\\n }\\n ],\\n \\"gmtService\\": \\"2024-09-27 11:23:20\\"\\n },\\n \\"gmtCreate\\": \\"2024-09-27 11:23:20\\",\\n \\"gmtEnd\\": \\"2024-09-27 11:23:20\\",\\n \\"gmtStart\\": \\"2024-09-27 11:23:20\\",\\n \\"qualityCheckList\\": [\\n {\\n \\"checkExplanation\\": \\"暂无\\",\\n \\"checkPassed\\": \\"PASSED\\",\\n \\"checkProcess\\": \\"暂无\\",\\n \\"checked\\": \\"HIT\\",\\n \\"gmtEnd\\": \\"2024-05-23 14:57:50\\",\\n \\"gmtStart\\": \\"2024-05-23 14:57:50\\",\\n \\"mode\\": \\"0\\",\\n \\"originDialogue\\": [\\n {\\n \\"begin\\": 0,\\n \\"beginTime\\": \\"2024-05-23 14:57:50\\",\\n \\"content\\": \\"您好,我是2001,很高兴为您服务!\\",\\n \\"customerId\\": \\"xxx\\",\\n \\"customerServiceId\\": \\"23876432\\",\\n \\"customerServiceType\\": \\"0\\",\\n \\"end\\": 0,\\n \\"id\\": 1,\\n \\"role\\": \\"0\\",\\n \\"type\\": \\"TEXT\\"\\n }\\n ],\\n \\"qualityGroupId\\": \\"warning_customers\\",\\n \\"ruleDescription\\": \\"进入检测预警客户流程\\",\\n \\"ruleId\\": \\"wcm_start\\",\\n \\"bizType\\": \\"No\\",\\n \\"ruleType\\": \\"0\\",\\n \\"subNodeCol\\": [\\n \\"{\\\\n \\\\\\"ruleId\\\\\\": \\\\\\"wxx_regulatory_authorities\\\\\\",\\\\n \\\\\\"ruleDescription\\\\\\": \\\\\\"具体某机构预警\\\\\\",\\\\n \\\\\\"checked\\\\\\": \\\\\\"HIT\\\\\\",\\\\n \\\\\\"checkProcess\\\\\\": \\\\\\"通过审查对话记录,客户主要询问了关于贷款资方信息和结清证明的问题,并表达了想要注销账户的意愿。在整个对话过程中,客户并未提及任何具体的部门名称,也没有明确表示要向部门投诉的意图。\\\\\\",\\\\n \\\\\\"originDialogue\\\\\\": null,\\\\n \\\\\\"checkPassed\\\\\\": \\\\\\"NOT_PASSED\\\\\\",\\\\n \\\\\\"checkExplanation\\\\\\": null,\\\\n \\\\\\"mode\\\\\\": \\\\\\"0\\\\\\",\\\\n \\\\\\"gmtStart\\\\\\": \\\\\\"2024-12-02 10:38:39\\\\\\",\\\\n \\\\\\"gmtEnd\\\\\\": \\\\\\"2024-12-02 10:38:43\\\\\\",\\\\n \\\\\\"qualityGroupId\\\\\\": \\\\\\"warning_customers\\\\\\",\\\\n \\\\\\"bizType\\\\\\": null,\\\\n \\\\\\"ruleType\\\\\\": \\\\\\"0\\\\\\",\\\\n \\\\\\"subNodeCol\\\\\\": null\\\\n }\\"\\n ]\\n }\\n ],\\n \\"status\\": \\"INIT\\",\\n \\"taskId\\": \\"1703557101831\\"\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"67C7021A-D268-553D-8C15-A087B9604028\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-01-01 00:00:00\\"\\n}","type":"json"}]', + 'title' => 'Obtain quality inspection Result', + 'changeSet' => [ + ['createdAt' => '2024-12-17T12:52:56.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-19T13:39:23.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQualityCheckTaskResult'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ttsModelId', - 'in' => 'query', - 'schema' => [ - 'title' => '语音合成模型id。默认为nls-base。支持cosyvoice-v2。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'cosyvoice-v2' => 'cosyvoice-v2', - 'nls-base' => 'nls-base', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetQualityCheckTaskResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'nls-base', - 'default' => 'pcm', ], ], + ], + ], + 'GetSummaryTaskResult' => [ + 'summary' => 'Retrieves the result of a financial report summary task.', + 'path' => '/{workspaceId}/api/task/summary/result', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'inputFormat', - 'in' => 'query', - 'schema' => [ - 'title' => '输入音频格式,支持pcm/wav/mp3', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pcm', - 'default' => 'pcm', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'outputFormat', - 'in' => 'query', - 'schema' => [ - 'title' => '输出音频格式', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'wav', - 'default' => 'wav', - ], + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxxx'], ], [ - 'name' => 'sampleRate', + 'name' => 'taskId', 'in' => 'query', + 'schema' => ['description' => 'Task ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '17071319'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '采样率', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SAMPLE_RATE_16K', - 'default' => 'SAMPLE_RATE_16K', - 'enum' => [ - 'SAMPLE_RATE_16K', - 'SAMPLE_RATE_8K', - 'SAMPLE_RATE_24K', - 'SAMPLE_RATE_48K', + 'title' => 'ResultCode<ChatModelResponse>', + 'description' => 'ResultCode', + 'type' => 'object', + 'properties' => [ + 'cost' => ['description' => 'Time spent', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => [ + 'title' => '', + 'description' => 'Response data', + 'type' => 'object', + 'properties' => [ + 'choices' => [ + 'title' => '', + 'description' => 'Details of the content generated by the model.', + 'type' => 'array', + 'items' => [ + 'description' => 'Chat messages', + 'type' => 'object', + 'properties' => [ + 'finishReason' => ['description' => 'Reason why the model stopped generating content.', 'type' => 'string', 'title' => '', 'example' => 'stop'], + 'index' => ['description' => 'Sequence number of the generated result. Default is 0.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'message' => [ + 'title' => '', + 'description' => 'Message output by the model.', + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'Text generated by the model.', 'type' => 'string', 'title' => '', 'example' => '### **报告期经营业绩概述**\\n截至2024年3月31日止三个月的未经审核综合业绩显示强劲增长.'], + 'role' => ['description' => 'Role of the model. Always assistant.', 'type' => 'string', 'title' => '', 'example' => 'assistant'], + 'toolCalls' => [ + 'title' => '', + 'description' => 'Tool calling', + 'type' => 'array', + 'items' => ['description' => 'Tool calling', 'type' => 'object', 'example' => 'null', 'title' => ''], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'created' => ['description' => 'Creation time', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1726285125915'], + 'id' => ['description' => 'System-generated ID that identifies this call.', 'type' => 'string', 'title' => '', 'example' => '1202'], + 'modelId' => ['description' => 'Name of the model used in this call.', 'type' => 'string', 'title' => '', 'example' => 'qwen-max'], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '0bc13a9517168617617186457e401f'], + 'time' => ['description' => 'Time', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], + 'totalTokens' => ['description' => 'Token count', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '300'], + 'usage' => [ + 'title' => '', + 'description' => 'Token consumption', + 'type' => 'object', + 'properties' => [ + 'imageCount' => ['description' => 'Number of images, for models such as wanx', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'imageTokens' => ['description' => 'Image token count, for models such as qwen-vl', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'inputTokens' => ['description' => 'Input token count', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'outputTokens' => ['description' => 'Output token count', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'totalTokens' => ['description' => 'Total token count', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '300'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '0bc13a9517168617617186457e401f'], + 'success' => ['description' => 'Whether the operation succeeded', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], ], + 'example' => '', ], ], - [ - 'name' => 'voiceCode', - 'in' => 'query', - 'schema' => [ - 'title' => '音色参数值,仅限于支持字/句级别时间戳。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'longxiaochun_v2', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"choices\\": [\\n {\\n \\"finishReason\\": \\"stop\\",\\n \\"index\\": 0,\\n \\"message\\": {\\n \\"content\\": \\"### **报告期经营业绩概述**\\\\\\\\n截至2024年3月31日止三个月的未经审核综合业绩显示强劲增长.\\",\\n \\"role\\": \\"assistant\\",\\n \\"toolCalls\\": [\\n null\\n ]\\n }\\n }\\n ],\\n \\"created\\": 1726285125915,\\n \\"id\\": \\"1202\\",\\n \\"modelId\\": \\"qwen-max\\",\\n \\"requestId\\": \\"0bc13a9517168617617186457e401f\\",\\n \\"time\\": \\"2024-04-24 11:54:34\\",\\n \\"totalTokens\\": 300,\\n \\"usage\\": {\\n \\"imageCount\\": 0,\\n \\"imageTokens\\": 0,\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 200,\\n \\"totalTokens\\": 300\\n }\\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"}]', + 'title' => 'Retrieve Financial Report Summary Job Result ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSummaryTaskResult'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetSummaryTaskResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'GetTaskResult' => [ + 'summary' => 'Retrieves the result of an asynchronous task.', + 'path' => '/{workspaceId}/api/task/result', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'volume', - 'in' => 'query', - 'schema' => [ - 'title' => '音量,范围是0~100,可选,默认50。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - 'default' => '50', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'speechRate', - 'in' => 'query', - 'schema' => [ - 'title' => '朗读语速。'."\n" - .'● 当ttsModelId为nls-base时:范围是-500~500,默认是0。'."\n" - .'● 当ttsModelId为cosyvoice-v2时:'."\n" - .'指定合成音频的语速,取值范围:0.5~2。'."\n" - .' ○ 0.5:表示默认语速的0.5倍速。'."\n" - .' ○ 1:表示默认语速。默认语速是指模型默认输出的合成语速,语速会因发音人不同而略有不同。约每秒钟4个字。'."\n" - .' ○ 2:表示默认语速的2倍速。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxxx'], ], [ - 'name' => 'pitchRate', + 'name' => 'taskId', 'in' => 'query', - 'schema' => [ - 'title' => '朗读语调。'."\n" - .'● 当ttsModelId为nls-base时:'."\n" - .'范围是-500~500,默认是0。'."\n" - .'● 当ttsModelId为cosyvoice-v2时:指定合成音频的语调,取值范围:0.5~2。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '17071319'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'RealTimeDialogResp', - 'description' => 'RealTimeDialogResp', + 'title' => 'ResultCode<ChatModelResponse>', + 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '1C98B466-D6E0-5252-A60B-F345CBB33DDB', - ], + 'cost' => ['description' => 'The time consumed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => ['description' => 'The result of the asynchronous task.'."\n" + ."\n" + .'## PDF translation task'."\n" + ."\n" + .'The returned file\\_url is a downloadable file address.'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "file_url": "https://finllmworks.oss-cn-zhangjiakou.aliyuncs.com/render_pdf/5336180997111160501.pdf"'."\n" + .'}'."\n" + .'```', 'type' => 'object', 'example' => '{'."\n" + .' "file_url": "https://finllmworks.oss-cn-zhangjiakou.aliyuncs.com/render_pdf/5336180997111160501.pdf"'."\n" + .'}', 'title' => ''], + 'dataType' => ['description' => 'The data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '9D5D6BB5-BEAE-53C8-A70A-7275CC1F856C'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'The timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"file_url\\": \\"https://finllmworks.oss-cn-zhangjiakou.aliyuncs.com/render_pdf/5336180997111160501.pdf\\"\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"9D5D6BB5-BEAE-53C8-A70A-7275CC1F856C\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', + 'title' => 'Retrieve Result', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTaskResult'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetTaskResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1C98B466-D6E0-5252-A60B-F345CBB33DDB\\"\\n}","type":"json"}]', ], - 'RunDialogAnalysis' => [ - 'summary' => '流式获取外呼会话分析结果', - 'path' => '/{workspaceId}/api/virtualHuman/dialog/stream/analysis', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'GetTaskStatus' => [ + 'summary' => 'Gets the status of a task.', + 'path' => '/{workspaceId}/api/task/status', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/octet-stream', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxx', - ], + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxxx'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '请求体参数。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'sessionId' => [ - 'title' => '会话ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1759457905S001vejpvd6vej', - ], - ], - 'required' => false, - ], + 'name' => 'taskId', + 'in' => 'query', + 'schema' => ['description' => 'Task ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '17071319'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<DialogAnalysisResult>', - 'description' => 'ResultCode<DialogAnalysisResult>', + 'title' => 'ResultCode<String>', + 'description' => 'ResultCode\\<string>', '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', - ], + 'cost' => ['description' => 'Execution time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], 'data' => [ - 'title' => '响应数据', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'dialogAnalysisRespList' => [ - 'title' => '会话分析结果列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '会话分析结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'sessionId' => [ - 'title' => '会话ID', - 'description' => '', - 'type' => 'string', - 'example' => '1759457905S001vejpvd6vej', - ], - 'gmtCreate' => [ - 'title' => '会话的创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-04-24 11:54:34'."\n", - ], - 'status' => [ - 'title' => '会话分析的任务执行状态', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'success' => 'success', - 'pending' => 'pending', - 'error' => 'error', - ], - 'example' => 'success', - ], - 'analysisResp' => [ - 'title' => '会话分析的结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'dialogLabels' => [ - 'title' => '会话标签列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '会话标签', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'title' => '标签名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'value' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], - 'dialogSummary' => [ - 'title' => '会话摘要', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'dialogExecPlan' => [ - 'title' => '会话执行计划', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'dialogSop' => [ - 'title' => '会话SOP', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'dialogProcessAnalysis' => [ - 'title' => '会话过程分析', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'title' => '会话过程分析内容', - 'description' => '', - 'type' => 'any', - 'example' => '', - ], - ], - 'dialogOpenAnalysis' => [ - 'title' => '会话开放分析', - 'description' => '', - 'type' => 'object', - 'additionalProperties' => [ - 'title' => '会话开放分析内容', - 'description' => '', - 'type' => 'any', - 'example' => '', - ], - ], - ], - ], - 'failNode' => [ - 'title' => '失败节点列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '失败节点', - 'description' => '', - 'type' => 'string', - 'example' => 'DIALOG_OPEN_ANALYSIS', - ], - ], - ], - ], - ], - ], - ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '02CD4454-3F2C-57D0-9060-68DEAA1F6993', - ], - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'description' => 'Response data. The current status of the task.'."\n" + ."\n" + .'- invalid: Parameters or dependent resources are unavailable.'."\n" + ."\n" + .'- success: The task completed successfully.'."\n" + ."\n" + .'- evict: The task was canceled.'."\n" + ."\n" + .'- error: The task failed.'."\n" + ."\n" + .'- running: The task is running.'."\n" + ."\n" + .'- pending: The task is queued.', + 'enumValueTitles' => ['running' => 'running', 'pending' => 'pending', 'invalid' => 'invalid', 'error' => 'error', 'evict' => 'evict'], + 'type' => 'string', + 'title' => '', + 'example' => 'running', + ], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '30F6AD44-F078-540D-B5A5-1E519C8E9E6D'], + 'success' => ['description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"running\\",\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"30F6AD44-F078-540D-B5A5-1E519C8E9E6D\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', + 'title' => 'Obtain Job Status', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTaskStatus'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetTaskStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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 \\"dialogAnalysisRespList\\": [\\n {\\n \\"sessionId\\": \\"1759457905S001vejpvd6vej\\",\\n \\"gmtCreate\\": \\"2024-04-24 11:54:34\\\\n\\",\\n \\"status\\": \\"success\\",\\n \\"analysisResp\\": {\\n \\"dialogLabels\\": [\\n {\\n \\"name\\": \\"二级标签\\",\\n \\"value\\": \\"协商还款\\"\\n }\\n ],\\n \\"dialogSummary\\": \\"- 是否有资金需求:否\\\\\\\\\\\\\\\\n- 是否有意向:否,客户认为自己已经解决,对当前状态表示不解\\\\\\\\\\\\\\\\n- 是否可营销:否,对话中未表现出对营销信息的兴趣或接受度\\\\\\\\\\\\\\\\n- 待满足需求:客户希望在三天内解决问题\\",\\n \\"dialogExecPlan\\": \\"1. 核实客户账户信息,确认还款情况。\\\\\\\\\\\\\\\\n2. 若未收到还款,联系财务部门确认是否到账延迟。\\\\\\\\\\\\\\\\n3. 若已还款,更新客户记录并致歉。\\\\\\\\\\\\\\\\n4. 跟进客户,确保问题解决。\\",\\n \\"dialogSop\\": \\"营销\\",\\n \\"dialogProcessAnalysis\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"dialogues\\\\\\": [\\\\n {\\\\n \\\\\\"result\\\\\\": [\\\\n {\\\\n \\\\\\"value\\\\\\": \\\\\\"开场白\\\\\\",\\\\n \\\\\\"key\\\\\\": \\\\\\"客服\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"value\\\\\\": \\\\\\"拒绝\\\\\\",\\\\n \\\\\\"key\\\\\\": \\\\\\"客户\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"round\\\\\\": 1.0\\\\n },\\\\n {\\\\n \\\\\\"result\\\\\\": [\\\\n {\\\\n \\\\\\"value\\\\\\": \\\\\\"挽留\\\\\\",\\\\n \\\\\\"key\\\\\\": \\\\\\"客服\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"value\\\\\\": \\\\\\"中性\\\\\\",\\\\n \\\\\\"key\\\\\\": \\\\\\"客户\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"round\\\\\\": 2.0\\\\n }\\\\n ],\\\\n \\\\\\"dialogProcessAnalysisStr\\\\\\": \\\\\\"第一轮对话:客服-开场白,客户-拒绝\\\\\\\\\\\\\\\\n第二轮对话:客服-挽留,客户-中性\\\\\\"\\\\n}\\"\\n },\\n \\"dialogOpenAnalysis\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"dialogues\\\\\\": [\\\\n {\\\\n \\\\\\"result\\\\\\": [\\\\n {\\\\n \\\\\\"value\\\\\\": \\\\\\"开场白\\\\\\",\\\\n \\\\\\"key\\\\\\": \\\\\\"客服\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"value\\\\\\": \\\\\\"拒绝\\\\\\",\\\\n \\\\\\"key\\\\\\": \\\\\\"客户\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"round\\\\\\": 1.0\\\\n },\\\\n {\\\\n \\\\\\"result\\\\\\": [\\\\n {\\\\n \\\\\\"value\\\\\\": \\\\\\"挽留\\\\\\",\\\\n \\\\\\"key\\\\\\": \\\\\\"客服\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"value\\\\\\": \\\\\\"中性\\\\\\",\\\\n \\\\\\"key\\\\\\": \\\\\\"客户\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"round\\\\\\": 2.0\\\\n }\\\\n ],\\\\n \\\\\\"dialogProcessAnalysisStr\\\\\\": \\\\\\"第一轮对话:客服-开场白,客户-拒绝\\\\\\\\\\\\\\\\n第二轮对话:客服-挽留,客户-中性\\\\\\"\\\\n}\\"\\n }\\n },\\n \\"failNode\\": [\\n \\"DIALOG_OPEN_ANALYSIS\\"\\n ]\\n }\\n ]\\n },\\n \\"requestId\\": \\"02CD4454-3F2C-57D0-9060-68DEAA1F6993\\",\\n \\"cost\\": 0\\n}","type":"json"}]', ], - 'RunAgent' => [ - 'summary' => '运行智能体', - 'path' => '/{workspaceId}/api/bot/thread/run', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'InvokePlugin' => [ + 'summary' => 'Call a plugin and retrieve its response.', + 'path' => '/{workspaceId}/api/plugin/invoke', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/octet-stream', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxx', - ], + 'schema' => ['description' => 'Path parameter. The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '请求体参数', - 'description' => '', + 'description' => 'Request body parameters.', 'type' => 'object', 'properties' => [ - 'modelId' => [ - 'title' => '模型id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'qwen-plus', - ], - 'threadId' => [ - 'title' => '会话id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '4vlag5ken3', - ], - 'botId' => [ - 'title' => '智能体id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'd6zxykawk9', - ], - 'userContent' => [ - 'title' => '用户输入', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'stream' => [ - 'title' => '是否流式,默认为true', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'versionId' => [ - 'title' => '运行版本Id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w4paqoezm2', - ], - 'useDraft' => [ - 'title' => '是否使用草稿版本,草稿是指编辑区域最新的,没有发布的版本,不稳定', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'userInputs' => [ - 'title' => '用户定义的更复杂的输入参数', - 'type' => 'object', - ], + 'params' => ['description' => 'Request parameters.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" + .' "query": "介绍一下贵金属业务",'."\n" + .' "filters": ['."\n" + .' {'."\n" + .' "libraryId": "9xznrxw"'."\n" + .' }'."\n" + .' ],'."\n" + .' "topK": 1'."\n" + .' }'], + 'pluginId' => ['description' => 'The plugin ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '3mj87da7zr'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<AgentResponse>', - 'description' => 'ResultCode<AgentResponse>', + 'title' => 'ResultCode<JSONObject>', + 'description' => 'Result code.', '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' => 'object', - 'properties' => [ - 'versionId' => [ - 'title' => '智能体版本Id', - 'description' => '', - 'type' => 'string', - 'example' => 'w4paqoezm2', - ], - 'traceId' => [ - 'title' => '链路Id', - 'description' => '', - 'type' => 'string', - 'example' => '5bdb9809856c58acb92001f8ae65773c', - ], - 'threadId' => [ - 'title' => '会话Id', - 'description' => '', - 'type' => 'string', - 'example' => '4vlag5ken3', - ], - 'functionCallResponses' => [ - 'title' => '工具调用响应', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '工具调用响应', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'functionName' => [ - 'title' => '工具函数名称', - 'description' => '', - 'type' => 'string', - 'example' => 'web_search', - ], - 'displayName' => [ - 'title' => '工具函数展示名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'functionArgs' => [ - 'title' => '工具函数参数', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'result' => [ - 'title' => '工具调用结果', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'startTime' => [ - 'title' => '开始时间', - 'description' => '', - 'type' => 'string', - 'example' => '2025-01-21 16:37:14', - ], - 'endTime' => [ - 'title' => '结束时间', - 'description' => '', - 'type' => 'string', - 'example' => '2025-01-21 16:37:14', - ], - ], - ], - ], - 'response' => [ - 'title' => '模型响应', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'id' => [ - 'title' => '系统生成的标识本次调用的id。', - 'description' => '', - 'type' => 'string', - 'example' => 'd91d9afa-7cfc-4235-b012-a6f8e6ffa443', - ], - 'modelId' => [ - 'title' => '本次调用的模型名。', - 'description' => '', - 'type' => 'string', - 'example' => 'qwen-plus', - ], - 'choices' => [ - 'title' => '模型生成内容的详情。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '模型生成内容的详情。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'index' => [ - 'title' => '生成的结果序列编号,默认为0。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'message' => [ - 'title' => '模型输出的消息。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'role' => [ - 'title' => '模型的角色,固定为assistant。', - 'description' => '', - 'type' => 'string', - 'example' => 'assistant', - ], - 'roleDisplayName' => [ - 'title' => '模型的角色的展示名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'assistant', - ], - 'content' => [ - 'title' => '模型生成的文本。', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'finishReason' => [ - 'title' => '模型生成内容结束原因。', - 'description' => '', - 'type' => 'string', - 'example' => 'stop', - ], - ], - ], - ], - 'created' => [ - 'title' => '创建时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1737448637', - ], - 'time' => [ - 'title' => '时间', - 'description' => '', - 'type' => 'string', - 'example' => '2025-01-21T16:37:17.497206762', - ], - ], - ], - 'inputTokens' => [ - 'title' => '输入token', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '766', - ], - 'outputTokens' => [ - 'title' => '输出token', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '988', - ], - ], - ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => 'EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258', - ], - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'cost' => ['description' => 'Response time in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => ['description' => 'Response data.', 'type' => 'object', 'title' => '', 'example' => '{\'jobWaiting\': [0, 0], \'timestamps\': [1713383820, 1713383880], \'jobUsage\': [0, 0], \'quotaUsage\': [123, 32]}'], + 'dataType' => ['description' => 'Data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '915AAAB9-4908-5224-9E53-9E9D7D0AA94B'], + 'success' => ['description' => 'Indicates whether the call succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp in YYYY-MM-DD HH:MM:SS format.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"915AAAB9-4908-5224-9E53-9E9D7D0AA94B\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', + 'title' => 'Invoke Plugin', + 'description' => '**Prerequisites**'."\n" + ."\n" + .'- You have activated Alibaba Cloud Model Studio and Tongyi Dianjin services.'."\n" + ."\n" + .'- Obtain the workspace ID. For more information, see [Get the workspace ID](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InvokePlugin'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:InvokePlugin', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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\\": {\\n \\"versionId\\": \\"w4paqoezm2\\",\\n \\"traceId\\": \\"5bdb9809856c58acb92001f8ae65773c\\",\\n \\"threadId\\": \\"4vlag5ken3\\",\\n \\"functionCallResponses\\": [\\n {\\n \\"functionName\\": \\"web_search\\",\\n \\"displayName\\": \\"搜索引擎\\",\\n \\"functionArgs\\": \\"{\\\\\\\\\\\\\\"query\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2025年1月28日到2月3日天气预报\\\\\\\\\\\\\\"}\\",\\n \\"result\\": \\"下周天气晴朗\\",\\n \\"startTime\\": \\"2025-01-21 16:37:14\\",\\n \\"endTime\\": \\"2025-01-21 16:37:14\\"\\n }\\n ],\\n \\"response\\": {\\n \\"id\\": \\"d91d9afa-7cfc-4235-b012-a6f8e6ffa443\\",\\n \\"modelId\\": \\"qwen-plus\\",\\n \\"choices\\": [\\n {\\n \\"index\\": 0,\\n \\"message\\": {\\n \\"role\\": \\"assistant\\",\\n \\"roleDisplayName\\": \\"assistant\\",\\n \\"content\\": \\"下周天气都不错\\"\\n },\\n \\"finishReason\\": \\"stop\\"\\n }\\n ],\\n \\"created\\": 1737448637,\\n \\"time\\": \\"2025-01-21T16:37:17.497206762\\"\\n },\\n \\"inputTokens\\": 766,\\n \\"outputTokens\\": 988\\n },\\n \\"requestId\\": \\"EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258\\",\\n \\"cost\\": 0\\n}","type":"json"}]', ], - 'CreateDialog' => [ - 'summary' => '创建外呼会话', - 'path' => '/{workspaceId}/api/virtualHuman/dialog/create', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'PreviewDocument' => [ + 'summary' => 'Preview documents. Retrieve document download links, types, and titles. Use this operation to preview documents.', + 'path' => '/{workspaceId}/api/library/document/preview', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], + 'schema' => ['description' => 'Path parameter, workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxxxx'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'documentId', + 'in' => 'query', + 'schema' => ['description' => 'Document ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '8326472354762354'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'ResultCode<DocumentPreviewVO>', + 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ - 'playCode' => [ - 'title' => '剧本编码', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'live_broadcast_qa', - ], - 'channel' => [ - 'title' => '渠道', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'taobao', - ], - 'metaData' => [ - 'title' => '其他信息', - 'description' => '', + 'cost' => ['description' => 'Time consumed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => [ + 'title' => '', + 'description' => 'Returned data.', 'type' => 'object', - 'required' => false, - 'example' => 'null', - ], - 'qaLibraryList' => [ - 'title' => 'QA问答库ID列表,enableLibrary为true时,不得为空。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd86a4b9cd3', + 'properties' => [ + 'previewType' => ['description' => 'Preview type.', 'type' => 'string', 'title' => '', 'example' => 'pdf'], + 'title' => ['description' => 'Document title.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'uploadTime' => ['description' => 'Upload time.', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], + 'url' => ['description' => 'Document URL.', 'type' => 'string', 'title' => '', 'example' => 'https://agi.alicdn.com/user/d0o/d3c1f50d-a6c2-49b3-b0c8-3e613c3f20ee_16872_3236784461.png'], ], - 'required' => false, - ], - 'requestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ebf83826-dc1c-46f8-9759-0fb6da4c8xxx'."\n", - ], - 'enableLibrary' => [ - 'title' => '是否开启意图库,默认是false。', - 'type' => 'boolean', - 'required' => false, - 'default' => 'true', - ], - 'selfDirected' => [ - 'title' => '是否开启自主问答,默认是false。', - 'type' => 'boolean', - 'default' => 'false', + 'example' => '', ], + 'dataType' => ['description' => 'Data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => 'ff551395-1c8a-4f30-8ffd-ef7e87c70b4c'], + 'success' => ['description' => 'Is successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Time.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], ], - 'required' => false, + 'example' => '', ], ], ], + '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"}]', + 'title' => 'Preview document', + 'description' => '**Prerequisites**'."\n" + ."\n" + .'- You must activate Alibaba Cloud Model Studio and Tongyi Gold services.'."\n" + ."\n" + .'- Obtain the workspace ID. For more information, see [workspace identity](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PreviewDocument'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:PreviewDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ReIndex' => [ + 'summary' => 'Reindexing reprocesses the specified document by parsing it, splitting it into chunks, and building a new index.', + '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' => ['description' => 'Path parameter. The ID of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxxxx'], + ], + [ + 'name' => 'documentId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the document.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '8326472354762354'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<DiaBaseResult>', - 'description' => 'ResultCode<DiaBaseResult>', + 'title' => 'ResultCode<ResultCodeEnum>', + 'description' => 'The response object.', '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' => 'object', - 'properties' => [ - 'sessionId' => [ - 'title' => '会话ID', - 'description' => '', - 'type' => 'string', - 'example' => '1728545917713234', - ], - 'openingRemarks' => [ - 'title' => '开场白', - 'type' => 'string', - ], - ], - ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '003D019A-1BB3-53EC-A0D2-CE76DA5D73B1', - ], - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'cost' => ['description' => 'Processing time', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => ['description' => 'The response data.', 'type' => 'string', 'title' => '', 'example' => 'True'], + 'dataType' => ['description' => 'The data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '32FFC91D-0A9F-585A-B84F-8A54C5187035'], + 'success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'The timestamp in YYYY-MM-DD HH:MM:SS format.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'Reindex', + 'description' => 'Before you use this operation, review the billing method and pricing for Tongyi Dianjin.'."\n" + ."\n" + .'**Prerequisites**'."\n" + ."\n" + .'- You have activated Alibaba Cloud Model Studio and Tongyi Dianjin.'."\n" + ."\n" + .'- You have obtained a workspace ID: Retrieve the [workspace identifier](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReIndex'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:ReIndex', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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\\": {\\n \\"sessionId\\": \\"1728545917713234\\",\\n \\"openingRemarks\\": \\"你好,我是XX客服人员。\\"\\n },\\n \\"requestId\\": \\"003D019A-1BB3-53EC-A0D2-CE76DA5D73B1\\",\\n \\"cost\\": 0\\n}","type":"json"}]', ], 'RealTimeDialog' => [ - 'summary' => '实时对话', + 'summary' => 'Starts a real-time session. After you create a session by calling the CreateDialog API, use this API to conduct the real-time interaction.', 'path' => '/{workspaceId}/api/realtime/dialog/chat', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'text/event-stream', - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['text/event-stream', 'application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '请求体参数。', - 'description' => '', + 'title' => '', + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'bizType' => [ - 'title' => '业务类型,默认mixIntentChat。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mixIntentChat', - 'default' => 'mixIntentChat', - ], - 'analysis' => [ - 'title' => '是否分析', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - 'recommend' => [ - 'title' => '推荐意图', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - 'metaData' => [ - 'title' => '元信息,用于封装提示词。', - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '', - ], - 'stream' => [ - 'title' => '是否流式返回', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'bizType' => ['description' => 'The business type. The default value is mixIntentChat.', 'type' => 'string', 'example' => 'mixIntentChat', 'default' => 'mixIntentChat', 'title' => '', 'required' => false], + 'analysis' => ['description' => 'Specifies whether to perform analysis.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], + 'recommend' => ['description' => 'The recommended intent.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], + 'metaData' => ['description' => 'The metadata used to encapsulate prompts.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" + .' "phoneTailNumber": "机主尾号:98X1",'."\n" + .' "preScreeningQuota": "预审额度:3万",'."\n" + .' "generalInterest": "平台一般利息:20.4%"'."\n" + .' }'], + 'stream' => ['description' => 'Specifies whether to return the response in a stream.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], 'conversationModel' => [ - 'title' => '对话列表', - 'description' => '', + 'title' => '', + 'description' => 'The list of conversations.', 'type' => 'array', 'items' => [ - 'title' => '对话', - 'description' => '', + 'title' => '', + 'description' => 'A conversation.', 'type' => 'object', 'properties' => [ 'role' => [ - 'title' => '角色。0表示客户,1表示坐席。', - 'description' => '', + 'description' => 'The role. 0 indicates the customer, and 1 indicates the customer service representative.', 'type' => 'integer', 'format' => 'int32', 'required' => true, + 'enum' => ['0', '1'], + 'title' => '', 'example' => '0', - 'enum' => [ - '0', - '1', - ], - ], - 'intentionCode' => [ - 'title' => '意图编码', - 'type' => 'string', - 'required' => false, - 'example' => '1983746378992743', ], + 'intentionCode' => ['title' => 'Intent Code ', 'description' => 'The intent code.', 'type' => 'string', 'required' => false, 'example' => '198379874354'], 'customerServiceType' => [ - 'title' => '坐席类型,0: 机器人,1: 人工。', - 'description' => '', + 'description' => 'The type of the customer service representative. 0: bot, 1: human.', 'type' => 'string', + 'enum' => ['0', '1'], + 'title' => '', 'required' => false, 'example' => '0', - 'enum' => [ - '0', - '1', - ], - ], - 'customerServiceId' => [ - 'title' => '客服ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1374683645635', - ], - 'customerId' => [ - 'title' => '对话角色的唯一标识', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '98457834685635', - ], - 'content' => [ - 'title' => '对话的具体内容', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', ], + 'customerServiceId' => ['description' => 'The ID of the customer service representative. This parameter is **required**.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1374683645635'], + 'customerId' => ['description' => 'The unique ID of the conversation role. This parameter is **required**.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '98457834685635'], + 'content' => ['description' => 'The specific content of the conversation.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '人工客服'], 'type' => [ - 'title' => '对话内容的类型[Text(文本),Audio(音频),Image(图片)]', - 'description' => '', + 'description' => 'The type of the conversation content. Valid values: text, audio, and image.', 'type' => 'string', 'required' => true, + 'enum' => ['text', 'audio', 'image'], + 'title' => '', 'example' => 'audio', - 'enum' => [ - 'text', - 'audio', - 'image', - ], - ], - 'beginTime' => [ - 'title' => '这句话的开始时间', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-11-08 09:51:16', - ], - 'begin' => [ - 'title' => '本句话的开始时间,相对于会话开始点的偏移时间ms', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - 'end' => [ - 'title' => '本句话的结束时间,相对于会话开始点的偏移时间ms', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', ], + 'beginTime' => ['description' => 'The start time of this sentence.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2024-11-08 09:51:16'], + 'begin' => ['description' => 'The start time of the sentence, in milliseconds, relative to the start of the session.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '5'], + 'end' => ['description' => 'The end time of the sentence, in milliseconds, relative to the start of the session.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], ], 'required' => false, + 'example' => '', ], 'required' => true, + 'example' => '', ], - 'sessionId' => [ - 'title' => '会话ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '237645726354', - ], - 'dialogMemoryTurns' => [ - 'title' => '携带的会话历史轮数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'userVad' => [ - 'title' => '是否用户打断', - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], - 'scriptContentPlayed' => [ - 'title' => '上一句客服话术已经播报的部分', - 'type' => 'string', - ], - 'opType' => [ - 'title' => '操作类型,目前支持common/hierarchical', - 'type' => 'string', - 'example' => 'common', - 'default' => 'common', - ], + 'sessionId' => ['description' => 'The session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '237645726354'], + 'dialogMemoryTurns' => ['description' => 'The number of historical conversation turns to include.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '3'], + 'userVad' => ['title' => 'Indicates whether the user interrupted', 'description' => 'Specifies whether the user interrupted the conversation.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true'], + 'scriptContentPlayed' => ['title' => 'Portion of the previous customer service script that has already been played', 'description' => 'The part of the previous script from the customer service representative that has been played.', 'type' => 'string', 'required' => false, 'example' => '你好,我是'], + 'opType' => ['title' => 'Operation Type, currently supports common or hierarchical', 'description' => 'The operation type. Only common and hierarchical are supported.', 'type' => 'string', 'example' => 'common', 'default' => 'common', 'required' => false], ], 'required' => false, + 'example' => '', ], ], ], @@ -7147,402 +4899,176 @@ 'description' => 'IntentionChatResp', 'type' => 'object', 'properties' => [ - 'id' => [ - 'title' => '本次调用的唯一标识符。每个chunk对象有相同的id。', - 'description' => '', - 'type' => 'string', - 'example' => 'eb2b6139-ddf1-91a0-a47f-df7617ae9032', - ], + 'id' => ['description' => 'The unique identifier for this call. Each chunk object has the same ID.', 'type' => 'string', 'title' => '', 'example' => 'eb2b6139-ddf1-91a0-a47f-df7617ae9032'], 'choices' => [ - 'title' => '生成内容的数组,可包含一个或多个choices对象。', - 'description' => '', + 'title' => '', + 'description' => 'An array of generated content. It can contain one or more choice objects.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The generated content.', 'type' => 'object', 'properties' => [ - 'index' => [ - 'title' => '在choices列表中的序列编号。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'finishReason' => [ - 'title' => '会话结束时为stop,会话正在进行中为null;当success为false时,为错误信息。', - 'description' => '', - 'type' => 'string', - 'example' => 'stop', - ], + 'index' => ['description' => 'The sequence number in the choices list.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'finishReason' => ['description' => 'The value is \\`stop\\` if the session ends. The value is \\`null\\` if the session is in progress. If \\`success\\` is \\`false\\`, this parameter returns an error message.', 'type' => 'string', 'title' => '', 'example' => 'stop'], 'message' => [ - 'title' => '非流式时,返回的全量结果。', - 'description' => '', + 'title' => '', + 'description' => 'The full result returned for non-streaming responses. This is empty for streaming responses.', 'type' => 'object', 'properties' => [ - 'intentionCode' => [ - 'title' => '意图code', - 'description' => '', - 'type' => 'string', - 'example' => '1853360771162058752', - ], - 'intentionScript' => [ - 'title' => '意图话术', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'intentionName' => [ - 'title' => '意图名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'recommendIntention' => [ - 'title' => '推荐意图', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'recommendScript' => [ - 'title' => '推荐话术', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'analysisProcess' => [ - 'title' => '分析过程', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'selfDirectedScript' => [ - 'title' => '自主问答话术 增量数据', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'callTime' => [ - 'title' => 'time', - 'description' => 'time', - 'type' => 'string', - 'example' => '1735139569523', - ], - 'hangUpDialog' => [ - 'title' => '挂断对话', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'selfDirectedScriptFullContent' => [ - 'title' => '自主问答话术 全量数据', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'interrupt' => [ - 'title' => '是否打断', - 'type' => 'boolean', - ], - 'skipCurrentRecognize' => [ - 'title' => '是否跳过当前识别', - 'type' => 'boolean', - 'default' => 'false', - ], + 'intentionCode' => ['description' => 'The intent code.', 'type' => 'string', 'title' => '', 'example' => '1853360771162058752'], + 'intentionScript' => ['description' => 'The intent script.', 'type' => 'string', 'title' => '', 'example' => '抱歉,我没有明白您的意思,或者您可以拨打我们的客服热线,请客服人员为您解答。'], + 'intentionName' => ['description' => 'The intent name.', 'type' => 'string', 'title' => '', 'example' => '其它'], + 'recommendIntention' => ['description' => 'The recommended intent.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'recommendScript' => ['description' => 'The recommended script.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'analysisProcess' => ['description' => 'The analysis process.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'selfDirectedScript' => ['description' => 'The script for the Q\\&A pair. This is incremental data. This is empty for streaming responses.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'callTime' => ['title' => 'time', 'description' => 'The time.', 'type' => 'string', 'example' => '1735139569523'], + 'hangUpDialog' => ['description' => 'Hang up the dialog.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'selfDirectedScriptFullContent' => ['description' => 'The script for the Q\\&A pair. This is the full data.', 'type' => 'string', 'title' => '', 'example' => '关于宇宙的大小,这是一个非常深奥的科学话题'."\n"], + 'interrupt' => ['title' => 'is interrupted ', 'description' => 'Specifies whether the conversation was interrupted.', 'type' => 'boolean', 'example' => 'false'], + 'skipCurrentRecognize' => ['title' => 'is skip current recognition ', 'description' => 'Specifies whether to skip the current recognition.', 'type' => 'boolean', 'default' => 'false', 'example' => ''], ], + 'example' => '', ], 'delta' => [ - 'title' => '流式时,返回的增量结果。', - 'description' => '', + 'title' => '', + 'description' => 'The incremental result returned for streaming responses. This is empty for non-streaming responses.', 'type' => 'object', 'properties' => [ - 'intentionCode' => [ - 'title' => '意图code', - 'description' => '', - 'type' => 'string', - 'example' => '1853360771162058752', - ], - 'intentionScript' => [ - 'title' => '意图话术', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'intentionName' => [ - 'title' => '意图名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'recommendIntention' => [ - 'title' => '推荐意图', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'recommendScript' => [ - 'title' => '推荐话术', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'analysisProcess' => [ - 'title' => '分析过程', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'selfDirectedScript' => [ - 'title' => '自主问答话术 增量数据', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'callTime' => [ - 'title' => 'time', - 'description' => 'time', - 'type' => 'string', - 'example' => 'null', - ], - 'hangUpDialog' => [ - 'title' => '挂断对话', - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'selfDirectedScriptFullContent' => [ - 'title' => '自主问答话术 全量数据', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'interrupt' => [ - 'title' => '是否打断', - 'type' => 'boolean', - ], - 'skipCurrentRecognize' => [ - 'title' => '是否跳过当前识别', - 'type' => 'boolean', - 'default' => 'false', - ], + 'intentionCode' => ['description' => 'The intent code.', 'type' => 'string', 'title' => '', 'example' => '1853360771162058752'], + 'intentionScript' => ['description' => 'The intent script.', 'type' => 'string', 'title' => '', 'example' => '抱歉,我没有明白您的意思,或者您可以拨打我们的客服热线,请客服人员为您解答。'], + 'intentionName' => ['description' => 'The intent name.', 'type' => 'string', 'title' => '', 'example' => '其他'], + 'recommendIntention' => ['description' => 'The recommended intent.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'recommendScript' => ['description' => 'The recommended script.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'analysisProcess' => ['description' => 'The analysis process.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'selfDirectedScript' => ['description' => 'The script for the Q\\&A pair. This is incremental data.', 'type' => 'string', 'title' => '', 'example' => '话题'], + 'callTime' => ['title' => 'time', 'description' => 'The time.', 'type' => 'string', 'example' => 'null'], + 'hangUpDialog' => ['description' => 'Hangs up the dialog.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'selfDirectedScriptFullContent' => ['description' => 'The script for the Q\\&A pair. This is the full data.', 'type' => 'string', 'title' => '', 'example' => '关于宇宙的大小,这是一个非常深奥的科学话题'], + 'interrupt' => ['title' => 'is interrupt', 'description' => 'Specifies whether the conversation was interrupted.', 'type' => 'boolean', 'example' => 'false'], + 'skipCurrentRecognize' => ['title' => 'is skip current detect', 'description' => 'Specifies whether to skip the current recognition.', 'type' => 'boolean', 'default' => 'false', 'example' => 'false'], ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'created' => [ - 'title' => '本次请求被创建的时间戳', - 'description' => '', - 'type' => 'string', - 'example' => '1735139569523', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658', - ], + 'created' => ['description' => 'The timestamp when this request was created.', 'type' => 'string', 'title' => '', 'example' => '1735139569523'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"id\\": \\"eb2b6139-ddf1-91a0-a47f-df7617ae9032\\",\\n \\"choices\\": [\\n {\\n \\"index\\": 0,\\n \\"finishReason\\": \\"stop\\",\\n \\"message\\": {\\n \\"intentionCode\\": \\"1853360771162058752\\",\\n \\"intentionScript\\": \\"抱歉,我没有明白您的意思,或者您可以拨打我们的客服热线,请客服人员为您解答。\\",\\n \\"intentionName\\": \\"其它\\",\\n \\"recommendIntention\\": \\"null\\",\\n \\"recommendScript\\": \\"null\\",\\n \\"analysisProcess\\": \\"null\\",\\n \\"selfDirectedScript\\": \\"null\\",\\n \\"callTime\\": \\"1735139569523\\",\\n \\"hangUpDialog\\": false,\\n \\"selfDirectedScriptFullContent\\": \\"关于宇宙的大小,这是一个非常深奥的科学话题\\\\n\\",\\n \\"interrupt\\": false,\\n \\"skipCurrentRecognize\\": false\\n },\\n \\"delta\\": {\\n \\"intentionCode\\": \\"1853360771162058752\\",\\n \\"intentionScript\\": \\"抱歉,我没有明白您的意思,或者您可以拨打我们的客服热线,请客服人员为您解答。\\",\\n \\"intentionName\\": \\"其他\\",\\n \\"recommendIntention\\": \\"null\\",\\n \\"recommendScript\\": \\"null\\",\\n \\"analysisProcess\\": \\"null\\",\\n \\"selfDirectedScript\\": \\"话题\\",\\n \\"callTime\\": \\"null\\",\\n \\"hangUpDialog\\": false,\\n \\"selfDirectedScriptFullContent\\": \\"关于宇宙的大小,这是一个非常深奥的科学话题\\",\\n \\"interrupt\\": false,\\n \\"skipCurrentRecognize\\": false\\n }\\n }\\n ],\\n \\"created\\": \\"1735139569523\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658\\"\\n}","type":"json"}]', + 'title' => 'Real-time Session ', + 'description' => 'Before using this API, make sure you understand the billing methods and pricing of the Tongyi Gold service.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'Alibaba Cloud Model Studio and the Tongyi Gold service are activated.'."\n" + ."\n" + .'Obtain a workspaceId. For more information, see [Get an app ID and workspace](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [ + ['createdAt' => '2025-09-25T02:55:43.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-28T02:04:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-25T12:02:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RealTimeDialog'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:RealTimeDialog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"id\\": \\"eb2b6139-ddf1-91a0-a47f-df7617ae9032\\",\\n \\"choices\\": [\\n {\\n \\"index\\": 0,\\n \\"finishReason\\": \\"stop\\",\\n \\"message\\": {\\n \\"intentionCode\\": \\"1853360771162058752\\",\\n \\"intentionScript\\": \\"抱歉,我没有明白您的意思,或者您可以拨打我们的客服热线,请客服人员为您解答。\\",\\n \\"intentionName\\": \\"其它\\",\\n \\"recommendIntention\\": \\"null\\",\\n \\"recommendScript\\": \\"null\\",\\n \\"analysisProcess\\": \\"null\\",\\n \\"selfDirectedScript\\": \\"null\\",\\n \\"callTime\\": \\"1735139569523\\",\\n \\"hangUpDialog\\": false,\\n \\"selfDirectedScriptFullContent\\": \\"关于宇宙的大小,这是一个非常深奥的科学话题\\\\n\\",\\n \\"interrupt\\": false,\\n \\"skipCurrentRecognize\\": true\\n },\\n \\"delta\\": {\\n \\"intentionCode\\": \\"1853360771162058752\\",\\n \\"intentionScript\\": \\"抱歉,我没有明白您的意思,或者您可以拨打我们的客服热线,请客服人员为您解答。\\",\\n \\"intentionName\\": \\"其他\\",\\n \\"recommendIntention\\": \\"null\\",\\n \\"recommendScript\\": \\"null\\",\\n \\"analysisProcess\\": \\"null\\",\\n \\"selfDirectedScript\\": \\"话题\\",\\n \\"callTime\\": \\"null\\",\\n \\"hangUpDialog\\": false,\\n \\"selfDirectedScriptFullContent\\": \\"关于宇宙的大小,这是一个非常深奥的科学话题\\",\\n \\"interrupt\\": false,\\n \\"skipCurrentRecognize\\": false\\n }\\n }\\n ],\\n \\"created\\": \\"1735139569523\\",\\n \\"success\\": true,\\n \\"requestId\\": \\"5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658\\"\\n}","type":"json"}]', ], 'RealtimeDialogAssist' => [ - 'summary' => '实时会话辅助', + 'summary' => 'Provides real-time dialog assistance after a session is created using CreateDialog. Note: This operation returns multiple intents, tags, and SOP flows. Unlike real-time sessions, it does not support streaming responses.', 'path' => '/{workspaceId}/api/realtime/dialog/assist', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'text/event-stream', - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['text/event-stream', 'application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body parameters.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '0FC6636E-380A-5369-AE01-D1C15BB9B254', - ], - 'bizType' => [ - 'title' => '业务类型,IntentionBizTypeEnum[COMMON(通用意图识别),ATTITUDE(客户态度意图识别),BUSINESS(协商还款意图识别),MIX_INTENT_CHAT(混合问答),SIGNAL_LABLE(信令标签意图识别),DIALOG_ASSIST(对话辅助),code(code),desc(描述)]', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'dialogAssist', - ], - 'analysis' => [ - 'title' => '是否分析', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - 'metaData' => [ - 'title' => 'metaData', - 'description' => 'metaData', - 'type' => 'object', - 'required' => false, - 'example' => '', - ], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '0FC6636E-380A-5369-AE01-D1C15BB9B254'], + 'bizType' => ['description' => 'Business type. Currently, only dialogAssist is supported.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dialogAssist'], + 'analysis' => ['description' => 'Whether to analyze', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], + 'metaData' => ['title' => 'metaData', 'description' => 'metaData', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "phoneTailNumber": "机主尾号:98X1",'."\n" + .' "preScreeningQuota": "预审额度:3万",'."\n" + .' "generalInterest": "平台一般利息:20.4%"'."\n" + .' }'], 'conversationModel' => [ - 'title' => '对话列表', - 'description' => '', + 'title' => '', + 'description' => 'Dialog list', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Dialog', 'type' => 'object', 'properties' => [ - 'role' => [ - 'title' => '角色', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - 'customerServiceType' => [ - 'title' => '坐席类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], - 'customerServiceId' => [ - 'title' => '客服ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1374683645635', - ], - 'customerId' => [ - 'title' => '对话角色的唯一标识', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '98457834685635', - ], - 'content' => [ - 'title' => '对话的具体内容', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'type' => [ - 'title' => '对话内容的类型,DialogueTypeEnum[Text(文本),Audio(音频),Image(图片),code,desc]', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'text', - 'default' => 'text', - ], - 'beginTime' => [ - 'title' => '这句话的开始时间', - 'type' => 'string', - 'example' => '2025-12-12 09:00:00', - ], - 'begin' => [ - 'title' => '本句话的开始时间,相对于会话开始点的偏移时间ms', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'end' => [ - 'title' => '本句话的结束时间,相对于会话开始点的偏移时间ms', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'role' => ['description' => 'Role. 0 indicates customer, 1 indicates agent.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '0'], + 'customerServiceType' => ['description' => 'Agent type. 0: Robot, 1: Human.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '0'], + 'customerServiceId' => ['description' => 'Customer service ID', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1374683645635'], + 'customerId' => ['description' => 'Unique identity of the dialog role', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '98457834685635'], + 'content' => ['description' => 'Specific content of the dialog', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '你好'], + 'type' => ['description' => 'Type of dialog content. Currently, only text is supported.', 'type' => 'string', 'required' => false, 'example' => 'text', 'default' => 'text', 'title' => ''], + 'beginTime' => ['title' => 'Start time of this utterance ', 'description' => 'Start time of this utterance', 'type' => 'string', 'example' => '2025-12-12 09:00:00', 'required' => false], + 'begin' => ['title' => 'Start time of this utterance, expressed as an offset in milliseconds from the start point of the session ', 'description' => 'Start time of this utterance, offset in milliseconds from the session start.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], + 'end' => ['title' => 'End time of this utterance, expressed as an offset in milliseconds from the start point of the session ', 'description' => 'End time of this utterance, offset in milliseconds from the session start.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, + 'example' => '', ], - 'sessionId' => [ - 'title' => '会话ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1915593248420413441', - ], - 'dialogMemoryTurns' => [ - 'title' => '携带的会话历史轮数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], - 'userVad' => [ - 'title' => '是否用户打断', - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], - 'scriptContentPlayed' => [ - 'title' => '上一句客服话术已经播报的部分', - 'type' => 'string', - 'example' => '你好', - ], - 'hangUpDialog' => [ - 'title' => '挂断会话', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'sessionId' => ['description' => 'Session ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '1915593248420413441'], + 'dialogMemoryTurns' => ['description' => 'Number of historical dialog turns included', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'default' => '0', 'title' => '', 'required' => false], + 'userVad' => ['title' => 'Indicates whether the user interrupted ', 'description' => 'Whether the user interrupted', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true'], + 'scriptContentPlayed' => ['title' => 'The portion of the previous customer service script that has already been played', 'description' => 'Portion of the previous agent utterance already broadcast', 'type' => 'string', 'example' => '你好', 'required' => false], + 'hangUpDialog' => ['description' => 'Hang up the session', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -7550,1947 +5076,2236 @@ 200 => [ 'schema' => [ 'title' => 'ResultCode<DialogAssistResult>', - 'description' => 'ResultCode<DialogAssistResult>', + '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', - ], + 'success' => ['description' => 'Whether successful', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], 'data' => [ - 'title' => '响应数据', - 'description' => '', + 'title' => '', + 'description' => 'Response data', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => '请求唯一ID', - 'description' => '', - 'type' => 'string', - 'example' => '0FC6636E-380A-5369-AE01-D1C15BB9B254'."\n", - ], - 'sessionId' => [ - 'title' => '会话ID', - 'description' => '', - 'type' => 'string', - 'example' => '1915593248420413441', - ], - 'interrupt' => [ - 'title' => '是否打断', - 'type' => 'boolean', - ], + 'requestId' => ['description' => 'Unique request ID. This request ID matches the request ID in the input parameter.', 'type' => 'string', 'title' => '', 'example' => '0FC6636E-380A-5369-AE01-D1C15BB9B254'], + 'sessionId' => ['description' => 'Session ID', 'type' => 'string', 'title' => '', 'example' => '"1915593248420413441"'], + 'interrupt' => ['title' => 'Whether interrupted ', 'description' => 'Whether interrupted', 'type' => 'boolean', 'example' => 'true'], 'conversationModel' => [ - 'title' => '本轮对话内容', - 'description' => '', + 'title' => '', + 'description' => 'Current dialog content', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Specific content of the dialog', 'type' => 'object', 'properties' => [ - 'role' => [ - 'title' => '角色', - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'customerServiceType' => [ - 'title' => '坐席类型', - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'customerServiceId' => [ - 'title' => '客服ID', - 'description' => '', - 'type' => 'string', - 'example' => '1374683645635', - ], - 'customerId' => [ - 'title' => '对话角色的唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => '98457834685635', - ], - 'content' => [ - 'title' => '对话的具体内容', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'type' => [ - 'title' => '对话内容的类型', - 'description' => '', - 'type' => 'string', - 'example' => 'text', - ], - ], + 'role' => ['description' => 'Role. 0 indicates customer, 1 indicates agent.', 'type' => 'string', 'title' => '', 'example' => '"0"'], + 'customerServiceType' => ['description' => 'Agent type. 0: Robot, 1: Human.', 'type' => 'string', 'title' => '', 'example' => '"0"'], + 'customerServiceId' => ['description' => 'Customer service ID', 'type' => 'string', 'title' => '', 'example' => '"1374683645635"'], + 'customerId' => ['description' => 'Unique identity of the dialog role', 'type' => 'string', 'title' => '', 'example' => '"98457834685635"'], + 'content' => ['description' => 'Specific content of the dialog', 'type' => 'string', 'title' => '', 'example' => '你好'], + 'type' => ['description' => 'Type of dialog content', 'type' => 'string', 'title' => '', 'example' => 'text'], + ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], 'assistScripts' => [ - 'title' => '话术辅助结果', - 'description' => '', + 'title' => '', + 'description' => 'List of dialog assist results', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Dialog assist result', 'type' => 'object', 'properties' => [ - 'intentCode' => [ - 'title' => '意图编码', - 'description' => '', - 'type' => 'string', - 'example' => '1920005488515465216', - ], - 'intentName' => [ - 'title' => '意图名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'intentLabels' => [ - 'title' => '意图标签', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'assistScript' => [ - 'title' => '推荐话术', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'isDefault' => [ - 'title' => '是否意图逃逸', - 'description' => '', - 'type' => 'boolean', - ], + 'intentCode' => ['description' => 'Intent encoding', 'type' => 'string', 'title' => '', 'example' => '"1920005488515465216"'], + 'intentName' => ['description' => 'Intent name', 'type' => 'string', 'title' => '', 'example' => '礼貌问答'], + 'intentLabels' => ['description' => 'Intent labels', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'assistScript' => ['description' => 'Recommended utterance', 'type' => 'string', 'title' => '', 'example' => '可按照SOP流程回应。'], + 'isDefault' => ['description' => 'Whether intent escaped', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], 'assistSop' => [ - 'title' => '流程辅助结果', - 'description' => '', + 'title' => '', + 'description' => 'List of flow assist results', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Flow assist result', 'type' => 'object', 'properties' => [ - 'intentCode' => [ - 'title' => '意图编码', - 'description' => '', - 'type' => 'string', - 'example' => 'XXX', - ], - 'intentName' => [ - 'title' => '意图名称', - 'description' => '', - 'type' => 'string', - 'example' => 'XXX', - ], - 'assistSop' => [ - 'title' => '推荐流程', - 'description' => '', - 'type' => 'string', - 'example' => 'XXX', - ], - 'isDefault' => [ - 'title' => '是否意图逃逸', - 'description' => '', - 'type' => 'boolean', - ], + 'intentCode' => ['description' => 'Intent encoding', 'type' => 'string', 'title' => '', 'example' => 'XXX'], + 'intentName' => ['description' => 'Intent name', 'type' => 'string', 'title' => '', 'example' => 'XXX'], + 'assistSop' => ['description' => 'Recommended flow', 'type' => 'string', 'title' => '', 'example' => 'XXX'], + 'isDefault' => ['description' => 'Indicates whether the intent is to escape.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], + 'title' => '', + 'example' => '', ], - ], - 'analysisProcess' => [ - 'title' => '分析过程', - 'description' => '', - 'type' => 'string', 'example' => '', ], + 'analysisProcess' => ['description' => 'Analysis process', 'type' => 'string', 'title' => '', 'example' => '客户回答的内容与提供的意图列表描述均不匹配,没有表达出对账单、还款、天气或其他服务的具体需求或问题。'], ], + 'example' => '', ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '67C7021A-D268-553D-8C15-A087B9604028', - ], - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'requestId' => ['description' => 'Request ID. This is the system-recorded request ID. If issues arise, provide this ID to the Model Studio DianJin R\\&D team for troubleshooting.', 'type' => 'string', 'title' => '', 'example' => '67C7021A-D268-553D-8C15-A087B9604028'], + 'cost' => ['description' => 'Time consumed', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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 \\"requestId\\": \\"0FC6636E-380A-5369-AE01-D1C15BB9B254\\",\\n \\"sessionId\\": \\"\\\\\\"1915593248420413441\\\\\\"\\",\\n \\"interrupt\\": true,\\n \\"conversationModel\\": [\\n {\\n \\"role\\": \\"\\\\\\"0\\\\\\"\\",\\n \\"customerServiceType\\": \\"\\\\\\"0\\\\\\"\\",\\n \\"customerServiceId\\": \\"\\\\\\"1374683645635\\\\\\"\\",\\n \\"customerId\\": \\"\\\\\\"98457834685635\\\\\\"\\",\\n \\"content\\": \\"你好\\",\\n \\"type\\": \\"text\\"\\n }\\n ],\\n \\"assistScripts\\": [\\n {\\n \\"intentCode\\": \\"\\\\\\"1920005488515465216\\\\\\"\\",\\n \\"intentName\\": \\"礼貌问答\\",\\n \\"intentLabels\\": \\"null\\",\\n \\"assistScript\\": \\"可按照SOP流程回应。\\",\\n \\"isDefault\\": true\\n }\\n ],\\n \\"assistSop\\": [\\n {\\n \\"intentCode\\": \\"XXX\\",\\n \\"intentName\\": \\"XXX\\",\\n \\"assistSop\\": \\"XXX\\",\\n \\"isDefault\\": true\\n }\\n ],\\n \\"analysisProcess\\": \\"客户回答的内容与提供的意图列表描述均不匹配,没有表达出对账单、还款、天气或其他服务的具体需求或问题。\\"\\n },\\n \\"requestId\\": \\"67C7021A-D268-553D-8C15-A087B9604028\\",\\n \\"cost\\": 0\\n}","type":"json"}]', - ], - 'GetDialogDetail' => [ - 'summary' => '获取异步任务的结果', - 'path' => '/{workspaceId}/api/virtualHuman/dialog/detail', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'title' => 'Real-Time Session Assistance ', + 'description' => 'Before you use this API, make sure that you understand the billing methods and [pricing](https://help.aliyun.com/zh/model-studio/tongyi-dianjin-overview?spm=a2c4g.11186623.help-menu-2400256.d_1_6_6_0.15e77499sSMTGb) of Alibaba Cloud Model Studio DianJin.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'Activate the Alibaba Cloud Model Studio and Model Studio DianJin services.'."\n" + ."\n" + .'Obtain the [workspace identity](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8) to use as your workspaceId.', + 'changeSet' => [ + ['createdAt' => '2026-01-07T02:52:32.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:RealtimeDialogAssist', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'RebuildTask' => [ + 'summary' => 'Rebuilds an existing task. You cannot rebuild tasks that are queued or currently executing.', + 'path' => '/{workspaceId}/api/task/rebuild', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREsfmJIZ0TW'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'title' => '业务空间Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxx', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ - 'name' => 'sessionId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '会话ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1906623923815534xxx', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'taskIds' => [ + 'title' => '', + 'description' => 'A list of task IDs.', + 'type' => 'array', + 'items' => ['description' => 'A task ID.', 'type' => 'string', 'required' => false, 'example' => '3894763764', 'title' => ''], + 'required' => true, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<DialogDetailQueryResponse>', - 'description' => 'ResultCode<DialogDetailQueryResponse>', + 'title' => 'ResultCode<List<Map<String, Object>>>', + 'description' => 'ResultCode\\<List\\<Map\\<String, Object>>>', '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', - ], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'dataType' => ['description' => 'The data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'time' => ['description' => 'The timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], 'data' => [ - 'title' => '响应数据', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'totalDialogTurns' => [ - 'title' => '总对话轮次', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'validDialogTurns' => [ - 'title' => '有效对话轮次', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'dialogueList' => [ - 'title' => '对话明细', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'role' => [ - 'title' => '角色', - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'customerServiceType' => [ - 'title' => '坐席类型', - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'customerServiceId' => [ - 'title' => '客服ID', - 'description' => '', - 'type' => 'string', - 'example' => 'BOT', - ], - 'customerId' => [ - 'title' => '客户ID', - 'description' => '', - 'type' => 'string', - 'example' => '123761283', - ], - 'content' => [ - 'title' => '对话的具体内容', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'type' => [ - 'title' => '对话内容的类型', - 'description' => '', - 'type' => 'string', - 'example' => 'text', - ], - 'id' => [ - 'title' => '本句话的唯一标识,内部赋值', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1742869659849', - ], - 'recordId' => [ - 'title' => '本句话的唯一标识,内部赋值,String类型。', - 'type' => 'string', - 'example' => '19387872364736xdhcb', - ], - 'intentCode' => [ - 'title' => '意图code', - 'description' => '', - 'type' => 'string', - 'example' => '193874634xxx', - ], - 'intentName' => [ - 'title' => '意图名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'hangUpDialog' => [ - 'title' => '是否挂断:当句是否挂断会话标识', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - 'status' => [ - 'title' => '会话状态', - 'description' => '', - 'type' => 'string', - 'example' => 'COMPLETED', - 'enum' => [ - 'INIT', - 'PROCESSING', - 'COMPLETED', - 'ERROR', - ], - ], - 'gmtCreate' => [ - 'title' => '会话时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-09-27 11:23:20', - ], - ], - ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658', - ], - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', + 'title' => '', + 'description' => 'The data returned.', + 'type' => 'array', + 'items' => ['description' => 'The result of the rebuild task operation. \\`taskId\\` is the task ID. \\`status\\` indicates the operation status (\\`success\\` or \\`error\\`). \\`message\\` provides details.'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "message": "The task is being executed and cannot be rebuilt.",'."\n" + .' "taskId": "-253103935",'."\n" + .' "status": "error"'."\n" + .'}'."\n" + .'```', 'type' => 'object', 'title' => '', 'example' => '{'."\n" + .' "message": "任务正在执行中,不能重新构建",'."\n" + .' "taskId": "-253103935",'."\n" + .' "status": "error"'."\n" + .'}'], + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258'], + 'cost' => ['description' => 'The time consumed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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 {\\n \\"message\\": \\"任务正在执行中,不能重新构建\\",\\n \\"taskId\\": \\"-253103935\\",\\n \\"status\\": \\"error\\"\\n }\\n ],\\n \\"requestId\\": \\"EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258\\",\\n \\"cost\\": 0\\n}","type":"json"}]', + 'title' => 'Rebuild Job ', + 'description' => 'Before you use this API, review the billing methods and pricing for the Dianjin service.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'You have activated Alibaba Cloud Model Studio and the Dianjin service.'."\n" + ."\n" + .'You have obtained a workspace ID. For more information, see [Get an app ID and workspace](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebuildTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:RebuildTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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 \\"totalDialogTurns\\": 10,\\n \\"validDialogTurns\\": 5,\\n \\"dialogueList\\": [\\n {\\n \\"role\\": \\"0\\",\\n \\"customerServiceType\\": \\"0\\",\\n \\"customerServiceId\\": \\"BOT\\",\\n \\"customerId\\": \\"123761283\\",\\n \\"content\\": \\"请问具体怎么操作呢?\\",\\n \\"type\\": \\"text\\",\\n \\"id\\": 1742869659849,\\n \\"recordId\\": \\"19387872364736xdhcb\\",\\n \\"intentCode\\": \\"193874634xxx\\",\\n \\"intentName\\": \\"客户询问如何操作\\",\\n \\"hangUpDialog\\": true\\n }\\n ],\\n \\"status\\": \\"COMPLETED\\",\\n \\"gmtCreate\\": \\"2024-09-27 11:23:20\\"\\n },\\n \\"requestId\\": \\"5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658\\",\\n \\"cost\\": 0\\n}","type":"json"}]', ], - 'GetDialogLog' => [ - 'summary' => '查询会话日志', - 'path' => '/{workspaceId}/api/dialog/log', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'RecallDocument' => [ + 'summary' => 'You can retrieve document chunks from a document library using text. You can specify the number of chunks to retrieve, filter them by metadata conditions, and choose whether to complete the document chunks.', + 'path' => '/{workspaceId}/api/library/recallDocument', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxx', - ], + 'schema' => ['description' => 'Path parameter, workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '请求体内容', - 'description' => '', + 'description' => 'Request body parameters.', 'type' => 'object', 'properties' => [ - 'id' => [ - 'title' => '实时对话接口返回参数中id字段', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '175600129454077743fb03ac54955a4be72ec08f9c216', - ], - 'sessionId' => [ - 'title' => '会话ID', - 'description' => '', - 'type' => 'string', + 'filters' => [ + 'title' => '', + 'description' => 'Metadata filter conditions.', + 'type' => 'array', + 'items' => [ + 'description' => 'Filter.', + 'type' => 'object', + 'properties' => [ + 'and' => [ + 'title' => '', + 'description' => 'AND expression, used to filter documents/document chunks.', + 'type' => 'array', + 'items' => [ + 'description' => 'AND expression.', + 'type' => 'object', + 'properties' => [ + 'boost' => ['description' => 'Keyword weight.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '20', 'title' => ''], + 'key' => ['description' => 'The key of the metadata in the document library.', 'type' => 'string', 'required' => false, 'example' => 'docType', 'title' => ''], + 'operator' => ['description' => 'The relationship between the value stored in the document library metadata key and the value you enter.'."\n" + ."\n" + .'- eq: The value stored in the document library metadata key equals the value you enter.'."\n" + ."\n" + .'- lte: The value stored in the document library metadata key is less than or equal to the value you enter.'."\n" + ."\n" + .'- gte: The value stored in the document library metadata key is greater than or equal to the value you enter.'."\n" + ."\n" + .'- lt: The value stored in the document library metadata key is less than the value you enter.'."\n" + ."\n" + .'- gt: The value stored in the document library metadata key is greater than the value you enter.'."\n" + ."\n" + .'- contains: The list of values stored in the document library metadata key contains the value you enter.', 'type' => 'string', 'required' => false, 'example' => 'contains', 'title' => ''], + 'value' => ['description' => 'The value of the metadata you enter.', 'type' => 'string', 'required' => false, 'example' => '策略报告', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'chunkType' => ['description' => 'Document chunk type, used to filter document chunks, such as: Text, Graph, Table, FAQ.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Text'], + 'docIdList' => [ + 'title' => '', + 'description' => 'Document ID list, used to filter documents/document chunks.', + 'type' => 'array', + 'items' => ['description' => 'Document ID.', 'type' => 'string', 'required' => false, 'example' => '8372458573692819933', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'libraryId' => ['description' => 'Document library ID, used to filter documents/document chunks.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'sdbjhvs'], + 'or' => [ + 'title' => '', + 'description' => 'OR expression, used to filter documents/document chunks.', + 'type' => 'array', + 'items' => [ + 'description' => 'OR expression.', + 'type' => 'object', + 'properties' => [ + 'boost' => ['description' => 'Keyword weight.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '30', 'title' => ''], + 'key' => ['description' => 'The key of the metadata in the document library.', 'type' => 'string', 'required' => false, 'example' => 'researcher', 'title' => ''], + 'operator' => ['description' => 'The relationship between the value stored in the document library metadata key and the value you enter.'."\n" + ."\n" + .'- eq: The value stored in the document library metadata key equals the value you enter.'."\n" + ."\n" + .'- lte: The value stored in the document library metadata key is less than or equal to the value you enter.'."\n" + ."\n" + .'- gte: The value stored in the document library metadata key is greater than or equal to the value you enter.'."\n" + ."\n" + .'- lt: The value stored in the document library metadata key is less than the value you enter.'."\n" + ."\n" + .'- gt: The value stored in the document library metadata key is greater than the value you enter.'."\n" + ."\n" + .'- contains: The list of values stored in the document library metadata key contains the value you enter.', 'type' => 'string', 'required' => false, 'example' => 'eq', 'title' => ''], + 'value' => ['description' => 'The value of the metadata you enter.', 'type' => 'string', 'required' => false, 'example' => 'zhangsan', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'status' => [ + 'title' => '', + 'description' => 'Document status list, used to filter documents.', + 'type' => 'array', + 'items' => ['description' => 'Document status.', 'type' => 'string', 'required' => false, 'example' => 'WaitRefresh', 'title' => ''], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => true, - 'example' => '1758010668S001w4paq82azm', + 'example' => '', ], + 'query' => ['description' => 'Text.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '欧洲杯历史上有哪些球队因为球员的适应新文化而受益'], + 'rearrangement' => ['description' => 'Enable parent-child document chunk retrieval.'."\n" + ."\n" + .'- Parent-child document chunks: During document parsing, a complete semantic block, such as a paragraph or a section, might split into multiple document chunks. This depends on your chunking strategy. When you enable parent-child document retrieval, the system attempts to complete the semantic block of the retrieved document chunk. This makes the corpus more semantically complete when constructing prompts, improving answer completeness and accuracy.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], + 'topK' => ['description' => 'The number of document chunks to retrieve.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<IntentRecognize>', - 'description' => 'ResultCode<IntentRecognize>', + 'title' => 'ResultCode<LibraryDocumentRecallVO>', + 'description' => 'Returned data.', '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', - ], + 'cost' => ['description' => 'Time elapsed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], 'data' => [ - 'title' => '响应数据', - 'description' => '', + 'title' => '', + 'description' => 'Response data.', 'type' => 'object', 'properties' => [ - 'recallList' => [ - 'title' => '召回列表', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'intentionList' => [ - 'title' => '意图列表', - 'description' => '', + 'chunkList' => [ + 'title' => '', + 'description' => 'Chunk list.', 'type' => 'array', 'items' => [ - 'title' => '意图', - 'description' => '', + 'description' => 'Chunk.', 'type' => 'object', 'properties' => [ - 'intentionName' => [ - 'title' => '意图名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'intentionScript' => [ - 'title' => '意图话术(命中意图列表字段存在,并且 命中“其它”且开启自主问答,这里返回的是自主问答生成的话术)', - 'description' => '', - 'type' => 'string', + 'chunkId' => ['description' => 'Document chunk ID.', 'type' => 'string', 'title' => '', 'example' => '823746762354'], + 'chunkMeta' => ['description' => 'Document chunk metadata.', 'type' => 'object', 'title' => '', 'example' => '{"a":"1"}'], + 'chunkOssUrl' => ['description' => 'Document chunk OSS address.', 'type' => 'string', 'title' => '', 'example' => 'http://oss-xxx-hangzhou.com/xxx'], + 'chunkText' => ['description' => 'Document chunk text.', 'type' => 'string', 'title' => '', 'example' => '测试文档块'], + 'chunkType' => ['description' => 'Document chunk type.', 'type' => 'string', 'title' => '', 'example' => 'text'], + 'docId' => ['description' => 'Document ID.', 'type' => 'string', 'title' => '', 'example' => '839468263472'], + 'fileType' => ['description' => 'Document type.', 'type' => 'string', 'title' => '', 'example' => 'pdf'], + 'libraryId' => ['description' => 'Document library ID.', 'type' => 'string', 'title' => '', 'example' => 'dscsbdsk'], + 'libraryName' => ['description' => 'Document library name.', 'type' => 'string', 'title' => '', 'example' => '测试文档库'], + 'nextChunkId' => ['description' => 'Next document chunk ID.', 'type' => 'string', 'title' => '', 'example' => '982374872364'], + 'pos' => [ + 'title' => '', + 'description' => 'Document chunk position.', + 'type' => 'array', + 'items' => [ + 'description' => 'Document chunk position coordinates.', + 'type' => 'object', + 'properties' => [ + 'axisArray' => [ + 'title' => '', + 'description' => 'Coordinates.', + 'type' => 'array', + 'items' => ['description' => 'Coordinate value.', 'type' => 'number', 'format' => 'double', 'example' => '20.8', 'title' => ''], + 'example' => '', + ], + 'page' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'textHighlightArea' => [ + 'title' => '', + 'description' => 'Text highlight area, used for text-type file highlighting.', + 'type' => 'array', + 'items' => ['description' => 'Text highlight area data.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], 'example' => '', ], - 'description' => [ - 'title' => '意图描述', - 'description' => '', - 'type' => 'string', + 'preChunkId' => ['description' => 'Previous document chunk ID.', 'type' => 'string', 'title' => '', 'example' => '827364827364832'], + 'score' => ['description' => 'Document chunk score.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0.5'], + 'title' => ['description' => 'Document title.', 'type' => 'string', 'title' => '', 'example' => 'test'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'chunkPartList' => [ + 'title' => '', + 'description' => 'Chunk part (layout recognition result) list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Chunk part (layout recognition result).', + 'type' => 'object', + 'properties' => [ + 'chunkId' => ['description' => 'Document chunk ID.', 'type' => 'string', 'title' => '', 'example' => '98327482364'], + 'chunkMeta' => ['description' => 'Document chunk metadata.', 'type' => 'object', 'title' => '', 'example' => '{"a":"1"}'], + 'chunkOssUrl' => ['description' => 'Document chunk OSS address.', 'type' => 'string', 'title' => '', 'example' => 'http://oss-xxx-hangzhou.com/xxx'."\n"], + 'chunkText' => ['description' => 'Document chunk text.', 'type' => 'string', 'title' => '', 'example' => '测试文档块'."\n"], + 'chunkType' => ['description' => 'Document chunk type.', 'type' => 'string', 'title' => '', 'example' => 'text'], + 'docId' => ['description' => 'Document ID.', 'type' => 'string', 'title' => '', 'example' => '92837482364'], + 'fileType' => ['description' => 'Document type.', 'type' => 'string', 'title' => '', 'example' => 'pdf'], + 'libraryId' => ['description' => 'Document library ID.', 'type' => 'string', 'title' => '', 'example' => 'sjdhgjsd'], + 'libraryName' => ['description' => 'Document library name.', 'type' => 'string', 'title' => '', 'example' => '测试文档库'], + 'nextChunkId' => ['description' => 'Next document chunk ID.', 'type' => 'string', 'title' => '', 'example' => '2387648263542'], + 'pos' => [ + 'title' => '', + 'description' => 'Document chunk position.', + 'type' => 'array', + 'items' => [ + 'description' => 'Document chunk position data.', + 'type' => 'object', + 'properties' => [ + 'axisArray' => [ + 'title' => '', + 'description' => 'Coordinates.', + 'type' => 'array', + 'items' => ['description' => 'Coordinate value.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''], + 'example' => '', + ], + 'page' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'textHighlightArea' => [ + 'title' => '', + 'description' => 'Text highlight area, used for text-type file highlighting.', + 'type' => 'array', + 'items' => ['description' => 'Text highlight area position data.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], 'example' => '', ], + 'preChunkId' => ['description' => 'Previous document chunk ID.', 'type' => 'string', 'title' => '', 'example' => '32874682764'], + 'score' => ['description' => 'Document chunk score.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0.5'], + 'title' => ['description' => 'Document title.', 'type' => 'string', 'title' => '', 'example' => '测试文档标题'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'conversationList' => [ - 'title' => '对话内容', - 'description' => '', - 'type' => 'string', + 'chunkTextList' => [ + 'title' => '', + 'description' => 'Chunk text list.', + 'type' => 'array', + 'items' => ['description' => 'Document chunk', 'type' => 'string', 'example' => '这是一段测试文档块', 'title' => ''], 'example' => '', ], - 'hitIntentionList' => [ - 'title' => '命中意图列表', - 'description' => '', + 'documents' => [ + 'title' => '', + 'description' => 'Document list.', 'type' => 'array', 'items' => [ - 'title' => '命中意图', - 'description' => '', + 'description' => 'Document information.', 'type' => 'object', 'properties' => [ - 'intentionName' => [ - 'title' => '意图名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'intentionScript' => [ - 'title' => '意图话术(命中意图列表字段存在,并且 命中“其它”且开启自主问答,这里返回的是自主问答生成的话术)', - 'description' => '', - 'type' => 'string', + 'docId' => ['description' => 'Document ID.', 'type' => 'string', 'title' => '', 'example' => '92837482364'], + 'documentMeta' => ['description' => 'Document metadata.', 'type' => 'object', 'title' => '', 'example' => '{"a":"1"}'."\n"], + 'fileType' => ['description' => 'Document type.', 'type' => 'string', 'title' => '', 'example' => 'pdf'], + 'gmtCreate' => ['description' => 'Creation time.', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], + 'libraryId' => ['description' => 'Document library ID.', 'type' => 'string', 'title' => '', 'example' => 'sjdhgjsd'."\n"], + 'title' => ['description' => 'Document title.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'url' => ['description' => 'Document link.', 'type' => 'string', 'title' => '', 'example' => 'http://oss-xxx-hangzhou.com/test.pdf'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'embeddingElapsedMs' => ['description' => 'Vector computation time elapsed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'textChunkList' => [ + 'title' => '', + 'description' => 'List of chunks retrieved from the text index.', + 'type' => 'array', + 'items' => [ + 'description' => 'Chunk retrieved from the text index.', + 'type' => 'object', + 'properties' => [ + 'chunkId' => ['description' => 'Document chunk ID.', 'type' => 'string', 'title' => '', 'example' => '32874682364'], + 'chunkMeta' => ['description' => 'Document chunk metadata.', 'type' => 'object', 'title' => '', 'example' => '{"a":"1"}'."\n"], + 'chunkOssUrl' => ['description' => 'Document chunk OSS address.', 'type' => 'string', 'title' => '', 'example' => 'http://oss-xxx-hangzhou.com/xxx'."\n"], + 'chunkText' => ['description' => 'Document chunk text.', 'type' => 'string', 'title' => '', 'example' => '这是一段测试文档块'."\n"], + 'chunkType' => ['description' => 'Document chunk type.', 'type' => 'string', 'title' => '', 'example' => 'text'], + 'docId' => ['description' => 'Document ID.', 'type' => 'string', 'title' => '', 'example' => '8372467263542'], + 'fileType' => ['description' => 'Document type.', 'type' => 'string', 'title' => '', 'example' => 'pdf'], + 'libraryId' => ['description' => 'Document library ID.', 'type' => 'string', 'title' => '', 'example' => 'djsgfsjd'], + 'libraryName' => ['description' => 'Document library name.', 'type' => 'string', 'title' => '', 'example' => '测试文档库'], + 'nextChunkId' => ['description' => 'Next document chunk ID.', 'type' => 'string', 'title' => '', 'example' => '23874682432'], + 'pos' => [ + 'title' => '', + 'description' => 'Document chunk position.', + 'type' => 'array', + 'items' => [ + 'description' => 'Document chunk position.', + 'type' => 'object', + 'properties' => [ + 'axisArray' => [ + 'title' => '', + 'description' => 'Coordinates.', + 'type' => 'array', + 'items' => ['description' => 'Coordinate value.', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], + 'example' => '', + ], + 'page' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'textHighlightArea' => [ + 'title' => '', + 'description' => 'Text highlight area, used for text-type file highlighting.', + 'type' => 'array', + 'items' => ['description' => 'Text highlight area data.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], 'example' => '', ], - 'description' => [ - 'title' => '意图描述', - 'description' => '', - 'type' => 'string', + 'preChunkId' => ['description' => 'Previous document chunk ID.', 'type' => 'string', 'title' => '', 'example' => '89473868346'], + 'score' => ['description' => 'Document chunk score.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0.5'], + 'title' => ['description' => 'Document title.', 'type' => 'string', 'title' => '', 'example' => '测试文档标题'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'textSearchElapsedMs' => ['description' => 'Text search time elapsed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'totalElapsedMs' => ['description' => 'Total time elapsed, including vector computation time, vector search time, and text search time (depending on retrieval parameters).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '400'], + 'vectorChunkList' => [ + 'title' => '', + 'description' => 'List of chunks retrieved from the vector index.', + 'type' => 'array', + 'items' => [ + 'description' => 'Chunk retrieved from the vector index.', + 'type' => 'object', + 'properties' => [ + 'chunkId' => ['description' => 'Document chunk ID.', 'type' => 'string', 'title' => '', 'example' => '8723642345276'], + 'chunkMeta' => ['description' => 'Document chunk metadata.', 'type' => 'object', 'title' => '', 'example' => '{"a":"1"}'], + 'chunkOssUrl' => ['description' => 'Document chunk OSS address.', 'type' => 'string', 'title' => '', 'example' => 'https://oss-xxxx-hangzhou.com/test.pdf'], + 'chunkText' => ['description' => 'Document chunk text.', 'type' => 'string', 'title' => '', 'example' => '这是一段测试文本'], + 'chunkType' => ['description' => 'Document chunk type.', 'type' => 'string', 'title' => '', 'example' => 'text'], + 'docId' => ['description' => 'Document ID.', 'type' => 'string', 'title' => '', 'example' => '78326476235675372'], + 'fileType' => ['description' => 'Document type.', 'type' => 'string', 'title' => '', 'example' => 'pdf'], + 'libraryId' => ['description' => 'Document library ID.', 'type' => 'string', 'title' => '', 'example' => 'djsgfsjd'], + 'libraryName' => ['description' => 'Document library name.', 'type' => 'string', 'title' => '', 'example' => '测试文档库'], + 'nextChunkId' => ['description' => 'Next document chunk ID.', 'type' => 'string', 'title' => '', 'example' => '293846872343'], + 'pos' => [ + 'title' => '', + 'description' => 'Document chunk position.', + 'type' => 'array', + 'items' => [ + 'description' => 'Document chunk position coordinates.', + 'type' => 'object', + 'properties' => [ + 'axisArray' => [ + 'title' => '', + 'description' => 'Coordinates.', + 'type' => 'array', + 'items' => ['description' => 'Coordinate value.', 'type' => 'number', 'format' => 'double', 'example' => '48.8', 'title' => ''], + 'example' => '', + ], + 'page' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'textHighlightArea' => [ + 'title' => '', + 'description' => 'Text highlight area, used for text-type file highlighting.', + 'type' => 'array', + 'items' => ['description' => 'Text highlight area.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], 'example' => '', ], + 'preChunkId' => ['description' => 'Previous document chunk ID.', 'type' => 'string', 'title' => '', 'example' => '873647326542'], + 'score' => ['description' => 'Document chunk score.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0.5'], + 'title' => ['description' => 'Document title.', 'type' => 'string', 'title' => '', 'example' => 'test'], ], + 'title' => '', + 'example' => '', ], - ], - 'analysisProcess' => [ - 'title' => '分析过程(实时对话时开启分析过程开关则有值)', - 'description' => '', - 'type' => 'string', 'example' => '', ], - 'modelCostTime' => [ - 'title' => '模型调用耗时时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1382', - ], + 'vectorSearchElapsedMs' => ['description' => 'Vector search time elapsed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], ], + 'example' => '', ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '051EEB18-049A-17FF-A5E0-14A5B127C798', - ], - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'dataType' => ['description' => 'Data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => '0bc13a9517168617617186457e401f'], + 'success' => ['description' => 'Success.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'document recall ', + 'description' => '**Prerequisites**'."\n" + ."\n" + .'- Activate the Alibaba Cloud Model Studio service and the Tongyi Dianjin service.'."\n" + ."\n" + .'- Obtain the workspace ID. Obtain the [workspace identity](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%93%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecallDocument'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:RecallDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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\\": {\\n \\"recallList\\": \\"## Example:\\\\\\\\n- 对话内容为:\\\\\\\\\\\\\\"##客服##:您好,请问有什么可以帮到您?\\\\\\\\n ##客户##:暂时没有了。谢谢。\\\\\\\\\\\\\\"时,用户意图为:\\\\\\\\\\\\\\"客户想要挂断电话\\\\\\\\\\\\\\"\\\\\\\\n- 对话内容为:\\\\\\\\\\\\\\"##客服##:您好,请问有什么可以帮到您?\\\\\\\\n ##客户##:哎你好。\\\\\\\\\\\\\\"时,用户意图为:\\\\\\\\\\\\\\"客户询问来电目的\\\\\\\\\\\\\\"\\\\\\\\n- 对话内容为:\\\\\\\\\\\\\\"##客服##:您好,请问有什么可以帮到您?\\\\\\\\n ##客户##:我现在财务状况很好,谢谢关心。\\\\\\\\\\\\\\"时,用户意图为:\\\\\\\\\\\\\\"客户拒绝贷款\\\\\\\\\\\\\\"\\\\\\\\n- 对话内容为:\\\\\\\\\\\\\\"##客服##:您好,请问有什么可以帮到您?\\\\\\\\n ##客户##:不用了,谢谢,不要再打电话了,谢谢。\\\\\\\\\\\\\\"时,用户意图为:\\\\\\\\\\\\\\"投诉/退订/不要打电话/骂人\\\\\\\\\\\\\\"\\\\\\\\n- 对话内容为:\\\\\\\\\\\\\\"##客服##:您好,请问有什么可以帮到您?\\\\\\\\n ##客户##:你好。\\\\\\\\\\\\\\"时,用户意图为:\\\\\\\\\\\\\\"客户询问来电目的\\\\\\\\\\\\\\"\\",\\n \\"intentionList\\": [\\n {\\n \\"intentionName\\": \\"客户明确表示拒绝营销\\",\\n \\"intentionScript\\": \\"非常抱歉,给您带来了不好的体验。如您无需再接受我们的官方来电,请回复“我要退订”四个字!\\",\\n \\"description\\": \\"客户明确表示投诉/退订/不要打电话/骂人等拒绝营销\\"\\n }\\n ],\\n \\"conversationList\\": \\"##客服##:您好,请问是张三先生是吧?\\\\\\\\n ##客户##:人工客服\\\\\\\\n ##客服##:您好,我是2804,很高兴为您服务!\\\\\\\\n ##客服##:您好,请问有什么可以帮到您?\\\\\\\\n ##客户##:好的 谢谢\\\\\\\\n \\",\\n \\"hitIntentionList\\": [\\n {\\n \\"intentionName\\": \\"客户要求转人工\\",\\n \\"intentionScript\\": \\"很抱歉,我这里无法直接为您转接,您可以拨打我司客服热线进行咨询。\\\\n\\",\\n \\"description\\": \\"客户希望与真人接触,不想和AI客服继续对话。\\"\\n }\\n ],\\n \\"analysisProcess\\": \\"客户回答的内容与提供的意图列表描述均不匹配,没有表达出对账单、还款、天气或其他服务的具体需求或问题。\\",\\n \\"modelCostTime\\": 1382\\n },\\n \\"requestId\\": \\"051EEB18-049A-17FF-A5E0-14A5B127C798\\",\\n \\"cost\\": 0\\n}","type":"json"}]', ], - 'GetDialogAnalysisResult' => [ - 'summary' => '获取外呼会话分析结果', - 'path' => '/{workspaceId}/api/virtualHuman/dialog/analysis', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'RecognizeIntention' => [ + 'summary' => 'Detects intents. This operation supports global and hierarchical intent detection, attitude detection, and enterprise detection.', + 'path' => '/{workspaceId}/api/recog/intent', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxx', - ], + 'schema' => ['description' => 'Workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '请求体参数。', - 'description' => '', + 'description' => 'Request body.', 'type' => 'object', 'properties' => [ - 'sessionIds' => [ - 'title' => '会话id列表。useUrl为true时,返回ossUrl;支持1000个会话,超过1000个,返回前1000个会话的分析结果。useUrl为false时,返回会话分析结果;仅支持10个会话,超过10个,返回前10个会话的分析结果。非必填。sessionIds为空时根据起始时间和结束时间查询会话分析结果。不为空时,根据sessionIds查询会话分析结果。二者不可同时为空。', - 'description' => '', + 'analysis' => ['description' => 'Enable analysis.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], + 'bizType' => [ + 'description' => 'Business type.', + 'enumValueTitles' => ['common' => 'Intent detection', 'business' => 'Enterprise detection', 'attitude' => 'Attitude detection'], + 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => 'common', + ], + 'conversation' => ['description' => 'Conversation text.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '##客服##:您好,请问是朱杰先生吗?这里是诚信财务的周莉。我们发现您有一项款项昨天是账单日,但您还没还款,这很可能是一个小小的疏忽。来电是提醒您尽快完成还款,避免影响您的信用记录。\\n ##客户##:今天天气怎么样呢?'], + 'globalIntentionList' => [ + 'title' => '', + 'description' => 'Global intent list. Required when opType is hierarchical.', 'type' => 'array', 'items' => [ - 'title' => '会话ID。', - 'description' => '', - 'type' => 'string', + 'description' => 'Global intent.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'Intent description.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '正常付款3'], + 'intention' => ['description' => 'Intent name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '正常付款3'], + 'intentionCode' => ['description' => 'Intent code.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1810566978021232640'], + 'intentionScript' => ['title' => 'Intent Script', 'description' => 'Intent script.', 'type' => 'string', 'required' => false, 'example' => '好的,那先不打扰您了,祝您生活愉快!再见!'], + ], 'required' => false, - 'example' => '183764873624', + 'title' => '', + 'example' => '', ], 'required' => false, + 'example' => '', ], - 'useUrl' => [ - 'title' => '返回结果是否为ossUrl。为true时,返回结果ossUrl,链接有效期为1小时。默认为true;支持1000个会话,超过1000个,返回前1000个会话的分析结果。为false时,返回会话分析结果;仅支持10个会话,超过10个,返回前10个会话的分析结果。', - 'description' => '', - 'type' => 'boolean', + 'hierarchicalIntentionList' => [ + 'title' => '', + 'description' => 'Hierarchical intent list. Required when opType is hierarchical.', + 'type' => 'array', + 'items' => [ + 'description' => 'Hierarchical intent.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'Intent description.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '询问股票价格'], + 'intention' => ['description' => 'Intent name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '询问股票价格'], + 'intentionCode' => ['description' => 'Intent code.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1810929291010150400'], + 'intentionScript' => ['title' => 'Intent Script', 'description' => 'Intent script.', 'type' => 'string', 'required' => false, 'example' => '好的,那先不打扰您了,祝您生活愉快!再见!'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'true', - 'default' => 'true', + 'example' => '', ], - 'startTime' => [ - 'title' => '起始时间, 格式为yyyy-MM-dd HH:mm:ss。sessionIds不为空时,根据sessionIds查询会话分析结果。', - 'description' => '', - 'type' => 'string', + 'intentionList' => [ + 'title' => '', + 'description' => 'Intent list. Required when bizType is not attitude.', + 'type' => 'array', + 'items' => [ + 'description' => 'Intent.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'Intent description.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '客户表示忘记还款'], + 'intention' => ['description' => 'Intent name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '客户表示忘记还款'], + 'intentionCode' => ['description' => 'Intent code.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1808766224000262144'], + 'intentionScript' => ['title' => 'Intent script ', 'description' => 'Intent script.', 'type' => 'string', 'required' => false, 'example' => '好的,那先不打扰您了,祝您生活愉快!再见!'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '2024-09-14 09:11:00', + 'example' => '', ], - 'endTime' => [ - 'title' => '结束时间, 格式为yyyy-MM-dd HH:mm:ss。sessionIds不为空时,根据sessionIds查询会话分析结果。', - 'description' => '', + 'opType' => [ + 'description' => 'Operation type.', + 'enumValueTitles' => ['common' => 'Common', 'hierarchical' => 'Hierarchical'], 'type' => 'string', + 'example' => 'common', + 'default' => 'common', + 'title' => '', 'required' => false, - 'example' => '2024-09-23 09:20:02', - ], - 'asc' => [ - 'title' => '是否升序, 默认为true,按会话创建时间升序排序。为false时,按会话创建时间降序排序。', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', ], + 'recommend' => ['description' => 'Recommend intent.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], + 'intentionDomainCode' => ['title' => 'Intent library: Local intent library code ', 'description' => 'Intent library: Local intent library code.', 'type' => 'string', 'required' => false, 'example' => 'collection'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应体参数。', - 'description' => '', + 'title' => 'ResultCode<RecogResult>', + 'description' => 'Result code.', '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', - ], + 'cost' => ['description' => 'Processing time in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], 'data' => [ - 'title' => '响应数据', - 'description' => '', + 'title' => '', + 'description' => 'Response data.', 'type' => 'object', 'properties' => [ - 'dialogAnalysisRespList' => [ - 'title' => '会话分析结果列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '会话分析结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'sessionId' => [ - 'title' => '会话ID', - 'description' => '', - 'type' => 'string', - 'example' => '183764873624', - ], - 'gmtCreate' => [ - 'title' => '会话的创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-04-24 11:54:34'."\n", - ], - 'status' => [ - 'title' => '会话分析的任务执行状态。'."\n" - .'- init 表示未开始'."\n" - .'- pending 表示会话分析任务正在排队中'."\n" - .'- running 表示会话分析任务正在进行中'."\n" - .'- error 表示会话分析任务执行失败'."\n" - .'- success 表示会话分析任务执行成功', - 'description' => '', - 'type' => 'string', - 'example' => 'running', - 'enum' => [ - 'init', - 'pending', - 'running', - 'error', - 'success', - ], - ], - 'ossUrl' => [ - 'title' => '会话分析的结果,ossUrl形式,过期时间为一小时。', - 'description' => '', - 'type' => 'string', - 'example' => 'https://xxx.oss-cn-beijing.aliyuncs.com/dialog-analysis/2024-12-30/2/1826661605606129665', - ], - 'analysisResp' => [ - 'title' => '会话分析的结果', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'dialogLabels' => [ - 'title' => '会话标签列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '会话标签', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'title' => '标签名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'value' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - ], - ], - ], - 'dialogSummary' => [ - 'title' => '会话摘要', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'dialogExecPlan' => [ - 'title' => '会话执行计划', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'dialogSop' => [ - 'title' => '会话SOP', - 'type' => 'string', - ], - 'dialogProcessAnalysis' => [ - 'title' => '会话过程分析', - 'type' => 'object', - ], - 'dialogOpenAnalysis' => [ - 'title' => '会话开放分析', - 'type' => 'object', - ], - ], - ], - ], - ], - ], + 'analysisProcess' => ['description' => 'Analysis process.', 'type' => 'string', 'title' => '', 'example' => '客户回答的内容与提供的意图列表描述均不匹配,没有表达出对账单、还款、天气或其他服务的具体需求或问题。'], + 'intentionCode' => ['description' => 'Intent code.', 'type' => 'string', 'title' => '', 'example' => '-1'], + 'intentionName' => ['description' => 'Intent name.', 'type' => 'string', 'title' => '', 'example' => '其它'], + 'recommendIntention' => ['description' => 'Recommended intent.', 'type' => 'string', 'title' => '', 'example' => '客户试图回避谈论逾期还款的话题'], + 'recommendScript' => ['description' => 'Recommended script.', 'type' => 'string', 'title' => '', 'example' => '朱先生,理解您可能对天气感兴趣,但更重要的是您的账户情况。请让我们专注于您未偿还的款项,这对您的信用健康至关重要。'], + 'intentionScript' => ['title' => 'Intent script ', 'description' => 'Intent script.', 'type' => 'string', 'example' => '朱先生,理解您可能对天气感兴趣,但更重要的是您的账户情况。请让我们专注于您未偿还的款项,这对您的信用健康至关重要。'], ], + 'example' => '', ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '88A006F0-B565-53BA-B38A-DBDF9D0B2935', - ], - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'dataType' => ['description' => 'Data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => '003D019A-1BB3-53EC-A0D2-CE76DA5D73B1'], + 'success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"analysisProcess\\": \\"客户回答的内容与提供的意图列表描述均不匹配,没有表达出对账单、还款、天气或其他服务的具体需求或问题。\\",\\n \\"intentionCode\\": \\"-1\\",\\n \\"intentionName\\": \\"其它\\",\\n \\"recommendIntention\\": \\"客户试图回避谈论逾期还款的话题\\",\\n \\"recommendScript\\": \\"朱先生,理解您可能对天气感兴趣,但更重要的是您的账户情况。请让我们专注于您未偿还的款项,这对您的信用健康至关重要。\\",\\n \\"intentionScript\\": \\"朱先生,理解您可能对天气感兴趣,但更重要的是您的账户情况。请让我们专注于您未偿还的款项,这对您的信用健康至关重要。\\"\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"003D019A-1BB3-53EC-A0D2-CE76DA5D73B1\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', + 'title' => 'Intent recognition ', + 'description' => 'Before you use this operation, review the billing methods and pricing of Alibaba Cloud Tongyi Dianjin.'."\n" + ."\n" + .'**Prerequisites**'."\n" + ."\n" + .'- You have activated Alibaba Cloud Model Studio and Tongyi Dianjin.'."\n" + ."\n" + .'- You have obtained a [workspace ID](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [ + ['createdAt' => '2024-11-14T09:02:12.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecognizeIntention'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:RecognizeIntention', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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 \\"dialogAnalysisRespList\\": [\\n {\\n \\"sessionId\\": \\"183764873624\\",\\n \\"gmtCreate\\": \\"2024-04-24 11:54:34\\\\n\\",\\n \\"status\\": \\"running\\",\\n \\"ossUrl\\": \\"https://xxx.oss-cn-beijing.aliyuncs.com/dialog-analysis/2024-12-30/2/1826661605606129665\\",\\n \\"analysisResp\\": {\\n \\"dialogLabels\\": [\\n {\\n \\"name\\": \\"额度不足\\",\\n \\"value\\": \\"0\\"\\n }\\n ],\\n \\"dialogSummary\\": \\"- 是否有资金需求:不确定,客户未明确表示有无资金需求。\\\\\\\\n- 是否有意向:不确定,客户未明确表达意向。\\\\\\\\n- 是否可营销:不可营销,客户对客服的多次询问未表现出兴趣,且对话中提到因不适希望减少联系。\\\\\\\\n- 待满足需求:客户希望了解具体的预审额度信息。\\",\\n \\"dialogExecPlan\\": \\"1. 客服应再次确认客户的疑问是否已解决,特别是关于额度的具体数额。\\\\\\\\n2. 如果客户仍有疑问,提供客服热线电话,建议客户直接拨打以获取更详细的帮助。\\\\\\\\n3. 提醒客户检查短信中的链接,以便快速查看和操作。\\\\\\\\n4. 记录此次通话中客户表现出的任何不适或不便,确保后续跟进时更加体贴。\\\\\\\\n5. 发送一条包含操作指南的短信,确保客户能够轻松找到并使用服务。\\\\\\\\n6. 结束通话前,再次感谢客户的支持,并表达希望客户早日康复的愿望。\\",\\n \\"dialogSop\\": \\"产品介绍\\",\\n \\"dialogProcessAnalysis\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"dialogOpenAnalysis\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n }\\n ]\\n },\\n \\"requestId\\": \\"88A006F0-B565-53BA-B38A-DBDF9D0B2935\\",\\n \\"cost\\": 0\\n}","type":"json"}]', ], - 'CreateDialogAnalysisTask' => [ - 'summary' => '创建会话分析任务', - 'path' => '/{workspaceId}/api/virtualHuman/dialog/analysis/submit', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'RunAgent' => [ + 'summary' => 'Run an agent. This API supports both streaming and non-streaming responses.', + 'path' => '/{workspaceId}/api/bot/thread/run', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/octet-stream'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Request body parameters', 'type' => 'object', 'properties' => [ - 'metaData' => [ - 'title' => '元数据,用于会话分析过程中需要消费的一些业务相关的属性,由业务系统在发起会话分析任务的时候实时传入。', - 'description' => '', + 'modelId' => ['description' => 'Model ID. Optional. If empty, the agent uses the model from its configuration.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'qwen-plus'], + 'threadId' => ['description' => 'Thread ID. Optional. If empty, a new thread starts.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '4vlag5ken3'], + 'botId' => ['description' => 'Agent ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd6zxykawk9'], + 'userContent' => ['description' => 'User input', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '你是谁'], + 'stream' => ['description' => 'Enable streaming. Default is true.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'versionId' => ['description' => 'Version ID to run', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'w4paqoezm2'], + 'useDraft' => ['description' => 'Use the draft version. Drafts are unpublished versions in the editor. They are unstable. Default is false.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], + 'userInputs' => ['title' => 'User-defined complex input parameters', 'description' => 'More complex user-defined input parameters', 'type' => 'object', 'required' => false, 'example' => '{"name": "zhangsan"}'], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResultCode<AgentResponse>', + 'description' => 'ResultCode\\<agentresponse>\\</agentresponse>', + 'type' => 'object', + 'properties' => [ + 'success' => ['description' => 'Indicates success', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'data' => [ + 'title' => '', + 'description' => 'Response data', 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .'"labels": "XXX",'."\n" - .'"summaryConstraints": "XXX",'."\n" - .'"sopInfo": "XXX"'."\n" - .'}', - ], - 'playCode' => [ - 'title' => '会话场景编码,关联会话分析配置', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'common', - ], - 'analysisNodes' => [ - 'title' => '分析节点,默认为空,表示全部节点。可传入一个或者多个。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DIALOG_EXECUTION_PLAN' => '', - 'DIALOG_SUMMARY' => '', - 'DIALOG_SOP' => '', - 'DIALOG_LABEL' => '', + 'properties' => [ + 'versionId' => ['description' => 'Agent version ID', 'type' => 'string', 'title' => '', 'example' => 'w4paqoezm2'], + 'traceId' => ['description' => 'Trace ID', 'type' => 'string', 'title' => '', 'example' => '5bdb9809856c58acb92001f8ae65773c'], + 'threadId' => ['description' => 'Thread ID', 'type' => 'string', 'title' => '', 'example' => '4vlag5ken3'], + 'functionCallResponses' => [ + 'title' => '', + 'description' => 'Tool call responses', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Tool call response', + 'type' => 'object', + 'properties' => [ + 'functionName' => ['description' => 'Tool function name', 'type' => 'string', 'title' => '', 'example' => 'web_search'], + 'displayName' => ['description' => 'Tool function display name', 'type' => 'string', 'title' => '', 'example' => '搜索引擎'], + 'functionArgs' => ['description' => 'Tool function arguments', 'type' => 'string', 'title' => '', 'example' => '{\\"query\\":\\"2025年1月28日到2月3日天气预报\\"}'], + 'result' => ['description' => 'Tool call result', 'type' => 'string', 'title' => '', 'example' => '下周天气晴朗'], + 'startTime' => ['description' => 'Start time', 'type' => 'string', 'title' => '', 'example' => '2025-01-21 16:37:14'], + 'endTime' => ['description' => 'End time', 'type' => 'string', 'title' => '', 'example' => '2025-01-21 16:37:14'], + ], + 'example' => '', + ], + 'example' => '', ], - 'example' => 'DIALOG_LABEL', - ], - 'required' => false, - ], - 'requestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '0FC6636E-380A-5369-AE01-D1C15BB9B254', - ], - 'conversationList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'dialogueList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'content' => [ - 'title' => '对话的具体内容', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'role' => [ - 'title' => '角色(0: 客户;1: 坐席)', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - '', - '', + 'response' => [ + 'title' => '', + 'description' => 'Model response', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'ID generated by the system for this call.', 'type' => 'string', 'title' => '', 'example' => 'd91d9afa-7cfc-4235-b012-a6f8e6ffa443'], + 'modelId' => ['description' => 'Name of the model used for this call.', 'type' => 'string', 'title' => '', 'example' => 'qwen-plus'], + 'choices' => [ + 'title' => '', + 'description' => 'Details of the model-generated content.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Details of the model-generated content.', + 'type' => 'object', + 'properties' => [ + 'index' => ['description' => 'Index number of the generated result. Default is 0.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'message' => [ + 'title' => '', + 'description' => 'Message from the model.', + 'type' => 'object', + 'properties' => [ + 'role' => ['description' => 'Role of the model. Fixed value: assistant.', 'type' => 'string', 'title' => '', 'example' => 'assistant'], + 'roleDisplayName' => ['description' => 'Display name of the model\'s role.', 'type' => 'string', 'title' => '', 'example' => 'assistant'], + 'content' => ['description' => 'Text generated by the model.', 'type' => 'string', 'title' => '', 'example' => '下周天气都不错'], + ], + 'example' => '', ], - 'example' => '1', + 'finishReason' => ['description' => 'Reason why the model stopped generating content.', 'type' => 'string', 'title' => '', 'example' => 'stop'], ], + 'example' => '', ], - 'required' => false, + 'example' => '', ], - 'required' => true, + 'created' => ['description' => 'Creation time', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1737448637'], + 'time' => ['description' => 'Time', 'type' => 'string', 'title' => '', 'example' => '2025-01-21T16:37:17.497206762'], ], + 'example' => '', ], - 'required' => false, + 'inputTokens' => ['description' => 'Input tokens', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '766'], + 'outputTokens' => ['description' => 'Output tokens', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '988'], ], - 'required' => true, + 'example' => '', ], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => 'EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258'], + 'cost' => ['description' => 'Duration in milliseconds', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], ], - 'required' => false, + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ResultCode<List<String>>', - 'description' => 'ResultCode<List<String>>', - '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' => '响应数据,返回会话ID列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1876540295480209409', - ], - ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => 'EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258', - ], - '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\\": {\\n \\"versionId\\": \\"w4paqoezm2\\",\\n \\"traceId\\": \\"5bdb9809856c58acb92001f8ae65773c\\",\\n \\"threadId\\": \\"4vlag5ken3\\",\\n \\"functionCallResponses\\": [\\n {\\n \\"functionName\\": \\"web_search\\",\\n \\"displayName\\": \\"搜索引擎\\",\\n \\"functionArgs\\": \\"{\\\\\\\\\\\\\\"query\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2025年1月28日到2月3日天气预报\\\\\\\\\\\\\\"}\\",\\n \\"result\\": \\"下周天气晴朗\\",\\n \\"startTime\\": \\"2025-01-21 16:37:14\\",\\n \\"endTime\\": \\"2025-01-21 16:37:14\\"\\n }\\n ],\\n \\"response\\": {\\n \\"id\\": \\"d91d9afa-7cfc-4235-b012-a6f8e6ffa443\\",\\n \\"modelId\\": \\"qwen-plus\\",\\n \\"choices\\": [\\n {\\n \\"index\\": 0,\\n \\"message\\": {\\n \\"role\\": \\"assistant\\",\\n \\"roleDisplayName\\": \\"assistant\\",\\n \\"content\\": \\"下周天气都不错\\"\\n },\\n \\"finishReason\\": \\"stop\\"\\n }\\n ],\\n \\"created\\": 1737448637,\\n \\"time\\": \\"2025-01-21T16:37:17.497206762\\"\\n },\\n \\"inputTokens\\": 766,\\n \\"outputTokens\\": 988\\n },\\n \\"requestId\\": \\"EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258\\",\\n \\"cost\\": 0\\n}","type":"json"}]', + 'title' => 'Run agent ', + 'description' => 'Before you use this API, review the billing model and pricing for Tongyi Dianjin.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'You have activated Alibaba Cloud Model Studio and Tongyi Dianjin.'."\n" + ."\n" + .'Obtain a workspace ID: [Obtain your workspace ID](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'responseParamsDescription' => '## Streaming API example:'."\n" + ."\n" + .'### The messageType field indicates the type of each frame.'."\n" + ."\n" + .'- toolDiscovery (tool discovery)'."\n" + ."\n" + .'- functionCall (tool call)'."\n" + ."\n" + .'- toolResponse (tool response)'."\n" + ."\n" + .'- toolStartStep (start a tool processing step)'."\n" + ."\n" + .'- toolEmitStepData (detail data sent during each step)'."\n" + ."\n" + .'- completeStep (complete a tool processing step)'."\n" + ."\n" + .'- **answer** (answer)'."\n" + ."\n" + .'```'."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"ToolDiscovery","contentGroup":"","content":"{\\"toolName\\":\\"web_search\\",\\"displayName\\":\\"Search engine\\"}","contentType":"JSON","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:19"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"FunctionCall","contentGroup":"","content":"{\\"functionArgs\\":\\"{\\\\\\"query\\\\\\":\\\\\\"next week\'s weather\\\\\\"}\\",\\"functionName\\":\\"web_search\\",\\"displayName\\":\\"Search engine\\"}","contentType":"JSON","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:19"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"ToolResponse","contentGroup":"","content":"{\\"toolName\\":\\"web_search\\",\\"result\\":\\"{\\\\\\"items\\\\\\":{\\\\\\"item\\\\\\":[{\\\\\\"sc_name\\\\\\":\\\\\\"weather_moji\\\\\\",\\\\\\"weather_moji\\\\\\":{\\\\\\"sc_stype\\\\\\":\\\\\\"BOOK\\\\\\",\\\\\\"wisdomData\\\\\\":{\\\\\\"country\\\\\\":\\\\\\"China\\\\\\",\\\\\\"province\\\\\\":\\\\\\"Zhejiang Province\\\\\\",\\\\\\"city\\\\\\":\\\\\\"Hangzhou City\\\\\\",\\\\\\"district\\\\\\":\\\\\\"Hangzhou City\\\\\\",\\\\\\"realtime_data\\\\\\":{\\\\\\"current\\\\\\":{\\\\\\"real_feel\\\\\\":\\\\\\"13.0\\\\\\",\\\\\\"vis\\\\\\":\\\\\\"5000\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"haze\\\\\\",\\\\\\"comfort\\\\\\":\\\\\\"54\\\\\\",\\\\\\"daytime\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"2.31\\\\\\",\\\\\\"tips\\\\\\":\\\\\\"Slightly cool but comfortable.\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"2\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"-3.0\\\\\\",\\\\\\"icon_weak\\\\\\":\\\\\\"16_weak\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"2\\\\\\",\\\\\\"sun_rise\\\\\\":\\\\\\"2025-01-21 06:55:00\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"45\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"45\\\\\\",\\\\\\"obs_time\\\\\\":\\\\\\"2025-01-21 16:45:08\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1015\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"15.0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"sun_down\\\\\\":\\\\\\"2025-01-21 17:26:00\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"34\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"30\\\\\\",\\\\\\"precip_1h\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"get_time\\\\\\":\\\\\\"2025-01-21 16:15:03\\\\\\"}},\\\\\\"weather_forecast_data\\\\\\":{\\\\\\"lowest_temp\\\\\\":\\\\\\"-3\\\\\\",\\\\\\"hourly\\\\\\":{\\\\\\"item\\\\\\":[{\\\\\\"real_feel\\\\\\":\\\\\\"13.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"2\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"haze\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-21\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-21 16:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"36\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"2.0\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"45\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"-4.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"2\\\\\\",\\\\\\"day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"16\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"16\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1014\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"15.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"34\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"30\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"14.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-21\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-21 17:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"31\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"2.1\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"45\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"-1.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"4\\\\\\",\\\\\\"day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"1\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"17\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1020\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"14.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"32\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"11.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-21\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-21 18:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"36\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"2.3\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"45\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"1.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"4\\\\\\",\\\\\\"day\\\\\\":\\\\\\"0\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"19\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"18\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1021\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"13.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"41\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"10.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-21\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-21 19:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"28\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"2.1\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"45\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"2.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"4\\\\\\",\\\\\\"day\\\\\\":\\\\\\"0\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"19\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"19\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1021\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"12.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"52\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"10.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-21\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-21 20:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"25\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"1.4\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"45\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"4.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"4\\\\\\",\\\\\\"day\\\\\\":\\\\\\"0\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"19\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"20\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1022\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"10.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"62\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"10.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-21\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-21 21:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"26\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"1.2\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"45\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"3.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"4\\\\\\",\\\\\\"day\\\\\\":\\\\\\"0\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"19\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"21\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1022\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"10.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"69\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"9.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-21\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-21 22:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"11\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"0.9\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"45\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"3.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"4\\\\\\",\\\\\\"day\\\\\\":\\\\\\"0\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"19\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"22\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1022\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"9.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"71\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"9.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"clear\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-21\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-21 23:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"2\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"0.6\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"45\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"3.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"4\\\\\\",\\\\\\"day\\\\\\":\\\\\\"0\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"18\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"23\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1022\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"8.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"5\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"73\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"8.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-22 0:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"21\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"0.6\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"45\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"3.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"3\\\\\\",\\\\\\"day\\\\\\":\\\\\\"0\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"19\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"0\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1022\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"8.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"75\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"7.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-22 1:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"31\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"0.5\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"225\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"2.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"11\\\\\\",\\\\\\"day\\\\\\":\\\\\\"0\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"southwest wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"19\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"1\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1022\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"7.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"76\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"6.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-22 2:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"38\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"1.0\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"225\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"2.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"10\\\\\\",\\\\\\"day\\\\\\":\\\\\\"0\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"southwest wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"19\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"2\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1021\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"7.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"76\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"5.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-22 3:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"46\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"1.4\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"225\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"2.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"10\\\\\\",\\\\\\"day\\\\\\":\\\\\\"0\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"southwest wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"19\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"3\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1021\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"7.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"74\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"4.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-22 4:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"52\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"1.4\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"180\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"1.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"9\\\\\\",\\\\\\"day\\\\\\":\\\\\\"0\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"south wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"19\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"4\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1021\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"6.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"72\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"4.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-22 5:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"65\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"1.6\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"180\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"1.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"9\\\\\\",\\\\\\"day\\\\\\":\\\\\\"0\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"south wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"19\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"5\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1020\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"6.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"70\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"4.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-22 6:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"63\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"1.6\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"180\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"1.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"9\\\\\\",\\\\\\"day\\\\\\":\\\\\\"0\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"south wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"19\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"6\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1021\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"6.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"73\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"4.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-22 7:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"60\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"1.7\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"135\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"8\\\\\\",\\\\\\"day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"southeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"1\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"7\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1021\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"7.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"73\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"5.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-22 8:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"48\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"1.6\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"135\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"1.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"8\\\\\\",\\\\\\"day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"southeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"1\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"8\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1022\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"7.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"71\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"7.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-22 9:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"48\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"1.8\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"135\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"1.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"8\\\\\\",\\\\\\"day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"southeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"1\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"9\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1022\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"9.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"61\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"9.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"2\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-22 10:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"38\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"2.3\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"135\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"8\\\\\\",\\\\\\"day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"southeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"1\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"10\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1022\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"11.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"48\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"11.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"3\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-22 11:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"47\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"135\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"-1.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"8\\\\\\",\\\\\\"day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"southeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"1\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"11\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1022\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"13.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"43\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"14.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"3\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-22 12:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"31\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"2.3\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"135\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"8\\\\\\",\\\\\\"day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"southeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"1\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"12\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1021\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"14.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"39\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"16.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"3\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-22 13:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"29\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"2.2\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"135\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"8\\\\\\",\\\\\\"day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"southeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"1\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"13\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1019\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"16.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"38\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"17.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"3\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-22 14:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"30\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"1.9\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"135\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"8\\\\\\",\\\\\\"day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"southeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"1\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"14\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1018\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"17.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"37\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"18.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"2\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-22 15:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"29\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"1.3\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"135\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"1.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"8\\\\\\",\\\\\\"day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"southeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"1\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"15\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1018\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"17.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"82\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"36\\\\\\"},{\\\\\\"real_feel\\\\\\":\\\\\\"19.0\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"4\\\\\\",\\\\\\"weather\\\\\\":\\\\\\"clear\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"predict_time\\\\\\":\\\\\\"2025-01-22 16:00:00\\\\\\",\\\\\\"sky\\\\\\":\\\\\\"21\\\\\\",\\\\\\"snow\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"wspd\\\\\\":\\\\\\"0.9\\\\\\",\\\\\\"wind_level\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_degrees\\\\\\":\\\\\\"135\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 16:06:02\\\\\\",\\\\\\"dewpoint\\\\\\":\\\\\\"2.0\\\\\\",\\\\\\"wind_dir_id\\\\\\":\\\\\\"7\\\\\\",\\\\\\"day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_dir\\\\\\":\\\\\\"southeast wind\\\\\\",\\\\\\"icon\\\\\\":\\\\\\"0\\\\\\",\\\\\\"predict_hour\\\\\\":\\\\\\"16\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1018\\\\\\",\\\\\\"temp\\\\\\":\\\\\\"17.0\\\\\\",\\\\\\"weather_id\\\\\\":\\\\\\"5\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"30\\\\\\"}]},\\\\\\"days_15_diff\\\\\\":\\\\\\"21\\\\\\",\\\\\\"highest_temp\\\\\\":\\\\\\"18\\\\\\",\\\\\\"daily\\\\\\":{\\\\\\"item\\\\\\":[{\\\\\\"wind_dir_id_night\\\\\\":\\\\\\"3\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"icon_day\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"4\\\\\\",\\\\\\"wind_degrees_day\\\\\\":\\\\\\"45\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-20\\\\\\",\\\\\\"wind_dir_night\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"wind_level_night\\\\\\":\\\\\\"2\\\\\\",\\\\\\"moon_down\\\\\\":\\\\\\"2025-01-20 10:26:00\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-20 22:00:00\\\\\\",\\\\\\"weather_id_night\\\\\\":\\\\\\"8\\\\\\",\\\\\\"weather_night\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"wspd_night\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"wind_degrees_night\\\\\\":\\\\\\"45\\\\\\",\\\\\\"wind_level_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_dir_id_day\\\\\\":\\\\\\"3\\\\\\",\\\\\\"sun_rise\\\\\\":\\\\\\"2025-01-20 06:55:00\\\\\\",\\\\\\"wind_dir_day\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"weather_day\\\\\\":\\\\\\"clear\\\\\\",\\\\\\"moon_phase\\\\\\":\\\\\\"WaningGibbous\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1020\\\\\\",\\\\\\"wspd_day\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"temp_low\\\\\\":\\\\\\"4.0\\\\\\",\\\\\\"moon_rise\\\\\\":\\\\\\"2025-01-20 23:22:00\\\\\\",\\\\\\"sun_down\\\\\\":\\\\\\"2025-01-20 17:25:00\\\\\\",\\\\\\"icon_night\\\\\\":\\\\\\"31\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"34\\\\\\",\\\\\\"temp_high\\\\\\":\\\\\\"15.0\\\\\\",\\\\\\"weather_id_day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"get_time\\\\\\":\\\\\\"2025-01-20 22:50:03\\\\\\"},{\\\\\\"wind_dir_id_night\\\\\\":\\\\\\"4\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"icon_day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"4\\\\\\",\\\\\\"wind_degrees_day\\\\\\":\\\\\\"45\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-21\\\\\\",\\\\\\"wind_dir_night\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"wind_level_night\\\\\\":\\\\\\"2\\\\\\",\\\\\\"moon_down\\\\\\":\\\\\\"2025-01-21 10:52:00\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 13:00:00\\\\\\",\\\\\\"weather_id_night\\\\\\":\\\\\\"8\\\\\\",\\\\\\"weather_night\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"wspd_night\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"wind_degrees_night\\\\\\":\\\\\\"45\\\\\\",\\\\\\"wind_level_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_dir_id_day\\\\\\":\\\\\\"4\\\\\\",\\\\\\"sun_rise\\\\\\":\\\\\\"2025-01-21 06:55:00\\\\\\",\\\\\\"wind_dir_day\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"weather_day\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"moon_phase\\\\\\":\\\\\\"WaningGibbous\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1022\\\\\\",\\\\\\"wspd_day\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"temp_low\\\\\\":\\\\\\"5.0\\\\\\",\\\\\\"moon_rise\\\\\\":\\\\\\"2025-01-21 00:00:00\\\\\\",\\\\\\"sun_down\\\\\\":\\\\\\"2025-01-21 17:26:00\\\\\\",\\\\\\"icon_night\\\\\\":\\\\\\"31\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"50\\\\\\",\\\\\\"temp_high\\\\\\":\\\\\\"17.0\\\\\\",\\\\\\"weather_id_day\\\\\\":\\\\\\"8\\\\\\",\\\\\\"get_time\\\\\\":\\\\\\"2025-01-21 14:50:03\\\\\\"},{\\\\\\"wind_dir_id_night\\\\\\":\\\\\\"5\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"icon_day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"3\\\\\\",\\\\\\"wind_degrees_day\\\\\\":\\\\\\"135\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-22\\\\\\",\\\\\\"wind_dir_night\\\\\\":\\\\\\"east wind\\\\\\",\\\\\\"wind_level_night\\\\\\":\\\\\\"1\\\\\\",\\\\\\"moon_down\\\\\\":\\\\\\"2025-01-22 11:20:00\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 13:00:00\\\\\\",\\\\\\"weather_id_night\\\\\\":\\\\\\"8\\\\\\",\\\\\\"weather_night\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"wspd_night\\\\\\":\\\\\\"0.9\\\\\\",\\\\\\"wind_degrees_night\\\\\\":\\\\\\"90\\\\\\",\\\\\\"wind_level_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_dir_id_day\\\\\\":\\\\\\"8\\\\\\",\\\\\\"sun_rise\\\\\\":\\\\\\"2025-01-22 06:55:00\\\\\\",\\\\\\"wind_dir_day\\\\\\":\\\\\\"southeast wind\\\\\\",\\\\\\"weather_day\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"moon_phase\\\\\\":\\\\\\"Last\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1020\\\\\\",\\\\\\"wspd_day\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"temp_low\\\\\\":\\\\\\"7.0\\\\\\",\\\\\\"moon_rise\\\\\\":\\\\\\"2025-01-22 00:16:00\\\\\\",\\\\\\"sun_down\\\\\\":\\\\\\"2025-01-22 17:27:00\\\\\\",\\\\\\"icon_night\\\\\\":\\\\\\"31\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"54\\\\\\",\\\\\\"temp_high\\\\\\":\\\\\\"17.0\\\\\\",\\\\\\"weather_id_day\\\\\\":\\\\\\"8\\\\\\",\\\\\\"get_time\\\\\\":\\\\\\"2025-01-21 14:50:03\\\\\\"},{\\\\\\"wind_dir_id_night\\\\\\":\\\\\\"3\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"icon_day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"3\\\\\\",\\\\\\"wind_degrees_day\\\\\\":\\\\\\"45\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-23\\\\\\",\\\\\\"wind_dir_night\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"wind_level_night\\\\\\":\\\\\\"2\\\\\\",\\\\\\"moon_down\\\\\\":\\\\\\"2025-01-23 11:51:00\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 13:00:00\\\\\\",\\\\\\"weather_id_night\\\\\\":\\\\\\"8\\\\\\",\\\\\\"weather_night\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"wspd_night\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"wind_degrees_night\\\\\\":\\\\\\"45\\\\\\",\\\\\\"wind_level_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_dir_id_day\\\\\\":\\\\\\"3\\\\\\",\\\\\\"sun_rise\\\\\\":\\\\\\"2025-01-23 06:54:00\\\\\\",\\\\\\"wind_dir_day\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"weather_day\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"moon_phase\\\\\\":\\\\\\"WaningCrescent\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1020\\\\\\",\\\\\\"wspd_day\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"temp_low\\\\\\":\\\\\\"8.0\\\\\\",\\\\\\"moon_rise\\\\\\":\\\\\\"2025-01-23 01:12:00\\\\\\",\\\\\\"sun_down\\\\\\":\\\\\\"2025-01-23 17:28:00\\\\\\",\\\\\\"icon_night\\\\\\":\\\\\\"31\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"67\\\\\\",\\\\\\"temp_high\\\\\\":\\\\\\"18.0\\\\\\",\\\\\\"weather_id_day\\\\\\":\\\\\\"8\\\\\\",\\\\\\"get_time\\\\\\":\\\\\\"2025-01-21 14:50:03\\\\\\"},{\\\\\\"wind_dir_id_night\\\\\\":\\\\\\"4\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"3.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"60\\\\\\",\\\\\\"icon_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_degrees_day\\\\\\":\\\\\\"45\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-24\\\\\\",\\\\\\"wind_dir_night\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"wind_level_night\\\\\\":\\\\\\"3\\\\\\",\\\\\\"moon_down\\\\\\":\\\\\\"2025-01-24 12:27:00\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 13:00:00\\\\\\",\\\\\\"weather_id_night\\\\\\":\\\\\\"51\\\\\\",\\\\\\"weather_night\\\\\\":\\\\\\"light rain\\\\\\",\\\\\\"wspd_night\\\\\\":\\\\\\"4.4\\\\\\",\\\\\\"wind_degrees_night\\\\\\":\\\\\\"45\\\\\\",\\\\\\"wind_level_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_dir_id_day\\\\\\":\\\\\\"4\\\\\\",\\\\\\"sun_rise\\\\\\":\\\\\\"2025-01-24 06:54:00\\\\\\",\\\\\\"wind_dir_day\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"weather_day\\\\\\":\\\\\\"cloudy\\\\\\",\\\\\\"moon_phase\\\\\\":\\\\\\"WaningCrescent\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1022\\\\\\",\\\\\\"wspd_day\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"temp_low\\\\\\":\\\\\\"7.0\\\\\\",\\\\\\"moon_rise\\\\\\":\\\\\\"2025-01-24 02:10:00\\\\\\",\\\\\\"sun_down\\\\\\":\\\\\\"2025-01-24 17:29:00\\\\\\",\\\\\\"icon_night\\\\\\":\\\\\\"7\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"82\\\\\\",\\\\\\"temp_high\\\\\\":\\\\\\"14.0\\\\\\",\\\\\\"weather_id_day\\\\\\":\\\\\\"13\\\\\\",\\\\\\"get_time\\\\\\":\\\\\\"2025-01-21 14:50:03\\\\\\"},{\\\\\\"wind_dir_id_night\\\\\\":\\\\\\"4\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"6.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"50\\\\\\",\\\\\\"icon_day\\\\\\":\\\\\\"3\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees_day\\\\\\":\\\\\\"45\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-25\\\\\\",\\\\\\"wind_dir_night\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"wind_level_night\\\\\\":\\\\\\"2\\\\\\",\\\\\\"moon_down\\\\\\":\\\\\\"2025-01-25 13:10:00\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 13:00:00\\\\\\",\\\\\\"weather_id_night\\\\\\":\\\\\\"51\\\\\\",\\\\\\"weather_night\\\\\\":\\\\\\"light rain\\\\\\",\\\\\\"wspd_night\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"wind_degrees_night\\\\\\":\\\\\\"45\\\\\\",\\\\\\"wind_level_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_dir_id_day\\\\\\":\\\\\\"4\\\\\\",\\\\\\"sun_rise\\\\\\":\\\\\\"2025-01-25 06:54:00\\\\\\",\\\\\\"wind_dir_day\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"weather_day\\\\\\":\\\\\\"light rain\\\\\\",\\\\\\"moon_phase\\\\\\":\\\\\\"WaningCrescent\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1024\\\\\\",\\\\\\"wspd_day\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"temp_low\\\\\\":\\\\\\"5.0\\\\\\",\\\\\\"moon_rise\\\\\\":\\\\\\"2025-01-25 03:10:00\\\\\\",\\\\\\"sun_down\\\\\\":\\\\\\"2025-01-25 17:30:00\\\\\\",\\\\\\"icon_night\\\\\\":\\\\\\"7\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"75\\\\\\",\\\\\\"temp_high\\\\\\":\\\\\\"13.0\\\\\\",\\\\\\"weather_id_day\\\\\\":\\\\\\"51\\\\\\",\\\\\\"get_time\\\\\\":\\\\\\"2025-01-21 14:50:03\\\\\\"},{\\\\\\"wind_dir_id_night\\\\\\":\\\\\\"15\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"4.9\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"60\\\\\\",\\\\\\"icon_day\\\\\\":\\\\\\"3\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"1\\\\\\",\\\\\\"wind_degrees_day\\\\\\":\\\\\\"315\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-26\\\\\\",\\\\\\"wind_dir_night\\\\\\":\\\\\\"northwest wind\\\\\\",\\\\\\"wind_level_night\\\\\\":\\\\\\"3\\\\\\",\\\\\\"moon_down\\\\\\":\\\\\\"2025-01-26 14:01:00\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 13:00:00\\\\\\",\\\\\\"weather_id_night\\\\\\":\\\\\\"51\\\\\\",\\\\\\"weather_night\\\\\\":\\\\\\"light rain\\\\\\",\\\\\\"wspd_night\\\\\\":\\\\\\"4.4\\\\\\",\\\\\\"wind_degrees_night\\\\\\":\\\\\\"315\\\\\\",\\\\\\"wind_level_day\\\\\\":\\\\\\"3\\\\\\",\\\\\\"wind_dir_id_day\\\\\\":\\\\\\"15\\\\\\",\\\\\\"sun_rise\\\\\\":\\\\\\"2025-01-26 06:53:00\\\\\\",\\\\\\"wind_dir_day\\\\\\":\\\\\\"northwest wind\\\\\\",\\\\\\"weather_day\\\\\\":\\\\\\"light rain\\\\\\",\\\\\\"moon_phase\\\\\\":\\\\\\"WaningCrescent\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1026\\\\\\",\\\\\\"wspd_day\\\\\\":\\\\\\"4.4\\\\\\",\\\\\\"temp_low\\\\\\":\\\\\\"2.0\\\\\\",\\\\\\"moon_rise\\\\\\":\\\\\\"2025-01-26 04:10:00\\\\\\",\\\\\\"sun_down\\\\\\":\\\\\\"2025-01-26 17:31:00\\\\\\",\\\\\\"icon_night\\\\\\":\\\\\\"7\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"80\\\\\\",\\\\\\"temp_high\\\\\\":\\\\\\"9.0\\\\\\",\\\\\\"weather_id_day\\\\\\":\\\\\\"51\\\\\\",\\\\\\"get_time\\\\\\":\\\\\\"2025-01-21 14:50:03\\\\\\"},{\\\\\\"wind_dir_id_night\\\\\\":\\\\\\"15\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"icon_day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"4\\\\\\",\\\\\\"wind_degrees_day\\\\\\":\\\\\\"315\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-27\\\\\\",\\\\\\"wind_dir_night\\\\\\":\\\\\\"northwest wind\\\\\\",\\\\\\"wind_level_night\\\\\\":\\\\\\"2\\\\\\",\\\\\\"moon_down\\\\\\":\\\\\\"2025-01-27 15:00:00\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 13:00:00\\\\\\",\\\\\\"weather_id_night\\\\\\":\\\\\\"13\\\\\\",\\\\\\"weather_night\\\\\\":\\\\\\"cloudy\\\\\\",\\\\\\"wspd_night\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"wind_degrees_night\\\\\\":\\\\\\"315\\\\\\",\\\\\\"wind_level_day\\\\\\":\\\\\\"3\\\\\\",\\\\\\"wind_dir_id_day\\\\\\":\\\\\\"15\\\\\\",\\\\\\"sun_rise\\\\\\":\\\\\\"2025-01-27 06:53:00\\\\\\",\\\\\\"wind_dir_day\\\\\\":\\\\\\"northwest wind\\\\\\",\\\\\\"weather_day\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"moon_phase\\\\\\":\\\\\\"WaningCrescent\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1030\\\\\\",\\\\\\"wspd_day\\\\\\":\\\\\\"4.4\\\\\\",\\\\\\"temp_low\\\\\\":\\\\\\"-1.0\\\\\\",\\\\\\"moon_rise\\\\\\":\\\\\\"2025-01-27 05:07:00\\\\\\",\\\\\\"sun_down\\\\\\":\\\\\\"2025-01-27 17:31:00\\\\\\",\\\\\\"icon_night\\\\\\":\\\\\\"2\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"42\\\\\\",\\\\\\"temp_high\\\\\\":\\\\\\"8.0\\\\\\",\\\\\\"weather_id_day\\\\\\":\\\\\\"8\\\\\\",\\\\\\"get_time\\\\\\":\\\\\\"2025-01-21 14:50:03\\\\\\"},{\\\\\\"wind_dir_id_night\\\\\\":\\\\\\"4\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"icon_day\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"4\\\\\\",\\\\\\"wind_degrees_day\\\\\\":\\\\\\"315\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-28\\\\\\",\\\\\\"wind_dir_night\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"wind_level_night\\\\\\":\\\\\\"2\\\\\\",\\\\\\"moon_down\\\\\\":\\\\\\"2025-01-28 16:04:00\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 13:00:00\\\\\\",\\\\\\"weather_id_night\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather_night\\\\\\":\\\\\\"clear\\\\\\",\\\\\\"wspd_night\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"wind_degrees_night\\\\\\":\\\\\\"45\\\\\\",\\\\\\"wind_level_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_dir_id_day\\\\\\":\\\\\\"14\\\\\\",\\\\\\"sun_rise\\\\\\":\\\\\\"2025-01-28 06:52:00\\\\\\",\\\\\\"wind_dir_day\\\\\\":\\\\\\"northwest wind\\\\\\",\\\\\\"weather_day\\\\\\":\\\\\\"clear\\\\\\",\\\\\\"moon_phase\\\\\\":\\\\\\"WaningCrescent\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1031\\\\\\",\\\\\\"wspd_day\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"temp_low\\\\\\":\\\\\\"1.0\\\\\\",\\\\\\"moon_rise\\\\\\":\\\\\\"2025-01-28 06:01:00\\\\\\",\\\\\\"sun_down\\\\\\":\\\\\\"2025-01-28 17:32:00\\\\\\",\\\\\\"icon_night\\\\\\":\\\\\\"30\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"36\\\\\\",\\\\\\"temp_high\\\\\\":\\\\\\"10.0\\\\\\",\\\\\\"weather_id_day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"get_time\\\\\\":\\\\\\"2025-01-21 14:50:03\\\\\\"},{\\\\\\"wind_dir_id_night\\\\\\":\\\\\\"3\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"icon_day\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"3\\\\\\",\\\\\\"wind_degrees_day\\\\\\":\\\\\\"45\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-29\\\\\\",\\\\\\"wind_dir_night\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"wind_level_night\\\\\\":\\\\\\"2\\\\\\",\\\\\\"moon_down\\\\\\":\\\\\\"2025-01-29 17:12:00\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 13:00:00\\\\\\",\\\\\\"weather_id_night\\\\\\":\\\\\\"1\\\\\\",\\\\\\"weather_night\\\\\\":\\\\\\"clear\\\\\\",\\\\\\"wspd_night\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"wind_degrees_night\\\\\\":\\\\\\"45\\\\\\",\\\\\\"wind_level_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_dir_id_day\\\\\\":\\\\\\"4\\\\\\",\\\\\\"sun_rise\\\\\\":\\\\\\"2025-01-29 06:52:00\\\\\\",\\\\\\"wind_dir_day\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"weather_day\\\\\\":\\\\\\"clear\\\\\\",\\\\\\"moon_phase\\\\\\":\\\\\\"New\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1029\\\\\\",\\\\\\"wspd_day\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"temp_low\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"moon_rise\\\\\\":\\\\\\"2025-01-29 06:48:00\\\\\\",\\\\\\"sun_down\\\\\\":\\\\\\"2025-01-29 17:33:00\\\\\\",\\\\\\"icon_night\\\\\\":\\\\\\"30\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"40\\\\\\",\\\\\\"temp_high\\\\\\":\\\\\\"7.0\\\\\\",\\\\\\"weather_id_day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"get_time\\\\\\":\\\\\\"2025-01-21 14:50:03\\\\\\"},{\\\\\\"wind_dir_id_night\\\\\\":\\\\\\"16\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"3.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"60\\\\\\",\\\\\\"icon_day\\\\\\":\\\\\\"0\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"3\\\\\\",\\\\\\"wind_degrees_day\\\\\\":\\\\\\"135\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-30\\\\\\",\\\\\\"wind_dir_night\\\\\\":\\\\\\"northwest wind\\\\\\",\\\\\\"wind_level_night\\\\\\":\\\\\\"2\\\\\\",\\\\\\"moon_down\\\\\\":\\\\\\"2025-01-30 18:20:00\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 13:00:00\\\\\\",\\\\\\"weather_id_night\\\\\\":\\\\\\"49\\\\\\",\\\\\\"weather_night\\\\\\":\\\\\\"sleet\\\\\\",\\\\\\"wspd_night\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"wind_degrees_night\\\\\\":\\\\\\"315\\\\\\",\\\\\\"wind_level_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_dir_id_day\\\\\\":\\\\\\"7\\\\\\",\\\\\\"sun_rise\\\\\\":\\\\\\"2025-01-30 06:51:00\\\\\\",\\\\\\"wind_dir_day\\\\\\":\\\\\\"southeast wind\\\\\\",\\\\\\"weather_day\\\\\\":\\\\\\"clear\\\\\\",\\\\\\"moon_phase\\\\\\":\\\\\\"WaxingCrescent\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1024\\\\\\",\\\\\\"wspd_day\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"temp_low\\\\\\":\\\\\\"1.0\\\\\\",\\\\\\"moon_rise\\\\\\":\\\\\\"2025-01-30 07:29:00\\\\\\",\\\\\\"sun_down\\\\\\":\\\\\\"2025-01-30 17:34:00\\\\\\",\\\\\\"icon_night\\\\\\":\\\\\\"6\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"51\\\\\\",\\\\\\"temp_high\\\\\\":\\\\\\"10.0\\\\\\",\\\\\\"weather_id_day\\\\\\":\\\\\\"1\\\\\\",\\\\\\"get_time\\\\\\":\\\\\\"2025-01-21 14:50:03\\\\\\"},{\\\\\\"wind_dir_id_night\\\\\\":\\\\\\"4\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"3.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"70\\\\\\",\\\\\\"icon_day\\\\\\":\\\\\\"5\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees_day\\\\\\":\\\\\\"315\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-31\\\\\\",\\\\\\"wind_dir_night\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"wind_level_night\\\\\\":\\\\\\"2\\\\\\",\\\\\\"moon_down\\\\\\":\\\\\\"2025-01-31 19:28:00\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 13:00:00\\\\\\",\\\\\\"weather_id_night\\\\\\":\\\\\\"13\\\\\\",\\\\\\"weather_night\\\\\\":\\\\\\"cloudy\\\\\\",\\\\\\"wspd_night\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"wind_degrees_night\\\\\\":\\\\\\"45\\\\\\",\\\\\\"wind_level_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_dir_id_day\\\\\\":\\\\\\"16\\\\\\",\\\\\\"sun_rise\\\\\\":\\\\\\"2025-01-31 06:51:00\\\\\\",\\\\\\"wind_dir_day\\\\\\":\\\\\\"northwest wind\\\\\\",\\\\\\"weather_day\\\\\\":\\\\\\"sleet\\\\\\",\\\\\\"moon_phase\\\\\\":\\\\\\"WaxingCrescent\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1022\\\\\\",\\\\\\"wspd_day\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"temp_low\\\\\\":\\\\\\"-2.0\\\\\\",\\\\\\"moon_rise\\\\\\":\\\\\\"2025-01-31 08:06:00\\\\\\",\\\\\\"sun_down\\\\\\":\\\\\\"2025-01-31 17:35:00\\\\\\",\\\\\\"icon_night\\\\\\":\\\\\\"2\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"56\\\\\\",\\\\\\"temp_high\\\\\\":\\\\\\"3.0\\\\\\",\\\\\\"weather_id_day\\\\\\":\\\\\\"49\\\\\\",\\\\\\"get_time\\\\\\":\\\\\\"2025-01-21 14:50:03\\\\\\"},{\\\\\\"wind_dir_id_night\\\\\\":\\\\\\"3\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"icon_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"3\\\\\\",\\\\\\"wind_degrees_day\\\\\\":\\\\\\"45\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-02-01\\\\\\",\\\\\\"wind_dir_night\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"wind_level_night\\\\\\":\\\\\\"2\\\\\\",\\\\\\"moon_down\\\\\\":\\\\\\"2025-02-01 20:34:00\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 13:00:00\\\\\\",\\\\\\"weather_id_night\\\\\\":\\\\\\"8\\\\\\",\\\\\\"weather_night\\\\\\":\\\\\\"partly cloudy\\\\\\",\\\\\\"wspd_night\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"wind_degrees_night\\\\\\":\\\\\\"45\\\\\\",\\\\\\"wind_level_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_dir_id_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"sun_rise\\\\\\":\\\\\\"2025-02-01 06:50:00\\\\\\",\\\\\\"wind_dir_day\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"weather_day\\\\\\":\\\\\\"cloudy\\\\\\",\\\\\\"moon_phase\\\\\\":\\\\\\"WaxingCrescent\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1023\\\\\\",\\\\\\"wspd_day\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"temp_low\\\\\\":\\\\\\"-3.0\\\\\\",\\\\\\"moon_rise\\\\\\":\\\\\\"2025-02-01 08:39:00\\\\\\",\\\\\\"sun_down\\\\\\":\\\\\\"2025-02-01 17:36:00\\\\\\",\\\\\\"icon_night\\\\\\":\\\\\\"31\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"66\\\\\\",\\\\\\"temp_high\\\\\\":\\\\\\"5.0\\\\\\",\\\\\\"weather_id_day\\\\\\":\\\\\\"13\\\\\\",\\\\\\"get_time\\\\\\":\\\\\\"2025-01-21 14:50:03\\\\\\"},{\\\\\\"wind_dir_id_night\\\\\\":\\\\\\"3\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"icon_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"3\\\\\\",\\\\\\"wind_degrees_day\\\\\\":\\\\\\"45\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-02-02\\\\\\",\\\\\\"wind_dir_night\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"wind_level_night\\\\\\":\\\\\\"2\\\\\\",\\\\\\"moon_down\\\\\\":\\\\\\"2025-02-02 21:40:00\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 13:00:00\\\\\\",\\\\\\"weather_id_night\\\\\\":\\\\\\"13\\\\\\",\\\\\\"weather_night\\\\\\":\\\\\\"cloudy\\\\\\",\\\\\\"wspd_night\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"wind_degrees_night\\\\\\":\\\\\\"45\\\\\\",\\\\\\"wind_level_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_dir_id_day\\\\\\":\\\\\\"3\\\\\\",\\\\\\"sun_rise\\\\\\":\\\\\\"2025-02-02 06:49:00\\\\\\",\\\\\\"wind_dir_day\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"weather_day\\\\\\":\\\\\\"cloudy\\\\\\",\\\\\\"moon_phase\\\\\\":\\\\\\"WaxingCrescent\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1023\\\\\\",\\\\\\"wspd_day\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"temp_low\\\\\\":\\\\\\"-2.0\\\\\\",\\\\\\"moon_rise\\\\\\":\\\\\\"2025-02-02 09:10:00\\\\\\",\\\\\\"sun_down\\\\\\":\\\\\\"2025-02-02 17:37:00\\\\\\",\\\\\\"icon_night\\\\\\":\\\\\\"2\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"74\\\\\\",\\\\\\"temp_high\\\\\\":\\\\\\"6.0\\\\\\",\\\\\\"weather_id_day\\\\\\":\\\\\\"13\\\\\\",\\\\\\"get_time\\\\\\":\\\\\\"2025-01-21 14:50:03\\\\\\"},{\\\\\\"wind_dir_id_night\\\\\\":\\\\\\"3\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"0\\\\\\",\\\\\\"icon_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees_day\\\\\\":\\\\\\"45\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-02-03\\\\\\",\\\\\\"wind_dir_night\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"wind_level_night\\\\\\":\\\\\\"2\\\\\\",\\\\\\"moon_down\\\\\\":\\\\\\"2025-02-03 22:46:00\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 13:00:00\\\\\\",\\\\\\"weather_id_night\\\\\\":\\\\\\"13\\\\\\",\\\\\\"weather_night\\\\\\":\\\\\\"cloudy\\\\\\",\\\\\\"wspd_night\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"wind_degrees_night\\\\\\":\\\\\\"45\\\\\\",\\\\\\"wind_level_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_dir_id_day\\\\\\":\\\\\\"3\\\\\\",\\\\\\"sun_rise\\\\\\":\\\\\\"2025-02-03 06:49:00\\\\\\",\\\\\\"wind_dir_day\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"weather_day\\\\\\":\\\\\\"cloudy\\\\\\",\\\\\\"moon_phase\\\\\\":\\\\\\"WaxingCrescent\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1024\\\\\\",\\\\\\"wspd_day\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"temp_low\\\\\\":\\\\\\"1.0\\\\\\",\\\\\\"moon_rise\\\\\\":\\\\\\"2025-02-03 09:42:00\\\\\\",\\\\\\"sun_down\\\\\\":\\\\\\"2025-02-03 17:38:00\\\\\\",\\\\\\"icon_night\\\\\\":\\\\\\"2\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"67\\\\\\",\\\\\\"temp_high\\\\\\":\\\\\\"5.0\\\\\\",\\\\\\"weather_id_day\\\\\\":\\\\\\"13\\\\\\",\\\\\\"get_time\\\\\\":\\\\\\"2025-01-21 14:50:03\\\\\\"},{\\\\\\"wind_dir_id_night\\\\\\":\\\\\\"3\\\\\\",\\\\\\"qpf\\\\\\":\\\\\\"8.0\\\\\\",\\\\\\"pop\\\\\\":\\\\\\"80\\\\\\",\\\\\\"icon_day\\\\\\":\\\\\\"9\\\\\\",\\\\\\"uvi\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_degrees_day\\\\\\":\\\\\\"45\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-02-04\\\\\\",\\\\\\"wind_dir_night\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"wind_level_night\\\\\\":\\\\\\"2\\\\\\",\\\\\\"moon_down\\\\\\":\\\\\\"2025-02-04 23:53:00\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 13:00:00\\\\\\",\\\\\\"weather_id_night\\\\\\":\\\\\\"49\\\\\\",\\\\\\"weather_night\\\\\\":\\\\\\"sleet\\\\\\",\\\\\\"wspd_night\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"wind_degrees_night\\\\\\":\\\\\\"45\\\\\\",\\\\\\"wind_level_day\\\\\\":\\\\\\"2\\\\\\",\\\\\\"wind_dir_id_day\\\\\\":\\\\\\"4\\\\\\",\\\\\\"sun_rise\\\\\\":\\\\\\"2025-02-04 06:48:00\\\\\\",\\\\\\"wind_dir_day\\\\\\":\\\\\\"northeast wind\\\\\\",\\\\\\"weather_day\\\\\\":\\\\\\"rain\\\\\\",\\\\\\"moon_phase\\\\\\":\\\\\\"WaxingCrescent\\\\\\",\\\\\\"mslp\\\\\\":\\\\\\"1024\\\\\\",\\\\\\"wspd_day\\\\\\":\\\\\\"2.4\\\\\\",\\\\\\"temp_low\\\\\\":\\\\\\"0.0\\\\\\",\\\\\\"moon_rise\\\\\\":\\\\\\"2025-02-04 10:15:00\\\\\\",\\\\\\"sun_down\\\\\\":\\\\\\"2025-02-04 17:38:00\\\\\\",\\\\\\"icon_night\\\\\\":\\\\\\"6\\\\\\",\\\\\\"humidity\\\\\\":\\\\\\"60\\\\\\",\\\\\\"temp_high\\\\\\":\\\\\\"7.0\\\\\\",\\\\\\"weather_id_day\\\\\\":\\\\\\"78\\\\\\",\\\\\\"get_time\\\\\\":\\\\\\"2025-01-21 14:50:03\\\\\\"}]}},\\\\\\"index_data\\\\\\":{\\\\\\"index\\\\\\":{\\\\\\"item\\\\\\":[{\\\\\\"index_level\\\\\\":\\\\\\"4\\\\\\",\\\\\\"index_type_id\\\\\\":\\\\\\"12\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 14:22:02\\\\\\",\\\\\\"index_desc\\\\\\":\\\\\\"Colds are likely to occur. Avoid crowded places to reduce the risk of catching a cold.\\\\\\",\\\\\\"index_type\\\\\\":\\\\\\"Cold index\\\\\\",\\\\\\"index_level_desc\\\\\\":\\\\\\"Likely\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-21\\\\\\"},{\\\\\\"index_level\\\\\\":\\\\\\"7\\\\\\",\\\\\\"index_type_id\\\\\\":\\\\\\"17\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 14:22:02\\\\\\",\\\\\\"index_desc\\\\\\":\\\\\\"Not ideal for car washing. No rain expected tomorrow, but strong winds may leave dust on your vehicle.\\\\\\",\\\\\\"index_type\\\\\\":\\\\\\"Car wash index\\\\\\",\\\\\\"index_level_desc\\\\\\":\\\\\\"Not ideal\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-21\\\\\\"},{\\\\\\"index_level\\\\\\":\\\\\\"5\\\\\\",\\\\\\"index_type_id\\\\\\":\\\\\\"20\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 14:22:02\\\\\\",\\\\\\"index_desc\\\\\\":\\\\\\"Slightly cool. Add layers to your clothing.\\\\\\",\\\\\\"index_type\\\\\\":\\\\\\"Clothing index\\\\\\",\\\\\\"index_level_desc\\\\\\":\\\\\\"Cool\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-21\\\\\\"},{\\\\\\"index_level\\\\\\":\\\\\\"2\\\\\\",\\\\\\"index_type_id\\\\\\":\\\\\\"21\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 14:22:02\\\\\\",\\\\\\"index_desc\\\\\\":\\\\\\"Low UV radiation. Use SPF12-15, PA+ sunscreen.\\\\\\",\\\\\\"index_type\\\\\\":\\\\\\"UV index\\\\\\",\\\\\\"index_level_desc\\\\\\":\\\\\\"Low\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-21\\\\\\"},{\\\\\\"index_level\\\\\\":\\\\\\"2\\\\\\",\\\\\\"index_type_id\\\\\\":\\\\\\"32\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"2025-01-21 14:22:02\\\\\\",\\\\\\"index_desc\\\\\\":\\\\\\"Current weather conditions make it unlikely for major allergens to spread. Allergy symptoms are unlikely.\\\\\\",\\\\\\"index_type\\\\\\":\\\\\\"Allergy index\\\\\\",\\\\\\"index_level_desc\\\\\\":\\\\\\"Unlikely\\\\\\",\\\\\\"predict_date\\\\\\":\\\\\\"2025-01-21\\\\\\"}]}}}}},{\\\\\\"RawUrl\\\\\\":\\\\\\"https://3g.china.com/act/news/10000169/20250120/47893150.html\\\\\\",\\\\\\"sc_name\\\\\\":\\\\\\"structure_web_info\\\\\\",\\\\\\"time\\\\\\":\\\\\\"1737363220\\\\\\",\\\\\\"hostname\\\\\\":\\\\\\"China.com\\\\\\",\\\\\\"article_title\\\\\\":\\\\\\"Xi\'an to see snow, sleet, and cooling next week; widespread snow and sleet expected\\\\\\",\\\\\\"url\\\\\\":\\\\\\"https://3g.china.com/act/news/10000169/20250120/47893150.html\\\\\\",\\\\\\"shorturl\\\\\\":\\\\\\"3g.china.com\\\\\\",\\\\\\"title\\\\\\":\\\\\\"Xi\'an next week will see snow, sleet, and cooling - China.com\\\\\\",\\\\\\"desc\\\\\\":\\\\\\"Shaanxi Provincial Meteorological Bureau issued an important weather report on January 19, forecasting widespread snow, sleet, cooling, and strong winds from January 24 to 26. Snow and sleet will mainly fall on January 24 and 25, while cooling will last from January 24 to 26. This weather event features wide coverage, high intensity, and complex precipitation types, along with significant cooling and strong winds...\\\\\\",\\\\\\"attributes\\\\\\":{\\\\\\"desc_truncate\\\\\\":0,\\\\\\"MainBody_truncate\\\\\\":1},\\\\\\"MainBody\\\\\\":\\\\\\"Shaanxi Provincial Meteorological Bureau issued an important weather report on January 19, forecasting widespread snow, sleet, cooling, and strong winds from January 24 to 26. Snow and sleet will mainly fall on January 24 and 25, while cooling will last from January 24 to 26. This weather event features wide coverage, high intensity, and complex precipitation types, along with significant cooling and strong winds.\\\\\\\\nOn January 24, northern Shaanxi will see moderate to heavy snow (2–5 mm), southern Shaanxi, Guanzhong, and Shangluo will see sleet turning into heavy to blizzard-level snow (5–15 mm), and Hanzhong and Ankang will see light to moderate rain or sleet turning into light to moderate snow (3–15 mm). On January 25, northern Shaanxi will see light to moderate snow (1–3 mm), Guanzhong will see moderate to heavy snow (3–5 mm), and southern Shaanxi will see sleet turning into moderate to heavy snow (4–15 mm).\\\\\\\\nSnow depth is expected to reach 5–8 cm in northern Shaanxi, 1–6 cm in Guanzhong, 0–5 cm in southern Shaanxi, and 10–20 cm in Qinba Mountain areas. From January 24 to 26, average daily temperatures in northern Shaanxi and Qinba Mountain areas will drop by 12–14°C, with local drops up to 16°C; Guanzhong will drop by 10–14°C; and southern Shaanxi will drop by 10–12°C. The lowest temperatures will occur on the morning of January 27, at -22 to -20°C in northern Shaanxi, -18 to -16°C in northern Guanzhong, -10 to -8°C in southern Guanzhong, -14 to -12°C in Shangluo, -7 to -5°C in Hanzhong and Ankang, and -18 to -13°C in Qinba Mountain areas, with some areas below -20°C. From January 24 night to January 26, northern Shaanxi, most parts of Guanzhong, Shangluo, and Qinba Mountain areas will experience gales of level 5...\\\\\\"},{\\\\\\"RawUrl\\\\\\":\\\\\\"https://c.m.163.com/news/a/JM90PUQI0514CILT.html\\\\\\",\\\\\\"sc_name\\\\\\":\\\\\\"structure_web_info\\\\\\",\\\\\\"time\\\\\\":\\\\\\"1737260160\\\\\\",\\\\\\"hostname\\\\\\":\\\\\\"NetEase News App\\\\\\",\\\\\\"article_title\\\\\\":\\\\\\"Next week\'s weather to change dramatically; a wave of overcast and rainy days coming, with minimum temperature of -2°C on Chinese New Year\'s Eve\\\\\\",\\\\\\"url\\\\\\":\\\\\\"https://c.m.163.com/news/a/JM90PUQI0514CILT.html\\\\\\",\\\\\\"shorturl\\\\\\":\\\\\\"c.m.163.com\\\\\\",\\\\\\"title\\\\\\":\\\\\\"Next week\'s weather to change dramatically; a wave of overcast and rainy days coming, with minimum temperature of -2°C on Chinese New Year\'s Eve - NetEase News App\\\\\\",\\\\\\"desc\\\\\\":\\\\\\"District Meteorological Station issued a weather forecast at 6 a.m. on January 19, 2025: clear to partly cloudy, with fog in some areas before noon today. Tomorrow will be partly cloudy. Westerly winds today, shifting to northwesterly winds tomorrow, both at force 3–4. Today\'s maximum temperature is 15°C, and tomorrow\'s minimum temperature is -1°C, with thin ice. This warming trend covers most of China. Before January 21, ...\\\\\\",\\\\\\"attributes\\\\\\":{\\\\\\"desc_truncate\\\\\\":0,\\\\\\"MainBody_truncate\\\\\\":1},\\\\\\"MainBody\\\\\\":\\\\\\"This weekend\\\\\\\\nJinshan District remains clear to partly cloudy\\\\\\\\nwith abundant sunshine\\\\\\\\nand warming as the main theme\\\\\\\\nDistrict Meteorological Station issued a weather forecast at 6 a.m. on January 19, 2025: clear to partly cloudy, with fog in some areas before noon today. Tomorrow will be partly cloudy. Westerly winds today, shifting to northwesterly winds tomorrow, both at force 3–4. Today\'s maximum temperature is 15°C, and tomorrow\'s minimum temperature is -1°C, with thin ice.\\\\\\\\nThis warming trend covers most of China. Before January 21, the cumulative increase in maximum temperatures in most parts of China can reach 6°C to 12°C. From January 19 to 21 is the warmest period of this cycle, with the 10°C maximum temperature line reaching southern North China, and temperatures south of the Yangtze River generally exceeding 20°C, with many places in South China exceeding 25°C.\\\\\\\\nOpen NetEase News to view more pictures\\\\\\\\nImage source: Huakai Haishang Ecological Park\\\\\\\\nBased on the current forecast, the warmth in many parts of southern China is comparable to early to mid-April. The warmth in the Jiangnan area is particularly prominent, with maximum temperatures generally 10°C to 15°C higher than the same period in previous years.\\\\\\\\nAfter this major warming trend\\\\\\\\na \'corrective\' cold front will move south\\\\\\\\nand temperatures may return to\\\\\\\\nnormal winter levels before the Spring Festival\\\\\\\\nStarting next Thursday, cloud cover will increase significantly\\\\\\\\nbringing a period of continuous overcast and rainy weather\\\\\\\\nThe dry weather that has lasted for more than a month\\\\\\\\nwill be alleviated\\\\\\\\nAround next Sunday\\\\\\\\na strong cold front will arrive\\\\\\\\nand temperatures will drop sharply\\\\\\\\nThe key day is Little New Year\'s Eve\\\\\\\\n(note January 27)\\\\\\\\nthe temperature will drop to -2°C\\\\\\\\nand the maximum temperature will only be 4°C\\\\\\\\nThe diurnal temperature range in recent days\\\\\\\\nmay be nearly 10°C\\\\\\\\nWarm during the day\\\\\\\\nbut still cool in the morning and evening...\\\\\\"},{\\\\\\"RawUrl\\\\\\":\\\\\\"https://sdxw.iqilu.com/share/YS0yMS0xNjE5NjExMA.html\\\\\\",\\\\\\"sc_name\\\\\\":\\\\\\"structure_web_info\\\\\\",\\\\\\"time\\\\\\":\\\\\\"1737277064\\\\\\",\\\\\\"hostname\\\\\\":\\\\\\"Qilu.com\\\\\\",\\\\\\"article_title\\\\\\":\\\\\\"Weather change next week! Shandong to welcome cold air, strong winds, and cooling, with light rain in some areas\\\\\\",\\\\\\"url\\\\\\":\\\\\\"https://sdxw.iqilu.com/share/YS0yMS0xNjE5NjExMA.html\\\\\\",\\\\\\"shorturl\\\\\\":\\\\\\"sdxw.iqilu.com\\\\\\",\\\\\\"title\\\\\\":\\\\\\"Weather change next week! Shandong to welcome cold air, strong winds, and cooling, with light rain in some areas - Qilu.com\\\\\\",\\\\\\"desc\\\\\\":\\\\\\"Today, the weather theme for most of China is still: dry. The weather will change next week, with Shandong welcoming cold air. According to Shandong... In short, next week\'s snow, sleet, and cooling will affect a wide area, and the cold of winter may return. It is currently the peak of the Spring Festival travel rush, so friends with travel plans should pack enough clothes and adjust their itineraries according to the weather changes...\\\\\\",\\\\\\"attributes\\\\\\":{\\\\\\"desc_truncate\\\\\\":0,\\\\\\"MainBody_truncate\\\\\\":1},\\\\\\"MainBody\\\\\\":\\\\\\"Original title: Weather change next week! Shandong to welcome cold air, strong winds, and cooling, with light rain in some areas\\\\\\\\nSource: Shandong Radio and Television Station\\\\\\\\nToday is the third day of the \'Fourth Nine\' period, and an unusually long and warm spell is approaching, with temperatures significantly higher than normal for this time of year.\\\\\\\\nToday, the weather theme for most of China is still: dry.\\\\\\\\nWeather will change next week, with Shandong welcoming cold air\\\\\\\\nAccording to the latest forecast from the Shandong Provincial Meteorological Station, from the 19th, day to night, the province will be clear to partly cloudy. From the 20th, day to night, the province will be clear to partly cloudy. From the 21st to the 24th, a weak cold front will affect the province, with mostly cloudy weather and light rain in some parts of southern Shandong.\\\\\\\\nSpecific forecast for the next 7 days:\\\\\\\\nFrom the night of the 18th to the day of the 19th, the province will be clear to partly cloudy. The peninsula area will have southerly winds of force 4–5 with gusts of 6, shifting to northerly winds of force 3–4. Other areas will have southerly winds of force 3–4, shifting to northerly winds of force 2–3.\\\\\\\\nMinimum temperature: around -5°C in northwestern Shandong and the peninsula inland areas, and around -3°C in other areas.\\\\\\\\nMaximum temperature: around 11°C in southern Shandong, around 5°C in northern coastal areas, and around 8°C in other areas.\\\\\\\\nFrom the night of the 19th to the day of the 20th, the province will be clear to partly cloudy. Northerly winds will shift to southerly winds, with force 3–4 in the peninsula area and around 3 in other areas.\\\\\\\\nMinimum temperature: around -5°C in northwestern and central Shandong, and around -3°C in other areas.\\\\\\\\nMaximum temperature: around 13°C in Heze and Liaocheng, around 7°C in the peninsula area, and around 10°C in other areas.\\\\\\\\nFrom the night of the 20th to the day of the 21st, the province will be clear to partly cloudy. The peninsula area will have southerly winds of force 3–4, while other areas will have southerly winds shifting to northerly winds of force 3–...\\\\\\"},{\\\\\\"RawUrl\\\\\\":\\\\\\"https://sdxw.iqilu.com/share/YS0yMS0xNjE5NjY4NA.html\\\\\\",\\\\\\"sc_name\\\\\\":\\\\\\"structure_web_info\\\\\\",\\\\\\"time\\\\\\":\\\\\\"1737298306\\\\\\",\\\\\\"hostname\\\\\\":\\\\\\"Qilu.com\\\\\\",\\\\\\"article_title\\\\\\":\\\\\\"Snow, sleet, and cooling! Heavy fog! Dezhou\'s weather forecast for next week→\\\\\\",\\\\\\"url\\\\\\":\\\\\\"https://sdxw.iqilu.com/share/YS0yMS0xNjE5NjY4NA.html\\\\\\",\\\\\\"shorturl\\\\\\":\\\\\\"sdxw.iqilu.com\\\\\\",\\\\\\"title\\\\\\":\\\\\\"Snow, sleet, and cooling! Heavy fog! Dezhou\'s weather forecast for next week→ - Qilu.com\\\\\\",\\\\\\"desc\\\\\\":\\\\\\"Qilu.com · Lightning News, January 19 - Dezhou Meteorological Station released the latest weather forecast this afternoon, predicting mainly clear to partly cloudy weather from January 20–24, with rising temperatures. Heavy fog may occur on the mornings of the 23rd and 24th. A snow, sleet, and cooling event is expected from the 25th to the 26th. The weekly minimum temperature of -7°C will occur on the morning of the 20th, and the weekly maximum...\\\\\\",\\\\\\"attributes\\\\\\":{\\\\\\"desc_truncate\\\\\\":0,\\\\\\"MainBody_truncate\\\\\\":0},\\\\\\"MainBody\\\\\\":\\\\\\"Qilu.com · Lightning News, January 19 - Dezhou Meteorological Station released the latest weather forecast this afternoon, predicting mainly clear to partly cloudy weather from January 20–24, with rising temperatures. Heavy fog may occur on the mornings of the 23rd and 24th. A snow, sleet, and cooling event is expected from the 25th to the 26th. The weekly minimum temperature of -7°C will occur on the morning of the 20th, and the weekly maximum temperature of 11°C will occur from the 20th to the 21st.\\\\\\\\nSpecific forecast\\\\\\\\nTonight: clear, southeast wind force 1, minimum temperature -6°C.\\\\\\\\nTomorrow: clear, south wind force 2, maximum temperature 11°C.\\\\\\\\nNight of the 20th: clear, southwest wind force 1, minimum temperature -4°C.\\\\\\\\nDay of the 21st: clear to partly cloudy, northeast wind force 2, maximum temperature 10°C.\\\\\\\\nNight of the 21st: clear, northeast wind force 2, minimum temperature -1°C.\\\\\\\\nDay of the 22nd: clear, northeast wind force 2, maximum temperature 10°C.\\\\\\\\nNight of the 22nd: clear, north wind force 1, minimum temperature -5°C.\\\\\\\\nDay of the 23rd: clear, northeast wind force 2, maximum temperature 8°C.\\\\\\\\nDezhou Station, Sun Jiuxin\\\\\\"},{\\\\\\"RawUrl\\\\\\":\\\\\\"https://mparticle.uc.cn/article.html?uc_param_str\\\\u003dfrdnsnpfvecpntnwprdssskt#!wm_aid\\\\u003d32cfb6517da7454c90e50a00e84dc7ab!!wm_id\\\\u003d64e2b4f2a9dc49a4be162b53d6572fd9\\\\\\",\\\\\\"sc_name\\\\\\":\\\\\\"structure_web_info\\\\\\",\\\\\\"time\\\\\\":\\\\\\"1737292453\\\\\\",\\\\\\"hostname\\\\\\":\\\\\\"Information Supermarket\\\\\\",\\\\\\"article_title\\\\\\":\\\\\\"Return home early! Dry weather to continue in the short term! Widespread snow and sleet trend credible for late next week\\\\\\",\\\\\\"url\\\\\\":\\\\\\"https://mparticle.uc.cn/article.html?uc_param_str\\\\u003dfrdnsnpfvecpntnwprdssskt#!wm_aid\\\\u003d32cfb6517da7454c90e50a00e84dc7ab!!wm_id\\\\u003d64e2b4f2a9dc49a4be162b53d6572fd9\\\\\\",\\\\\\"shorturl\\\\\\":\\\\\\"mparticle.uc.cn\\\\\\",\\\\\\"title\\\\\\":\\\\\\"Return home early! Dry weather to continue in the short term! Widespread snow and sleet trend credible for late next week - Information Supermarket\\\\\\",\\\\\\"desc\\\\\\":\\\\\\"But then it will decrease again, and for the latter half of the week, most areas will have clear and dry weather. In addition, dust may affect Ningxia and other areas at the beginning of the week. National precipitation forecast map (issued by the Central Meteorological Administration). Experts say that monitoring data shows that this afternoon (19th), the air on the Qinghai-Tibet Plateau and in the central and eastern regions is still dry. Among them, ...\\\\\\",\\\\\\"attributes\\\\\\":{\\\\\\"desc_truncate\\\\\\":0,\\\\\\"MainBody_truncate\\\\\\":1},\\\\\\"MainBody\\\\\\":\\\\\\"△ National precipitation forecast map (issued by the Central Meteorological Administration)\\\\\\\\nMinsheng Tianxia, Beijing, January 19 - In a flash, the traditional \'Minor Cold\' solar term is nearing its end. This week (January 13 - January 19), experts say the national weather stage saw a pattern of strong-then-weak cold air, with temperatures bottoming out and then rising, showing a \'V-shaped\' trend of low in the middle and significantly higher at the beginning and end of the week. In addition, at the beginning of the week, under the influence of the southern branch trough and the passage of a cold front, precipitation temporarily increased. But then it decreased again, and for the latter half of the week, most areas will have clear and dry weather. In addition, dust may affect Ningxia and other areas at the beginning of the week.\\\\\\\\n△ National precipitation forecast map (issued by the Central Meteorological Administration)\\\\\\\\nExperts say that monitoring data shows that this afternoon (19th), the air on the Qinghai-Tibet Plateau and in the central and eastern regions is still dry. Among them, the relative humidity in Lhasa and Lijiang is less than 10%. In addition, statistics show that the relative humidity in Zhengzhou, Shijiazhuang, Beijing, Tianjin, Taiyuan, and Jinan is less than 20%. According to the latest meteorological data analysis, there will still be little rain and snow in the next 3 days; but after next Thursday (23rd), there may be widespread precipitation in the central and eastern regions.\\\\\\\\n△ National precipitation forecast map (issued by the Central Meteorological Administration)\\\\\\\\nIt is worth noting that industry insiders emphasize that it is not difficult to judge from the situation that, as experts say, there are still differences in the forecasts of European and American meteorological numerical models regarding the scope and intensity of snowfall; therefore, the public needs to pay attention to the revisions of the meteorological departments on water vapor transport and dynamic coordination in the later period. As...\\\\\\"},{\\\\\\"RawUrl\\\\\\":\\\\\\"http://cj.sina.cn/articles/view/2369612657/8d3d6b71019018vom?finpagefr\\\\u003dp_104\\\\\\",\\\\\\"sc_name\\\\\\":\\\\\\"structure_web_info\\\\\\",\\\\\\"time\\\\\\":\\\\\\"1737286740\\\\\\",\\\\\\"hostname\\\\\\":\\\\\\"Finance Headlines\\\\\\",\\\\\\"article_title\\\\\\":\\\\\\"Widespread snowfall + cooling! Weather changes next week→\\\\\\",\\\\\\"url\\\\\\":\\\\\\"http://cj.sina.cn/articles/view/2369612657/8d3d6b71019018vom?finpagefr\\\\u003dp_104\\\\\\",\\\\\\"shorturl\\\\\\":\\\\\\"cj.sina.cn\\\\\\",\\\\\\"title\\\\\\":\\\\\\"Widespread snowfall + cooling! Weather changes next week→ - Finance Headlines\\\\\\",\\\\\\"desc\\\\\\":\\\\\\"It is now the fourth nine-day period of winter, but the weather pattern of high temperatures and clear, dry conditions continues in most of Inner Mongolia. It is expected that in the next few days, the cold air will continue to be inactive, and temperatures across the region will rise steadily, with little rain or snow. Looking ahead, starting from the 24th, a stronger cold front will affect our region, bringing widespread snow, sleet, and...\\\\\\",\\\\\\"attributes\\\\\\":{\\\\\\"desc_truncate\\\\\\":0,\\\\\\"MainBody_truncate\\\\\\":0},\\\\\\"MainBody\\\\\\":\\\\\\"Jungar Banner\'s weather forecast for the next week\\\\\\\\n(January 20 - January 26)\\\\\\\\n▪ Monday to Thursday (January 20 - January 23), Jungar Banner will be mainly clear, with temperatures slowly rising;\\\\\\\\n▪ Friday to Saturday (January 24 - January 25), Jungar Banner will have a widespread snowfall event, with strong winds during the snowfall, and temperatures dropping by 8–10°C after the snow;\\\\\\\\n▪ Sunday (January 26), partly cloudy, with the minimum temperature dropping to -19 to -15°C.\\\\\\\\nIt is now the fourth nine-day period of winter, but the weather pattern of high temperatures and clear, dry conditions continues in most of Inner Mongolia. It is expected that in the next few days, the cold air will continue to be inactive, and temperatures across the region will rise steadily, with little rain or snow. Looking ahead, starting from the 24th, a stronger cold front will affect our region, bringing widespread snow, sleet, and cooling. There will be heavy snow in many parts of the central and western regions, and blizzards in the western and southern parts of Ordos City. Temperatures in most of the western region and the western part of the northeast will drop by 6 to 8°C, with some areas dropping by more than 8°C, accompanied by short-term northwesterly winds of force 5-6, gusting to 7-8.\\\\\\\\nAs the Spring Festival approaches, during the peak of the travel rush, the public needs to pay timely attention to the latest weather forecasts and take precautions against the adverse effects of rain, snow, and cooling on transportation.\\\\\\\\nSource: Jungar Banner Converged Media Center\\\\\\\\n0 comments | 0 participants User comments\\\\\\"},{\\\\\\"RawUrl\\\\\\":\\\\\\"https://m.163.com/dy/article/JMA24PJU0530JPVV.html?spss\\\\u003ddy_author\\\\\\",\\\\\\"sc_name\\\\\\":\\\\\\"structure_web_info\\\\\\",\\\\\\"time\\\\\\":\\\\\\"1737295147\\\\\\",\\\\\\"hostname\\\\\\":\\\\\\"NetEase Subscription\\\\\\",\\\\\\"article_title\\\\\\":\\\\\\"-6°C + sleet! Zibo\'s weather next week→\\\\\\",\\\\\\"url\\\\\\":\\\\\\"https://m.163.com/dy/article/JMA24PJU0530JPVV.html?spss\\\\u003ddy_author\\\\\\",\\\\\\"shorturl\\\\\\":\\\\\\"m.163.com\\\\\\",\\\\\\"title\\\\\\":\\\\\\"-6°C + sleet! Zibo\'s weather next week→ - NetEase Subscription\\\\\\",\\\\\\"desc\\\\\\":\\\\\\"Next week, some areas of Shandong will have light rain and snow. According to the Shandong Provincial Meteorological Station, from the 20th to the 21st, the weather in the province will be clear to partly cloudy, with rising temperatures; from the 22nd to the 25th, a weak cold front will affect the area, with increased cloud cover and some... From the night of the 21st to the day of the 22nd, Heze, Jining, and Liaocheng will have partly cloudy to cloudy weather with light rain in some areas, while other areas will have partly cloudy weather...\\\\\\",\\\\\\"attributes\\\\\\":{\\\\\\"desc_truncate\\\\\\":0,\\\\\\"MainBody_truncate\\\\\\":1},\\\\\\"MainBody\\\\\\":\\\\\\"Tomorrow (January 20)\\\\\\\\nwill be the Major Cold solar term\\\\\\\\nMajor Cold is the last of the twenty-four solar terms\\\\\\\\nWhat will the weather be like next\\\\\\\\nLet\'s take a look\\\\\\\\nStarting from the 23rd, a strong cold front will bring rain, snow, and cooling\\\\\\\\nAccording to @ChinaWeather, from January 19 to 21, temperatures in most of the country will continue to rise steadily, and we will welcome the Major Cold solar term with even warmer \'posture\'. This round of warming will be long-lasting and widespread, and temperatures in various places will reach their recent highs. Starting from the 23rd, a strong cold front will affect most of our country, bringing widespread rain and snow. During the Spring Festival travel rush, the public needs to pay close attention to weather changes and make corresponding preparations in advance.\\\\\\\\nNext week, some areas of Shandong will have light rain and snow\\\\\\\\nAccording to the Shandong Provincial Meteorological Station, from the 20th to the 21st, the weather in the province will be clear to partly cloudy, with rising temperatures; from the 22nd to the 25th, a weak cold front will affect the area, with increased cloud cover and light rain and snow in some areas.\\\\\\\\nSpecific forecast\\\\\\\\nFrom the night of the 19th to the day of the 20th, the province will be clear to partly cloudy. North wind shifting to south wind, force 3-4. Minimum temperature: around -5°C in northwestern and central Shandong, and around -3°C in other areas. Maximum temperature: around 12°C in Liaocheng, Heze, and Jining, around 6°C in northern coastal areas, and around 9°C in other areas.\\\\\\\\nFrom the night of the 20th to the day of the 21st, the province will be clear to partly cloudy. South wind shifting to north wind, force 3-4. Minimum temperature: around -1°C in coastal areas, and around -3°C in other areas. Maximum temperature: around 10°C in northwestern Shandong and the peninsula, and around 13°C in other areas.\\\\\\\\nFrom the night of the 21st to the day of the 22nd, Heze, Jining, and...\\\\\\"},{\\\\\\"RawUrl\\\\\\":\\\\\\"http://cj.sina.cn/articles/view/1931238691/731c5d2301901pjje?finpagefr\\\\u003dp_104\\\\\\",\\\\\\"sc_name\\\\\\":\\\\\\"structure_web_info\\\\\\",\\\\\\"time\\\\\\":\\\\\\"1737286980\\\\\\",\\\\\\"hostname\\\\\\":\\\\\\"Finance Headlines\\\\\\",\\\\\\"article_title\\\\\\":\\\\\\"Rain, snow, strong winds, and cooling are coming! Next week, Qingdao\'s weather will change!\\\\\\",\\\\\\"url\\\\\\":\\\\\\"http://cj.sina.cn/articles/view/1931238691/731c5d2301901pjje?finpagefr\\\\u003dp_104\\\\\\",\\\\\\"shorturl\\\\\\":\\\\\\"cj.sina.cn\\\\\\",\\\\\\"title\\\\\\":\\\\\\"Rain, snow, strong winds, and cooling are coming! Next week, Qingdao\'s weather will change! - Finance Headlines\\\\\\",\\\\\\"desc\\\\\\":\\\\\\"For the next two days, the clear and warm weather trend will continue, with the city\'s maximum temperature reaching between 7 and 11 degrees, which is conducive to pre-holiday cleaning and Spring Festival travel. In general, for most of next week, there will be no significant cold air influence, with weak winds and small temperature fluctuations. However, for inland areas, although it doesn\'t feel like the fourth nine-day period of winter during the day, the diurnal temperature range is large, ...\\\\\\",\\\\\\"attributes\\\\\\":{\\\\\\"desc_truncate\\\\\\":0,\\\\\\"MainBody_truncate\\\\\\":1},\\\\\\"MainBody\\\\\\":\\\\\\"It\'s the third and fourth nine-day periods of winter\\\\\\\\nWinter is ending and spring is coming. At 4:00 on January 20, we will welcome the last of the twenty-four solar terms—Major Cold\\\\\\\\nIt is expected that from January 19 to 21,\\\\\\\\ntemperatures in most of the country will continue to rise steadily,\\\\\\\\nand we will welcome the Major Cold solar term with an even warmer \'posture\'.\\\\\\\\nThis round of warming will be long-lasting and widespread,\\\\\\\\nand temperatures in various places will reach their recent highs.\\\\\\\\nStarting from the 23rd,\\\\\\\\na strong cold front will affect most of our country,\\\\\\\\nand bring widespread rain and snow.\\\\\\\\nIt will bring a 6 to 10°C drop in temperature to most areas,\\\\\\\\nwith some areas seeing a drop of more than 12°C,\\\\\\\\naccompanied by winds of force 4 to 6.\\\\\\\\nShandong Provincial Meteorological Station at 16:00 on January 19, 2025\\\\\\\\nreleased a short-term weather forecast for the province\\\\\\\\nFrom the night of the 19th to the day of the 20th, the province will be clear to partly cloudy. North wind shifting to south wind, force 3–4.\\\\\\\\nMinimum temperature: around -5°C in northwestern and central Shandong, and around -3°C in other areas.\\\\\\\\nMaximum temperature: around 12°C in Liaocheng, Heze, and Jining, around 6°C in northern coastal areas, and around 9°C in other areas.\\\\\\\\nFrom the night of the 20th to the day of the 21st, the province will be clear to partly cloudy. South wind shifting to north wind, force 3–4.\\\\\\\\nMinimum temperature: around -1°C in coastal areas, and around -3°C in other areas.\\\\\\\\nMaximum temperature: around 10°C in northwestern Shandong and the peninsula, and around 13°C in other areas.\\\\\\\\nFrom the night of the 21st to the day of the 22nd, Heze, Jining, and Liaocheng will have partly cloudy to cloudy weather with light rain in some areas, while other areas will have partly cloudy weather. North wind, force 3–4.\\\\\\\\nMinimum temperature: around 1°C in southern Shandong and coastal areas, and around -2°C in other areas.\\\\\\\\nMaximum temperature: in...\\\\\\"},{\\\\\\"RawUrl\\\\\\":\\\\\\"https://m.163.com/dy/article/JM9AHHJC0550E6NG.html?spss\\\\u003ddy_author\\\\\\",\\\\\\"sc_name\\\\\\":\\\\\\"structure_web_info\\\\\\",\\\\\\"time\\\\\\":\\\\\\"1737270399\\\\\\",\\\\\\"hostname\\\\\\":\\\\\\"NetEase Subscription\\\\\\",\\\\\\"article_title\\\\\\":\\\\\\"Rain, snow! Cooling! Next week, Linyi\'s weather will change!\\\\\\",\\\\\\"url\\\\\\":\\\\\\"https://m.163.com/dy/article/JM9AHHJC0550E6NG.html?spss\\\\u003ddy_author\\\\\\",\\\\\\"shorturl\\\\\\":\\\\\\"m.163.com\\\\\\",\\\\\\"title\\\\\\":\\\\\\"Rain, snow! Cooling! Next week, Linyi\'s weather will change! - NetEase Subscription\\\\\\",\\\\\\"desc\\\\\\":\\\\\\"In short, next week\'s rain, snow, and cooling will affect a wide area, and the cold of winter may return. It is currently the peak of the Spring Festival travel rush, so friends with travel plans should pack enough clothes and adjust their itineraries according to the weather changes. However, the forecast is still far out, and the weather may still change, so it is necessary to keep a close watch. Spread the word! Let everyone know! The video account has been updated...\\\\\\",\\\\\\"attributes\\\\\\":{\\\\\\"desc_truncate\\\\\\":0,\\\\\\"MainBody_truncate\\\\\\":1},\\\\\\"MainBody\\\\\\":\\\\\\"Although it is now the fourth nine-day period of winter\\\\\\\\nLinyi is experiencing significant warming\\\\\\\\nToday\'s maximum temperature reached 12°C\\\\\\\\nSpecific weather forecast\\\\\\\\nThis afternoon to tonight, clear to partly cloudy, north wind force 3, temperature 12 to -3°C;\\\\\\\\nFrom the day of the 20th to the night, clear to partly cloudy, north wind shifting to south wind force 3, temperature 11 to -1°C;\\\\\\\\nFrom the day of the 21st to the night, clear to partly cloudy, south wind shifting to east wind force 3–4, temperature 12 to -1°C.\\\\\\\\nHowever\\\\\\\\nNext week, the weather will change\\\\\\\\nAccording to the latest forecast from the Shandong Provincial Meteorological Station\\\\\\\\nFrom the 19th to the 21st, the province will be clear to partly cloudy\\\\\\\\nwith rising temperatures\\\\\\\\nFrom the 22nd to the 25th, a weak cold front will affect the area\\\\\\\\nwith light rain and snow in southern Shandong\\\\\\\\nWeather forecast for the next three days in the province\\\\\\\\nFrom the day of the 19th to the night, the province will be clear to partly cloudy. The peninsula area will have a north wind of force 3–4, while other areas will have a north wind shifting to a south wind of force 3–4.\\\\\\\\nNighttime minimum temperature: around -5°C in northwestern and central Shandong, and around -3°C in other areas.\\\\\\\\nMaximum temperature: around 11°C in southern Shandong, around 5°C in northern coastal areas, and around 8°C in other areas.\\\\\\\\nFrom the day of the 20th to the night, the province will be clear to partly cloudy. The peninsula area will have a north wind shifting to a south wind of force 3–4, while other areas will have a south wind of force 3–4.\\\\\\\\nNighttime minimum temperature: around -1°C in coastal areas, and around -3°C in other areas.\\\\\\\\nMaximum temperature: around 13°C in Heze and Liaocheng, around 7°C in the peninsula area, and around 10°C in other areas.\\\\\\\\nFrom the day of the 21st to the night, northwestern Shandong will have partly cloudy to cloudy weather, while other areas will have partly cloudy weather. South wind shifting to north wind, force 3–4.\\\\\\\\nNighttime minimum temperature: in...\\\\\\"}],\\\\\\"@attributes\\\\\\":{\\\\\\"total\\\\\\":760082,\\\\\\"searchtime\\\\\\":339,\\\\\\"status\\\\\\":\\\\\\"OK\\\\\\"}}}\\"}","contentType":"JSON","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:20"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":"According to","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:24"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" the search","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:24"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" results","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:24"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":", next week\'s weather","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:24"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" forecast is as follows:\\n\\n-","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:24"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" **January 2","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:24"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":"2 (Monday","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:25"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":")**: Partly","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:25"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" cloudy, with temperatures gradually","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:25"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" rising. The daytime high","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:25"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" will be around 17","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:25"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":"°C, and the nighttime low","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:25"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" will be around 7°C","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:25"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":".\\n- **January","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:26"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" 23","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:26"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" (Tuesday)**","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:26"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":": Partly cloudy,","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:26"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" with temperatures continuing to rise.","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:27"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" The daytime high will be around","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:27"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" 18°C,","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:27"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" and the nighttime low will be around","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:27"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" 8°C.\\n-","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:27"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" **January 2","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:27"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":"4 (Wednesday","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:28"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":")**: Partly","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:28"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" cloudy to cloudy,","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:28"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" with light rain in some areas","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:28"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":". The daytime high will be","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:28"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" around 14°C","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:29"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":", and the nighttime low will be","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:29"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" around 7°C.\\n","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:29"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":"- **January","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:30"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" 25 (","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:30"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":"Thursday)**:","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:30"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" Cloudy to light rain","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:30"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":". The daytime high will be","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:30"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" around 13°C","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:30"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":", and the nighttime low will be","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:31"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" around 5°C.\\n","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:31"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":"- **January","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:31"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" 26 (","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:31"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":"Friday)**:","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:31"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" Light rain. The daytime","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:31"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" high will be around 9","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:31"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":"°C, and the nighttime low","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:32"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" will be around 2°C","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:33"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":".\\n- **January","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:33"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" 27","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:33"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" (Saturday)**","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:34"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":": Cloudy to clear","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:34"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":". The daytime high will be","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:34"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" around 8°C,","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:34"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" and the nighttime low will be around","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:34"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" -1°C.\\n","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:34"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":"- **January","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:34"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" 28 (","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:35"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":"Sunday)**","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:35"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":": Clear. The daytime","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:35"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" high will be around 1","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:35"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":"0°C, and the nighttime","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:35"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" low will be around 1","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:35"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":"°C.\\n\\n Additionally,","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:35"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" starting from January 2","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:36"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":"4,","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:36"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" a strong","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:36"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" cold front will bring","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:36"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" widespread","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:36"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" rain, snow, and cooling","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:36"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":". Especially on January","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:37"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" 27","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:37"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" (Saturday) and","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:37"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" January 28","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:37"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" (Sunday","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:37"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":"), temperatures will drop","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:37"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" significantly. Stay","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:38"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" warm and plan","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:38"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":" your travel accordingly.","contentType":"TEXT","extraInfo":null,"stop":false,"time":"2025-01-21 16:57:38"}'."\n" + ."\n" + .'data:{"versionId":"439xzzdxwg","modelId":"qwen2.5-72b-instruct","threadId":"wx4nvjkvad","replayId":"7x6p2wrbav","role":"assistant","roleDisplayName":"","messageType":"Answer","contentGroup":"","content":null,"contentType":"TEXT","extraInfo":null,"stop":true,"time":"2025-01-21 16:57:38"}'."\n" + .'```', + 'changeSet' => [ + ['createdAt' => '2025-06-26T12:54:47.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunAgent'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:RunAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - '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 \\"1876540295480209409\\"\\n ],\\n \\"requestId\\": \\"EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258\\",\\n \\"cost\\": 0\\n}","type":"json"}]', ], - 'RebuildTask' => [ - 'summary' => '重建任务', - 'path' => '/{workspaceId}/api/task/rebuild', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'RunChatResultGeneration' => [ + 'summary' => 'Generates chat responses. You can select a model for the conversation and choose streaming or non-streaming output.', + 'path' => '/{workspaceId}/api/run/chat/generation', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREsfmJIZ0TW', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], + 'schema' => ['description' => 'Path parameter. The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body parameters.', 'type' => 'object', 'properties' => [ - 'taskIds' => [ - 'title' => '任务id列表', - 'description' => '', + 'inferenceParameters' => ['description' => 'Hyperparameters used for inference.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{"topP": 0.8}'], + 'messages' => [ + 'title' => '', + 'description' => 'Messages to input into the model.', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'Message content.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '你是一个信息处理专家'], + 'role' => ['description' => 'Message role.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'user'], + ], 'required' => false, - 'example' => '3894763764', + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => true, + 'example' => '', + ], + 'modelId' => ['description' => 'The model service type. Get this value from the /api/app/config API endpoint in the llmHelperTypeList field.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'qwen-max'], + 'sessionId' => ['description' => 'Session ID. Use this to mark a conversation.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '237645726354'], + 'stream' => ['description' => 'Streaming mode. Set to true for streaming responses. Set to false for full responses. Default is false.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], + 'tools' => [ + 'title' => '', + 'description' => 'Tool information. Specify a list of tools the model can call. When multiple tools are provided, the model selects one to generate a response.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Tool information.', + 'type' => 'object', + 'properties' => [ + 'function' => [ + 'title' => '', + 'description' => 'An object containing name, description, and parameters.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'A string describing the tool function. This helps the model decide when and how to call it.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '工具函数的描述'], + 'name' => ['description' => 'A string representing the tool function name. It must contain only letters, digits, underscores, and hyphens. Maximum length is 64 characters.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'get_time'], + 'parameters' => [ + 'title' => '', + 'description' => 'An object describing the tool parameters. It must be a valid JSON Schema.', + 'type' => 'object', + 'properties' => [ + 'properties' => ['description' => 'Properties.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "location": {'."\n" + .' "type": "string",'."\n" + .' "description": "The city and state, e.g. San Francisco, CA"'."\n" + .' },'."\n" + .' "unit": {'."\n" + .' "type": "string",'."\n" + .' "enum": ['."\n" + .' "celsius",'."\n" + .' "fahrenheit"'."\n" + .' ]'."\n" + .' }'."\n" + .' }', 'title' => ''], + 'type' => ['description' => 'Type.', 'type' => 'string', 'required' => false, 'example' => 'object', 'title' => ''], + ], + 'required' => false, + 'example' => '', + ], + 'required' => [ + 'description' => 'List of required parameters.', + 'type' => 'array', + 'items' => ['description' => 'Required parameter.', 'type' => 'string', 'required' => false, 'example' => 'location', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + 'type' => ['description' => 'A string indicating the tool type. Currently, only "function" is supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'function'], + ], + 'required' => false, + 'example' => '', + ], + 'required' => false, + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<List<Map<String, Object>>>', - 'description' => 'ResultCode<List<Map<String, Object>>>', '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' => '', + 'choices' => [ + 'title' => '', + 'description' => 'Details of the model-generated content.', 'type' => 'array', 'items' => [ - 'title' => '', - 'description' => '', + 'description' => 'Details of the model-generated content.', 'type' => 'object', + 'properties' => [ + 'finishReason' => ['description' => 'Three possible values:'."\n" + ."\n" + .'- null while generating;'."\n" + ."\n" + .'- "stop" if generation ends due to a stop condition in the input parameters;'."\n" + ."\n" + .'- "length" if generation ends because the output is too long.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'index' => ['description' => 'Sequence number of the generated result. Default is 0.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'message' => [ + 'title' => '', + 'description' => 'Chat message.', + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'Message content.', 'type' => 'string', 'title' => '', 'example' => '你是谁'], + 'role' => ['description' => 'Role.', 'type' => 'string', 'title' => '', 'example' => 'user'], + 'toolCalls' => [ + 'title' => '', + 'description' => 'List of tool calls.', + 'type' => 'array', + 'items' => ['description' => 'Tool call.', 'type' => 'object', 'example' => '{'."\n" + .' "type": "function",'."\n" + .' "function": {'."\n" + .' "name": "get_current_weather",'."\n" + .' "arguments": "{\\"location\\": \\"长沙\\", \\"unit\\": \\"celsius\\"}"'."\n" + .' },'."\n" + .' "id": ""'."\n" + .' }', 'title' => ''], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'title' => '', 'example' => '', ], + 'example' => '', ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => 'EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258', - ], - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', + 'created' => ['description' => 'Creation time.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1720602203'], + 'id' => ['description' => 'Request identifier.', 'type' => 'string', 'title' => '', 'example' => 'eb2b6139-ddf1-91a0-a47f-df7617ae9032'], + 'modelId' => ['description' => 'Large Language Model (LLM) ID.', 'type' => 'string', 'title' => '', 'example' => 'qwen-max'], + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => 'eb2b6139-ddf1-91a0-a47f-df7617ae9032'."\n"], + 'time' => ['description' => 'Timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], + 'totalTokens' => ['description' => 'Total tokens.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '500'], + 'usage' => [ + 'title' => '', + 'description' => 'Usage.', + 'type' => 'object', + 'properties' => [ + 'imageCount' => ['description' => 'Number of images. Returned by models such as wanx.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'imageTokens' => ['description' => 'Image tokens. Returned by models such as qwen-vl.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], + 'inputTokens' => ['description' => 'Input tokens.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'outputTokens' => ['description' => 'Output tokens.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '300'], + 'totalTokens' => ['description' => 'Total tokens.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '500'], + ], + 'example' => '', ], ], - ], - ], - ], - '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 {\\n \\"message\\": \\"任务正在执行中,不能重新构建\\",\\n \\"taskId\\": \\"-253103935\\",\\n \\"status\\": \\"error\\"\\n }\\n ],\\n \\"requestId\\": \\"EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258\\",\\n \\"cost\\": 0\\n}","type":"json"}]', - ], - 'EvictTask' => [ - 'summary' => '中断任务', - 'path' => '/{workspaceId}/api/task/evict', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'title' => '业务空间Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], - ], - [ - 'name' => 'taskId', - 'in' => 'query', - 'schema' => [ - 'title' => '任务Id', 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '17071319', + 'title' => '', + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ResultCode<String>', - 'description' => 'ResultCode<String>', - 'type' => 'object', - 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'data' => [ - 'title' => '响应数据', - 'description' => '', - 'type' => 'string', - 'example' => '17071319', - ], - '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' => '44BD277A-87F9-5310-8D63-3E6645F1DA85', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'time' => [ - 'title' => '时间戳', - 'description' => '', - 'type' => 'string', - 'example' => '2024-04-24 11:54:34', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"choices\\": [\\n {\\n \\"finishReason\\": \\"null\\",\\n \\"index\\": 0,\\n \\"message\\": {\\n \\"content\\": \\"你是谁\\",\\n \\"role\\": \\"user\\",\\n \\"toolCalls\\": [\\n {\\n \\"type\\": \\"function\\",\\n \\"function\\": {\\n \\"name\\": \\"get_current_weather\\",\\n \\"arguments\\": \\"{\\\\\\"location\\\\\\": \\\\\\"长沙\\\\\\", \\\\\\"unit\\\\\\": \\\\\\"celsius\\\\\\"}\\"\\n },\\n \\"id\\": \\"\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"created\\": 1720602203,\\n \\"id\\": \\"eb2b6139-ddf1-91a0-a47f-df7617ae9032\\",\\n \\"modelId\\": \\"qwen-max\\",\\n \\"requestId\\": \\"eb2b6139-ddf1-91a0-a47f-df7617ae9032\\\\n\\",\\n \\"time\\": \\"2024-04-24 11:54:34\\",\\n \\"totalTokens\\": 500,\\n \\"usage\\": {\\n \\"imageCount\\": 0,\\n \\"imageTokens\\": 0,\\n \\"inputTokens\\": 200,\\n \\"outputTokens\\": 300,\\n \\"totalTokens\\": 500\\n }\\n}","type":"json"}]', + 'title' => 'Generate conversation result ', + 'description' => 'Before you use this API, review the billing method and pricing for Alibaba Cloud Tongyi Dianjin.'."\n" + ."\n" + .'**Prerequisites**'."\n" + ."\n" + .'- Activate Alibaba Cloud Model Studio and Tongyi Dianjin.'."\n" + ."\n" + .'- Obtain your workspace ID: retrieve your [workspace identifier](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunChatResultGeneration'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:RunChatResultGeneration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"17071319\\",\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"返回任务取消的结果,成功/失败。\\",\\n \\"requestId\\": \\"44BD277A-87F9-5310-8D63-3E6645F1DA85\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', ], - 'GetTaskStatus' => [ - 'summary' => '获取财报总结任务结果', - 'path' => '/{workspaceId}/api/task/status', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'RunDialogAnalysis' => [ + 'summary' => 'Retrieves session analysis results through a streaming API.', + 'path' => '/{workspaceId}/api/virtualHuman/dialog/stream/analysis', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/octet-stream'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'title' => '业务空间Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx', 'title' => ''], ], [ - 'name' => 'taskId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '任务Id', - 'description' => '', - 'type' => 'string', - 'required' => true, + 'title' => '', + 'description' => 'The request body parameters.', + 'type' => 'object', + 'properties' => [ + 'sessionId' => ['description' => 'The session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '1759457905S001vejpvd6vej'], + ], + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<String>', - 'description' => 'ResultCode<String>', + 'title' => 'ResultCode<DialogAnalysisResult>', + 'description' => 'Result code', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], + 'success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'dataType' => ['description' => 'The data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'time' => ['description' => 'The timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], 'data' => [ - 'title' => '响应数据,任务状态。', - 'description' => '', - 'type' => 'string', - ], - 'dataType' => [ - 'title' => '数据类型', - 'description' => '', - 'type' => 'string', - ], - 'errCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - ], - 'message' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - ], - 'time' => [ - 'title' => '时间戳', - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'dialogAnalysisRespList' => [ + 'title' => '', + 'description' => 'The list of session analysis results.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The session analysis result.', + 'type' => 'object', + 'properties' => [ + 'sessionId' => ['description' => 'The session ID.', 'type' => 'string', 'title' => '', 'example' => '1759457905S001vejpvd6vej'], + 'gmtCreate' => ['description' => 'The time when the session was created.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'."\n"], + 'status' => [ + 'description' => 'The execution status of the session analysis task.', + 'enumValueTitles' => ['success' => 'The task succeeded.', 'pending' => 'The task is in progress.', 'error' => 'The task failed.'], + 'type' => 'string', + 'title' => '', + 'example' => 'success', + ], + 'analysisResp' => [ + 'title' => '', + 'description' => 'The result of the session analysis.', + 'type' => 'object', + 'properties' => [ + 'dialogLabels' => [ + 'title' => '', + 'description' => 'The list of session labels.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The session label.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The label name.', 'type' => 'string', 'title' => '', 'example' => '二级标签'], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => '协商还款'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'dialogSummary' => ['description' => 'The session summary.', 'type' => 'string', 'title' => '', 'example' => '- 是否有资金需求:否\\\\n- 是否有意向:否,客户认为自己已经解决,对当前状态表示不解\\\\n- 是否可营销:否,对话中未表现出对营销信息的兴趣或接受度\\\\n- 待满足需求:客户希望在三天内解决问题'], + 'dialogExecPlan' => ['description' => 'The session execution plan.', 'type' => 'string', 'title' => '', 'example' => '1. 核实客户账户信息,确认还款情况。\\\\n2. 若未收到还款,联系财务部门确认是否到账延迟。\\\\n3. 若已还款,更新客户记录并致歉。\\\\n4. 跟进客户,确保问题解决。'], + 'dialogSop' => ['description' => 'The session SOP.', 'type' => 'string', 'title' => '', 'example' => '营销'], + 'dialogProcessAnalysis' => [ + 'title' => '', + 'description' => 'The session process analysis.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The content of the session process analysis.', 'type' => 'any', 'title' => '', 'example' => '{'."\n" + .' "dialogues": ['."\n" + .' {'."\n" + .' "result": ['."\n" + .' {'."\n" + .' "value": "开场白",'."\n" + .' "key": "客服"'."\n" + .' },'."\n" + .' {'."\n" + .' "value": "拒绝",'."\n" + .' "key": "客户"'."\n" + .' }'."\n" + .' ],'."\n" + .' "round": 1.0'."\n" + .' },'."\n" + .' {'."\n" + .' "result": ['."\n" + .' {'."\n" + .' "value": "挽留",'."\n" + .' "key": "客服"'."\n" + .' },'."\n" + .' {'."\n" + .' "value": "中性",'."\n" + .' "key": "客户"'."\n" + .' }'."\n" + .' ],'."\n" + .' "round": 2.0'."\n" + .' }'."\n" + .' ],'."\n" + .' "dialogProcessAnalysisStr": "第一轮对话:客服-开场白,客户-拒绝\\\\n第二轮对话:客服-挽留,客户-中性"'."\n" + .'}'], + 'example' => '', + ], + 'dialogOpenAnalysis' => [ + 'title' => '', + 'description' => 'The session open analysis.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The content of the session open analysis.', 'type' => 'any', 'title' => '', 'example' => '{'."\n" + .' "dialogues": ['."\n" + .' {'."\n" + .' "result": ['."\n" + .' {'."\n" + .' "value": "开场白",'."\n" + .' "key": "客服"'."\n" + .' },'."\n" + .' {'."\n" + .' "value": "拒绝",'."\n" + .' "key": "客户"'."\n" + .' }'."\n" + .' ],'."\n" + .' "round": 1.0'."\n" + .' },'."\n" + .' {'."\n" + .' "result": ['."\n" + .' {'."\n" + .' "value": "挽留",'."\n" + .' "key": "客服"'."\n" + .' },'."\n" + .' {'."\n" + .' "value": "中性",'."\n" + .' "key": "客户"'."\n" + .' }'."\n" + .' ],'."\n" + .' "round": 2.0'."\n" + .' }'."\n" + .' ],'."\n" + .' "dialogProcessAnalysisStr": "第一轮对话:客服-开场白,客户-拒绝\\\\n第二轮对话:客服-挽留,客户-中性"'."\n" + .'}'], + 'example' => '', + ], + ], + 'example' => '', + ], + 'failNode' => [ + 'title' => '', + 'description' => 'The list of failed nodes.', + 'type' => 'array', + 'items' => ['description' => 'The failed node.', 'type' => 'string', 'title' => '', 'example' => 'DIALOG_OPEN_ANALYSIS'], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '02CD4454-3F2C-57D0-9060-68DEAA1F6993'], + 'cost' => ['description' => 'The time consumed, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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 \\"dialogAnalysisRespList\\": [\\n {\\n \\"sessionId\\": \\"1759457905S001vejpvd6vej\\",\\n \\"gmtCreate\\": \\"2024-04-24 11:54:34\\\\n\\",\\n \\"status\\": \\"success\\",\\n \\"analysisResp\\": {\\n \\"dialogLabels\\": [\\n {\\n \\"name\\": \\"二级标签\\",\\n \\"value\\": \\"协商还款\\"\\n }\\n ],\\n \\"dialogSummary\\": \\"- 是否有资金需求:否\\\\\\\\\\\\\\\\n- 是否有意向:否,客户认为自己已经解决,对当前状态表示不解\\\\\\\\\\\\\\\\n- 是否可营销:否,对话中未表现出对营销信息的兴趣或接受度\\\\\\\\\\\\\\\\n- 待满足需求:客户希望在三天内解决问题\\",\\n \\"dialogExecPlan\\": \\"1. 核实客户账户信息,确认还款情况。\\\\\\\\\\\\\\\\n2. 若未收到还款,联系财务部门确认是否到账延迟。\\\\\\\\\\\\\\\\n3. 若已还款,更新客户记录并致歉。\\\\\\\\\\\\\\\\n4. 跟进客户,确保问题解决。\\",\\n \\"dialogSop\\": \\"营销\\",\\n \\"dialogProcessAnalysis\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"dialogues\\\\\\": [\\\\n {\\\\n \\\\\\"result\\\\\\": [\\\\n {\\\\n \\\\\\"value\\\\\\": \\\\\\"开场白\\\\\\",\\\\n \\\\\\"key\\\\\\": \\\\\\"客服\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"value\\\\\\": \\\\\\"拒绝\\\\\\",\\\\n \\\\\\"key\\\\\\": \\\\\\"客户\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"round\\\\\\": 1.0\\\\n },\\\\n {\\\\n \\\\\\"result\\\\\\": [\\\\n {\\\\n \\\\\\"value\\\\\\": \\\\\\"挽留\\\\\\",\\\\n \\\\\\"key\\\\\\": \\\\\\"客服\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"value\\\\\\": \\\\\\"中性\\\\\\",\\\\n \\\\\\"key\\\\\\": \\\\\\"客户\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"round\\\\\\": 2.0\\\\n }\\\\n ],\\\\n \\\\\\"dialogProcessAnalysisStr\\\\\\": \\\\\\"第一轮对话:客服-开场白,客户-拒绝\\\\\\\\\\\\\\\\n第二轮对话:客服-挽留,客户-中性\\\\\\"\\\\n}\\"\\n },\\n \\"dialogOpenAnalysis\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"dialogues\\\\\\": [\\\\n {\\\\n \\\\\\"result\\\\\\": [\\\\n {\\\\n \\\\\\"value\\\\\\": \\\\\\"开场白\\\\\\",\\\\n \\\\\\"key\\\\\\": \\\\\\"客服\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"value\\\\\\": \\\\\\"拒绝\\\\\\",\\\\n \\\\\\"key\\\\\\": \\\\\\"客户\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"round\\\\\\": 1.0\\\\n },\\\\n {\\\\n \\\\\\"result\\\\\\": [\\\\n {\\\\n \\\\\\"value\\\\\\": \\\\\\"挽留\\\\\\",\\\\n \\\\\\"key\\\\\\": \\\\\\"客服\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"value\\\\\\": \\\\\\"中性\\\\\\",\\\\n \\\\\\"key\\\\\\": \\\\\\"客户\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"round\\\\\\": 2.0\\\\n }\\\\n ],\\\\n \\\\\\"dialogProcessAnalysisStr\\\\\\": \\\\\\"第一轮对话:客服-开场白,客户-拒绝\\\\\\\\\\\\\\\\n第二轮对话:客服-挽留,客户-中性\\\\\\"\\\\n}\\"\\n }\\n },\\n \\"failNode\\": [\\n \\"DIALOG_OPEN_ANALYSIS\\"\\n ]\\n }\\n ]\\n },\\n \\"requestId\\": \\"02CD4454-3F2C-57D0-9060-68DEAA1F6993\\",\\n \\"cost\\": 0\\n}","type":"json"}]', + 'title' => 'Generate Conversation Analysis Result ', + 'description' => 'Before you use this API, make sure that you understand the billing methods and pricing for Tongyi Gold.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'You have activated Alibaba Cloud Model Studio and Tongyi Gold.'."\n" + ."\n" + .'You must have a workspace ID. For more information, see [workspace identity](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:RunDialogAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"running\\",\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"30F6AD44-F078-540D-B5A5-1E519C8E9E6D\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', ], - 'CreateDocsSummaryTask' => [ - 'summary' => '创建财报总结任务', - 'path' => '/{workspaceId}/api/task/summary/docs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'RunLibraryChatGeneration' => [ + 'summary' => 'Generates a chat response from a document library. You can ask questions in natural language, and the system retrieves relevant information to provide a summarized answer.', + 'path' => '/{workspaceId}/api/run/library/chat/generation', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx'."\n", - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'docInfos' => [ - 'title' => '文档信息列表', - 'description' => '', + 'docIdList' => [ + 'title' => '', + 'description' => 'A list of document IDs.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'docId' => [ - 'title' => '文档id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '198386463432', - ], - 'endPage' => [ - 'title' => '结束页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'items' => ['description' => 'A document ID.', 'type' => 'string', 'required' => false, 'example' => '1273827636xxx', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'enableFollowUp' => ['description' => 'Specifies whether to enable multi-turn enhancement.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], + 'enableMultiQuery' => ['description' => 'Specifies whether to enable query splitting.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], + 'enableOpenQa' => ['description' => 'Specifies whether to enable openQA.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], + 'followUpLlm' => ['description' => 'The Large Language Model (LLM) used for multi-turn query enhancement.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'qwen-max'], + 'libraryId' => ['description' => 'The ID of the document library.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '3akzl28vap'], + 'llmType' => ['description' => 'The type of the LLM.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'qwen-max'], + 'multiQueryLlm' => ['description' => 'The LLM used for query splitting.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'qwen-max'], + 'query' => ['description' => 'The query entered by the user.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '这两天北京气候怎么样'], + 'queryCriteria' => [ + 'title' => '', + 'description' => 'The property filter.', + 'type' => 'object', + 'properties' => [ + 'and' => [ + 'title' => '', + 'description' => 'The \\`and\\` expression, used to filter documents or document chunks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The content of the \\`and\\` expression.', + 'type' => 'object', + 'properties' => [ + 'boost' => ['description' => 'The weight of the tag. A value less than 1 decreases the weight of the corresponding keyword. A value greater than 1 increases the weight.', 'type' => 'number', 'format' => 'float', 'title' => '', 'required' => false, 'example' => '0.5'], + 'key' => ['description' => 'The key of the tag.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'city'], + 'operator' => ['description' => 'The operator for the tag. It specifies the relationship between the metadata key\'s stored value and your input value.'."\n" + ."\n" + .'- eq: Equal to.'."\n" + ."\n" + .'- lte: Less than or equal to.'."\n" + ."\n" + .'- gte: Greater than or equal to.'."\n" + ."\n" + .'- lt: Less than.'."\n" + ."\n" + .'- gt: Greater than.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'eq'], + 'value' => ['description' => 'The value of the tag.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '北京'], + ], 'required' => false, - 'example' => '2', - ], - 'libraryId' => [ - 'title' => '文档库id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rdxrmo6amk', + 'title' => '', + 'example' => '', ], - 'startPage' => [ - 'title' => '起始页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'required' => false, + 'example' => '', + ], + 'or' => [ + 'title' => '', + 'description' => 'The \\`or\\` expression, used to filter documents or document chunks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The content of the \\`or\\` expression.', + 'type' => 'object', + 'properties' => [ + 'boost' => ['description' => 'The weight of the tag. A value less than 1 decreases the weight of the corresponding keyword. A value greater than 1 increases the weight.', 'type' => 'number', 'format' => 'float', 'title' => '', 'required' => false, 'example' => '0.5'], + 'key' => ['description' => 'The key of the tag.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'city'], + 'operator' => ['description' => 'The operator for the tag. It specifies the relationship between the metadata key\'s stored value and your input value.'."\n" + ."\n" + .'- eq: Equal to.'."\n" + ."\n" + .'- lte: Less than or equal to.'."\n" + ."\n" + .'- gte: Greater than or equal to.'."\n" + ."\n" + .'- lt: Less than.'."\n" + ."\n" + .'- gt: Greater than.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'eq'], + 'value' => ['description' => 'The value of the tag.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '北京'], + ], 'required' => false, - 'example' => '1', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], - 'required' => false, ], - 'required' => true, + 'required' => false, + 'example' => '', ], - 'enableTable' => [ - 'title' => '是否启用表格,默认为true,表示启用。', - 'description' => '', - 'type' => 'boolean', + 'rerankType' => ['description' => 'The type of the sort policy. Valid values: \\`linear\\` and \\`model\\`. \\`linear\\`: rule-based sorting. \\`model\\`: model-based sorting (LLM).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'linear'], + 'sessionId' => ['title' => 'sessionId', 'description' => 'The session ID.', 'type' => 'string', 'required' => false, 'example' => 'null'], + 'stream' => ['description' => 'Specifies whether to use streaming or non-streaming mode.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], + 'subQueryList' => [ + 'title' => '', + 'description' => 'A list of subqueries.', + 'type' => 'array', + 'items' => ['description' => 'A subquery.', 'type' => 'string', 'required' => false, 'example' => '北京最近气温如何?', 'title' => ''], 'required' => false, - 'example' => 'true', - 'default' => 'true', + 'example' => '', ], - 'instruction' => [ - 'title' => '指令', - 'description' => '', - 'type' => 'string', + 'textSearchParameter' => [ + 'title' => '', + 'description' => 'Search engine parameters: text search parameters.', + 'type' => 'object', + 'properties' => [ + 'limit' => ['description' => 'The number of rows to return.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], + 'searchAnalyzerType' => ['description' => 'The search tokenizer. Valid values: \\`Standard\\`, \\`IkMaxWord\\`, and \\`IkSmart\\`. Configure this parameter as needed. If left empty, the tokenizer attached to the document library is used.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'IkMaxWord'], + ], 'required' => false, 'example' => '', ], - 'modelId' => [ - 'title' => '模型id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'qwen-plus', + 'topK' => ['description' => 'The final number of retrieved corpus entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], + 'vectorSearchParameter' => [ + 'title' => '', + 'description' => 'Search engine parameters: vector search parameters.', + 'type' => 'object', + 'properties' => [ + 'limit' => ['description' => 'The number of rows to return.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], + ], + 'required' => false, + 'example' => '', ], + 'withDocumentReference' => ['description' => 'Specifies whether to return document references.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<String>', - 'description' => 'ResultCode<String>', + 'title' => 'ResultCode<Object>', + 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'data' => [ - 'title' => '响应数据', - 'description' => '', - 'type' => 'string', - 'example' => '765675376', - ], - '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-01-01 00:00:00', - ], + 'cost' => ['description' => 'The time consumed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => ['description' => 'The response data (non-streaming).', 'type' => 'any', 'title' => '', 'example' => '{'."\n" + .' "finish":true,'."\n" + .' "text":"是的,记名预付卡的有效期不得低于3年。",'."\n" + .' "message": "是的,记名预付卡的有效期不得低于3年。",'."\n" + .' "queryResult":{'."\n" + .' "errCode": "0", //接口协议层面的错误码,正常为0,未授权,参数错误,服务器异常时会发生变化,可以忽略不处理'."\n" + .' "message": "ok", //接口协议层面的消息'."\n" + .' "data":{'."\n" + .' "success": true, //有回答true 无回答false'."\n" + .' "answer": null, //大模型生成的回答结果'."\n" + .' "embeddingElapsedMs": 127,'."\n" + .' "vectorSearchElapsedMs": 2745,'."\n" + .' "llmElapsedMs": 7911,'."\n" + .' "totalElapsedMs": 10820,'."\n" + .' "chunks": [ //召回的分块信息,一般为top5或top10,可联系我们调整效果'."\n" + .' {'."\n" + .' "chunkId": "470182177892469799", //分块信息的编号'."\n" + .' "docId": "22666332", //分块关联的文档编号'."\n" + .' "chunkText": "Profits plummeted in the first quarter, can\'t you bear it? In fact, previous rounds of price cuts have indeed had a certain impact on Tesla\'s financial data. Tesla has just released its financial report for the first quarter of this year. The data shows that in Q1 2023, Tesla achieved revenue of 23.33 billion US dollars, an increase of 24% over the previous year; Tesla delivered more than 422,000 electric vehicles worldwide in the first quarter, an increase of 36% over the previous year", //新闻原始内容'."\n" + .' "chunkMeta": { // demo数据中的其他metadata'."\n" + .' "language": "en",'."\n" + .' "unique_id": "news_22666332_13",'."\n" + .' "content_type": "news",'."\n" + .' "stock_id_list": []'."\n" + .' }'."\n" + .' }],'."\n" + .' "documents": [{'."\n" + .' "docId": "1686637056086872065", //文档编号'."\n" + .' "gmtCreate": "2023-08-02 15:16:25", //文档的创建时间'."\n" + .' "libraryId": "a1b2c3", //文档关联的知识库编号'."\n" + .' "title": "2023年工银信用卡微信、京东绑卡消费累计积分活动", //文档标题'."\n" + .' "url": null //文档连接,如有'."\n" + .' }] //块文本关联的文档'."\n" + .' },'."\n" + .' "success": true //接口协议层面的成功/失败状态 true就是errCode为0'."\n" + .' }'."\n" + .' }'], + 'dataType' => ['description' => 'The data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'The timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"{\\\\n \\\\\\"finish\\\\\\":true,\\\\n \\\\\\"text\\\\\\":\\\\\\"是的,记名预付卡的有效期不得低于3年。\\\\\\",\\\\n \\\\\\"message\\\\\\": \\\\\\"是的,记名预付卡的有效期不得低于3年。\\\\\\",\\\\n \\\\\\"queryResult\\\\\\":{\\\\n \\\\\\"errCode\\\\\\": \\\\\\"0\\\\\\",\\\\t//接口协议层面的错误码,正常为0,未授权,参数错误,服务器异常时会发生变化,可以忽略不处理\\\\n \\\\\\"message\\\\\\": \\\\\\"ok\\\\\\",\\\\t//接口协议层面的消息\\\\n \\\\\\"data\\\\\\":{\\\\n \\\\\\"success\\\\\\": true,\\\\t//有回答true 无回答false\\\\n \\\\\\"answer\\\\\\": null,\\\\t//大模型生成的回答结果\\\\n \\\\\\"embeddingElapsedMs\\\\\\": 127,\\\\n \\\\\\"vectorSearchElapsedMs\\\\\\": 2745,\\\\n \\\\\\"llmElapsedMs\\\\\\": 7911,\\\\n \\\\\\"totalElapsedMs\\\\\\": 10820,\\\\n \\\\\\"chunks\\\\\\": [\\\\t//召回的分块信息,一般为top5或top10,可联系我们调整效果\\\\n {\\\\n \\\\\\"chunkId\\\\\\": \\\\\\"470182177892469799\\\\\\",\\\\t//分块信息的编号\\\\n \\\\\\"docId\\\\\\": \\\\\\"22666332\\\\\\",\\\\t//分块关联的文档编号\\\\n \\\\\\"chunkText\\\\\\": \\\\\\"Profits plummeted in the first quarter, can\'t you bear it? In fact, previous rounds of price cuts have indeed had a certain impact on Tesla\'s financial data. Tesla has just released its financial report for the first quarter of this year. The data shows that in Q1 2023, Tesla achieved revenue of 23.33 billion US dollars, an increase of 24% over the previous year; Tesla delivered more than 422,000 electric vehicles worldwide in the first quarter, an increase of 36% over the previous year\\\\\\",\\\\t//新闻原始内容\\\\n \\\\\\"chunkMeta\\\\\\": {\\\\t// demo数据中的其他metadata\\\\n \\\\\\"language\\\\\\": \\\\\\"en\\\\\\",\\\\n \\\\\\"unique_id\\\\\\": \\\\\\"news_22666332_13\\\\\\",\\\\n \\\\\\"content_type\\\\\\": \\\\\\"news\\\\\\",\\\\n \\\\\\"stock_id_list\\\\\\": []\\\\n }\\\\n }],\\\\n \\\\\\"documents\\\\\\": [{\\\\n \\\\\\"docId\\\\\\": \\\\\\"1686637056086872065\\\\\\",\\\\t//文档编号\\\\n \\\\\\"gmtCreate\\\\\\": \\\\\\"2023-08-02 15:16:25\\\\\\",\\\\t//文档的创建时间\\\\n \\\\\\"libraryId\\\\\\": \\\\\\"a1b2c3\\\\\\",\\\\t//文档关联的知识库编号\\\\n \\\\\\"title\\\\\\": \\\\\\"2023年工银信用卡微信、京东绑卡消费累计积分活动\\\\\\",\\\\t//文档标题\\\\n \\\\\\"url\\\\\\": null\\\\t//文档连接,如有\\\\n }]\\\\t//块文本关联的文档\\\\n },\\\\n \\\\\\"success\\\\\\": true\\\\t//接口协议层面的成功/失败状态 true就是errCode为0\\\\n }\\\\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"}]', + 'title' => 'Generate Document Library Session', + 'responseParamsDescription' => '## Streaming response description'."\n" + ."\n" + .'### Result rewritten based on conversation history'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "success": true,'."\n" + .' "dataType": "copilotStep",'."\n" + .' "time": "2024-08-26 11:28:10",'."\n" + .' "errCode": "0",'."\n" + .' "message": "ok",'."\n" + .' "data": {'."\n" + .' "stepName": "start_followup_query", // Start rewriting'."\n" + .' "data": "How is the performance"'."\n" + .' },'."\n" + .' "requestId": null,'."\n" + .' "cost": null'."\n" + .'}'."\n" + ."\n\n" + .'{'."\n" + .' "success": true,'."\n" + .' "dataType": "copilotStep",'."\n" + .' "time": "2024-08-26 11:28:10",'."\n" + .' "errCode": "0",'."\n" + .' "message": "ok",'."\n" + .' "data": {'."\n" + .' "stepName": "completed_followup_query", // Rewriting completed'."\n" + .' "data": "How is the performance"'."\n" + .' },'."\n" + .' "requestId": null,'."\n" + .' "cost": null'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'### Query decomposition'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "success": true,'."\n" + .' "dataType": "copilotStep",'."\n" + .' "time": "2024-08-26 11:28:10",'."\n" + .' "errCode": "0",'."\n" + .' "message": "ok",'."\n" + .' "data": {'."\n" + .' "stepName": "start_understand_query", // Start decomposition'."\n" + .' "data": "How is the performance"'."\n" + .' },'."\n" + .' "requestId": null,'."\n" + .' "cost": null'."\n" + .'}'."\n" + ."\n" + .'{'."\n" + .' "success": true,'."\n" + .' "dataType": "copilotStep",'."\n" + .' "time": "2024-08-26 11:28:12",'."\n" + .' "errCode": "0",'."\n" + .' "message": "ok",'."\n" + .' "data": {'."\n" + .' "stepName": "completed_understand_query", // Decomposition completed'."\n" + .' "data": ['."\n" + .' "What is the specific time period for the performance?",'."\n" + .' "Which industry\'s or company\'s performance are you referring to?",'."\n" + .' "What are the data metrics for performance? For example, revenue, profit, market share, etc."'."\n" + .' ]'."\n" + .' },'."\n" + .' "requestId": null,'."\n" + .' "cost": null'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'### Retrieval results'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "success": true,'."\n" + .' "dataType": "queryResult",'."\n" + .' "time": "2023-09-20 16:36:04",'."\n" + .' "errCode": "0",'."\n" + .' "message": "retriever completed",'."\n" + .' "data": {'."\n" + .' "success": true,'."\n" + .' "answer": null,'."\n" + .' "prompt": "Please use the following context to answer the final question.\\n The following is the context:\\n ... unless otherwise specified in these measures. The validity period of a non-registered prepaid card must not be less than 3 years.\\n Prepaid cards must not have an overdraft function.\\n When issuing and selling prepaid cards, the issuing institution must inform the cardholder of the card\'s validity period and its calculation method. For prepaid cards that still have a balance after the expiration date, the issuing institution must provide services such as extension, activation, or card replacement to ensure the cardholder can continue to use the funds.\\n Article 9: The face of the prepaid card must display elements such as the prepaid card name, the name of the issuing institution, whether it is registered, the card number, the validity period or expiration date, notes for the cardholder, and the customer service phone number.\\n Article 10: Individuals or entities purchasing a registered prepaid card or making a one-time purchase of non-registered prepaid cards worth CNY 10,000 or more must use their real names and provide valid identification.\\n The issuing institution must verify the identity of the purchaser and the entity\'s handler,\\n\\n ... information.\\n For registered prepaid cards, the issuing institution must also record the cardholder\'s valid identification information, prepaid card number, amount, and other information in the core prepaid card business processing system.\\n Article 12: For one-time purchases of prepaid cards worth CNY 5,000 or more by an entity, or CNY 50,000 or more by an individual, the purchase must be made through non-cash settlement methods such as bank transfer. Cash must not be used.\\n The purchaser must not use a credit card to buy a prepaid card.\\n Article 13: When purchasing prepaid cards using non-cash settlement methods such as bank transfer, the payer\'s bank account name and the purchaser\'s name must be the same.\\n The issuing institution must verify the consistency of the account information and identity information, and record information such as the payer\'s bank account name and number, the payee\'s bank account name and number, and the transfer amount in the core prepaid card business processing system.\\n Article 14\\n\\n\\n\\n Based on your understanding of the context, provide an answer. Keep the answer as concise as possible. If you do not know the answer, just say \'I don\'t know\'.\\n Question: Must the validity period of a registered prepaid card be no less than 3 years?\\n Answer:",'."\n" + .' "embeddingElapsedMs": 1423,'."\n" + .' "vectorSearchElapsedMs": 115,'."\n" + .' "textSearchElapsedMs": 0,'."\n" + .' "llmElapsedMs": null,'."\n" + .' "totalElapsedMs": 1626,'."\n" + .' "reRankElapsedMs": 8,'."\n" + .' "chunks": ['."\n" + .' {'."\n" + .' "libraryId": "5rdxr3dxmk",'."\n" + .' "libraryName": "Fudian Bank Test Knowledge Base",'."\n" + .' "title": "Measures for the Administration of Prepaid Card Business of Payment Institutions (Announcement [2012] No. 12 of the People\'s Bank of China)",'."\n" + .' "chunkId": "478245189908103170",'."\n" + .' "docId": "1701838553380655106",'."\n" + .' "chunkText": "... unless otherwise specified in these measures. The validity period of a non-registered prepaid card must not be less than 3 years.\\n Prepaid cards must not have an overdraft function.\\n When issuing and selling prepaid cards, the issuing institution must inform the cardholder of the card\'s validity period and its calculation method. For prepaid cards that still have a balance after the expiration date, the issuing institution must provide services such as extension, activation, or card replacement to ensure the cardholder can continue to use the funds.\\n Article 9: The face of the prepaid card must display elements such as the prepaid card name, the name of the issuing institution, whether it is registered, the card number, the validity period or expiration date, notes for the cardholder, and the customer service phone number.\\n Article 10: Individuals or entities purchasing a registered prepaid card or making a one-time purchase of non-registered prepaid cards worth CNY 10,000 or more must use their real names and provide valid identification.\\n The issuing institution must verify the identity of the purchaser and the entity\'s handler,",'."\n" + .' "fileType": "pdf",'."\n" + .' "chunkMeta": {},'."\n" + .' "score": 0.92747295'."\n" + .' },'."\n" + .' {'."\n" + .' "libraryId": "5rdxr3dxmk",'."\n" + .' "libraryName": "Fudian Bank Test Knowledge Base",'."\n" + .' "title": "Measures for the Administration of Prepaid Card Business of Payment Institutions (Announcement [2012] No. 12 of the People\'s Bank of China)",'."\n" + .' "chunkId": "478245189908234242",'."\n" + .' "docId": "1701838553380655106",'."\n" + .' "chunkText": "... information.\\n For registered prepaid cards, the issuing institution must also record the cardholder\'s valid identification information, prepaid card number, amount, and other information in the core prepaid card business processing system.\\n Article 12: For one-time purchases of prepaid cards worth CNY 5,000 or more by an entity, or CNY 50,000 or more by an individual, the purchase must be made through non-cash settlement methods such as bank transfer. Cash must not be used.\\n The purchaser must not use a credit card to buy a prepaid card.\\n Article 13: When purchasing prepaid cards using non-cash settlement methods such as bank transfer, the payer\'s bank account name and the purchaser\'s name must be the same.\\n The issuing institution must verify the consistency of the account information and identity information, and record information such as the payer\'s bank account name and number, the payee\'s bank account name and number, and the transfer amount in the core prepaid card business processing system.\\n Article 14",'."\n" + .' "fileType": "pdf",'."\n" + .' "chunkMeta": {},'."\n" + .' "score": 0.8335201'."\n" + .' }'."\n" + .' ],'."\n" + .' "vectorChunks": ['."\n" + .' {'."\n" + .' "libraryId": "5rdxr3dxmk",'."\n" + .' "libraryName": null,'."\n" + .' "title": null,'."\n" + .' "chunkId": "478245189908103170",'."\n" + .' "docId": "1701838553380655106",'."\n" + .' "chunkText": "... unless otherwise specified in these measures. The validity period of a non-registered prepaid card must not be less than 3 years.\\n Prepaid cards must not have an overdraft function.\\n When issuing and selling prepaid cards, the issuing institution must inform the cardholder of the card\'s validity period and its calculation method. For prepaid cards that still have a balance after the expiration date, the issuing institution must provide services such as extension, activation, or card replacement to ensure the cardholder can continue to use the funds.\\n Article 9: The face of the prepaid card must display elements such as the prepaid card name, the name of the issuing institution, whether it is registered, the card number, the validity period or expiration date, notes for the cardholder, and the customer service phone number.\\n Article 10: Individuals or entities purchasing a registered prepaid card or making a one-time purchase of non-registered prepaid cards worth CNY 10,000 or more must use their real names and provide valid identification.\\n The issuing institution must verify the identity of the purchaser and the entity\'s handler,",'."\n" + .' "fileType": null,'."\n" + .' "chunkMeta": {},'."\n" + .' "score": 0.85494584'."\n" + .' },'."\n" + .' {'."\n" + .' "libraryId": "5rdxr3dxmk",'."\n" + .' "libraryName": null,'."\n" + .' "title": null,'."\n" + .' "chunkId": "478245189908234242",'."\n" + .' "docId": "1701838553380655106",'."\n" + .' "chunkText": "... information.\\n For registered prepaid cards, the issuing institution must also record the cardholder\'s valid identification information, prepaid card number, amount, and other information in the core prepaid card business processing system.\\n Article 12: For one-time purchases of prepaid cards worth CNY 5,000 or more by an entity, or CNY 50,000 or more by an individual, the purchase must be made through non-cash settlement methods such as bank transfer. Cash must not be used.\\n The purchaser must not use a credit card to buy a prepaid card.\\n Article 13: When purchasing prepaid cards using non-cash settlement methods such as bank transfer, the payer\'s bank account name and the purchaser\'s name must be the same.\\n The issuing institution must verify the consistency of the account information and identity information, and record information such as the payer\'s bank account name and number, the payee\'s bank account name and number, and the transfer amount in the core prepaid card business processing system.\\n Article 14",'."\n" + .' "fileType": null,'."\n" + .' "chunkMeta": {},'."\n" + .' "score": 0.6670402'."\n" + .' }'."\n" + .' ],'."\n" + .' "textChunks": [],'."\n" + .' "chunkParts": [],'."\n" + .' "chunkTextList": ['."\n" + .' "... unless otherwise specified in these measures. The validity period of a non-registered prepaid card must not be less than 3 years.\\n Prepaid cards must not have an overdraft function.\\n When issuing and selling prepaid cards, the issuing institution must inform the cardholder of the card\'s validity period and its calculation method. For prepaid cards that still have a balance after the expiration date, the issuing institution must provide services such as extension, activation, or card replacement to ensure the cardholder can continue to use the funds.\\n Article 9: The face of the prepaid card must display elements such as the prepaid card name, the name of the issuing institution, whether it is registered, the card number, the validity period or expiration date, notes for the cardholder, and the customer service phone number.\\n Article 10: Individuals or entities purchasing a registered prepaid card or making a one-time purchase of non-registered prepaid cards worth CNY 10,000 or more must use their real names and provide valid identification.\\n The issuing institution must verify the identity of the purchaser and the entity\'s handler,",'."\n" + .' "... information.\\n For registered prepaid cards, the issuing institution must also record the cardholder\'s valid identification information, prepaid card number, amount, and other information in the core prepaid card business processing system.\\n Article 12: For one-time purchases of prepaid cards worth CNY 5,000 or more by an entity, or CNY 50,000 or more by an individual, the purchase must be made through non-cash settlement methods such as bank transfer. Cash must not be used.\\n The purchaser must not use a credit card to buy a prepaid card.\\n Article 13: When purchasing prepaid cards using non-cash settlement methods such as bank transfer, the payer\'s bank account name and the purchaser\'s name must be the same.\\n The issuing institution must verify the consistency of the account information and identity information, and record information such as the payer\'s bank account name and number, the payee\'s bank account name and number, and the transfer amount in the core prepaid card business processing system.\\n Article 14"'."\n" + .' ],'."\n" + .' "documents": ['."\n" + .' {'."\n" + .' "docId": "1701838553380655106",'."\n" + .' "gmtCreate": "2023-09-13 14:01:44",'."\n" + .' "libraryId": null,'."\n" + .' "title": "Measures for the Administration of Prepaid Card Business of Payment Institutions (Announcement [2012] No. 12 of the People\'s Bank of China)",'."\n" + .' "url": null,'."\n" + .' "fileType": "pdf"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "cost": null'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'### Model summary result'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "success": true,'."\n" + .' "dataType": "message",'."\n" + .' "time": "2023-09-20 16:36:05",'."\n" + .' "errCode": "0",'."\n" + .' "message": "ok",'."\n" + .' "data": {'."\n" + .' "message": "Yes, ",// Incremental answer'."\n" + .' "text": "Yes, ", // Cumulative answer'."\n" + .' "finish": false'."\n" + .' },'."\n" + .' "cost": null'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunLibraryChatGeneration'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:RunLibraryChatGeneration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"765675376\\",\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"32FFC91D-0A9F-585A-B84F-8A54C5187035\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-01-01 00:00:00\\"\\n}","type":"json"}]', ], - 'CreateAnnualDocSummaryTask' => [ - 'summary' => '创建按年文档总结任务', - 'path' => '/{workspaceId}/api/task/summary/doc/annual', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SubmitChatQuestion' => [ + 'summary' => 'Submit a list of questions and retrieve results by calling the `GetChatQuestionResp` API.', + 'path' => '/{workspaceId}/api/virtualHuman/chat/submit', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxx', - ], + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body', 'type' => 'object', 'properties' => [ - 'anaYears' => [ - 'title' => '分析年份', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2023', - ], - 'required' => true, - ], - 'docInfos' => [ - 'title' => '文档信息列表', - 'description' => '', + 'sessionId' => ['description' => 'Session ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '237645726354'], + 'gmtService' => ['description' => 'Current time', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-09-27 11:23:20'], + 'liveScriptContent' => ['description' => 'Live channel script', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '我们家的酒全都是老酒,酒厂直售【当前用户问句】,保证正儿八经的自家酿造,地址都能告诉大家,品质实实在在的有保障。我们家这款酒入口非常绵柔顺滑,酱香、粮食香、花果香层层递进,空杯留香能持续48小时,不会有上头的感觉。今天我们是厂家直销,大家平时买酒在烟酒店要经过好几个环节的中间商,每个环节都要加价,今天在这里拍下,只会让你省不少冤枉钱。如果说你拿去存酒的话, 拍蓝瓶的云端系列也可以,越存的话会越香,你拿去托人办事、请人吃饭、商务宴请、搞接待送礼,直接带白瓶云悠系列。'."\n"], + 'openSmallTalk' => ['description' => 'Enable small talk. Default is true.', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'title' => '', 'example' => 'true'], + 'questionList' => [ + 'title' => '', + 'description' => 'Question list', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Question', 'type' => 'object', 'properties' => [ - 'docId' => [ - 'title' => '文档id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '198386463432', - ], - 'docYear' => [ - 'title' => '文档年份', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2023', - ], - 'endPage' => [ - 'title' => '结束页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - 'libraryId' => [ - 'title' => '文档库id', - 'description' => '', + 'sessionId' => ['description' => 'Session ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '1869300950603128834'], + 'userId' => ['description' => 'Unique ID of the user asking questions in the live channel', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '39485783475638465'], + 'userName' => ['description' => 'Name of the user asking questions in the live channel', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '张**'."\n"], + 'content' => ['description' => 'Question content', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '这是多大的体积'."\n"], + 'gmtCreate' => ['description' => 'Original question time', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2024-11-17 10:05:00'."\n"], + 'type' => [ + 'description' => 'Question type: PRODUCT\\_QA (audio submission), GOSSIP (operation submission), UNKNOWN (unknown)', + 'enumValueTitles' => ['PRODUCT_QA' => 'Audio submission', 'GOSSIP' => 'Operation submission', 'UNKNOWN' => 'Unknown'], 'type' => 'string', - 'required' => true, - 'example' => 'rdxrmo6amk', - ], - 'startPage' => [ - 'title' => '起始页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '', 'required' => false, - 'example' => '1', + 'example' => 'PRODUCT_QA'."\n", ], + 'reply' => ['description' => 'Reply content', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '这是三升的。'."\n"], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, - ], - 'enableTable' => [ - 'title' => '是否启用表格,默认为true,表示启用。', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], - 'instruction' => [ - 'title' => '指令', - 'description' => '', - 'type' => 'string', - 'required' => false, 'example' => '', ], - 'modelId' => [ - 'title' => '模型id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'qwen-plus', - ], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '0FC6636E-380A-5369-AE01-D1C15BB9B254'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<String>', - 'description' => 'ResultCode<String>', + 'title' => 'ResultCode<DiaChatSubmitVO>', + 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], 'data' => [ - 'title' => '响应数据。即任务ID。', - 'description' => '', - 'type' => 'string', - 'example' => '3284627354', - ], - '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-01-01 00:00:00', + 'title' => '', + 'description' => 'Response data', + 'type' => 'object', + 'properties' => [ + 'batchId' => ['description' => 'Batch ID', 'type' => 'string', 'title' => '', 'example' => '1869307330227937280'], + ], + 'example' => '', ], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '915AAAB9-4908-5224-9E53-9E9D7D0AA94B'], + 'cost' => ['description' => 'Time taken', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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 \\"batchId\\": \\"1869307330227937280\\"\\n },\\n \\"requestId\\": \\"915AAAB9-4908-5224-9E53-9E9D7D0AA94B\\",\\n \\"cost\\": 0\\n}","type":"json"}]', + 'title' => 'submit question List ', + 'description' => 'Review the pricing and billing details for the Tongyi Dianjin product before you use this API.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'Activate Alibaba Cloud Model Studio and Tongyi Dianjin.'."\n" + ."\n" + .'Obtain the \\`workspaceId\\`: Retrieve the [workspace identity](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitChatQuestion'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:SubmitChatQuestion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"3284627354\\",\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"32FFC91D-0A9F-585A-B84F-8A54C5187035\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-01-01 00:00:00\\"\\n}","type":"json"}]', ], - 'CreatePdfTranslateTask' => [ - 'summary' => '创建PDF翻译任务', - 'path' => '/{workspaceId}/api/task/pdfTranslate', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateDocument' => [ + 'summary' => 'Updates the title, metadata, and other information of a document.', + 'path' => '/{workspaceId}/api/library/document/updateDocument', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + '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-ik******RVYCKzt', - ], + 'schema' => ['description' => 'Path parameter, workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body parameter.', 'type' => 'object', 'properties' => [ - 'docId' => [ - 'title' => '文档id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '873648346573245', - ], - 'knowledge' => [ - 'title' => '知识:翻译时参考的领域知识', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'libraryId' => [ - 'title' => '文档库id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cjshcxxxx', - ], - 'modelId' => [ - 'title' => '模型id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'qwen-plus', - ], - 'translateTo' => [ - 'title' => '目标语言:默认为中文', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '中文', - 'default' => '中文', - ], + 'docId' => ['description' => 'Document ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '123'], + 'libraryId' => ['description' => 'Document library ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'abc123'], + 'meta' => ['description' => 'Document metadata.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" + .' "businessId": "12321"'."\n" + .' }'], + 'title' => ['description' => 'Document title.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -9498,2956 +7313,1270 @@ 200 => [ 'schema' => [ 'title' => 'ResultCode<String>', - 'description' => 'ResultCode<String>', + 'description' => 'Result.', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'data' => [ - 'title' => '响应数据', - 'description' => '', - 'type' => 'string', - 'example' => '3284627354', - ], - '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', - ], + 'cost' => ['description' => 'Time consumed', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => ['description' => 'Response data.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'dataType' => ['description' => 'Data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => 'eb2b6139-ddf1-91a0-a47f-df7617ae9032'], + 'success' => ['description' => 'Success status.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], ], + 'example' => '', ], ], ], - '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"}]', + 'title' => 'Update Document ', + 'description' => '**Prerequisites**'."\n" + ."\n" + .'- Activate the Alibaba Cloud Model Studio service and the Tongyi Gold service.'."\n" + ."\n" + .'- Obtain your workspace ID. For more information, see [workspace identity](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDocument'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:UpdateDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"3284627354\\",\\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"}]', ], - 'CreateFinReportSummaryTask' => [ - 'summary' => '创建财报总结任务', - 'path' => '/{workspaceId}/api/task/summary', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateDocumentChunk' => [ + 'summary' => 'Update the text content of a document chunk in a document.', + 'path' => '/{workspaceId}/api/library/updateDocumentChunk', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + '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', - ], + 'schema' => ['description' => 'Workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body parameters.', 'type' => 'object', 'properties' => [ - 'docId' => [ - 'title' => '文档id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'enableTable' => [ - 'title' => '是否启用表格', - 'description' => '', - 'type' => 'boolean', + 'libraryId' => ['description' => 'Library ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'sjdgdsfg'], + 'chunks' => [ + 'title' => '', + 'description' => 'List of document chunks.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Document chunk.', + 'type' => 'object', + 'properties' => [ + 'chunkId' => ['description' => 'Document chunk ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '1987834755763847'], + 'chunkText' => ['description' => 'Document chunk text.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '这是一段测试文本'], + ], + 'required' => true, + 'example' => '', + ], 'required' => true, - 'example' => 'true', - ], - 'endPage' => [ - 'title' => '结束页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'instruction' => [ - 'title' => '指令', - 'description' => '', - 'type' => 'string', - 'required' => false, 'example' => '', ], - 'libraryId' => [ - 'title' => '文档库id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3akzl28vap', - ], - 'modelId' => [ - 'title' => '模型id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'qwen-max', - ], - 'startPage' => [ - 'title' => '起始页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'taskType' => [ - 'title' => '任务类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'custom' => 'custom', - 'finance_report' => 'finance_report', - ], - 'example' => 'custom', - ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<String>', - 'description' => 'ResultCode<String>', + 'title' => 'ResultCode<ResultCodeEnum>', + 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'data' => [ - 'title' => '响应数据', - 'description' => '', - 'type' => 'string', - 'example' => '3284627354', - ], - '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', - ], + 'success' => ['description' => 'Is successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'dataType' => ['description' => 'Data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'time' => ['description' => 'Timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-01-01 00:00:00'], + 'errCode' => ['description' => 'Error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'data' => ['description' => 'Response data.', 'type' => 'string', 'title' => '', 'example' => 'SUCCESS'], + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => '003D019A-1BB3-53EC-A0D2-CE76DA5D73B1'], + 'cost' => ['description' => 'Processing time', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": \\"3284627354\\",\\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"}]', - ], - 'GetSummaryTaskResult' => [ - 'summary' => '获取财报总结任务结果', - 'path' => '/{workspaceId}/api/task/summary/result', - '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' => '业务空间Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxx', - ], - ], - [ - 'name' => 'taskId', - 'in' => 'query', - 'schema' => [ - 'title' => '任务Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '17071319', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ResultCode<ChatModelResponse>', - 'description' => 'ResultCode<ChatModelResponse>', - 'type' => 'object', - 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'data' => [ - 'title' => '响应数据', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'choices' => [ - 'title' => '模型生成内容的详情。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'finishReason' => [ - 'title' => '模型生成内容结束原因。', - 'description' => '', - 'type' => 'string', - 'example' => 'stop', - ], - 'index' => [ - 'title' => '生成的结果序列编号,默认为0。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'message' => [ - 'title' => '模型输出的消息。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'content' => [ - 'title' => '模型生成的文本。', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'role' => [ - 'title' => '模型的角色,固定为assistant。', - 'description' => '', - 'type' => 'string', - 'example' => 'assistant', - ], - 'toolCalls' => [ - 'title' => '工具调用', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'example' => 'null', - ], - ], - ], - ], - ], - ], - ], - 'created' => [ - 'title' => '创建时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1726285125915', - ], - 'id' => [ - 'title' => '系统生成的标识本次调用的id。', - 'description' => '', - 'type' => 'string', - 'example' => '1202', - ], - 'modelId' => [ - 'title' => '本次调用的模型名。', - 'description' => '', - 'type' => 'string', - 'example' => 'qwen-max', - ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '0bc13a9517168617617186457e401f', - ], - 'time' => [ - 'title' => '时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-04-24 11:54:34', - ], - 'totalTokens' => [ - 'title' => 'token量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - ], - 'usage' => [ - 'title' => '消耗token量', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'imageCount' => [ - 'title' => '图片数量,wanx等模型', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'imageTokens' => [ - 'title' => '图片token量,qwen-vl等模型', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'inputTokens' => [ - 'title' => '输入token量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'outputTokens' => [ - 'title' => '输出token量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'totalTokens' => [ - 'title' => '总token量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - ], - ], - ], - ], - ], - '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', - ], + '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"}]', + 'title' => 'Update document block content', + 'description' => 'Before using this API, ensure you understand the billing methods and pricing of the Tongyi Gold product.'."\n" + ."\n" + .'Prerequisites'."\n" + ."\n" + .'You must activate Alibaba Cloud Model Studio and Tongyi Gold services.'."\n" + ."\n" + .'Obtain the workspaceId. For more information, see the [workspace identity](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDocumentChunk'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dianjin:UpdateDocumentChunk', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"choices\\": [\\n {\\n \\"finishReason\\": \\"stop\\",\\n \\"index\\": 0,\\n \\"message\\": {\\n \\"content\\": \\"### **报告期经营业绩概述**\\\\\\\\n截至2024年3月31日止三个月的未经审核综合业绩显示强劲增长.\\",\\n \\"role\\": \\"assistant\\",\\n \\"toolCalls\\": [\\n null\\n ]\\n }\\n }\\n ],\\n \\"created\\": 1726285125915,\\n \\"id\\": \\"1202\\",\\n \\"modelId\\": \\"qwen-max\\",\\n \\"requestId\\": \\"0bc13a9517168617617186457e401f\\",\\n \\"time\\": \\"2024-04-24 11:54:34\\",\\n \\"totalTokens\\": 300,\\n \\"usage\\": {\\n \\"imageCount\\": 0,\\n \\"imageTokens\\": 0,\\n \\"inputTokens\\": 100,\\n \\"outputTokens\\": 200,\\n \\"totalTokens\\": 300\\n }\\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"}]', ], - 'GetTaskResult' => [ - 'summary' => '获取异步任务结果', - 'path' => '/{workspaceId}/api/task/result', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'UpdateLibrary' => [ + 'summary' => 'Updates a document library. You can update the library name, description, and index configuration.', + 'path' => '/{workspaceId}/api/library/update', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'title' => '业务空间Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxx', - ], - ], - [ - 'name' => 'taskId', - 'in' => 'query', - 'schema' => [ - 'title' => '任务Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '17071319', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ResultCode<ChatModelResponse>', - 'description' => 'ResultCode<ChatModelResponse>', - 'type' => 'object', - 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'data' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{'."\n" - .' "file_url": "https://finllmworks.oss-cn-zhangjiakou.aliyuncs.com/render_pdf/5336180997111160501.pdf"'."\n" - .'}', - ], - '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' => '9D5D6BB5-BEAE-53C8-A70A-7275CC1F856C', - ], - '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 \\"file_url\\": \\"https://finllmworks.oss-cn-zhangjiakou.aliyuncs.com/render_pdf/5336180997111160501.pdf\\"\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"9D5D6BB5-BEAE-53C8-A70A-7275CC1F856C\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', - ], - 'CreateQualityCheckTask' => [ - 'summary' => '创建财报总结的任务', - 'path' => '/{workspaceId}/api/qualitycheck/task/submit', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxx', - ], + 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body parameters', 'type' => 'object', 'properties' => [ - 'conversationList' => [ - 'title' => '会话内容,关联质检场景需要传入多个会话,否则只有一个会话', - 'description' => '', + 'description' => ['description' => 'Document library description', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '文档库描述'], + 'indexSetting' => [ + 'title' => '', + 'description' => 'Document library index configuration', 'type' => 'object', 'properties' => [ - 'callType' => [ - 'title' => '呼叫类型:', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 1 => '', - '', + 'chunkStrategy' => [ + 'title' => '', + 'description' => 'Chunking strategy', + 'type' => 'object', + 'properties' => [ + 'docTreeSplit' => ['description' => 'Layout-based chunking', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'docTreeSplitSize' => ['description' => 'Layout-based chunking size', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '160'], + 'enhanceGraph' => ['description' => 'Enhance images', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'enhanceTable' => ['description' => 'Enhance tables', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'overlap' => ['description' => 'Chunk overlap length', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '20'], + 'sentenceSplit' => ['description' => 'Split by sentence. Default is true', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'sentenceSplitSize' => ['description' => 'Average sentence-based chunking length', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '160'], + 'size' => ['description' => 'Fixed-length chunking size', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '256'], + 'split' => ['description' => 'Enable chunking', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], ], - 'example' => '1', - ], - 'customerId' => [ - 'title' => '客户ID', - 'description' => '', - 'type' => 'string', 'required' => false, - 'example' => '1', + 'example' => '', ], - 'customerName' => [ - 'title' => '客户名称', - 'description' => '', - 'type' => 'string', + 'modelConfig' => [ + 'title' => '', + 'description' => 'Model configuration', + 'type' => 'object', + 'properties' => [ + 'temperature' => ['description' => 'Temperature', 'type' => 'number', 'format' => 'double', 'title' => '', 'required' => false, 'example' => '0.8'], + 'topP' => ['title' => 'topP', 'description' => 'Top P', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.8'], + ], 'required' => false, 'example' => '', ], - 'customerServiceId' => [ - 'title' => '客服ID', - 'description' => '', - 'type' => 'string', + 'promptRoleStyle' => ['description' => 'Prompt role style', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '你是一位文档分析专家,非常善于从给定的知识中,找到重点,像老师给学生讲课一样把问题回答清晰。你的回答富有逻辑性,遇到复杂问题,你善于一步一步思考。'], + 'queryEnhancer' => [ + 'title' => '', + 'description' => 'Query enhancement', + 'type' => 'object', + 'properties' => [ + 'enableFollowUp' => ['description' => 'Multi-turn enhancement', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'enableMultiQuery' => ['description' => 'Use Large Language Models (LLMs) to decompose queries', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'enableOpenQa' => ['description' => 'Use Large Language Models (LLMs) to answer queries', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'enableQueryRewrite' => ['description' => 'Rewrite queries using domain knowledge', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'enableSession' => ['description' => 'Record session history', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'localKnowledgeId' => ['description' => 'Document library ID used for query rewriting', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'sjdhgfc'], + 'withDocumentReference' => ['description' => 'Include document references in responses', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + ], 'required' => false, - 'example' => 'xxx', + 'example' => '', ], - 'customerServiceName' => [ - 'title' => '客服名称', - 'description' => '', - 'type' => 'string', + 'recallStrategy' => [ + 'title' => '', + 'description' => 'Retrieval strategy', + 'type' => 'object', + 'properties' => [ + 'documentRankType' => [ + 'description' => 'Merge and sort strategy', + 'enumValueTitles' => ['model' => 'Sort using BGE', 'llm' => 'Sort using Large Language Models (LLMs)'], + 'type' => 'string', + 'title' => '', + 'required' => false, + 'example' => 'model', + ], + 'limit' => ['description' => 'Number of results from two-way merge and summarization', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], + ], 'required' => false, 'example' => '', ], - 'dialogueList' => [ - 'title' => '对话明细', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'begin' => [ - 'title' => '本句话的开始时间,相对于会话开始点的偏移时间ms', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'beginTime' => [ - 'title' => '这句话的开始时间', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-05-23 14:57:50', - ], - 'content' => [ - 'title' => '对话的具体内容', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'customerId' => [ - 'title' => '对话角色的唯一标识', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2348234', - ], - 'customerServiceId' => [ - 'title' => '客服ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '23874627346', - ], - 'customerServiceType' => [ - 'title' => '坐席类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', - ], - 'end' => [ - 'title' => '本句话的结束时间,相对于会话开始点的偏移时间ms', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'role' => [ - 'title' => '角色', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '1', - ], - 'type' => [ - 'title' => '对话内容的类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'IMAGE' => '', - 'TEXT' => '', - 'AUDIO' => '', - ], - 'example' => 'TEXT', - ], - ], - 'required' => false, + 'textIndexSetting' => [ + 'title' => '', + 'description' => 'Text index settings', + 'type' => 'object', + 'properties' => [ + 'category' => ['description' => 'Text index type', 'type' => 'string', 'example' => 'ElasticSearch', 'pattern' => '^ElasticSearch$', 'default' => 'ElasticSearch', 'title' => '', 'required' => false], + 'enable' => ['description' => 'Enable text indexing', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'indexAnalyzer' => ['description' => 'Text index analyzer: Standard, IkMaxWord, or IkSmart', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Standard'], + 'rankThreshold' => ['description' => 'Text index ranking threshold', 'type' => 'number', 'format' => 'double', 'title' => '', 'required' => false, 'example' => '0.5'], + 'searchAnalyzer' => ['description' => 'Text index search analyzer: Standard, IkMaxWord, or IkSmart', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Standard'], + 'topK' => ['description' => 'Number of final summarized results from text indexing', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '50'], ], - 'required' => true, + 'required' => false, + 'example' => '', ], - 'gmtService' => [ - 'title' => '会话时间', - 'description' => '', - 'type' => 'string', + 'vectorIndexSetting' => [ + 'title' => '', + 'description' => 'Vector index settings', + 'type' => 'object', + 'properties' => [ + 'category' => ['description' => 'Vector index source. We recommend ADB', 'type' => 'string', 'example' => 'ADB', 'pattern' => '^ADB$', 'default' => 'ADB', 'title' => '', 'required' => false], + 'embeddingType' => ['description' => 'Text embedding model for vector indexing', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'DashScope'], + 'enable' => ['description' => 'Enable vector indexing', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'rankThreshold' => ['description' => 'Vector index ranking threshold', 'type' => 'number', 'format' => 'double', 'title' => '', 'required' => false, 'example' => '0.5'], + 'topK' => ['description' => 'Number of final summarized results from vector indexing', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], + ], 'required' => false, - 'example' => '2024-09-27 11:23:20', + 'example' => '', ], ], - 'required' => true, - ], - 'gmtService' => [ - 'title' => '业务发生时间,用于系统记录提交时间,任务调度优先级决策等', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2024-09-27 11:23:20', - ], - 'metaData' => [ - 'title' => '元数据,用于规则执行过程中需要消费的一些业务相关的属性,由业务系统在发起质检的时候实时传入。', - 'description' => '', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => '', - ], - ], - 'qualityGroup' => [ - 'title' => '质检规则组', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '质检规则', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'warning_customers', - ], 'required' => false, + 'example' => '', ], - 'requestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '0FC6636E-380A-5369-AE01-D1C15BB9B254', - ], - 'type' => [ - 'title' => '质检类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - '', - ], - 'example' => '0', - ], - 'sceneCode' => [ - 'title' => '场景Code,如同playCode。', - 'type' => 'string', - ], + 'libraryId' => ['description' => 'Document library ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dsfbashdbb'], + 'libraryName' => ['description' => 'Document library name', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '测试文档库'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<QualitySubmitResponse>', - 'description' => 'ResultCode<QualitySubmitResponse>', + 'title' => 'ResultCode<String>', + 'description' => 'ResultCode\\<string>', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'data' => [ - 'title' => '响应数据', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'taskId' => [ - 'title' => 'taskId', - 'description' => 'taskId', - 'type' => 'string', - 'example' => '172373500521', - ], - ], - ], - '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' => 'EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'time' => [ - 'title' => '时间戳', - 'description' => '', - 'type' => 'string', - 'example' => '2024-04-24 11:54:34', - ], + 'cost' => ['description' => 'Processing time', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => ['description' => 'Response data', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'dataType' => ['description' => 'Data type', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'Error code', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'Error message', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => 'eb2b6139-ddf1-91a0-a47f-df7617ae9032'], + 'success' => ['description' => 'Operation succeeded', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"taskId\\": \\"172373500521\\"\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', - ], - 'GetQualityCheckTaskResult' => [ - 'summary' => '获取异步任务的结果', - 'path' => '/{workspaceId}/api/qualitycheck/task/query', - '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' => '业务空间Id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], - ], - [ - 'name' => 'taskId', - 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '17071319', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ResultCode<QualityQueryResponse>', - 'description' => 'ResultCode<QualityQueryResponse>', - 'type' => 'object', - 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - 'data' => [ - 'title' => '响应数据', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'conversationList' => [ - 'title' => '原始会话内容', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'callType' => [ - 'title' => '呼叫类型:', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 1 => '', - '', - ], - 'example' => '1', - ], - 'customerId' => [ - 'title' => '客户ID', - 'description' => '', - 'type' => 'string', - 'example' => '234234', - ], - 'customerName' => [ - 'title' => '客户名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'customerServiceId' => [ - 'title' => '客服ID', - 'description' => '', - 'type' => 'string', - 'example' => '23984763826', - ], - 'customerServiceName' => [ - 'title' => '客服名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'dialogueList' => [ - 'title' => '对话明细', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'begin' => [ - 'title' => '本句话的开始时间,相对于会话开始点的偏移时间ms', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'beginTime' => [ - 'title' => '这句话的开始时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-09-27 11:23:20', - ], - 'content' => [ - 'title' => '对话的具体内容', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'customerId' => [ - 'title' => '对话角色的唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'customerServiceId' => [ - 'title' => '客服ID', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'customerServiceType' => [ - 'title' => '坐席类型', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', - ], - 'end' => [ - 'title' => '本句话的结束时间,相对于会话开始点的偏移时间ms', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'id' => [ - 'title' => '本句话的唯一标识,内部赋值', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'role' => [ - 'title' => '角色', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', - ], - 'type' => [ - 'title' => '对话内容的类型', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'IMAGE' => '', - 'TEXT' => '', - 'AUDIO' => '', - ], - 'example' => 'TEXT', - ], - ], - ], - ], - 'gmtService' => [ - 'title' => '会话时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-09-27 11:23:20', - ], - ], - ], - 'gmtCreate' => [ - 'title' => '任务创建时间 提交任务的时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-09-27 11:23:20', - ], - 'gmtEnd' => [ - 'title' => '系统执行结束时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-09-27 11:23:20', - ], - 'gmtStart' => [ - 'title' => '系统执行开始时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-09-27 11:23:20', - ], - 'qualityCheckList' => [ - 'title' => '质检结果集', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'checkExplanation' => [ - 'title' => '通过或者不通过的原因解释', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'checkPassed' => [ - 'title' => '是否质检通过', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'NOT_PASSED' => '', - 'PASSED' => '', - ], - 'example' => 'PASSED', - ], - 'checkProcess' => [ - 'title' => '质检过程描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'checked' => [ - 'title' => '是否命中', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'HIT' => '', - 'NOT_HIT' => '', - ], - 'example' => 'HIT', - ], - 'gmtEnd' => [ - 'title' => '质检完成时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-05-23 14:57:50', - ], - 'gmtStart' => [ - 'title' => '质检开始时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-05-23 14:57:50', - ], - 'mode' => [ - 'title' => '内部质检模式', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - '', - ], - 'example' => '0', - ], - 'originDialogue' => [ - 'title' => '原始对话列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'begin' => [ - 'title' => '本句话的开始时间,相对于会话开始点的偏移时间ms', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'beginTime' => [ - 'title' => '这句话的开始时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-05-23 14:57:50', - ], - 'content' => [ - 'title' => '对话的具体内容', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'customerId' => [ - 'title' => '对话角色的唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => 'xxx', - ], - 'customerServiceId' => [ - 'title' => '客服ID', - 'description' => '', - 'type' => 'string', - 'example' => '23876432', - ], - 'customerServiceType' => [ - 'title' => '坐席类型', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', - ], - 'end' => [ - 'title' => '本句话的结束时间,相对于会话开始点的偏移时间ms', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'id' => [ - 'title' => '本句话的唯一标识,内部赋值', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'role' => [ - 'title' => '角色', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', - ], - 'type' => [ - 'title' => '对话内容的类型', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'IMAGE' => '', - 'TEXT' => '', - 'AUDIO' => '', - ], - 'example' => 'TEXT', - ], - ], - ], - ], - 'qualityGroupId' => [ - 'title' => '质检组ID', - 'description' => '', - 'type' => 'string', - 'example' => 'warning_customers', - ], - 'ruleDescription' => [ - 'title' => '质检项描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ruleId' => [ - 'title' => '质检项ID', - 'description' => '', - 'type' => 'string', - 'example' => 'wcm_start', - ], - 'bizType' => [ - 'title' => '规则业务类型', - 'type' => 'string', - ], - 'ruleType' => [ - 'title' => '规则正负向类型 0:负向,1:正向。', - 'type' => 'string', - ], - 'subNodeCol' => [ - 'title' => '子节点', - 'type' => 'array', - 'items' => [ - 'type' => 'any', - ], - ], - ], - ], - ], - 'status' => [ - 'title' => '任务状态', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'CANCELLED' => '', - 'INIT' => '', - 'COMPLETED' => '', - 'PROCESSING' => '', - 'FAIL' => '', - ], - 'example' => 'INIT', - ], - 'taskId' => [ - 'title' => '任务ID', - 'description' => '', - 'type' => 'string', - 'example' => '1703557101831', - ], - ], - ], - '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-01-01 00:00:00', - ], + '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"}]', + 'title' => 'Update Document Library ', + 'description' => '**Prerequisites**'."\n" + ."\n" + .'- You have activated Alibaba Cloud Model Studio and Tongyi Dianjin.'."\n" + ."\n" + .'- Obtain the workspace ID. For more information, see [Get the workspace ID](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLibrary'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dianjin:UpdateLibrary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"conversationList\\": {\\n \\"callType\\": \\"1\\",\\n \\"customerId\\": \\"234234\\",\\n \\"customerName\\": \\"张三\\",\\n \\"customerServiceId\\": \\"23984763826\\",\\n \\"customerServiceName\\": \\"李四\\",\\n \\"dialogueList\\": [\\n {\\n \\"begin\\": 0,\\n \\"beginTime\\": \\"2024-09-27 11:23:20\\",\\n \\"content\\": \\"您好,我是2001,很高兴为您服务!\\",\\n \\"customerId\\": \\"null\\",\\n \\"customerServiceId\\": \\"李四\\",\\n \\"customerServiceType\\": \\"0\\",\\n \\"end\\": 0,\\n \\"id\\": 1,\\n \\"role\\": \\"0\\",\\n \\"type\\": \\"TEXT\\"\\n }\\n ],\\n \\"gmtService\\": \\"2024-09-27 11:23:20\\"\\n },\\n \\"gmtCreate\\": \\"2024-09-27 11:23:20\\",\\n \\"gmtEnd\\": \\"2024-09-27 11:23:20\\",\\n \\"gmtStart\\": \\"2024-09-27 11:23:20\\",\\n \\"qualityCheckList\\": [\\n {\\n \\"checkExplanation\\": \\"暂无\\",\\n \\"checkPassed\\": \\"PASSED\\",\\n \\"checkProcess\\": \\"暂无\\",\\n \\"checked\\": \\"HIT\\",\\n \\"gmtEnd\\": \\"2024-05-23 14:57:50\\",\\n \\"gmtStart\\": \\"2024-05-23 14:57:50\\",\\n \\"mode\\": \\"0\\",\\n \\"originDialogue\\": [\\n {\\n \\"begin\\": 0,\\n \\"beginTime\\": \\"2024-05-23 14:57:50\\",\\n \\"content\\": \\"您好,我是2001,很高兴为您服务!\\",\\n \\"customerId\\": \\"xxx\\",\\n \\"customerServiceId\\": \\"23876432\\",\\n \\"customerServiceType\\": \\"0\\",\\n \\"end\\": 0,\\n \\"id\\": 1,\\n \\"role\\": \\"0\\",\\n \\"type\\": \\"TEXT\\"\\n }\\n ],\\n \\"qualityGroupId\\": \\"warning_customers\\",\\n \\"ruleDescription\\": \\"进入检测预警客户流程\\",\\n \\"ruleId\\": \\"wcm_start\\",\\n \\"bizType\\": \\"No\\",\\n \\"ruleType\\": \\"0\\",\\n \\"subNodeCol\\": [\\n \\"{\\\\n \\\\\\"ruleId\\\\\\": \\\\\\"wxx_regulatory_authorities\\\\\\",\\\\n \\\\\\"ruleDescription\\\\\\": \\\\\\"具体某机构预警\\\\\\",\\\\n \\\\\\"checked\\\\\\": \\\\\\"HIT\\\\\\",\\\\n \\\\\\"checkProcess\\\\\\": \\\\\\"通过审查对话记录,客户主要询问了关于贷款资方信息和结清证明的问题,并表达了想要注销账户的意愿。在整个对话过程中,客户并未提及任何具体的部门名称,也没有明确表示要向部门投诉的意图。\\\\\\",\\\\n \\\\\\"originDialogue\\\\\\": null,\\\\n \\\\\\"checkPassed\\\\\\": \\\\\\"NOT_PASSED\\\\\\",\\\\n \\\\\\"checkExplanation\\\\\\": null,\\\\n \\\\\\"mode\\\\\\": \\\\\\"0\\\\\\",\\\\n \\\\\\"gmtStart\\\\\\": \\\\\\"2024-12-02 10:38:39\\\\\\",\\\\n \\\\\\"gmtEnd\\\\\\": \\\\\\"2024-12-02 10:38:43\\\\\\",\\\\n \\\\\\"qualityGroupId\\\\\\": \\\\\\"warning_customers\\\\\\",\\\\n \\\\\\"bizType\\\\\\": null,\\\\n \\\\\\"ruleType\\\\\\": \\\\\\"0\\\\\\",\\\\n \\\\\\"subNodeCol\\\\\\": null\\\\n }\\"\\n ]\\n }\\n ],\\n \\"status\\": \\"INIT\\",\\n \\"taskId\\": \\"1703557101831\\"\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"67C7021A-D268-553D-8C15-A087B9604028\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-01-01 00:00:00\\"\\n}","type":"json"}]', ], - 'RecognizeIntention' => [ - 'summary' => '意图识别', - 'path' => '/{workspaceId}/api/recog/intent', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateQaLibrary' => [ + 'summary' => 'Updates a Q&A library. After the update, use the GenDocQaResult API to parse the Q&A pairs.', + 'path' => '/{workspaceId}/api/virtualHuman/qa/upload', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxx', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'analysis' => [ - 'title' => '是否分析', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - 'bizType' => [ - 'title' => '业务类型,[COMMON(通用意图识别),ATTITUDE(客户态度意图识别),BUSINESS(协商还款意图识别)]', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'common' => '', - 'business' => '', - 'attitude' => '', - ], - 'example' => 'common', - ], - 'conversation' => [ - 'title' => '对话内容', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'globalIntentionList' => [ - 'title' => '全局意图列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'title' => '意图描述', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'intention' => [ - 'title' => '意图名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'intentionCode' => [ - 'title' => '意图code', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1810566978021232640', - ], - 'intentionScript' => [ - 'title' => '意图话术', - 'type' => 'string', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'hierarchicalIntentionList' => [ - 'title' => '分层意图列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'title' => '意图描述', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'intention' => [ - 'title' => '意图名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'intentionCode' => [ - 'title' => '意图code', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1810929291010150400', - ], - 'intentionScript' => [ - 'title' => '意图话术', - 'type' => 'string', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'intentionList' => [ - 'title' => '意图列表', - 'description' => '', + 'parseQaResults' => [ + 'title' => '', + 'description' => 'A list of parsed Q\\&A pair results.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A parsed Q\\&A pair result.', 'type' => 'object', 'properties' => [ - 'description' => [ - 'title' => '意图描述', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'intention' => [ - 'title' => '意图名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'intentionCode' => [ - 'title' => '意图code', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1808766224000262144', - ], - 'intentionScript' => [ - 'title' => '意图话术', - 'type' => 'string', - ], + 'question' => ['description' => 'The question.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '这款**糯米大烧麦的净含量是多少?'."\n"], + 'answer' => ['description' => 'The answer.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '这款**糯米大烧麦的净含量是900g。'."\n"], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'opType' => [ - 'title' => '操作类型,[COMMON(通用),HIERARCHICAL(分层)]', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'common' => '', - 'hierarchical' => '', - ], - 'example' => 'common', - 'default' => 'common', - ], - 'recommend' => [ - 'title' => '推荐意图', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'intentionDomainCode' => [ - 'title' => '意图库: 本地意图库code', - 'type' => 'string', + 'required' => true, + 'example' => '', ], + 'qaLibraryId' => ['description' => 'The ID of the Q\\&A library.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '6jh378d'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '0FC6636E-380A-5369-AE01-D1C15BB9B254'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ResultCode<RecogResult>', - 'description' => 'ResultCode<RecogResult>', + 'title' => 'ResultCode<DiaChatQaUploadResponse>', + 'description' => 'ResultCode', 'type' => 'object', 'properties' => [ - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'dataType' => ['description' => 'The data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'time' => ['description' => 'The timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], 'data' => [ - 'title' => '响应数据', - 'description' => '', + 'title' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'analysisProcess' => [ - 'title' => '分析过程', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'intentionCode' => [ - 'title' => '意图code', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'intentionName' => [ - 'title' => '意图名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'recommendIntention' => [ - 'title' => '推荐意图', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'recommendScript' => [ - 'title' => '推荐话术', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'intentionScript' => [ - 'title' => '意图话术', - 'type' => 'string', - ], + 'qaLibraryId' => ['description' => 'The ID of the Q\\&A library.', 'type' => 'string', 'title' => '', 'example' => '6jh378d'], ], + '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' => '003D019A-1BB3-53EC-A0D2-CE76DA5D73B1', - ], - 'success' => [ - 'title' => '是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'time' => [ - 'title' => '时间戳', - 'description' => '', - 'type' => 'string', - 'example' => '2024-04-24 11:54:34', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258'], + 'cost' => ['description' => 'The time consumed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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 \\"qaLibraryId\\": \\"6jh378d\\"\\n },\\n \\"requestId\\": \\"EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258\\",\\n \\"cost\\": 0\\n}","type":"json"}]', + 'title' => 'Update Q&A Pair Library', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateQaLibrary'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:UpdateQaLibrary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cost\\": 0,\\n \\"data\\": {\\n \\"analysisProcess\\": \\"客户回答的内容与提供的意图列表描述均不匹配,没有表达出对账单、还款、天气或其他服务的具体需求或问题。\\",\\n \\"intentionCode\\": \\"-1\\",\\n \\"intentionName\\": \\"其它\\",\\n \\"recommendIntention\\": \\"客户试图回避谈论逾期还款的话题\\",\\n \\"recommendScript\\": \\"朱先生,理解您可能对天气感兴趣,但更重要的是您的账户情况。请让我们专注于您未偿还的款项,这对您的信用健康至关重要。\\",\\n \\"intentionScript\\": \\"朱先生,理解您可能对天气感兴趣,但更重要的是您的账户情况。请让我们专注于您未偿还的款项,这对您的信用健康至关重要。\\"\\n },\\n \\"dataType\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"message\\": \\"ok\\",\\n \\"requestId\\": \\"003D019A-1BB3-53EC-A0D2-CE76DA5D73B1\\",\\n \\"success\\": true,\\n \\"time\\": \\"2024-04-24 11:54:34\\"\\n}","type":"json"}]', ], - 'GenDocQaResult' => [ - 'summary' => '根据文档解析问答QA', - 'path' => '/{workspaceId}/api/virtualHuman/qa/parse', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UploadDocument' => [ + 'summary' => 'Upload a document to a document library. The system parses the document, splits it into chunks, and builds an index.', + 'path' => '/{workspaceId}/api/library/document/upload', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', - ], + 'schema' => ['description' => 'Path parameter. The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'docId' => [ - 'title' => '文档ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '182364872346', - ], - 'libraryId' => [ - 'title' => '文档库ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sjdgdsfg', - ], - 'requestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '0FC6636E-380A-5369-AE01-D1C15BB9B254', - ], + 'data' => ['description' => 'File metadata. You can use this to filter results during retrieval.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{\\"cateogry\\": \\"报告\\"}'], + 'fileName' => ['description' => 'The full file name, including the extension. Supported formats are PDF, DOC, DOCX, Markdown, PPT, and PPTX. File size must not exceed 100 MB. PDF, DOC, DOCX, PPT, and PPTX files must not exceed 500 pages.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test.pdf'], + 'fileUrl' => ['description' => 'The OSS URL of the file. If the file is not publicly readable, include a signature in the URL.'."\n" + ."\n" + .'If you use the SDK to upload files, upload the file directly. You do not need to provide an OSS URL. For more information, see the SDK documentation.', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'title' => '', 'example' => 'https://oss-xxx.hangzhou.com/test.pdf'], + 'libraryId' => ['description' => 'The document library ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'sjdhbcsj'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'QA对', - 'description' => '', + 'title' => 'ResultCode<String>', + 'description' => 'The response object.', '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' => [ - 'libraryId' => [ - 'title' => '文档库ID', - 'description' => '', - 'type' => 'string', - 'example' => '7wxwrjpabj', - ], - 'docId' => [ - 'title' => '文档ID', - 'description' => '', - 'type' => 'string', - 'example' => '873648346573245', - ], - 'currentStatus' => [ - 'title' => '当前状态[INIT(初始化),PROCESSING(处理中),COMPLETED(已结束),FAIL(失败)]', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'INIT' => '', - 'COMPLETED' => '', - 'PROCESSING' => '', - 'FAIL' => '', - ], - 'example' => 'PROCESSING', - ], - 'parseQaResults' => [ - 'title' => '问答解析的QA结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'question' => [ - 'title' => '问题', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'answer' => [ - 'title' => '解答', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], - ], - ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '44BD277A-87F9-5310-8D63-3E6645F1DA85', - ], - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'cost' => ['description' => 'The processing time, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'null'], + 'data' => ['description' => 'The returned data.', 'type' => 'string', 'title' => '', 'example' => '1782981430906818562'], + 'dataType' => ['description' => 'The data type.', 'type' => 'string', 'title' => '', 'example' => 'null'], + 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'ff3fef67-48d9-4379-a237-9ba8143fe739'], + 'success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'time' => ['description' => 'Timestamp.', 'type' => 'string', 'title' => '', 'example' => '2024-04-24 11:54:34'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => 'File ', + 'description' => 'Before you use this operation, review the Tongyi Dianjin pricing details.'."\n" + ."\n" + .'**Prerequisites**'."\n" + ."\n" + .'- You have activated Alibaba Cloud Model Studio and Tongyi Dianjin.'."\n" + ."\n" + .'- You have obtained a workspace ID. For more information, see [Get the workspace ID](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.2eb8281foUVd15#2612f896detsz:~:text=%E6%9F%A5%E7%9C%8BAPI%2DKEY%E3%80%82-,%E8%8E%B7%E5%8F%96APP%2DID%E5%92%8CWORKSPACE,-%E8%BF%9B%E5%85%A5%E6%88%91%E7%9A%84%E5%BA%94%E7%94%A8).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadDocument'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:UploadDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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 \\"libraryId\\": \\"7wxwrjpabj\\",\\n \\"docId\\": \\"873648346573245\\",\\n \\"currentStatus\\": \\"PROCESSING\\",\\n \\"parseQaResults\\": [\\n {\\n \\"question\\": \\"今天的天气怎么样?\\",\\n \\"answer\\": \\"今天的天气不错,多云转晴。\\\\n\\"\\n }\\n ]\\n },\\n \\"requestId\\": \\"44BD277A-87F9-5310-8D63-3E6645F1DA85\\",\\n \\"cost\\": 0\\n}","type":"json"}]', ], - 'UpdateQaLibrary' => [ - 'summary' => '更新QA问答库', - 'path' => '/{workspaceId}/api/virtualHuman/qa/upload', - 'methods' => [ - 'post', + ], + 'endpoints' => [ + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dianjin.cn-beijing.aliyuncs.com', 'endpoint' => 'dianjin.cn-beijing.aliyuncs.com', 'vpc' => 'dianjin-vpc.cn-beijing.aliyuncs.com'], + ], + 'errorCodes' => [], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'RealtimeDialogAssist'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2026-01-07T02:52:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateQualityCheckTask'], ], - 'security' => [ - [ - 'AK' => [], + 'createdAt' => '2025-12-11T01:42:42.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAnnualDocSummaryTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTaskStatus'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadDocument'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunAgent'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDocsSummaryTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLibrary'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenDocQaResult'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitChatQuestion'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFilterDocumentList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebuildTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePdfTranslateTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocumentList'], + ['threshold' => '120', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDialog'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLibraryList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLibrary'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLibrary'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAppConfig'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDocument'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocumentChunkList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDocumentChunk'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatQuestionResp'], + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RealTimeDialog'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateQaLibrary'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFinReportSummaryTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetParseResult'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDocument'], + ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecognizeIntention'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQualityCheckTaskResult'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecallDocument'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLibrary'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PreviewDocument'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDialogAnalysisResult'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDialogAnalysisTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateQualityCheckTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunLibraryChatGeneration'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDialogLog'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EvictTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDocumentUrl'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReIndex'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunChatResultGeneration'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSummaryTaskResult'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTaskResult'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDialogDetail'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePredefinedDocument'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InvokePlugin'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoryListByBizType'], + ], + ], + 'ram' => [ + 'productCode' => 'DianJin', + 'productName' => 'Alibaba Cloud Model Studio', + 'ramCodes' => ['dianjin'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetHistoryListByBizType', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetHistoryListByBizType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'DeleteLibrary', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dianjin:DeleteLibrary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'RealtimeDialogAssist', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:RealtimeDialogAssist', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', + [ + 'apiName' => 'RunLibraryChatGeneration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:RunLibraryChatGeneration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxx', + [ + 'apiName' => 'GetAppConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetAppConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'parseQaResults' => [ - 'title' => '问答解析的QA结果', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'question' => [ - 'title' => '问题', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'answer' => [ - 'title' => '解答', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'qaLibraryId' => [ - 'title' => 'QA问答库ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '6jh378d', - ], - 'requestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '0FC6636E-380A-5369-AE01-D1C15BB9B254', - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'GetDialogDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetDialogDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ResultCode<DiaChatQaUploadResponse>', - 'description' => 'ResultCode<DiaChatQaUploadResponse>', - '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' => [ - 'qaLibraryId' => [ - 'title' => 'QA库ID', - 'description' => '', - 'type' => 'string', - 'example' => '6jh378d', - ], - ], - ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => 'EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258', - ], - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - ], + [ + 'apiName' => 'EvictTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:EvictTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetDialogLog', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:GetDialogLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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 \\"qaLibraryId\\": \\"6jh378d\\"\\n },\\n \\"requestId\\": \\"EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258\\",\\n \\"cost\\": 0\\n}","type":"json"}]', - ], - 'SubmitChatQuestion' => [ - 'summary' => '提交问题列表', - 'path' => '/{workspaceId}/api/virtualHuman/chat/submit', - 'methods' => [ - 'post', + [ + 'apiName' => 'DeleteDocument', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:DeleteDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'InvokePlugin', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:InvokePlugin', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpdateDocument', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:UpdateDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'CreatePredefinedDocument', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreatePredefinedDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'RecallDocument', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:RecallDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'RecognizeIntention', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', + 'ramAction' => [ + 'action' => 'dianjin:RecognizeIntention', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxx', + [ + 'apiName' => 'GenDocQaResult', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:GenDocQaResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'sessionId' => [ - 'title' => '所属的会话ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '237645726354', - ], - 'gmtService' => [ - 'title' => '当前时间', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2024-09-27 11:23:20', - ], - 'liveScriptContent' => [ - 'title' => '直播脚本', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'openSmallTalk' => [ - 'title' => '是否开启闲聊 默认是:true 开启', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], - 'questionList' => [ - 'title' => '问题列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'sessionId' => [ - 'title' => '所属会话ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1869300950603128834', - ], - 'userId' => [ - 'title' => '直播间提问用户的唯一ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '39485783475638465', - ], - 'userName' => [ - 'title' => '直播间提问用户的名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'content' => [ - 'title' => '问题内容', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'gmtCreate' => [ - 'title' => '原始提问时间', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2024-11-17 10:05:00'."\n", - ], - 'type' => [ - 'title' => '问题类型,DialogueChatQuestionTypeEnum[PRODUCT_QA(音频提交),GOSSIP(操作提交),UNKNOWN(未知),code,desc]', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PRODUCT_QA' => '', - 'GOSSIP' => '', - 'UNKNOWN' => '', - ], - 'example' => 'PRODUCT_QA'."\n", - ], - 'reply' => [ - 'title' => '答复内容,回复的内容', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'requestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '0FC6636E-380A-5369-AE01-D1C15BB9B254', - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'RunAgent', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:RunAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ResultCode<DiaChatSubmitVO>', - 'description' => 'ResultCode<DiaChatSubmitVO>', - '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' => [ - 'batchId' => [ - 'title' => '批次ID', - 'description' => '', - 'type' => 'string', - 'example' => '1869307330227937280', - ], - ], - ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '915AAAB9-4908-5224-9E53-9E9D7D0AA94B', - ], - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - ], + [ + 'apiName' => 'CreateLibrary', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreateLibrary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DashscopeAsyncTaskFinishEvent', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:DashscopeAsyncTaskFinishEvent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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 \\"batchId\\": \\"1869307330227937280\\"\\n },\\n \\"requestId\\": \\"915AAAB9-4908-5224-9E53-9E9D7D0AA94B\\",\\n \\"cost\\": 0\\n}","type":"json"}]', - ], - 'GetChatQuestionResp' => [ - 'summary' => '获取问答结果', - 'path' => '/{workspaceId}/api/virtualHuman/chat/query', - 'methods' => [ - 'post', + [ + 'apiName' => 'GetDialogAnalysisResult', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:GetDialogAnalysisResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetChatQuestionResp', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:GetChatQuestionResp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'GetParseResult', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:GetParseResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'RealTimeDialog', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:RealTimeDialog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'EndToEndRealTimeDialog', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:EndToEndRealTimeDialog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'PreviewDocument', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:PreviewDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'RunDialogAnalysis', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'dianjin:RunDialogAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', + [ + 'apiName' => 'ReIndex', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:ReIndex', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '请求', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'sessionId' => [ - 'title' => '所属会话ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '237645726354', - ], - 'batchId' => [ - 'title' => '问题批次ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1869307330227937280', - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'CreateQualityCheckTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreateQualityCheckTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '结果', - 'description' => '', - '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' => 'object', - 'properties' => [ - 'currentState' => [ - 'title' => '当前状态[INIT(初始化),PROCESSING(处理中),COMPLETED(已结束)]', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'INIT' => '', - 'COMPLETED' => '', - 'PROCESSING' => '', - ], - 'example' => 'PROCESSING', - ], - 'questionList' => [ - 'title' => '问题列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '问题', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'sessionId' => [ - 'title' => '所属会话ID', - 'description' => '', - 'type' => 'string', - 'example' => '1732846760323001'."\n", - ], - 'userId' => [ - 'title' => '直播间提问用户的唯一ID', - 'description' => '', - 'type' => 'string', - 'example' => '39847834568436'."\n", - ], - 'userName' => [ - 'title' => '直播间提问用户的名称', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'content' => [ - 'title' => '问题内容', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'gmtCreate' => [ - 'title' => '原始提问时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-11-17 10:05:00'."\n", - ], - 'type' => [ - 'title' => '问题类型[PRODUCT_QA(音频提交),GOSSIP(操作提交),UNKNOWN(未知)]', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'PRODUCT_QA' => '', - 'GOSSIP' => '', - 'UNKNOWN' => '', - ], - 'example' => 'PRODUCT_QA', - ], - 'reply' => [ - 'title' => '答复内容,回复的内容', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'oriContent' => [ - 'title' => '原始问题', - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '44BD277A-87F9-5310-8D63-3E6645F1DA85'."\n", - ], - 'cost' => [ - 'title' => '耗时', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], - ], + [ + 'apiName' => 'UpdateQaLibrary', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:UpdateQaLibrary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetTaskStatus', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetTaskStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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\\": {\\n \\"currentState\\": \\"PROCESSING\\",\\n \\"questionList\\": [\\n {\\n \\"sessionId\\": \\"1732846760323001\\\\n\\",\\n \\"userId\\": \\"39847834568436\\\\n\\",\\n \\"userName\\": \\"张*\\",\\n \\"content\\": \\"今天天气怎么样\\",\\n \\"gmtCreate\\": \\"2024-11-17 10:05:00\\",\\n \\"type\\": \\"PRODUCT_QA\\",\\n \\"reply\\": \\"感谢您的支持!\\",\\n \\"oriContent\\": \\"今天天气怎么样\\"\\n }\\n ]\\n },\\n \\"requestId\\": \\"44BD277A-87F9-5310-8D63-3E6645F1DA85\\",\\n \\"cost\\": 0\\n}","type":"json"}]', - ], - 'RunChatResultGeneration' => [ - 'summary' => '获取生成式对话结果', - 'path' => '/{workspaceId}/api/run/chat/generation', - 'methods' => [ - 'post', + [ + 'apiName' => 'GetDocumentUrl', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetDocumentUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', - 'sse', + [ + 'apiName' => 'RunChatResultGeneration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:RunChatResultGeneration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetQualityCheckTaskResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetQualityCheckTaskResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'GetLibrary', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetLibrary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'CreatePdfTranslateTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreatePdfTranslateTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', + [ + 'apiName' => 'CreateFinReportSummaryTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreateFinReportSummaryTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxxxx', + [ + 'apiName' => 'SubmitChatQuestion', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:SubmitChatQuestion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'inferenceParameters' => [ - 'title' => '推理使用的超参数', - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{"topP": 0.8}', - ], - 'messages' => [ - 'title' => '输入模型的消息', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'content' => [ - 'title' => '消息的内容', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'role' => [ - 'title' => '消息的角色', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'user', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'modelId' => [ - 'title' => '模型服务种类,请通过/api/app/config接口获取,对应的字段llmHelperTypeList', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'qwen-max', - ], - 'sessionId' => [ - 'title' => 'sessionId,可用于标记对话', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '237645726354', - ], - 'stream' => [ - 'title' => '是否流式: true,流式返回答案;false,全量返回答案。不填默认为false', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - 'tools' => [ - 'title' => '输入的工具信息.'."\n" - .'用于指定可供模型调用的工具列表。当输入多个工具时,模型会选择其中一个生成结果。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '用于指定可供模型调用的工具库,一次function call流程模型会从中选择其中一个工具。tools中每一个tool的结构如下:'."\n" - ."\n" - .'type,类型为string,表示tools的类型,当前仅支持function。'."\n" - ."\n" - .'function,类型为object,键值包括name,description和parameters:'."\n" - ."\n" - .'name:类型为string,表示工具函数的名称,必须是字母、数字,可以包含下划线和短划线,最大长度为64。'."\n" - ."\n" - .'description:类型为string,表示工具函数的描述,供模型选择何时以及如何调用工具函数。'."\n" - ."\n" - .'parameters:类型为object,表示工具的参数描述,需要是一个合法的JSON Schema。JSON Schema的描述可以见链接。如果parameters参数为空,表示function没有入参。'."\n" - ."\n" - .'在function call流程中,无论是发起function call的轮次,还是向模型提交工具函数的执行结果,均需设置tools参数。当前支持的模型包括qwen-turbo、qwen-plus、qwen-max和qwen-max-longcontext。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'function' => [ - 'title' => '类型为object,键值包括name,description和parameters', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'title' => '类型为string,表示工具函数的描述,供模型选择何时以及如何调用工具函数', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'name' => [ - 'title' => '类型为string,表示工具函数的名称,必须是字母、数字,可以包含下划线和短划线,最大长度为64', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'get_time', - ], - 'parameters' => [ - 'title' => '类型为object,表示工具的参数描述,需要是一个合法的JSON Schema。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'properties' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "location": {'."\n" - .' "type": "string",'."\n" - .' "description": "The city and state, e.g. San Francisco, CA"'."\n" - .' },'."\n" - .' "unit": {'."\n" - .' "type": "string",'."\n" - .' "enum": ['."\n" - .' "celsius",'."\n" - .' "fahrenheit"'."\n" - .' ]'."\n" - .' }'."\n" - .' }', - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'object', - ], - ], - 'required' => false, - ], - 'required' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'location', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'type' => [ - 'title' => '类型为string,表示tools的类型,当前仅支持function', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'function', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'CreateAnnualDocSummaryTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreateAnnualDocSummaryTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'choices' => [ - 'title' => '模型生成内容的详情。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'finishReason' => [ - 'title' => '模型生成内容结束原因。'."\n" - .' 有三种情况:'."\n" - .' - 正在生成时为null;'."\n" - .' - 因触发输入参数中的stop条件而结束为stop;'."\n" - .' - 因生成长度过长而结束为length。', - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'index' => [ - 'title' => '生成的结果序列编号,默认为0。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'message' => [ - 'title' => '模型输出的消息。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'content' => [ - 'title' => '模型生成的文本。', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'role' => [ - 'title' => '模型的角色,固定为assistant。', - 'description' => '', - 'type' => 'string', - 'example' => 'user', - ], - 'toolCalls' => [ - 'title' => '工具调用', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'example' => '', - ], - ], - ], - ], - ], - ], - ], - 'created' => [ - 'title' => '创建时间戳', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1720602203', - ], - 'id' => [ - 'title' => '系统生成的标识本次调用的id。', - 'description' => '', - 'type' => 'string', - 'example' => 'eb2b6139-ddf1-91a0-a47f-df7617ae9032', - ], - 'modelId' => [ - 'title' => '本次调用的模型名。', - 'description' => '', - 'type' => 'string', - 'example' => 'qwen-max', - ], - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => 'eb2b6139-ddf1-91a0-a47f-df7617ae9032'."\n", - ], - 'time' => [ - 'title' => '时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-04-24 11:54:34', - ], - 'totalTokens' => [ - 'title' => '总token量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'usage' => [ - 'title' => '消耗量', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'imageCount' => [ - 'title' => '图片数量,wanx等模型', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'imageTokens' => [ - 'title' => '图片token量,qwen-vl等模型', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'inputTokens' => [ - 'title' => '输入token量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'outputTokens' => [ - 'title' => '输出token量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - ], - 'totalTokens' => [ - 'title' => '总token量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - ], - ], - ], + [ + 'apiName' => 'RebuildTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:RebuildTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"choices\\": [\\n {\\n \\"finishReason\\": \\"null\\",\\n \\"index\\": 0,\\n \\"message\\": {\\n \\"content\\": \\"你是谁\\",\\n \\"role\\": \\"user\\",\\n \\"toolCalls\\": [\\n {\\n \\"type\\": \\"function\\",\\n \\"function\\": {\\n \\"name\\": \\"get_current_weather\\",\\n \\"arguments\\": \\"{\\\\\\"location\\\\\\": \\\\\\"长沙\\\\\\", \\\\\\"unit\\\\\\": \\\\\\"celsius\\\\\\"}\\"\\n },\\n \\"id\\": \\"\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"created\\": 1720602203,\\n \\"id\\": \\"eb2b6139-ddf1-91a0-a47f-df7617ae9032\\",\\n \\"modelId\\": \\"qwen-max\\",\\n \\"requestId\\": \\"eb2b6139-ddf1-91a0-a47f-df7617ae9032\\\\n\\",\\n \\"time\\": \\"2024-04-24 11:54:34\\",\\n \\"totalTokens\\": 500,\\n \\"usage\\": {\\n \\"imageCount\\": 0,\\n \\"imageTokens\\": 0,\\n \\"inputTokens\\": 200,\\n \\"outputTokens\\": 300,\\n \\"totalTokens\\": 500\\n }\\n}","type":"json"}]', - ], - 'DashscopeAsyncTaskFinishEvent' => [ - 'summary' => 'Dashscope异步任务完成事件处理', - 'path' => '/{workspaceId}/event/dashscopeAsyncTaskFinish', - 'methods' => [ - 'post', + [ + 'apiName' => 'UploadDocument', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:UploadDocument', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'UpdateDocumentChunk', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dianjin:UpdateDocumentChunk', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetTaskResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetTaskResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'GetSummaryTaskResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetSummaryTaskResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'CreateDocsSummaryTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreateDocsSummaryTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'GetDocumentChunkList', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'dianjin:GetDocumentChunkList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'X-Load-Test', - 'in' => 'header', - 'schema' => [ - 'title' => '用户标识是否压测流量', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', + [ + 'apiName' => 'UpdateLibrary', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dianjin:UpdateLibrary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'title' => '业务空间ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'llm-xxx', + ], + [ + 'apiName' => 'CreateDialog', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreateDialog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '请求体参数', - 'description' => '', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'title' => '请求体参数', - 'description' => '', - 'type' => 'any', - 'example' => '{}', - ], - 'example' => '{}', + ], + [ + 'apiName' => 'CreateDialogAnalysisTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dianjin:CreateDialogAnalysisTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'WanProdResponse<Void>', - 'description' => 'WanProdResponse<Void>', - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'title' => '返回码', - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'message' => [ - 'title' => '返回信息', - 'description' => '', - 'type' => 'string', - 'example' => '成功', - ], - 'success' => [ - 'title' => '返回是否成功', - 'description' => '', - 'type' => 'boolean', - ], - 'retryAble' => [ - 'title' => '是否可重试', - 'description' => '', - 'type' => 'boolean', - ], - ], + [ + 'apiName' => 'GetDocumentList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetDocumentList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetFilterDocumentList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dianjin:GetFilterDocumentList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetLibraryList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dianjin:GetLibraryList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DianJin', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"0\\",\\n \\"message\\": \\"成功\\",\\n \\"success\\": true,\\n \\"retryAble\\": true\\n}","type":"json"}]', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'dianjin.cn-beijing.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |
