summaryrefslogtreecommitdiff
path: root/data/en_us/qualitycheck/2019-01-15
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/qualitycheck/2019-01-15
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/qualitycheck/2019-01-15')
-rw-r--r--data/en_us/qualitycheck/2019-01-15/api-docs.php30502
1 files changed, 16398 insertions, 14104 deletions
diff --git a/data/en_us/qualitycheck/2019-01-15/api-docs.php b/data/en_us/qualitycheck/2019-01-15/api-docs.php
index 712f794..ad7c125 100644
--- a/data/en_us/qualitycheck/2019-01-15/api-docs.php
+++ b/data/en_us/qualitycheck/2019-01-15/api-docs.php
@@ -1,3104 +1,1875 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'Qualitycheck',
- 'version' => '2019-01-15',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'Qualitycheck', 'version' => '2019-01-15'],
'directories' => [
[
- 'id' => 386700,
- 'title' => null,
+ 'children' => ['UploadAudioData', 'UploadDataV4', 'UploadData', 'UpdateQualityCheckData'],
'type' => 'directory',
- 'children' => [
- 'UploadAudioData',
- 'UploadDataV4',
- 'UploadData',
- 'UpdateQualityCheckData',
- ],
+ 'title' => 'Data upload',
],
[
- 'id' => 386705,
- 'title' => null,
- 'type' => 'directory',
'children' => [
[
- 'id' => 386706,
- 'title' => null,
+ 'children' => ['AddRuleV4', 'UpdateRuleV4', 'ListRulesV4', 'GetRuleV4', 'DeleteRuleV4', 'TestRuleV4'],
'type' => 'directory',
- 'children' => [
- 'AddRuleV4',
- 'UpdateRuleV4',
- 'ListRulesV4',
- 'GetRuleV4',
- 'DeleteRuleV4',
- 'TestRuleV4',
- ],
+ 'title' => 'Quality inspection rule management',
],
[
- 'id' => 386713,
- 'title' => null,
+ 'children' => ['DeleteCheckTypeToScheme', 'CreateQualityCheckScheme', 'UpdateQualityCheckScheme', 'GetQualityCheckScheme', 'ListQualityCheckScheme', 'DeleteQualityCheckScheme', 'UpdateRuleToScheme', 'CreateCheckTypeToScheme', 'UpdateCheckTypeToScheme'],
'type' => 'directory',
- 'children' => [
- 'DeleteCheckTypeToScheme',
- 'CreateQualityCheckScheme',
- 'UpdateQualityCheckScheme',
- 'GetQualityCheckScheme',
- 'ListQualityCheckScheme',
- 'DeleteQualityCheckScheme',
- 'UpdateRuleToScheme',
- 'CreateCheckTypeToScheme',
- 'UpdateCheckTypeToScheme',
- ],
+ 'title' => 'Quality inspection plan management',
],
[
- 'id' => 386723,
- 'title' => null,
+ 'children' => ['AddRuleCategory', 'GetRuleCategory', 'DelRuleCategory'],
'type' => 'directory',
- 'children' => [
- 'AddRuleCategory',
- 'GetRuleCategory',
- 'DelRuleCategory',
- ],
+ 'title' => 'Quality inspection rules - categories',
],
[
- 'id' => 386727,
- 'title' => null,
+ 'children' => ['AddBusinessCategory', 'DeleteBusinessCategory', 'GetBusinessCategoryList'],
'type' => 'directory',
- 'children' => [
- 'AddBusinessCategory',
- 'DeleteBusinessCategory',
- 'GetBusinessCategoryList',
- ],
+ 'title' => 'Quality inspection rules - applicable business',
],
],
+ 'type' => 'directory',
+ 'title' => 'Quality inspection rules & plans',
],
[
- 'id' => 386731,
- 'title' => null,
+ 'children' => ['GetSchemeTaskConfig', 'CreateSchemeTaskConfig', 'UpdateSchemeTaskConfig', 'ListSchemeTaskConfig'],
'type' => 'directory',
- 'children' => [
- 'GetSchemeTaskConfig',
- 'CreateSchemeTaskConfig',
- 'UpdateSchemeTaskConfig',
- 'ListSchemeTaskConfig',
- ],
+ 'title' => 'Call center - quality inspection task management',
],
[
- 'id' => 386736,
- 'title' => null,
+ 'children' => ['SubmitQualityCheckTask', 'SaveConfigDataSet', 'ListDataSet'],
'type' => 'directory',
- 'children' => [
- 'SubmitQualityCheckTask',
- 'SaveConfigDataSet',
- 'ListDataSet',
- 'DeleteDataSet',
- ],
+ 'title' => 'Datasets',
],
[
- 'id' => 386741,
- 'title' => null,
- 'type' => 'directory',
'children' => [
[
- 'id' => 386742,
- 'title' => null,
+ 'children' => ['GetResult', 'GetResultToReview'],
'type' => 'directory',
- 'children' => [
- 'GetResult',
- 'GetResultToReview',
- ],
+ 'title' => 'Quality inspection results',
],
[
- 'id' => 386745,
- 'title' => null,
+ 'children' => ['ListSessionGroup', 'AssignReviewerBySessionGroup', 'RevertAssignedSessionGroup'],
'type' => 'directory',
- 'children' => [
- 'ListSessionGroup',
- 'AssignReviewerBySessionGroup',
- 'RevertAssignedSessionGroup',
- ],
+ 'title' => 'Session group quality inspection',
],
[
- 'id' => 386749,
- 'title' => null,
+ 'children' => ['SubmitReviewInfoV4', 'AssignReviewer', 'SubmitComplaint', 'HandleComplaint', 'RevertAssignedSession'],
'type' => 'directory',
- 'children' => [
- 'SubmitReviewInfoV4',
- 'AssignReviewer',
- 'SubmitComplaint',
- 'HandleComplaint',
- 'RevertAssignedSession',
- ],
+ 'title' => 'Appeal & review & assignment',
],
],
+ 'type' => 'directory',
+ 'title' => 'Quality inspection results',
],
[
- 'id' => 386755,
- 'title' => null,
- 'type' => 'directory',
'children' => [
[
- 'id' => 386756,
- 'title' => null,
+ 'children' => ['CreateAsrVocab', 'UpdateAsrVocab', 'GetAsrVocab', 'ListAsrVocab', 'DeleteAsrVocab'],
'type' => 'directory',
- 'children' => [
- 'CreateAsrVocab',
- 'UpdateAsrVocab',
- 'GetAsrVocab',
- 'ListAsrVocab',
- 'DeleteAsrVocab',
- ],
+ 'title' => 'Hot word models',
],
[
- 'id' => 386762,
- 'title' => null,
+ 'children' => ['GetCustomizationConfigList', 'DeleteCustomizationConfig'],
'type' => 'directory',
- 'children' => [
- 'GetCustomizationConfigList',
- 'DeleteCustomizationConfig',
- ],
+ 'title' => 'Language models',
],
],
+ 'type' => 'directory',
+ 'title' => 'Voice model training',
],
[
- 'id' => 386765,
- 'title' => null,
- 'type' => 'directory',
'children' => [
[
- 'id' => 386766,
- 'title' => null,
+ 'children' => ['CreateTaskAssignRule', 'UpdateTaskAssignRule', 'ListTaskAssignRules', 'DeleteTaskAssignRule'],
'type' => 'directory',
- 'children' => [
- 'CreateTaskAssignRule',
- 'UpdateTaskAssignRule',
- 'ListTaskAssignRules',
- 'DeleteTaskAssignRule',
- ],
+ 'title' => 'Review management',
],
[
- 'id' => 386771,
- 'title' => null,
+ 'children' => ['CreateWarningConfig', 'UpdateWarningConfig', 'ListWarningConfig', 'DeleteWarningConfig'],
'type' => 'directory',
- 'children' => [
- 'CreateWarningConfig',
- 'UpdateWarningConfig',
- 'ListWarningConfig',
- 'DeleteWarningConfig',
- ],
+ 'title' => 'Alert management',
],
[
- 'id' => 386776,
- 'title' => null,
+ 'children' => ['CreateSkillGroupConfig', 'UpdateSkillGroupConfig', 'GetSkillGroupConfig', 'ListSkillGroupConfig', 'DeleteSkillGroupConfig'],
'type' => 'directory',
- 'children' => [
- 'CreateSkillGroupConfig',
- 'UpdateSkillGroupConfig',
- 'GetSkillGroupConfig',
- 'ListSkillGroupConfig',
- 'DeleteSkillGroupConfig',
- ],
+ 'title' => 'Skill group management',
],
],
+ 'type' => 'directory',
+ 'title' => 'System management',
],
[
- 'id' => 386782,
- 'title' => null,
- 'type' => 'directory',
'children' => [
[
- 'id' => 386783,
- 'title' => null,
+ 'children' => ['ApplyWsToken', 'GetSyncResult', 'SyncQualityCheck', 'UpdateSyncQualityCheckData'],
'type' => 'directory',
- 'children' => [
- 'ApplyWsToken',
- 'GetSyncResult',
- 'SyncQualityCheck',
- 'UpdateSyncQualityCheckData',
- ],
+ 'title' => 'Real-time quality inspection',
],
[
- 'id' => 386788,
- 'title' => null,
+ 'children' => ['DeleteSchemeTaskConfig'],
'type' => 'directory',
- 'children' => [
- 'DeleteSchemeTaskConfig',
- ],
+ 'title' => 'Others',
],
],
+ 'type' => 'directory',
+ 'title' => 'Deprecated or whitelist-only',
],
[
- 'id' => 386790,
- 'title' => null,
- 'type' => 'directory',
'children' => [
[
- 'id' => 386791,
- 'title' => null,
+ 'children' => ['GetRuleById', 'GetRulesCountList', 'UpdateRuleById', 'UpdateRule', 'UploadRule', 'GetRuleDetail', 'InvalidRule'],
'type' => 'directory',
- 'children' => [
- 'DeleteRule',
- 'GetRuleById',
- 'GetRulesCountList',
- 'UpdateRuleById',
- 'UpdateRule',
- 'UploadRule',
- 'GetRuleDetail',
- 'GetRule',
- 'ListRules',
- 'InvalidRule',
- ],
+ 'title' => 'Rule management',
],
[
- 'id' => 386802,
- 'title' => null,
+ 'children' => ['GetScoreInfo'],
'type' => 'directory',
- 'children' => [
- 'GetScoreInfo',
- ],
+ 'title' => 'Scoring management',
],
[
- 'id' => 386804,
- 'title' => null,
+ 'children' => ['SubmitReviewInfo', 'BatchSubmitReviewInfo', 'UploadDataSync'],
'type' => 'directory',
- 'children' => [
- 'SubmitReviewInfo',
- 'BatchSubmitReviewInfo',
- 'UploadDataSync',
- ],
+ 'title' => 'Others',
],
[
- 'id' => 386809,
- 'title' => null,
+ 'children' => ['GetNextResultToVerify', 'VerifyFile', 'VerifySentence'],
'type' => 'directory',
- 'children' => [
- 'GetNextResultToVerify',
- 'VerifyFile',
- 'VerifySentence',
- ],
+ 'title' => 'Manual evaluation',
],
[
- 'id' => 386813,
- 'title' => null,
+ 'children' => ['SubmitPrecisionTask', 'GetPrecisionTask', 'ListPrecisionTask', 'DeletePrecisionTask'],
'type' => 'directory',
- 'children' => [
- 'SubmitPrecisionTask',
- 'GetPrecisionTask',
- 'ListPrecisionTask',
- 'DeletePrecisionTask',
- ],
+ 'title' => 'Model performance evaluation',
],
],
+ 'type' => 'directory',
+ 'title' => 'Deprecated in new version (V4)',
],
[
- 'id' => 386818,
- 'title' => null,
- 'type' => 'directory',
'children' => [
- 'ListUsers',
- 'UpdateUser',
- 'CreateMiningTask',
- 'GetMiningTaskResult',
- 'CreateUser',
+ 'CreateMiningTask', 'GetMiningTaskResult', 'AnalyzeLabel', 'CreateAgent', 'CreateAgentTask', 'CreateTag', 'CreateUser', 'DeleteAgent', 'DeleteDataSet', 'DeleteRule', 'DeleteTag', 'ExecuteAgent', 'GenerateLabel', 'GetAgent', 'GetAgentTaskResult', 'GetLabelAnalysisResult', 'GetLabelGeneratedResult', 'GetRule', 'GetTag', 'ListRules',
+ 'ListTag', 'ListUsers', 'RunCompletionMessage', 'UpdateAgent', 'UpdateTag', 'UpdateUser',
],
+ 'type' => 'directory',
+ 'title' => 'Others',
],
],
'components' => [
'schemas' => [
- 'BusinessCategoryBasicInfo' => [
- 'properties' => [
- 'Bid' => [
- 'backendName' => 'bid',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ServiceType' => [
- 'backendName' => 'serviceType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Name' => [
- 'backendName' => 'name',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'OriginalId' => [
- 'backendName' => 'originalId',
- 'description' => 'originalId',
- 'format' => 'int64',
- 'title' => 'originalId',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- ],
+ 'AgentInfo' => [
'type' => 'object',
- 'visibility' => 'public',
- ],
- 'ConditionBasicInfo' => [
'properties' => [
- 'Cid' => [
- 'backendName' => 'cid',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Id' => [
- 'backendName' => 'id',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Rid' => [
- 'backendName' => 'rid',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Check_range' => [
- 'backendName' => 'check_range',
- 'description' => '',
+ 'Id' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'AgentName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'AgentDescription' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ModelType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'InputType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'InstructionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'InstructionTypeParam' => [
+ 'type' => 'object',
'properties' => [
- 'RoleId' => [
- 'backendName' => 'roleId',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Role' => [
- 'backendName' => 'role',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Anchor' => [
- 'backendName' => 'anchor',
- 'description' => '',
+ 'FieldsParam' => [
+ 'type' => 'object',
'properties' => [
- 'Cid' => [
- 'backendName' => 'cid',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Location' => [
- 'backendName' => 'location',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Hit_time' => [
- 'backendName' => 'hit_time',
+ 'NameDescPairList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Desc' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'description' => '',
- 'format' => 'int32',
'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
+ 'example' => '',
],
],
+ 'description' => '',
'title' => '',
- 'type' => 'object',
- 'visibility' => 'public',
+ 'example' => '',
],
- 'Range' => [
- 'backendName' => 'range',
- 'description' => '',
+ 'ServiceInspectionParam' => [
+ 'type' => 'object',
'properties' => [
- 'From' => [
- 'backendName' => 'from',
+ 'SceneName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'SceneDescription' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Dimensions' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Dimension' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Desc' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'description' => '',
- 'format' => 'int32',
'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
+ 'example' => '',
],
- 'To' => [
- 'backendName' => 'to',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TagCategoryParam' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'NameDescPairList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Desc' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ValueList' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'description' => '',
- 'format' => 'int32',
'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
+ 'example' => '',
],
],
- 'title' => '',
- 'type' => 'object',
- 'visibility' => 'public',
- ],
- 'Absolute' => [
- 'backendName' => 'absolute',
'description' => '',
'title' => '',
- 'type' => 'boolean',
- 'visibility' => 'public',
+ 'example' => '',
],
- 'AllSentencesSatisfy' => [
- 'backendName' => 'allSentencesSatisfy',
+ 'CustomPromptParam' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CustomPrompt' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'NameDescPairList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
'title' => '',
- 'type' => 'boolean',
- 'visibility' => 'public',
+ 'example' => '',
],
],
+ 'description' => '',
'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'BusinessCategoryBasicInfo' => [
+ 'properties' => [
+ 'Bid' => ['description' => 'Business ID ', 'format' => 'int32', 'title' => '业务ID', 'type' => 'integer', 'example' => '1'],
+ 'ServiceType' => ['description' => 'Service Type (ServiceCategory). ', 'format' => 'int32', 'title' => '服务类型(ServiceCategory)', 'type' => 'integer', 'example' => '1'],
+ 'Name' => ['description' => 'Business name ', 'title' => '业务名称', 'type' => 'string', 'example' => '全部'],
+ 'OriginalId' => ['description' => 'originalId', 'format' => 'int64', 'title' => 'originalId', 'type' => 'integer', 'example' => '1'],
+ ],
+ 'type' => 'object',
+ 'description' => 'Applicable business ',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ConditionBasicInfo' => [
+ 'properties' => [
+ 'Cid' => ['description' => 'Condition ID, which may be the primary key in the database or a transformed identifier such as a, b, or c ', 'title' => '条件id,可能是db中的主键,也可能是转换成的a, b, c', 'type' => 'string', 'example' => 'a'],
+ 'Id' => ['description' => 'Primary key in the database ', 'format' => 'int64', 'title' => '在db中的主键', 'type' => 'integer', 'example' => '1'],
+ 'Rid' => ['description' => 'ID of the rule to which the condition belongs ', 'title' => '条件所属的规则id', 'type' => 'string', 'example' => '1'],
+ 'Check_range' => [
+ 'description' => 'Detection range ',
+ 'properties' => [
+ 'RoleId' => ['description' => 'Corresponds to RoleType.id ', 'format' => 'int32', 'title' => '对应 RoleType.id', 'type' => 'integer', 'example' => '1'],
+ 'Role' => ['description' => 'Corresponds to RoleType.type ', 'title' => '对应 RoleType.type', 'type' => 'string', 'example' => '客服'],
+ 'Anchor' => [
+ 'description' => 'Precondition and postcondition ',
+ 'properties' => [
+ 'Cid' => ['description' => 'Condition ID ', 'title' => '条件ID', 'type' => 'string', 'example' => 'a'],
+ 'Location' => ['description' => 'Location ', 'title' => '位置', 'type' => 'string', 'example' => 'BEFORE'],
+ 'Hit_time' => ['description' => 'Hit count ', 'format' => 'int32', 'title' => '命中次数', 'type' => 'integer', 'example' => '1'],
+ ],
+ 'title' => '前置后置条件',
+ 'type' => 'object',
+ 'example' => '',
+ ],
+ 'Range' => [
+ 'description' => 'Relative range ',
+ 'properties' => [
+ 'From' => ['description' => 'Start index of the conversation ', 'format' => 'int32', 'title' => '对话开始索引', 'type' => 'integer', 'example' => '1'],
+ 'To' => ['description' => 'End index of the conversation', 'format' => 'int32', 'title' => '对话结束索引', 'type' => 'integer', 'example' => '2'],
+ ],
+ 'title' => '相对范围',
+ 'type' => 'object',
+ 'example' => '',
+ ],
+ 'Absolute' => ['description' => 'false: relative position; the sentence position is determined in combination with the anchor and the role ', 'title' => 'false: 相对位置; 会结合anchor以及角色来决定句子位置', 'type' => 'boolean', 'example' => 'true'],
+ 'AllSentencesSatisfy' => ['description' => 'true: Every sentence must satisfy the condition; ', 'title' => 'true: 每句话都必须满足条件;', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'title' => '检测范围',
'type' => 'object',
- 'visibility' => 'public',
+ 'example' => '',
],
'Operators' => [
- 'backendName' => 'operators',
- 'description' => '',
- 'itemName' => 'Operator',
- 'items' => [
- 'extendType' => 'true',
- 'ref' => '#/components/schemas/OperatorBasicInfo',
- 'visibility' => 'public',
- ],
- 'title' => '',
+ 'description' => 'List of operators ',
+ 'items' => ['ref' => '#/components/schemas/OperatorBasicInfo', 'description' => 'operator ', '$ref' => '#/components/schemas/OperatorBasicInfo', 'title' => '', 'example' => ''],
+ 'title' => '算子列表',
'type' => 'array',
- 'visibility' => 'public',
- ],
- 'Lambda' => [
- 'backendName' => 'lambda',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Exclusion' => [
- 'backendName' => 'exclusion',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Name' => [
- 'backendName' => 'name',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'UserGroup' => [
- 'backendName' => 'userGroup',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
+ 'example' => '',
],
+ 'Lambda' => ['description' => 'Lambda expression; for example: a&&b ', 'title' => 'Lambda表达式:例如:a&&b', 'type' => 'string', 'example' => 'a'],
+ 'Exclusion' => ['description' => 'Exclude ', 'format' => 'int32', 'title' => '排除', 'type' => 'integer', 'example' => '0'],
+ 'Name' => ['description' => 'Condition name ', 'title' => '条件名', 'type' => 'string', 'example' => 'xx'],
+ 'UserGroup' => ['description' => 'User group ', 'title' => '用户组', 'type' => 'string', 'example' => 'xxxx'],
],
'type' => 'object',
- 'visibility' => 'public',
+ 'description' => 'expression ',
+ 'title' => '',
+ 'example' => '',
],
'GraphFlowNode' => [
- 'description' => '',
+ 'description' => 'Flow node',
'properties' => [
- 'Id' => [
- 'backendName' => 'id',
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Rid' => [
- 'backendName' => 'rid',
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Name' => [
- 'backendName' => 'name',
- 'description' => '',
- 'example' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'NodeType' => [
- 'backendName' => 'nodeType',
- 'description' => '',
- 'example' => 'startNode',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Index' => [
- 'backendName' => 'index',
- 'description' => 'index',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => 'index',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Content' => [
- 'backendName' => 'content',
- 'description' => '',
- 'example' => '{}',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
+ 'Id' => ['title' => '节点id', 'description' => 'Node ID.', 'type' => 'integer', 'example' => '1', 'format' => 'int64'],
+ 'Rid' => ['title' => '规则ID,当规则没有落库时 rid为空。当规则落库时 rid == id', 'description' => 'Rule ID. \\`rid\\` is empty if the rule is not persisted. If the rule is persisted, \\`rid\\` equals \\`ID\\`.', 'type' => 'integer', 'example' => '1', 'format' => 'int64'],
+ 'Name' => ['title' => '节点名字', 'description' => 'Node name', 'type' => 'string', 'example' => '开始节点'],
+ 'NodeType' => ['title' => '节点类型', 'description' => 'Node Type', 'type' => 'string', 'example' => 'startNode'],
+ 'Index' => ['title' => 'index', 'description' => 'Index', 'type' => 'integer', 'example' => '1', 'format' => 'int32'],
+ 'Content' => ['title' => '前端展示使用', 'description' => 'Used for frontend display.', 'type' => 'string', 'example' => '{}'],
'Properties' => [
- 'backendName' => 'properties',
- 'description' => '',
+ 'description' => 'Node properties',
'properties' => [
- 'Type' => [
- 'backendName' => 'type',
- 'description' => '',
- 'example' => 'xx',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Role' => [
- 'backendName' => 'role',
- 'description' => '',
- 'example' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'SayType' => [
- 'backendName' => 'sayType',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'RuleScoreType' => [
- 'backendName' => 'ruleScoreType',
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreNum' => [
- 'backendName' => 'scoreNum',
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreType' => [
- 'backendName' => 'scoreType',
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreRuleHitType' => [
- 'backendName' => 'scoreRuleHitType',
- 'description' => '',
- 'example' => '0',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'AutoReview' => [
- 'backendName' => 'autoReview',
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreNumType' => [
- 'backendName' => 'scoreNumType',
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Lambda' => [
- 'backendName' => 'lambda',
- 'description' => '',
- 'example' => 'a',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'CheckType' => [
- 'backendName' => 'checkType',
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
+ 'Type' => ['title' => '属性类型', 'description' => 'Property type', 'type' => 'string', 'example' => 'xx'],
+ 'Role' => ['title' => 'single类型时,角色', 'description' => 'Role when the type is \\`single\\`.', 'type' => 'string', 'example' => '客户'],
+ 'SayType' => ['title' => 'single类型时,是否表达', 'description' => 'Indicates expression when the type is \\`single\\`.', 'type' => 'string', 'example' => ''],
+ 'RuleScoreType' => ['title' => '是否计分', 'description' => 'Is scored.', 'type' => 'integer', 'example' => '1', 'format' => 'int32'],
+ 'ScoreNum' => ['title' => '计分值', 'description' => 'Score value', 'type' => 'integer', 'example' => '1', 'format' => 'int32'],
+ 'ScoreType' => ['title' => '1加分 3减分 默认1', 'description' => '1: Add points; 3: Deduct points; default is 1.', 'type' => 'integer', 'example' => '1', 'format' => 'int32'],
+ 'ScoreRuleHitType' => ['title' => '0-命中节点时计分', 'description' => '0: Score when the node is hit.', 'type' => 'integer', 'example' => '0', 'format' => 'int32'],
+ 'AutoReview' => ['title' => '1 "不自动审核"', 'description' => '1: Do not auto-review.', 'type' => 'integer', 'example' => '1', 'format' => 'int32'],
+ 'ScoreNumType' => ['title' => '0-触发规则后加减分;1-触发规则后一次性得分', 'description' => '0: Add or deduct points after the rule is triggered; 1: Score once after the rule is triggered.', 'type' => 'integer', 'example' => '1', 'format' => 'int32'],
+ 'Lambda' => ['title' => '普通算子逻辑', 'description' => 'General operator logic.', 'type' => 'string', 'example' => 'a'],
+ 'CheckType' => ['title' => '质检维度', 'description' => 'Quality check dimension', 'type' => 'integer', 'example' => '1', 'format' => 'int32'],
'Triggers' => [
- 'backendName' => 'triggers',
- 'description' => '',
- 'itemName' => 'Trigger',
- 'items' => [
- 'description' => '',
- 'example' => 'a',
- 'extendType' => 'true',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'title' => '',
+ 'description' => 'Operators to follow.',
+ 'items' => ['description' => 'Operator', 'type' => 'string', 'example' => 'a', 'title' => ''],
+ 'title' => '关注的算子',
'type' => 'array',
- 'visibility' => 'public',
- ],
- 'BranchJudge' => [
- 'backendName' => 'branchJudge',
- 'description' => '',
- 'example' => 'true',
- 'title' => '',
- 'type' => 'boolean',
- 'visibility' => 'public',
- ],
- 'CheckMoreSize' => [
- 'backendName' => 'checkMoreSize',
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
+ 'example' => '',
],
+ 'BranchJudge' => ['title' => '是否开启分支判断', 'description' => 'Enable branch judgment.', 'type' => 'boolean', 'example' => 'true'],
+ 'CheckMoreSize' => ['title' => '最多检测N句', 'description' => 'Maximum N sentences to check.', 'type' => 'integer', 'example' => '1', 'format' => 'int32'],
],
- 'title' => '',
+ 'title' => '节点属性',
'type' => 'object',
- 'visibility' => 'public',
+ 'example' => '',
],
'Conditions' => [
- 'backendName' => 'conditions',
- 'description' => '',
- 'itemName' => 'Condition',
- 'items' => [
- 'description' => '',
- 'extendType' => 'true',
- 'ref' => '#/components/schemas/ConditionBasicInfo',
- 'visibility' => 'public',
- ],
- 'title' => '',
+ 'description' => 'Operator information.',
+ 'items' => ['description' => 'Operator', 'ref' => '#/components/schemas/ConditionBasicInfo', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ConditionBasicInfo'],
+ 'title' => '算子信息',
'type' => 'array',
- 'visibility' => 'public',
+ 'example' => '',
],
'NextNodes' => [
- 'backendName' => 'nextNodes',
- 'description' => '',
- 'itemName' => 'NextNode',
+ 'description' => 'Child nodes',
'items' => [
- 'extendType' => 'true',
'properties' => [
- 'Index' => [
- 'backendName' => 'index',
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Name' => [
- 'backendName' => 'name',
- 'description' => '',
- 'example' => 'a',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'NextNodeId' => [
- 'backendName' => 'nextNodeId',
- 'description' => '',
- 'example' => '31533',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Lambda' => [
- 'backendName' => 'lambda',
- 'description' => '',
- 'example' => 'a',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'CheckType' => [
- 'backendName' => 'checkType',
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
+ 'Index' => ['title' => '流程分支优先级。越小优先级越高', 'description' => 'Flow branch priority. A smaller value indicates higher priority.', 'type' => 'integer', 'example' => '1', 'format' => 'int32'],
+ 'Name' => ['title' => '条件分支名', 'description' => 'Conditional branch name.', 'type' => 'string', 'example' => 'a'],
+ 'NextNodeId' => ['title' => '后续节点ID', 'description' => 'Next node ID.', 'type' => 'integer', 'example' => '31533', 'format' => 'int64'],
+ 'Lambda' => ['title' => '通往下一跳的Lambda表达式', 'description' => 'Lambda expression for the next hop.', 'type' => 'string', 'example' => 'a'],
+ 'CheckType' => ['title' => '质检维度', 'description' => 'Quality check dimension', 'type' => 'integer', 'example' => '1', 'format' => 'int32'],
'Triggers' => [
- 'backendName' => 'triggers',
- 'description' => '',
- 'itemName' => 'Trigger',
- 'items' => [
- 'description' => '',
- 'example' => 'a',
- 'extendType' => 'true',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'title' => '',
+ 'description' => 'Operators to follow.',
+ 'items' => ['description' => 'Operator', 'type' => 'string', 'example' => 'a', 'title' => ''],
+ 'title' => '关注的算子',
'type' => 'array',
- 'visibility' => 'public',
+ 'example' => '',
],
],
'type' => 'object',
- 'visibility' => 'public',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => '',
+ 'title' => '子节点',
'type' => 'array',
- 'visibility' => 'public',
- ],
- 'UseConditions' => [
- 'backendName' => 'useConditions',
- 'description' => '',
- 'example' => 'true',
- 'title' => '',
- 'type' => 'boolean',
- 'visibility' => 'public',
+ 'example' => '',
],
+ 'UseConditions' => ['title' => '是否使用 算子匹配还是使用老板的匹配', 'description' => 'Whether to use operator matching or legacy matching.', 'type' => 'boolean', 'example' => 'true'],
],
'type' => 'object',
- 'visibility' => 'public',
+ 'title' => '',
+ 'example' => '',
],
'JudgeNodeMetaDesc' => [
- 'description' => '',
+ 'description' => 'Parameter settings for recording',
'properties' => [
- 'Field' => [
- 'backendName' => 'field',
- 'description' => '',
- 'example' => 'remark1',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'FieldType' => [
- 'backendName' => 'fieldType',
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'DataType' => [
- 'backendName' => 'dataType',
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Symbol' => [
- 'backendName' => 'symbol',
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Value' => [
- 'backendName' => 'value',
+ 'Field' => ['title' => '系统字段', 'description' => 'System field', 'type' => 'string', 'example' => 'remark1'],
+ 'FieldType' => ['title' => '字段数据来源类型:1:系统预定义字段 2:传参质检字段', 'description' => 'Field data source type: 1: System predefined field. 2: Quality inspection field for passed parameters.', 'type' => 'integer', 'example' => '1', 'format' => 'int32'],
+ 'DataType' => ['title' => '数据类型', 'description' => 'Data type', 'type' => 'integer', 'example' => '1', 'format' => 'int32'],
+ 'Symbol' => ['title' => '逻辑表达式', 'description' => 'Expression', 'type' => 'integer', 'example' => '1', 'format' => 'int32'],
+ 'Value' => ['title' => '预设值的值', 'description' => 'Preset value', 'type' => 'string', 'example' => 'xxx'],
+ 'ActualValue' => ['title' => '实际值', 'description' => 'Actual value', 'type' => 'string', 'example' => 'xx'],
+ 'ExpressionMetaDesc' => [
'description' => '',
- 'example' => 'xxx',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'ActualValue' => [
- 'backendName' => 'actualValue',
- 'description' => '',
- 'example' => 'xx',
+ 'type' => 'object',
+ 'properties' => [
+ 'LeftFieldType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'LeftOperand' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Operator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'RightFieldType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'RightOperand' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'RoundingMode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
+ 'example' => '',
],
],
'type' => 'object',
- 'visibility' => 'public',
+ 'title' => '',
+ 'example' => '',
],
'NextNodeSituations' => [
'properties' => [
'ConditionGroup' => [
- 'backendName' => 'conditionGroup',
- 'description' => '',
- 'itemName' => 'ConditionGroup',
+ 'description' => 'Judgment Conditions ',
'items' => [
- 'extendType' => 'true',
'properties' => [
'Conditions' => [
- 'backendName' => 'conditions',
- 'description' => '',
- 'itemName' => 'Condition',
- 'items' => [
- 'extendType' => 'true',
- 'ref' => '#/components/schemas/JudgeNodeMetaDesc',
- 'visibility' => 'public',
- ],
- 'title' => '',
+ 'description' => 'Collection of matching conditions ',
+ 'items' => ['ref' => '#/components/schemas/JudgeNodeMetaDesc', 'description' => 'Condition', '$ref' => '#/components/schemas/JudgeNodeMetaDesc', 'title' => '', 'example' => ''],
+ 'title' => '匹配条件集合',
'type' => 'array',
- 'visibility' => 'public',
- ],
- 'Type' => [
- 'backendName' => 'type',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
+ 'example' => '',
],
+ 'Type' => ['description' => 'The matching relationship between conditions ', 'title' => '条件之间的匹配关系', 'type' => 'string', 'example' => '1'],
],
'type' => 'object',
- 'visibility' => 'public',
+ 'description' => 'Condition ',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => '',
+ 'title' => '判断条件',
'type' => 'array',
- 'visibility' => 'public',
- ],
- 'Type' => [
- 'backendName' => 'type',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
+ 'example' => '',
],
+ 'Type' => ['description' => 'The matching relationship between conditions: currently all are OR relationships. ', 'title' => '条件之间的匹配关系 目前都是or的关系', 'type' => 'string', 'example' => '1'],
],
'type' => 'object',
- 'visibility' => 'public',
+ 'description' => 'Return Result ',
+ 'title' => '',
+ 'example' => '',
],
'OperatorBasicInfo' => [
'properties' => [
- 'Oid' => [
- 'backendName' => 'oid',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Id' => [
- 'backendName' => 'id',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Type' => [
- 'backendName' => 'type',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
+ 'Oid' => ['title' => '可能是主键id,也可能是前端生成的id', 'description' => 'The ID. This can be the primary key ID or an ID generated by the frontend.', 'type' => 'string', 'example' => 'a'],
+ 'Id' => ['title' => '主键id', 'description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Type' => ['title' => '算子类别', 'description' => 'The operator category.', 'type' => 'string', 'example' => 'HIT_ANY_KEYWORDS'],
'Param' => [
- 'backendName' => 'param',
- 'description' => '',
+ 'description' => 'The operator parameters.',
'properties' => [
- 'CustomerParam' => [
- 'backendName' => 'customerParam',
- 'description' => '',
- 'ref' => '#/components/schemas/JudgeNodeMetaDesc',
- 'title' => '',
- 'visibility' => 'public',
- ],
+ 'CustomerParam' => ['title' => '随录参数算子参数', 'description' => 'Parameters for the recording-related operator.', 'ref' => '#/components/schemas/JudgeNodeMetaDesc', 'example' => '', '$ref' => '#/components/schemas/JudgeNodeMetaDesc'],
'Keywords' => [
- 'backendName' => 'keywords',
- 'description' => '',
- 'itemName' => 'Keyword',
- 'items' => [
- 'extendType' => 'true',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'title' => '',
+ 'description' => 'The keywords.',
+ 'items' => ['description' => 'The keyword.', 'type' => 'string', 'title' => '', 'example' => '你好'],
+ 'title' => '关键词',
'type' => 'array',
- 'visibility' => 'public',
- ],
- 'Regex' => [
- 'backendName' => 'regex',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'NotRegex' => [
- 'backendName' => 'notRegex',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Phrase' => [
- 'backendName' => 'phrase',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
+ 'example' => '',
],
+ 'Regex' => ['title' => '正则表达式', 'description' => 'The regular expression.', 'type' => 'string', 'example' => '质疑.*'],
+ 'NotRegex' => ['title' => '排除的正则表达式', 'description' => 'The regular expression to exclude.', 'type' => 'string', 'example' => '优秀.*'],
+ 'Phrase' => ['title' => '语句', 'description' => 'The statement.', 'type' => 'string', 'example' => '你好,请问'],
'References' => [
- 'backendName' => 'references',
- 'description' => '',
- 'itemName' => 'Reference',
- 'items' => [
- 'extendType' => 'true',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'title' => '',
+ 'description' => 'The references.',
+ 'items' => ['description' => 'The reference.', 'type' => 'string', 'title' => '', 'example' => '你好.{0,10}'],
+ 'title' => 'references引用',
'type' => 'array',
- 'visibility' => 'public',
- ],
- 'Interval' => [
- 'backendName' => 'interval',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'IntervalEnd' => [
- 'backendName' => 'intervalEnd',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Threshold' => [
- 'backendName' => 'threshold',
- 'description' => '',
- 'format' => 'float',
- 'title' => '',
- 'type' => 'number',
- 'visibility' => 'public',
- ],
- 'In_sentence' => [
- 'backendName' => 'in_sentence',
- 'description' => '',
- 'title' => '',
- 'type' => 'boolean',
- 'visibility' => 'public',
- ],
- 'Target' => [
- 'backendName' => 'target',
- 'description' => 'target',
- 'format' => 'int32',
- 'title' => 'target',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'From_end' => [
- 'backendName' => 'from_end',
- 'description' => 'from_end',
- 'title' => 'from_end',
- 'type' => 'boolean',
- 'visibility' => 'public',
- ],
- 'Different_role' => [
- 'backendName' => 'different_role',
- 'description' => 'different_role',
- 'title' => 'different_role',
- 'type' => 'boolean',
- 'visibility' => 'public',
- ],
- 'Target_role' => [
- 'backendName' => 'target_role',
- 'description' => 'target_role',
- 'title' => 'target_role',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'RoleId' => [
- 'backendName' => 'roleId',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Velocity' => [
- 'backendName' => 'velocity',
- 'description' => '',
- 'format' => 'double',
- 'title' => '',
- 'type' => 'number',
- 'visibility' => 'public',
- ],
- 'VelocityInMint' => [
- 'backendName' => 'velocityInMint',
- 'description' => 'velocityInMint',
- 'format' => 'int32',
- 'title' => 'velocityInMint',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'KeywordExtension' => [
- 'backendName' => 'keywordExtension',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
+ 'example' => '',
],
+ 'Interval' => ['title' => 'interval代表区间范围开始', 'description' => 'The start of the interval.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'IntervalEnd' => ['title' => 'intervalEnd 代表区间范围结束', 'description' => 'The end of the interval.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'Threshold' => ['title' => '阈值', 'description' => 'The threshold.', 'type' => 'number', 'format' => 'float', 'example' => '90'],
+ 'In_sentence' => ['title' => '生效句子, true单个句子,false多个句子', 'description' => 'The effective sentences. \\`true\\` indicates a single sentence. \\`false\\` indicates multiple sentences.', 'type' => 'boolean', 'example' => 'true'],
+ 'Target' => ['title' => 'target', 'description' => 'The target sentence, specified as the number of sentences before the current one. If set to 0, the time interval is calculated as the end time of the current sentence minus its start time.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'From_end' => ['title' => 'from_end', 'description' => 'Used for the time interval operator. Specifies whether to calculate the time interval by subtracting the end time of the target sentence from the end time of the current sentence.', 'type' => 'boolean', 'example' => 'true'],
+ 'Different_role' => ['title' => 'different_role', 'description' => 'Used for the time interval operator. If set to \\`true\\`, the target sentence is not included in the calculation if it is spoken by the same role as the current sentence.', 'type' => 'boolean', 'example' => 'true'],
+ 'Target_role' => ['title' => 'target_role', 'description' => 'Used for the repetition operator. If the current sentence matches the regular expression, the matched part is searched for in the sentences spoken by the specified \\`Target\\_role\\` that appear before the current sentence.', 'type' => 'string', 'example' => '客服'],
+ 'RoleId' => ['title' => '算子中使用角色,目前用于上下文重复算子,与target_role一起使用。', 'description' => 'The role used in the operator. This parameter is currently used for the contextual repetition operator in conjunction with \\`Target\\_role\\`.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Velocity' => ['title' => '速度', 'description' => 'Used for the speech rate operator. The speech rate value per unit of time. It determines whether the speech rate of the current sentence exceeds the specified value. The time unit depends on the time units of the \\`start\\` and \\`end\\` parameters.', 'type' => 'number', 'format' => 'double', 'example' => '111'],
+ 'VelocityInMint' => ['title' => 'velocityInMint', 'description' => 'Used for the speech rate operator. The speech rate value per minute. It determines whether the speech rate of the current sentence exceeds the specified value.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'KeywordExtension' => ['title' => '关键字扩展', 'description' => 'The keyword extension.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Synonyms' => [
'additionalProperties' => [
- 'itemName' => 'Item',
- 'items' => [
- 'extendType' => 'true',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
+ 'items' => ['description' => 'The synonym.', 'type' => 'string', 'title' => '', 'example' => '售卖'],
'type' => 'array',
- 'visibility' => 'public',
+ 'description' => 'The synonyms.',
+ 'title' => '',
+ 'example' => '',
],
- 'backendName' => 'synonyms',
- 'description' => '',
- 'title' => '',
+ 'description' => 'The synonyms.',
+ 'title' => '同义词',
'type' => 'object',
- 'visibility' => 'public',
- ],
- 'Case_sensitive' => [
- 'backendName' => 'case_sensitive',
- 'description' => '',
- 'title' => '',
- 'type' => 'boolean',
- 'visibility' => 'public',
- ],
- 'Near_dialogue' => [
- 'backendName' => 'near_dialogue',
- 'description' => '',
- 'title' => '',
- 'type' => 'boolean',
- 'visibility' => 'public',
- ],
- 'MinWordSize' => [
- 'backendName' => 'minWordSize',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Hit_time' => [
- 'backendName' => 'hit_time',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
+ 'example' => '',
],
+ 'Case_sensitive' => ['title' => '区分大小写', 'description' => 'Specifies whether the matching is case-sensitive.', 'type' => 'boolean', 'example' => 'true'],
+ 'Near_dialogue' => ['title' => 'true表示取不同角色相邻的两句话,false表示取不同角色的第一句话比较响应时间(默认)', 'description' => '\\`true\\` indicates that the two contiguous sentences from different roles are used. \\`false\\` indicates that the first sentence from each role is used to compare the response time. The default is \\`false\\`.', 'type' => 'boolean', 'example' => 'true'],
+ 'MinWordSize' => ['title' => '句子中最少字数,小于此字数的句子不检查', 'description' => 'The minimum number of words in a sentence. Sentences with fewer words than this value are not checked.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Hit_time' => ['title' => '上下文重复算子:重复几次', 'description' => 'For the contextual repetition operator: the number of repetitions.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'Excludes' => [
- 'backendName' => 'excludes',
- 'description' => '',
- 'itemName' => 'Exclude',
- 'items' => [
- 'extendType' => 'true',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'title' => '',
+ 'description' => 'For the contextual repetition operator: the dialogues to exclude.',
+ 'items' => ['description' => 'For the contextual repetition operator: the dialogue to exclude.', 'type' => 'string', 'title' => '', 'example' => '负向'],
+ 'title' => '上下文重复算子:排除掉某些对话',
'type' => 'array',
- 'visibility' => 'public',
- ],
- 'From' => [
- 'backendName' => 'from',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'CheckFirstSentence' => [
- 'backendName' => 'checkFirstSentence',
- 'description' => '',
- 'title' => '',
- 'type' => 'boolean',
- 'visibility' => 'public',
- ],
- 'Average' => [
- 'backendName' => 'average',
- 'description' => '',
- 'title' => '',
- 'type' => 'boolean',
- 'visibility' => 'public',
- ],
- 'BeginType' => [
- 'backendName' => 'beginType',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'EndType' => [
- 'backendName' => 'endType',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'CompareOperator' => [
- 'backendName' => 'compareOperator',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Pkey' => [
- 'backendName' => 'pkey',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Poutput_type' => [
- 'backendName' => 'poutput_type',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
+ 'example' => '',
],
+ 'From' => ['title' => '上下文重复算子:检测当前句的前from句是否有重复;0表示前面的所有句', 'description' => 'For the contextual repetition operator: checks for repetitions within the \\`from\\` number of sentences before the current sentence. A value of \\`0\\` indicates all preceding sentences.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'CheckFirstSentence' => ['title' => '静音检测:要不要检测第一句话', 'description' => 'For silence detection: specifies whether to check the first sentence.', 'type' => 'boolean', 'example' => 'true'],
+ 'Average' => ['title' => '语速检测,是否计算整个对话平均语速,默认false', 'description' => 'For speech rate detection: specifies whether to calculate the average speech rate for the entire dialogue. The default is \\`false\\`.', 'type' => 'boolean', 'example' => 'true'],
+ 'BeginType' => ['title' => '时长算子,时长计算开始类型,录音开始,还是某句对话开始', 'description' => 'For the duration operator: the start type for the duration calculation. The calculation can start from the beginning of the recording or the beginning of a specific sentence.', 'type' => 'string', 'example' => '1'],
+ 'EndType' => ['title' => '时长算子,时长计算结束类型,录音结束,还是某句对话结束', 'description' => 'For the duration operator: the end type for the duration calculation. The calculation can end at the end of the recording or the end of a specific sentence.', 'type' => 'string', 'example' => '2'],
+ 'CompareOperator' => ['title' => '大于,还是小于,gt/lt', 'description' => 'The comparison operator. Valid values are \\`gt\\` (greater than) and \\`lt\\` (less than).', 'type' => 'string', 'example' => 'gt'],
+ 'Pkey' => ['title' => '涉外属性需要的变量', 'description' => 'The variable required for foreign-related properties.', 'type' => 'string', 'example' => 'xx'],
+ 'Poutput_type' => ['title' => 'poutput类型', 'description' => 'The poutput type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'SimilarlySentences' => [
- 'backendName' => 'similarlySentences',
- 'description' => '',
- 'itemName' => 'SimilarlySentence',
- 'items' => [
- 'extendType' => 'true',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'title' => '',
+ 'description' => 'Similar questions.',
+ 'items' => ['description' => 'The similar question.', 'type' => 'string', 'title' => '', 'example' => '我要购买'],
+ 'title' => '相识问',
'type' => 'array',
- 'visibility' => 'public',
+ 'example' => '',
],
'LgfSentences' => [
- 'backendName' => 'lgfSentences',
- 'description' => '',
- 'itemName' => 'LgfSentence',
- 'items' => [
- 'extendType' => 'true',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'title' => '',
+ 'description' => 'The LGF sentences.',
+ 'items' => ['description' => 'The LGF sentence.', 'type' => 'string', 'title' => '', 'example' => '你好{1}'],
+ 'title' => 'lgf句子',
'type' => 'array',
- 'visibility' => 'public',
- ],
- 'Score' => [
- 'backendName' => 'score',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ContextChatMatch' => [
- 'backendName' => 'contextChatMatch',
- 'description' => '',
- 'title' => '',
- 'type' => 'boolean',
- 'visibility' => 'public',
- ],
- 'KeywordMatchSize' => [
- 'backendName' => 'keywordMatchSize',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'MaxEmotionChangeValue' => [
- 'backendName' => 'maxEmotionChangeValue',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'CheckType' => [
- 'backendName' => 'checkType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'KnowledgeTargetId' => [
- 'backendName' => 'knowledgeTargetId',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'CategoryPathCode' => [
- 'backendName' => 'categoryPathCode',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'KnowledgeTargetType' => [
- 'backendName' => 'knowledgeTargetType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'KnowledgeTargetName' => [
- 'backendName' => 'knowledgeTargetName',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'QuestionThreshold' => [
- 'backendName' => 'questionThreshold',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'AnswerThreshold' => [
- 'backendName' => 'answerThreshold',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'KnowledgeSentenceNum' => [
- 'backendName' => 'knowledgeSentenceNum',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'KnowledgeInfo' => [
- 'backendName' => 'knowledgeInfo',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'BotId' => [
- 'backendName' => 'botId',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'UseEasAlgorithm' => [
- 'backendName' => 'useEasAlgorithm',
- 'description' => '',
- 'title' => '',
- 'type' => 'boolean',
- 'visibility' => 'public',
+ 'example' => '',
],
- 'Similarity_threshold' => [
- 'backendName' => 'similarity_threshold',
- 'description' => '',
- 'format' => 'double',
- 'title' => '',
- 'type' => 'number',
- 'visibility' => 'public',
+ 'Score' => ['title' => '分数', 'description' => 'The score.', 'type' => 'integer', 'format' => 'int32', 'example' => '70'],
+ 'ContextChatMatch' => ['title' => '是否单句话匹配;', 'description' => 'Specifies whether to match a single sentence.', 'type' => 'boolean', 'example' => 'true'],
+ 'KeywordMatchSize' => ['title' => '匹配到的关键字数量', 'description' => 'The number of matched keywords.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'MaxEmotionChangeValue' => ['title' => '能量值变化,默认3, 1~9', 'description' => 'The change in energy value. The default is 3. The range is 1 to 9.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'CheckType' => ['title' => '检测方式,1 相邻句能量波动 2 最大能量跨度 默认1', 'description' => 'The detection method. The default is 1.'."\n"
+ ."\n"
+ .'- 1: Energy fluctuation between contiguous sentences.'."\n"
+ ."\n"
+ .'- 2: Maximum energy span.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'KnowledgeTargetId' => ['title' => '知识类目或者知识Id', 'description' => 'The knowledge category or knowledge ID.', 'type' => 'string', 'example' => '1'],
+ 'CategoryPathCode' => ['title' => '知识类目路径', 'description' => 'The knowledge category path.', 'type' => 'string', 'example' => 'xx'],
+ 'KnowledgeTargetType' => ['title' => '0-类目 1-知识', 'description' => '0: Category. 1: Knowledge.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'KnowledgeTargetName' => ['title' => '知识类目名字或知识名字', 'description' => 'The name of the knowledge category or knowledge.', 'type' => 'string', 'example' => '订单'],
+ 'QuestionThreshold' => ['title' => '问题命中阈值', 'description' => 'The threshold for question hits.', 'type' => 'string', 'example' => '90'],
+ 'AnswerThreshold' => ['title' => '答案命中阈值', 'description' => 'The threshold for answer hits.', 'type' => 'string', 'example' => '90'],
+ 'KnowledgeSentenceNum' => ['title' => '命中问题后几句内检测答案', 'description' => 'The number of sentences after a question is hit within which to detect the answer.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'KnowledgeInfo' => ['title' => '知识信息', 'description' => 'The knowledge information.', 'type' => 'string', 'example' => '下单'],
+ 'BotId' => ['title' => '机器人id', 'description' => 'The robot ID.', 'type' => 'string', 'example' => 'chatbot-cn-xxx'],
+ 'UseEasAlgorithm' => ['title' => '使用eas算法', 'description' => 'Specifies whether to use the EAS algorithm.', 'type' => 'boolean', 'example' => 'true'],
+ 'Pvalues' => [
+ 'description' => 'The model detection type.',
+ 'title' => '模型检测类型',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'example' => '',
],
+ 'Similarity_threshold' => ['title' => '相似度阈值', 'description' => 'The similarity threshold.', 'type' => 'number', 'format' => 'double', 'example' => '90'],
'AntModelInfo' => [
- 'additionalProperties' => [
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'backendName' => 'antModelInfo',
- 'description' => '',
- 'title' => '',
+ 'additionalProperties' => ['description' => 'The Ant model information.', 'type' => 'string', 'title' => '', 'example' => 'xxx'],
+ 'description' => 'The Ant model information.',
+ 'title' => '蚂蚁模型信息',
'type' => 'object',
- 'visibility' => 'public',
+ 'example' => '',
],
- 'DelayTime' => [
- 'backendName' => 'delayTime',
+ 'DelayTime' => ['title' => '抢话算子 延时时长', 'description' => 'For the interruption operator: the delay duration.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Knowledges' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'LlmModelCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'HitCondition' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'SceneName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Dimensions' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Dimension' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Desc' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ExcludeCondition' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'IncludeCondition' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'description' => '',
- 'format' => 'int32',
'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
+ 'example' => '',
],
],
- 'title' => '',
+ 'title' => '算子参数',
'type' => 'object',
- 'visibility' => 'public',
- ],
- 'Name' => [
- 'backendName' => 'name',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'UserGroup' => [
- 'backendName' => 'userGroup',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'QualityCheckType' => [
- 'backendName' => 'qualityCheckType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
+ 'example' => '',
],
+ 'Name' => ['title' => '算子名', 'description' => 'The operator name.', 'type' => 'string', 'example' => 'a'],
+ 'UserGroup' => ['title' => '用户组', 'description' => 'The user group.', 'type' => 'string', 'example' => 'xxx'],
+ 'QualityCheckType' => ['title' => '质检类型:0 离线质检,1 实时质检', 'description' => 'The quality check type:'."\n"
+ ."\n"
+ .'- 0: Offline check'."\n"
+ ."\n"
+ .'- 1: Real-time check', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
'type' => 'object',
- 'visibility' => 'public',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'RuleCountInfo' => [
'properties' => [
- 'Rid' => [
- 'backendName' => 'rid',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Name' => [
- 'backendName' => 'name',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Type' => [
- 'backendName' => 'type',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Status' => [
- 'backendName' => 'status',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'CheckNumber' => [
- 'backendName' => 'checkNumber',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'HitNumber' => [
- 'backendName' => 'hitNumber',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'HitRate' => [
- 'backendName' => 'hitRate',
- 'description' => '',
- 'format' => 'float',
- 'title' => '',
- 'type' => 'number',
- 'visibility' => 'public',
- ],
- 'ReviewAccuracyRate' => [
- 'backendName' => 'reviewAccuracyRate',
- 'description' => '',
- 'format' => 'float',
- 'title' => '',
- 'type' => 'number',
- 'visibility' => 'public',
- ],
- 'ReviewRate' => [
- 'backendName' => 'reviewRate',
- 'description' => '',
- 'format' => 'float',
- 'title' => '',
- 'type' => 'number',
- 'visibility' => 'public',
- ],
- 'PreReviewNumber' => [
- 'backendName' => 'preReviewNumber',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ReviewNumber' => [
- 'backendName' => 'reviewNumber',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'UnReviewNumber' => [
- 'backendName' => 'unReviewNumber',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ProblemNumber' => [
- 'backendName' => 'problemNumber',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'StartTime' => [
- 'backendName' => 'startTime',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'EndTime' => [
- 'backendName' => 'endTime',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'CreateTime' => [
- 'backendName' => 'createTime',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'CreateEmpid' => [
- 'backendName' => 'createEmpid',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'CreateEmpName' => [
- 'backendName' => 'createEmpName',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'LastUpdateEmpid' => [
- 'backendName' => 'lastUpdateEmpid',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'LastUpdateEmpName' => [
- 'backendName' => 'lastUpdateEmpName',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'LastUpdateTime' => [
- 'backendName' => 'lastUpdateTime',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
+ 'Rid' => ['title' => '规则ID', 'description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
+ 'Name' => ['title' => '规则名称', 'description' => 'The rule name.', 'type' => 'string', 'example' => '0801转封装测试'],
+ 'Type' => ['title' => '规则类型', 'description' => 'The rule type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Status' => ['title' => '状态:待生效 / 生效中 / 已失效: 0 / 1 / 2', 'description' => 'The status of the rule.'."\n"
+ ."\n"
+ .'- 0: Pending'."\n"
+ ."\n"
+ .'- 1: Active'."\n"
+ ."\n"
+ .'- 2: Expired', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'CheckNumber' => ['title' => '检测会话数', 'description' => 'The number of checked sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'HitNumber' => ['title' => '命中会话量', 'description' => 'The number of hit sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'HitRate' => ['title' => '命中率', 'description' => 'The hit rate.', 'type' => 'number', 'format' => 'float', 'example' => '1'],
+ 'ReviewAccuracyRate' => ['title' => '复核准确率', 'description' => 'The review accuracy rate.', 'type' => 'number', 'format' => 'float', 'example' => '1'],
+ 'ReviewRate' => ['title' => '复核率', 'description' => 'The review rate.', 'type' => 'number', 'format' => 'float', 'example' => '1'],
+ 'PreReviewNumber' => ['title' => '待复核数', 'description' => 'The number of items pending review.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'ReviewNumber' => ['title' => '已复核数', 'description' => 'The number of reviewed items.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'UnReviewNumber' => ['title' => '未复核数量', 'description' => 'The number of unreviewed items.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'ProblemNumber' => ['title' => '发现问题数', 'description' => 'The number of problems found.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'StartTime' => ['title' => '开始时间', 'description' => 'The start time.', 'type' => 'string', 'example' => '1662685868850'],
+ 'EndTime' => ['title' => '结束时间', 'description' => 'The end time.', 'type' => 'string', 'example' => '1650092585176'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => 'The creation time.', 'type' => 'string', 'example' => '1615133575000'],
+ 'CreateEmpid' => ['title' => '创建人工号', 'description' => 'The employee ID of the creator.', 'type' => 'string', 'example' => '1'],
+ 'CreateEmpName' => ['title' => '创建人姓名', 'description' => 'The name of the creator.', 'type' => 'string', 'example' => '张三'],
+ 'LastUpdateEmpid' => ['title' => '最后更新人工号', 'description' => 'The employee ID of the user who last updated the rule.', 'type' => 'string', 'example' => '1'],
+ 'LastUpdateEmpName' => ['title' => '最后更新人姓名', 'description' => 'The name of the user who last updated the rule.', 'type' => 'string', 'example' => '张三'],
+ 'LastUpdateTime' => ['title' => '最后更新时间', 'description' => 'The last update time.', 'type' => 'string', 'example' => '1648200901000'],
'BusinessRange' => [
- 'backendName' => 'businessRange',
- 'description' => '',
- 'itemName' => 'BusinessRange',
- 'items' => [
- 'extendType' => 'true',
- 'format' => 'int32',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'title' => '',
+ 'description' => 'The business scope.',
+ 'items' => ['description' => 'The business scope.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'title' => '业务范围',
'type' => 'array',
- 'visibility' => 'public',
+ 'example' => '',
],
'BusinessCategoryBasicInfoList' => [
- 'backendName' => 'businessCategoryBasicInfoList',
- 'description' => '',
- 'itemName' => 'BusinessCategoryBasicInfoList',
- 'items' => [
- 'extendType' => 'true',
- 'ref' => '#/components/schemas/BusinessCategoryBasicInfo',
- 'visibility' => 'public',
- ],
- 'title' => '',
+ 'description' => 'A list of basic information about business categories.',
+ 'items' => ['description' => 'The business ID.', 'ref' => '#/components/schemas/BusinessCategoryBasicInfo', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/BusinessCategoryBasicInfo'],
+ 'title' => '业务类别基本信息列表',
'type' => 'array',
- 'visibility' => 'public',
+ 'example' => '',
],
'BusinessCategoryNameList' => [
- 'backendName' => 'businessCategoryNameList',
- 'description' => '',
- 'itemName' => 'BusinessCategoryNameList',
- 'items' => [
- 'extendType' => 'true',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'title' => '',
+ 'description' => 'A list of business category names.',
+ 'items' => ['description' => 'A list of business category names.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'title' => '业务类别名称列表',
'type' => 'array',
- 'visibility' => 'public',
- ],
- 'IsDelete' => [
- 'backendName' => 'isDelete',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'TypeName' => [
- 'backendName' => 'typeName',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'JobName' => [
- 'backendName' => 'jobName',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Comments' => [
- 'backendName' => 'comments',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'RealViolationNumber' => [
- 'backendName' => 'realViolationNumber',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'HitRealViolationRate' => [
- 'backendName' => 'hitRealViolationRate',
- 'description' => '',
- 'format' => 'float',
- 'title' => '',
- 'type' => 'number',
- 'visibility' => 'public',
- ],
- 'ReviewStatusName' => [
- 'backendName' => 'reviewStatusName',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Deny' => [
- 'backendName' => 'deny',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreSubId' => [
- 'backendName' => 'scoreSubId',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'AutoReview' => [
- 'backendName' => 'autoReview',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'RuleScoreType' => [
- 'backendName' => 'ruleScoreType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'UserGroup' => [
- 'backendName' => 'userGroup',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'OperationMode' => [
- 'backendName' => 'operationMode',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'IsSelect' => [
- 'backendName' => 'isSelect',
- 'description' => '',
- 'title' => '',
- 'type' => 'boolean',
- 'visibility' => 'public',
- ],
- 'RuleType' => [
- 'backendName' => 'ruleType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Effective' => [
- 'backendName' => 'effective',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'FullCycle' => [
- 'backendName' => 'fullCycle',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'EffectiveStartTime' => [
- 'backendName' => 'effectiveStartTime',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'EffectiveEndTime' => [
- 'backendName' => 'effectiveEndTime',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'QualityCheckType' => [
- 'backendName' => 'qualityCheckType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'GraphFlow' => [
- 'backendName' => 'graphFlow',
- 'description' => '',
- 'title' => '',
- 'type' => 'any',
- 'visibility' => 'public',
- ],
- 'RuleScoreSingleType' => [
- 'backendName' => 'ruleScoreSingleType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'TargetType' => [
- 'backendName' => 'targetType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
+ 'example' => '',
],
+ 'IsDelete' => ['title' => '是否删除', 'description' => 'Indicates if the rule is deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TypeName' => ['title' => '类型名称', 'description' => 'The type name.', 'type' => 'string', 'example' => '全部类别'],
+ 'JobName' => ['title' => '定时任务名称', 'description' => 'The scheduled task name.', 'type' => 'string', 'example' => 'job-1-20221012-105943'],
+ 'Comments' => ['title' => '评论', 'description' => 'The comments.', 'type' => 'string', 'example' => '测试'],
+ 'RealViolationNumber' => ['title' => '复核后真实违规的数量', 'description' => 'The number of actual violations after review.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'HitRealViolationRate' => ['title' => '命中违规率', 'description' => 'The hit rate of actual violations.', 'type' => 'number', 'format' => 'float', 'example' => '1'],
+ 'ReviewStatusName' => ['title' => '审核状态名字', 'description' => 'The review status name.', 'type' => 'string', 'example' => '通过'],
+ 'Deny' => ['title' => '1拒绝编辑规则,0/null可以编辑规则', 'description' => 'You can set this parameter to 1 to reject rule edits, or to 0 or null to allow rule edits.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ScoreSubId' => ['title' => '小项id', 'description' => 'The sub-item ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'AutoReview' => ['title' => '审核选项 1 不自动审核 3 自动审核', 'description' => 'The review option.'."\n"
+ ."\n"
+ .'- 1: Manual review'."\n"
+ ."\n"
+ .'- 3: Automatic review', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'RuleScoreType' => ['title' => '是否计分 1不计分 3计分', 'description' => 'Specifies if a score is calculated.'."\n"
+ ."\n"
+ .'- 1: No'."\n"
+ ."\n"
+ .'- 3: Yes', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'UserGroup' => ['title' => '用户组', 'description' => 'The user group.', 'type' => 'string', 'example' => 'xxxx'],
+ 'OperationMode' => ['title' => '操作模式', 'description' => 'The operation mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'IsSelect' => ['title' => '是否选择', 'description' => 'Indicates if the rule is selected.', 'type' => 'boolean', 'example' => 'true'],
+ 'RuleType' => ['title' => '内置规则Or用户创建规则', 'description' => 'The rule origin. For example, a built-in rule or a user-created rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Effective' => ['title' => '是否生效:0否,1是', 'description' => 'Indicates if the rule is active. \\`0\\`: No. \\`1\\`: Yes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'FullCycle' => ['title' => '是否为全生命周期生效,0否,1是', 'description' => 'Indicates if the rule is active for the entire lifecycle. \\`0\\`: No. \\`1\\`: Yes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'EffectiveStartTime' => ['title' => '生效开始时间', 'description' => 'The effective start time.', 'type' => 'string', 'example' => '1662685868850'],
+ 'EffectiveEndTime' => ['title' => '生效结束时间', 'description' => 'The effective end time.', 'type' => 'string', 'example' => '1662685868850'],
+ 'QualityCheckType' => ['title' => '质检类型:0 离线质检,1 实时质检', 'description' => 'The quality check type.'."\n"
+ ."\n"
+ .'- 0: Offline'."\n"
+ ."\n"
+ .'- 1: Real-time', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'GraphFlow' => ['title' => '流程画布', 'description' => 'The flow canvas, in JSON format.', 'type' => 'any', 'example' => '较复杂,忽略'],
+ 'RuleScoreSingleType' => ['title' => '-- 8-未设置评分', 'description' => 'The scoring type. \\`8\\`: No score is set.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TargetType' => ['title' => '规则种类:10-普通规则,11-流程规则', 'description' => 'The rule category.'."\n"
+ ."\n"
+ .'- 10: Standard'."\n"
+ ."\n"
+ .'- 11: Flow-based', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
'type' => 'object',
- 'visibility' => 'public',
+ 'description' => 'The rule details.',
+ 'title' => '',
+ 'example' => '',
],
'RuleInfo' => [
- 'description' => '',
+ 'description' => 'Details of the rule.',
'properties' => [
- 'Status' => [
- 'backendName' => 'status',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'IsDelete' => [
- 'backendName' => 'isDelete',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'StartTime' => [
- 'backendName' => 'startTime',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'EndTime' => [
- 'backendName' => 'endTime',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'BusinessCategoryNameList' => [
- 'backendName' => 'businessCategoryNameList',
- 'description' => '',
- 'itemName' => 'BusinessCategoryNameList',
+ 'Status' => ['title' => '规则状态', 'description' => 'The status of the rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'IsDelete' => ['title' => '是否已删除', 'description' => 'Indicates whether the rule is deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'StartTime' => ['title' => '开始时间', 'description' => 'The start time. This value is a Unix timestamp in milliseconds.', 'type' => 'string', 'example' => '1641277321000'],
+ 'EndTime' => ['title' => '结束时间', 'description' => 'The end time. This value is a Unix timestamp in milliseconds.', 'type' => 'string', 'example' => '1641277321000'],
+ 'Weight' => ['title' => '权重', 'description' => 'The weight of the rule.', 'type' => 'string', 'example' => '1'],
+ 'IsOnline' => ['title' => '是否在线', 'description' => 'Indicates whether the rule is online.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'CreateEmpid' => ['title' => '创建人工号', 'description' => 'The employee ID of the creator.', 'type' => 'string', 'example' => '1'],
+ 'CreateEmpName' => ['title' => '创建人姓名', 'description' => 'The name of the creator.', 'type' => 'string', 'example' => '张三'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => 'The creation time. This value is a Unix timestamp in milliseconds.', 'type' => 'string', 'example' => '1641277321000'],
+ 'LastUpdateTime' => ['title' => '最后更新时间', 'description' => 'The last update time. This value is a Unix timestamp in milliseconds.', 'type' => 'string', 'example' => '1641277321000'],
+ 'LastUpdateEmpid' => ['title' => '最后更新人工号', 'description' => 'The ID of the employee who last updated the rule.', 'type' => 'string', 'example' => '1'],
+ 'LastUpdateEmpName' => ['title' => '最后更新人姓名', 'description' => 'The name of the employee who last updated the rule.', 'type' => 'string', 'example' => '张三'],
+ 'Comments' => ['title' => '备注', 'description' => 'Remarks on the rule.', 'type' => 'string', 'example' => '违规'],
+ 'Deny' => ['title' => '1拒绝编辑规则,0/null可以编辑规则', 'description' => 'Indicates whether editing the rule is denied. Valid values: `1` (denied), `0` or `null` (allowed).', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ScoreSubId' => ['title' => '小项id', 'description' => 'The ID of the scoring subitem.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'ScoreName' => ['title' => '评分大项名称', 'description' => 'The name of the main scoring item.', 'type' => 'string', 'example' => '违规'],
+ 'ScoreSubName' => ['title' => '评分小项', 'description' => 'The name of the scoring subitem.', 'type' => 'string', 'example' => '1'],
+ 'ScoreType' => ['title' => '加分或者减分', 'description' => 'Indicates whether to add or deduct points.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ScoreDeleted' => ['title' => '评分项是否删除,用于删除时显示置灰', 'description' => 'Indicates whether the scoring item is deleted. A deleted item may be displayed as grayed out.', 'type' => 'boolean', 'example' => 'true'],
+ 'OperationMode' => ['title' => '操作模式', 'description' => 'The operation mode.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Meet' => ['title' => '是否满足', 'description' => 'Indicates whether the conditions are met.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Effective' => ['title' => '是否生效:0否,1是', 'description' => 'Indicates whether the rule is in effect. Valid values: `0` (No) and `1` (Yes).', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'FullCycle' => ['title' => '是否为全生命周期生效,0否,1是', 'description' => 'Indicates whether the rule is effective throughout its lifecycle. Valid values: `0` (No) and `1` (Yes).', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'EffectiveStartTime' => ['title' => '生效开始时间', 'description' => 'The effective start time of the rule.', 'type' => 'string', 'example' => 'OperationMode'],
+ 'EffectiveEndTime' => ['title' => '生效结束时间', 'description' => 'The effective end time of the rule.', 'type' => 'string', 'example' => 'OperationMode'],
+ 'QualityCheckType' => ['title' => '质检类型:0 离线质检,1 实时质检 //4.0逻辑兼容使用', 'description' => 'The quality check type. This parameter is used for compatibility with the v4.0 protocol. Valid values: `0` (offline quality check) and `1` (real-time quality check).', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Level' => ['title' => '规则级别:0 重度违规 1 中度违规 2 轻度违规', 'description' => 'The severity level of the rule. Valid values: `0` (Severe violation), `1` (Moderate violation), and `2` (Minor violation).', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'GraphFlow' => ['title' => '图流程画布', 'description' => 'The graph flow.', 'type' => 'any', 'example' => '{}'],
+ 'TaskFlowType' => ['title' => '流程图类型-已废弃-默认-1', 'description' => 'The type of the flowchart. This parameter is deprecated. The default value is `1`.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'CheckType' => ['title' => '0-服务规范性检测 1-服务态度检测 2-服务专业性检测 3-客户态度检测 4-服务流程正确性检测', 'description' => 'The check type. Valid values: `0` (Service compliance check), `1` (Service attitude check), `2` (Service professionalism check), `3` (Customer attitude check), and `4` (Service process correctness check).', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
+ 'SchemeCheckType' => ['title' => '质检维度对象', 'description' => 'The quality check dimension object.', 'ref' => '#/components/schemas/SchemeCheckType', 'example' => '', '$ref' => '#/components/schemas/SchemeCheckType'],
+ 'TargetType' => ['title' => '规则类别:10:质检方案-通用规则;11:质检方案-流程规则 //4.0协议专用', 'description' => 'The rule category. This parameter is used for compatibility with the v4.0 protocol. Valid values: `10` (General rule for quality check schemes) and `11` (Flow rule for quality check schemes).', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'ConfigType' => ['title' => '配置类型:1:简单条件配置,2:高级配置,默认1 //4.0协议专用', 'description' => 'The configuration type. This parameter is used for compatibility with the v4.0 protocol. Valid values: `1` (Simple condition configuration) and `2` (Advanced configuration). Default: `1`.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ScoreNumType' => ['title' => '0-触发规则后加减分 1-触发规则后一次性得分 //4.0协议专用', 'description' => 'The scoring method. This parameter is used for compatibility with the v4.0 protocol. Valid values: `0` (Add/deduct points when the rule is triggered) and `1` (Assign a one-time score when the rule is triggered).', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ScoreRuleHitType' => ['title' => '0-命中节点时计分', 'description' => 'The scoring trigger. Valid values: `0` (Score when a node is hit).', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'SchemeId' => ['title' => '所属质检方案Id', 'description' => 'The ID of the quality check scheme to which the rule belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'SchemeRuleMappingId' => ['title' => '质检方案与规则映射ID', 'description' => 'The mapping ID between the quality check scheme and the rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'SchemeName' => ['title' => '质检方案名称', 'description' => 'The name of the quality check scheme.', 'type' => 'string', 'example' => '通用方案'],
+ 'ModifyType' => ['title' => '在质检方案中是否已修改', 'description' => 'Indicates whether the rule has been modified within the quality check scheme.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'SortIndex' => ['title' => '质检维度内的排序', 'description' => 'The sort order of the rule in the quality check dimension.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'RuleType' => ['title' => '0:默认;1:用户创建 //4.0逻辑兼容使用', 'description' => 'The rule type. This parameter is used for compatibility with the v4.0 protocol. Valid values: `0` (Default) and `1` (User-created).', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Rid' => ['title' => '规则ID', 'description' => 'The rule ID.', 'type' => 'string', 'example' => '1'],
+ 'Name' => ['title' => '规则名称', 'description' => 'The rule name.', 'type' => 'string', 'example' => '开头语规则'],
+ 'TaskFlowId' => ['title' => '流程画布ID', 'description' => 'The ID of the flowchart.', 'type' => 'integer', 'format' => 'int64', 'example' => '111111111'],
+ 'Lambda' => ['title' => '形如a&&b的条件表达式', 'description' => 'The conditional expression, such as `a&&b`.', 'type' => 'string', 'example' => 'a&&b'],
+ 'ExternalProperty' => ['title' => '外部属性', 'description' => 'The external property.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Type' => ['title' => 'RuleCategory,2舆情监控,3业务类 //4.0 逻辑兼容使用', 'description' => 'The rule category. This parameter is used for compatibility with the v4.0 protocol. Valid values: `2` (Public opinion monitoring) and `3` (Business).', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'RuleCategoryName' => ['title' => '规则类别名称', 'description' => 'The name of the rule category.', 'type' => 'string', 'example' => '正向规则'],
+ 'AutoReview' => ['title' => '审核选项 1 不自动审核 3 自动审核 //4.0 协议兼容使用', 'description' => 'The review option. This parameter is used for compatibility with the v4.0 protocol. Valid values: `1` (Manual review) and `3` (Automatic review).', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'RuleScoreType' => ['title' => '是否计分 1不计分 3计分 //4.0 协议兼容使用', 'description' => 'Specifies whether to score the rule. This parameter is used for compatibility with the v4.0 protocol. Valid values: `1` (Do not score) and `3` (Score).', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'ScoreId' => ['title' => '评分大项ID', 'description' => 'The ID of the main scoring item.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'PreqRule' => [
+ 'type' => 'object',
'items' => [
+ 'type' => 'object',
+ 'properties' => [],
'description' => '',
- 'extendType' => 'true',
- 'type' => 'string',
- 'visibility' => 'public',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => '',
- 'type' => 'array',
- 'visibility' => 'public',
- ],
- 'Weight' => [
- 'backendName' => 'weight',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'IsOnline' => [
- 'backendName' => 'isOnline',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'CreateEmpid' => [
- 'backendName' => 'createEmpid',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'CreateEmpName' => [
- 'backendName' => 'createEmpName',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'CreateTime' => [
- 'backendName' => 'createTime',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'LastUpdateTime' => [
- 'backendName' => 'lastUpdateTime',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'LastUpdateEmpid' => [
- 'backendName' => 'lastUpdateEmpid',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'LastUpdateEmpName' => [
- 'backendName' => 'lastUpdateEmpName',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Comments' => [
- 'backendName' => 'comments',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Deny' => [
- 'backendName' => 'deny',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreSubId' => [
- 'backendName' => 'scoreSubId',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreName' => [
- 'backendName' => 'scoreName',
'description' => '',
'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'ScoreSubName' => [
- 'backendName' => 'scoreSubName',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'ScoreNum' => [
- 'backendName' => 'scoreNum',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreType' => [
- 'backendName' => 'scoreType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreDeleted' => [
- 'backendName' => 'scoreDeleted',
- 'description' => '',
- 'title' => '',
- 'type' => 'boolean',
- 'visibility' => 'public',
- ],
- 'OperationMode' => [
- 'backendName' => 'operationMode',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
+ 'example' => '',
+ 'properties' => [
+ 'Rid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
],
- 'Meet' => [
- 'backendName' => 'meet',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
+ 'ScoreNum' => ['title' => '分数num', 'description' => 'The score value.', 'type' => 'number', 'format' => 'float', 'example' => '1'],
+ 'BusinessCategoryNameList' => [
+ 'description' => 'A list of business category names.',
+ 'items' => ['description' => 'The business category.', 'type' => 'string', 'title' => '', 'example' => '全部'],
+ 'title' => '业务名称列表',
+ 'type' => 'array',
+ 'example' => '',
],
'Dialogues' => [
- 'backendName' => 'dialogues',
- 'description' => '',
- 'itemName' => 'Dialogue',
- 'items' => [
- 'extendType' => 'true',
- 'ref' => '#/components/schemas/RuleTestDialogue',
- 'visibility' => 'public',
- ],
- 'title' => '',
+ 'description' => 'A list of test dialogues.',
+ 'items' => ['description' => 'The content of a test dialogue.', 'ref' => '#/components/schemas/RuleTestDialogue', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/RuleTestDialogue'],
+ 'title' => '测试文案',
'type' => 'array',
- 'visibility' => 'public',
- ],
- 'Effective' => [
- 'backendName' => 'effective',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'FullCycle' => [
- 'backendName' => 'fullCycle',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'EffectiveStartTime' => [
- 'backendName' => 'effectiveStartTime',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'EffectiveEndTime' => [
- 'backendName' => 'effectiveEndTime',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'QualityCheckType' => [
- 'backendName' => 'qualityCheckType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Level' => [
- 'backendName' => 'level',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'GraphFlow' => [
- 'backendName' => 'graphFlow',
- 'description' => '',
- 'title' => '',
- 'type' => 'any',
- 'visibility' => 'public',
- ],
- 'TaskFlowType' => [
- 'backendName' => 'taskFlowType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'CheckType' => [
- 'backendName' => 'checkType',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'SchemeCheckType' => [
- 'backendName' => 'schemeCheckType',
- 'description' => '',
- 'ref' => '#/components/schemas/SchemeCheckType',
- 'title' => '',
- 'visibility' => 'public',
- ],
- 'TargetType' => [
- 'backendName' => 'targetType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ConfigType' => [
- 'backendName' => 'configType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreNumType' => [
- 'backendName' => 'scoreNumType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreRuleHitType' => [
- 'backendName' => 'scoreRuleHitType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'SchemeId' => [
- 'backendName' => 'schemeId',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'SchemeRuleMappingId' => [
- 'backendName' => 'schemeRuleMappingId',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'SchemeName' => [
- 'backendName' => 'schemeName',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'ModifyType' => [
- 'backendName' => 'modifyType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'SortIndex' => [
- 'backendName' => 'sortIndex',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'RuleType' => [
- 'backendName' => 'ruleType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Rid' => [
- 'backendName' => 'rid',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Name' => [
- 'backendName' => 'name',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'TaskFlowId' => [
- 'backendName' => 'taskFlowId',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Lambda' => [
- 'backendName' => 'lambda',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
+ 'example' => '',
],
'Triggers' => [
- 'backendName' => 'triggers',
- 'description' => '',
- 'itemName' => 'Trigger',
- 'items' => [
- 'extendType' => 'true',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'title' => '',
+ 'description' => 'A list of triggers.',
+ 'items' => ['description' => 'A trigger.', 'type' => 'string', 'title' => '', 'example' => 'a'],
+ 'title' => '关注的条件列表',
'type' => 'array',
- 'visibility' => 'public',
- ],
- 'ExternalProperty' => [
- 'backendName' => 'externalProperty',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Type' => [
- 'backendName' => 'type',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'RuleCategoryName' => [
- 'backendName' => 'ruleCategoryName',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'AutoReview' => [
- 'backendName' => 'autoReview',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'RuleScoreType' => [
- 'backendName' => 'ruleScoreType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreId' => [
- 'backendName' => 'scoreId',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
+ 'example' => '',
],
],
- 'title' => '',
+ 'title' => '规则明细',
'type' => 'object',
- 'visibility' => 'public',
+ 'example' => '',
],
'RulesInfo' => [
- 'description' => '',
- 'nullable' => false,
+ 'description' => 'Rule collection information ',
'properties' => [
'Conditions' => [
- 'backendName' => 'conditions',
- 'description' => '',
- 'itemName' => 'Condition',
- 'items' => [
- 'description' => '',
- 'extendType' => 'true',
- 'ref' => '#/components/schemas/ConditionBasicInfo',
- 'visibility' => 'public',
- ],
- 'nullable' => true,
- 'title' => '',
+ 'description' => 'Rule condition information; conditions for multiple rules are all placed in a single list ',
+ 'items' => ['description' => 'Rule condition information', 'ref' => '#/components/schemas/ConditionBasicInfo', '$ref' => '#/components/schemas/ConditionBasicInfo', 'title' => '', 'example' => ''],
+ 'title' => '规则条件信息,多个规则的条件都放在一个list中',
'type' => 'array',
- 'visibility' => 'public',
+ 'example' => '',
],
'Rules' => [
- 'backendName' => 'rules',
- 'description' => '',
- 'itemName' => 'Rule',
- 'items' => [
- 'description' => '',
- 'extendType' => 'true',
- 'ref' => '#/components/schemas/RuleInfo',
- 'visibility' => 'public',
- ],
- 'title' => '',
+ 'description' => 'Basic rule information; multiple rules may exist ',
+ 'items' => ['description' => 'Basic rule information ', 'ref' => '#/components/schemas/RuleInfo', '$ref' => '#/components/schemas/RuleInfo', 'title' => '', 'example' => ''],
+ 'title' => '规则基本信息,可能有多个规则',
'type' => 'array',
- 'visibility' => 'public',
+ 'example' => '',
],
'Dialogues' => [
- 'backendName' => 'dialogues',
- 'description' => '',
- 'itemName' => 'Dialogue',
- 'items' => [
- 'description' => '',
- 'extendType' => 'true',
- 'ref' => '#/components/schemas/RuleTestDialogue',
- 'visibility' => 'public',
- ],
- 'nullable' => true,
- 'title' => '',
+ 'description' => 'Testing copy ',
+ 'items' => ['description' => 'Testing copy information ', 'ref' => '#/components/schemas/RuleTestDialogue', '$ref' => '#/components/schemas/RuleTestDialogue', 'title' => '', 'example' => ''],
+ 'title' => '测试文案',
'type' => 'array',
- 'visibility' => 'public',
- ],
- 'Count' => [
- 'backendName' => 'count',
- 'description' => '',
- 'example' => '100',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'PageSize' => [
- 'backendName' => 'pageSize',
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'PageNumber' => [
- 'backendName' => 'pageNumber',
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
+ 'example' => '',
],
+ 'Count' => ['description' => 'Total number of entries ', 'example' => '100', 'format' => 'int32', 'title' => '总条数', 'type' => 'integer'],
+ 'PageSize' => ['description' => 'Page size ', 'example' => '10', 'format' => 'int32', 'title' => '页数', 'type' => 'integer'],
+ 'PageNumber' => ['description' => 'Current page ', 'example' => '1', 'format' => 'int32', 'title' => '当前页', 'type' => 'integer'],
],
'type' => 'object',
- 'visibility' => 'public',
+ 'title' => '',
+ 'example' => '',
],
'RuleTestDialogue' => [
'properties' => [
- 'Id' => [
- 'backendName' => 'id',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
+ 'Id' => ['description' => 'Conversation ID ', 'format' => 'int64', 'title' => '对话ID', 'type' => 'integer', 'example' => '1'],
'Content' => [
- 'backendName' => 'content',
- 'description' => '',
- 'itemName' => 'Content',
+ 'description' => 'Content ',
'items' => [
- 'extendType' => 'true',
'properties' => [
- 'HourMinSec' => [
- 'backendName' => 'hourMinSec',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Role' => [
- 'backendName' => 'role',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'Identity' => [
- 'backendName' => 'identity',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'EmotionValue' => [
- 'backendName' => 'emotionValue',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'SpeechRate' => [
- 'backendName' => 'speechRate',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Words' => [
- 'backendName' => 'words',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'End' => [
- 'backendName' => 'end',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'SilenceDuration' => [
- 'backendName' => 'silenceDuration',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'BeginTime' => [
- 'backendName' => 'beginTime',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Begin' => [
- 'backendName' => 'begin',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
+ 'HourMinSec' => ['description' => 'Hour, minute, second ', 'title' => '时分秒', 'type' => 'string', 'example' => '00:00:00'],
+ 'Role' => ['description' => 'Role ', 'title' => '角色', 'type' => 'string', 'example' => '客户'],
+ 'Identity' => ['description' => 'Identity ', 'title' => '身份标识', 'type' => 'string', 'example' => '客户'],
+ 'EmotionValue' => ['description' => 'Emotion energy value ', 'format' => 'int32', 'title' => '情绪能量值', 'type' => 'integer', 'example' => '1'],
+ 'SpeechRate' => ['description' => 'Speech rate ', 'format' => 'int64', 'title' => '语速', 'type' => 'integer', 'example' => '100'],
+ 'Words' => ['description' => 'Dialogue ', 'title' => '对话', 'type' => 'string', 'example' => '方便'],
+ 'End' => ['description' => 'End time in long ', 'format' => 'int64', 'title' => '结束时间inLong', 'type' => 'integer', 'example' => '1360'],
+ 'SilenceDuration' => ['description' => 'Silence duration ', 'format' => 'int64', 'title' => '静音时长', 'type' => 'integer', 'example' => '100'],
+ 'BeginTime' => ['description' => 'Start Time in long ', 'format' => 'int64', 'title' => '开始时间InLong', 'type' => 'integer', 'example' => '350'],
+ 'Begin' => ['description' => 'Start Time in long ', 'format' => 'int64', 'title' => '开始时间InLong', 'type' => 'integer', 'example' => '360'],
],
'type' => 'object',
- 'visibility' => 'public',
+ 'description' => 'Dialogue ',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => '',
+ 'title' => '对话内容',
'type' => 'array',
- 'visibility' => 'public',
- ],
- 'Name' => [
- 'backendName' => 'name',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'UserGroup' => [
- 'backendName' => 'userGroup',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
+ 'example' => '',
],
+ 'Name' => ['description' => 'Conversation Name ', 'title' => '对话名称', 'type' => 'string', 'example' => 'xx'],
+ 'UserGroup' => ['description' => 'group ', 'title' => '用户组', 'type' => 'string', 'example' => 'xx'],
],
'type' => 'object',
- 'visibility' => 'public',
+ 'description' => 'Rule testing dialogue ',
+ 'title' => '',
+ 'example' => '',
],
'SchemeCheckType' => [
'properties' => [
- 'CheckType' => [
- 'backendName' => 'checkType',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'CheckName' => [
- 'backendName' => 'checkName',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'SourceScore' => [
- 'backendName' => 'sourceScore',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Score' => [
- 'backendName' => 'score',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Enable' => [
- 'backendName' => 'enable',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'SchemeId' => [
- 'backendName' => 'schemeId',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
+ 'CheckType' => ['description' => 'Quality inspection dimension ID', 'format' => 'int64', 'title' => '检测项类型:默认如下', 'type' => 'integer', 'example' => '1'],
+ 'CheckName' => ['description' => 'Check item name', 'title' => '检测项名称', 'type' => 'string', 'example' => '流程规则'],
+ 'SourceScore' => ['description' => 'Original score ', 'format' => 'int32', 'title' => '原始得分', 'type' => 'integer', 'example' => '1'],
+ 'Score' => ['description' => 'Final score', 'format' => 'int32', 'title' => '最终得分', 'type' => 'integer', 'example' => '50'],
+ 'Enable' => ['description' => 'Is enabled ', 'format' => 'int32', 'title' => '是否启用', 'type' => 'integer', 'example' => '1'],
+ 'SchemeId' => ['description' => 'Quality inspection scheme ID', 'format' => 'int64', 'title' => '质检方案ID', 'type' => 'integer', 'example' => '1'],
'SchemeScoreInfoList' => [
- 'backendName' => 'schemeScoreInfoList',
- 'description' => '',
- 'itemName' => 'SchemeScoreInfoList',
+ 'description' => 'List of scoring items under the check item. See SchemeScoreInfo.',
'items' => [
- 'extendType' => 'true',
'properties' => [
- 'Rid' => [
- 'backendName' => 'rid',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Name' => [
- 'backendName' => 'name',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'TaskFlowId' => [
- 'backendName' => 'taskFlowId',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'TaskFlowName' => [
- 'backendName' => 'taskFlowName',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'ScoreType' => [
- 'backendName' => 'scoreType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreNumType' => [
- 'backendName' => 'scoreNumType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreNum' => [
- 'backendName' => 'scoreNum',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreRuleHitType' => [
- 'backendName' => 'scoreRuleHitType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
+ 'Rid' => ['description' => 'Rule ID ', 'format' => 'int64', 'title' => '规则ID', 'type' => 'integer', 'example' => '1'],
+ 'Name' => ['description' => 'Rule Name ', 'title' => '规则名称', 'type' => 'string', 'example' => 'xx'],
+ 'TaskFlowId' => ['description' => 'Flow ID ', 'format' => 'int64', 'title' => '流程ID', 'type' => 'integer', 'example' => '1'],
+ 'TaskFlowName' => ['description' => 'Flow name', 'title' => '流程名称', 'type' => 'string', 'example' => 'xx'],
+ 'ScoreType' => ['description' => '1 for adding points, 3 for deducting points; default is 1', 'format' => 'int32', 'title' => '1加分 3减分 默认1', 'type' => 'integer', 'example' => '1'],
+ 'ScoreNumType' => ['description' => '0 – Add or subtract points after triggering a rule', 'format' => 'int32', 'title' => '0-触发规则后加减分', 'type' => 'integer', 'example' => '0'],
+ 'ScoreNum' => ['description' => 'Agent rating: default 0, [0, 100] ', 'format' => 'int32', 'title' => '客服评分:默认0,[0, 100]', 'type' => 'integer', 'example' => '1'],
+ 'ScoreRuleHitType' => ['description' => '0 – Score when hitting an edge zone', 'format' => 'int32', 'title' => '0-命中节点时计分', 'type' => 'integer', 'example' => '0'],
],
'type' => 'object',
- 'visibility' => 'public',
+ 'description' => 'Scheme score',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => '',
+ 'title' => '检测项下评分项列表,见SchemeScoreInfo',
'type' => 'array',
- 'visibility' => 'public',
+ 'example' => '',
],
'TaskFlowScoreInfoList' => [
- 'backendName' => 'taskFlowScoreInfoList',
- 'description' => '',
- 'itemName' => 'TaskFlowScoreInfoList',
+ 'description' => 'List of scoring items under the check item. See TaskFlowScoreInfo.',
'items' => [
- 'extendType' => 'true',
'properties' => [
- 'TaskFlowId' => [
- 'backendName' => 'taskFlowId',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'TaskFlowName' => [
- 'backendName' => 'taskFlowName',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'TaskFlowType' => [
- 'backendName' => 'taskFlowType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
+ 'TaskFlowId' => ['description' => 'Flow ID', 'format' => 'int64', 'title' => '流程ID', 'type' => 'integer', 'example' => '1'],
+ 'TaskFlowName' => ['description' => 'flow name', 'title' => '流程名称', 'type' => 'string', 'example' => 'xx'],
+ 'TaskFlowType' => ['description' => '\'Flow version: 0: tree, 1: graph\'', 'format' => 'int32', 'title' => '\'流程版本:0:树,1:图\'', 'type' => 'integer', 'example' => '1'],
'SchemeScoreInfoList' => [
- 'backendName' => 'schemeScoreInfoList',
- 'description' => '',
- 'itemName' => 'SchemeScoreInfoList',
+ 'description' => 'list of scoring items',
'items' => [
- 'extendType' => 'true',
'properties' => [
- 'Rid' => [
- 'backendName' => 'rid',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Name' => [
- 'backendName' => 'name',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'TaskFlowId' => [
- 'backendName' => 'taskFlowId',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'TaskFlowName' => [
- 'backendName' => 'taskFlowName',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'ScoreType' => [
- 'backendName' => 'scoreType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreNumType' => [
- 'backendName' => 'scoreNumType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreNum' => [
- 'backendName' => 'scoreNum',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ScoreRuleHitType' => [
- 'backendName' => 'scoreRuleHitType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
+ 'Rid' => ['description' => 'Rule ID', 'format' => 'int64', 'title' => '规则ID', 'type' => 'integer', 'example' => '1'],
+ 'Name' => ['description' => 'Rule Name', 'title' => '规则名称', 'type' => 'string', 'example' => 'xx'],
+ 'TaskFlowId' => ['description' => 'Flow ID', 'format' => 'int64', 'title' => '流程ID', 'type' => 'integer', 'example' => '1'],
+ 'TaskFlowName' => ['description' => 'flow name', 'title' => '流程名称', 'type' => 'string', 'example' => 'xx'],
+ 'ScoreType' => ['description' => '1 for adding points, 3 for deducting points; default is 1', 'format' => 'int32', 'title' => '1加分 3减分 默认1', 'type' => 'integer', 'example' => '1'],
+ 'ScoreNumType' => ['description' => '0 – Points added or deducted after a rule is triggered', 'format' => 'int32', 'title' => '0-触发规则后加减分', 'type' => 'integer', 'example' => '0'],
+ 'ScoreNum' => ['description' => 'Agent score: default is 0, range [0, 100]', 'format' => 'int32', 'title' => '客服评分:默认0,[0, 100]', 'type' => 'integer', 'example' => '11'],
+ 'ScoreRuleHitType' => ['description' => '0—score when a hit occurs at an edge zone', 'format' => 'int32', 'title' => '0-命中节点时计分', 'type' => 'integer', 'example' => '0'],
],
'type' => 'object',
- 'visibility' => 'public',
+ 'description' => 'scheme score',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => '',
+ 'title' => '评分项列表',
'type' => 'array',
- 'visibility' => 'public',
+ 'example' => '',
],
],
'type' => 'object',
- 'visibility' => 'public',
+ 'description' => 'flow score',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => '',
+ 'title' => '检测项下评分项列表,见TaskFlowScoreInfo',
'type' => 'array',
- 'visibility' => 'public',
+ 'example' => '',
],
],
'type' => 'object',
- 'visibility' => 'public',
+ 'description' => 'dimension',
+ 'title' => '',
+ 'example' => '',
],
'TaskGraphFlow' => [
'properties' => [
- 'Id' => [
- 'backendName' => 'id',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'Rid' => [
- 'backendName' => 'rid',
- 'description' => '',
- 'format' => 'int64',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'RuleName' => [
- 'backendName' => 'ruleName',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
- 'SkipWhenFirstSessionNodeMiss' => [
- 'backendName' => 'skipWhenFirstSessionNodeMiss',
- 'description' => '',
- 'title' => '',
- 'type' => 'boolean',
- 'visibility' => 'public',
- ],
- 'FlowRuleScoreType' => [
- 'backendName' => 'flowRuleScoreType',
- 'description' => '',
- 'format' => 'int32',
- 'title' => '',
- 'type' => 'integer',
- 'visibility' => 'public',
- ],
- 'ShowProperties' => [
- 'backendName' => 'showProperties',
- 'description' => '',
- 'title' => '',
- 'type' => 'string',
- 'visibility' => 'public',
- ],
+ 'Id' => ['description' => 'Canvas ID of the flow', 'format' => 'int64', 'title' => '流程画布id', 'type' => 'integer', 'example' => '1'],
+ 'Rid' => ['description' => 'Rule ID', 'format' => 'int64', 'title' => '规则ID', 'type' => 'integer', 'example' => '1'],
+ 'RuleName' => ['description' => 'Rule Name', 'title' => '规则名称', 'type' => 'string', 'example' => '违规'],
+ 'SkipWhenFirstSessionNodeMiss' => ['description' => 'Skip if the first session node is not hit', 'title' => '首个对话节点未命中则跳过', 'type' => 'boolean', 'example' => 'true'],
+ 'FlowRuleScoreType' => ['description' => 'Flow scoring logic settings', 'format' => 'int32', 'title' => '流程计分逻辑设置', 'type' => 'integer', 'example' => '1'],
+ 'ShowProperties' => ['description' => 'Used for frontend display', 'title' => '前端展示使用', 'type' => 'string', 'example' => '{}'],
'Nodes' => [
- 'backendName' => 'nodes',
- 'description' => '',
- 'itemName' => 'Node',
- 'items' => [
- 'extendType' => 'true',
- 'ref' => '#/components/schemas/GraphFlowNode',
- 'visibility' => 'public',
- ],
- 'title' => '',
+ 'description' => 'All nodes in the flow',
+ 'items' => ['ref' => '#/components/schemas/GraphFlowNode', 'description' => 'Node information.', '$ref' => '#/components/schemas/GraphFlowNode', 'title' => '', 'example' => ''],
+ 'title' => '流程所有节点',
'type' => 'array',
- 'visibility' => 'public',
+ 'example' => '',
],
],
'type' => 'object',
- 'visibility' => 'public',
+ 'description' => 'flow',
+ 'title' => '',
+ 'example' => '',
],
],
],
'apis' => [
- 'UploadAudioData' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AddBusinessCategory' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{“callList”:“xxxxx”}',
- ],
+ 'schema' => ['description' => 'A complete JSON string. For details, see the table below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"name":"适用业务名称"}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '业务空间Id',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'Response code', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Response message', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'Business category ID', 'type' => 'string', 'example' => '348193421', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '76DB5D8C-5BD9-42A7-B527-5AF3A5F83F12', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123456',
+ 'title' => '',
+ 'example' => '',
],
],
],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"348193421\\",\\n \\"RequestId\\": \\"76DB5D8C-5BD9-42A7-B527-5AF3A5F83F12\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Add a business category ',
+ 'summary' => 'Adds a business category.',
+ 'requestParamsDescription' => '**JSON request parameter details**'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :---------- | :----- | :------- | :-------------------------- |'."\n"
+ .'| name | String | Yes | Business name |'."\n"
+ .'| serviceType | int | No | Top-level business category |'."\n"
+ .'| originalId | int | No | Source business category ID |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '### Invocation Sample '."\n"
+ ."\n"
+ .'```'."\n"
+ .'AddBusinessCategoryRequest addBusinessCategoryRequest = new AddBusinessCategoryRequest();'."\n"
+ .'addBusinessCategoryRequest.setAcceptFormat(FormatType.JSON);'."\n"
+ .'Map<String, Object> callMap = Maps.newHashMap();'."\n"
+ .'callMap.put("name","Testing123");'."\n"
+ .'addBusinessCategoryRequest.setJsonStr(JSON.toJSONString(callMap));'."\n"
+ .'AddBusinessCategoryResponse response = client.getAcsResponse(addBusinessCategoryRequest);'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddBusinessCategory'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'AddRuleCategory' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => ['operationType' => 'create'],
+ 'parameters' => [
+ [
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A JSON-formatted string. For details, see the following information.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"typeName":"规则类型A"}', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'baseMeAgentId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232927'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Code' => ['description' => 'Response code', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Response message', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'D10B9203-1A6A-49DA-AE56-4D160DD37DBC', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '76DB5D8C-5BD9-42A7-B527-5AF3A5***',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '76DB5D8C-5BD9-42A7-B527-5AF3A5F8***',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => 'Return Result',
+ 'type' => 'object',
+ 'properties' => [
+ 'Select' => ['description' => 'Indicates whether the newly added rule category is selected.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'Type' => ['description' => 'Rule category ID', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"76DB5D8C-5BD9-42A7-B527-5AF3A5***\\",\\n \\"RequestId\\": \\"76DB5D8C-5BD9-42A7-B527-5AF3A5F8***\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"D10B9203-1A6A-49DA-AE56-4D160DD37DBC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Select\\": false,\\n \\"Type\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'Add a rule category',
+ 'summary' => 'Add a rule category.',
+ 'requestParamsDescription' => '**Request Parameters in JSON string format**'."\n"
+ .'| Property | Value Type | Required | Description |'."\n"
+ .'|:---------|:-----------|:---------|:------------|'."\n"
+ .'| typeName | String | Yes | Rule category name |',
'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'UploadDataV4' => [
- 'summary' => 'UploadDataV4',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => '### Sample invocation'."\n"
+ .'```'."\n"
+ .' AddRuleCategoryRequest addRuleCategoryRequest = new AddRuleCategoryRequest();'."\n"
+ .' addRuleCategoryRequest.setAcceptFormat(FormatType.JSON);'."\n"
+ .' Map<String, Object> map = Maps.newHashMap();'."\n"
+ .' map.put("typeName", "***");'."\n"
+ .' addRuleCategoryRequest.setJsonStr(JSON.toJSONString(map));'."\n"
+ .' AddRuleCategoryResponse response = client.getAcsResponse(addRuleCategoryRequest);'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2024-06-21T03:06:47.000Z', 'description' => 'Response parameters changed, Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddRuleCategory'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sca:AddRuleCategory',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'AddRuleV4' => [
+ 'summary' => 'This operation creates a rule on the Quality Inspection Rule Configuration page. For Apsara Stack, the URL is ip:port/api/client/UpdateRuleById.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'JsonStr',
+ 'name' => 'JsonStrForRule',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => 'For more information about JsonStrForRule, see [`Rule object description`](~~453053~~).', 'type' => 'string', 'required' => true, 'example' => '无', 'title' => ''],
],
[
- 'name' => 'BaseMeAgentId',
+ 'name' => 'IsCopy',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123456',
- ],
+ 'schema' => ['description' => 'Specifies whether to copy the rule. Set this to \\`true\\` to copy the rule.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'title' => 'BaseResult',
+ 'description' => 'BaseResult',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6F5934C7-C223-4F0F-BBF3-5B3594***',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6F5934C7-C223-4F0F-BBF3-5B3594***',
- ],
- 'Success' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. \\`true\\`: The request was successful. \\`false\\` or \\`null\\`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The result code. \\`**200**\\` indicates that the request was successful. Other values indicate that the request failed. You can use this parameter to identify the cause of a failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Messages' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Message' => [
+ 'description' => 'Displays error details when an error occurs. Use this field if multiple messages are returned.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Displays error details when an error occurs. Use this field if the (Outputs) contain multiple messages.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code. A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Data' => ['description' => 'The ID of the new rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '无', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"6F5934C7-C223-4F0F-BBF3-5B3594***\\",\\n \\"RequestId\\": \\"6F5934C7-C223-4F0F-BBF3-5B3594***\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 0\\n}","type":"json"}]',
+ 'title' => 'Create Rule (New Quality Inspection) ',
+ 'requestParamsDescription' => '## Sample request parameters'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "rules": ['."\n"
+ .' {'."\n"
+ .' "name": "siqi-test",'."\n"
+ .' "comments": "Create a test rule",'."\n"
+ .' "autoReview": 1,'."\n"
+ .' "level": 2,'."\n"
+ .' "type": 1,'."\n"
+ .' "business": ['."\n"
+ .' {'."\n"
+ .' "bid": 0,'."\n"
+ .' "name": "All businesses"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "fullCycle": 1,'."\n"
+ .' "targetType": 10,'."\n"
+ .' "scoreNumType": 0,'."\n"
+ .' "scoreType": 1,'."\n"
+ .' "scoreNum": "1",'."\n"
+ .' "lambda": "a",'."\n"
+ .' "triggers": ['."\n"
+ .' "a"'."\n"
+ .' ],'."\n"
+ .' "ruleScoreType": 3,'."\n"
+ .' "isHitNumScore": 0'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "conditions": ['."\n"
+ .' {'."\n"
+ .' "cid": "a",'."\n"
+ .' "lambda": "1",'."\n"
+ .' "check_range": {},'."\n"
+ .' "operators": ['."\n"
+ .' {'."\n"
+ .' "oid": "1",'."\n"
+ .' "type": "HIT_ANY_KEYWORDS",'."\n"
+ .' "param": {'."\n"
+ .' "contextChatMatch": false,'."\n"
+ .' "in_sentence": false,'."\n"
+ .' "keywordMatchSize": 1,'."\n"
+ .' "keywords": ['."\n"
+ .' "Hello",'."\n"
+ .' "Welcome"'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Sample request code'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'public class sca {'."\n"
+ ."\n"
+ .' private static String ak = "YOUR_ACCESS_KEY_ID";'."\n"
+ .' private static String sk = "YOUR_ACCESS_KEY_SECRET";'."\n"
+ ."\n"
+ .' private static void addRule() throws Exception {'."\n"
+ .' String json="{\\n" +'."\n"
+ .' " \\"rules\\": [\\n" +'."\n"
+ .' " {\\n" +'."\n"
+ .' " \\"name\\": \\"siqi-test\\",\\n" +'."\n"
+ .' " \\"comments\\": \\"Create a test rule\\",\\n" +'."\n"
+ .' " \\"autoReview\\": 1,\\n" +'."\n"
+ .' " \\"level\\": 2,\\n" +'."\n"
+ .' " \\"type\\": 1,\\n" +'."\n"
+ .' " \\"business\\": [\\n" +'."\n"
+ .' " {\\n" +'."\n"
+ .' " \\"bid\\": 0,\\n" +'."\n"
+ .' " \\"name\\": \\"All businesses\\"\\n" +'."\n"
+ .' " }\\n" +'."\n"
+ .' " ],\\n" +'."\n"
+ .' " \\"fullCycle\\": 1,\\n" +'."\n"
+ .' " \\"targetType\\": 10,\\n" +'."\n"
+ .' " \\"scoreNumType\\": 0,\\n" +'."\n"
+ .' " \\"scoreType\\": 1,\\n" +'."\n"
+ .' " \\"scoreNum\\": \\"1\\",\\n" +'."\n"
+ .' " \\"lambda\\": \\"a\\",\\n" +'."\n"
+ .' " \\"triggers\\": [\\n" +'."\n"
+ .' " \\"a\\"\\n" +'."\n"
+ .' " ],\\n" +'."\n"
+ .' " \\"ruleScoreType\\": 3,\\n" +'."\n"
+ .' " \\"isHitNumScore\\": 0\\n" +'."\n"
+ .' " }\\n" +'."\n"
+ .' " ],\\n" +'."\n"
+ .' " \\"conditions\\": [\\n" +'."\n"
+ .' " {\\n" +'."\n"
+ .' " \\"cid\\": \\"a\\",\\n" +'."\n"
+ .' " \\"lambda\\": \\"1\\",\\n" +'."\n"
+ .' " \\"check_range\\": {},\\n" +'."\n"
+ .' " \\"operators\\": [\\n" +'."\n"
+ .' " {\\n" +'."\n"
+ .' " \\"oid\\": \\"1\\",\\n" +'."\n"
+ .' " \\"type\\": \\"HIT_ANY_KEYWORDS\\",\\n" +'."\n"
+ .' " \\"param\\": {\\n" +'."\n"
+ .' " \\"contextChatMatch\\": false,\\n" +'."\n"
+ .' " \\"in_sentence\\": false,\\n" +'."\n"
+ .' " \\"keywordMatchSize\\": 1,\\n" +'."\n"
+ .' " \\"keywords\\": [\\n" +'."\n"
+ .' " \\"Hello\\",\\n" +'."\n"
+ .' " \\"Welcome\\"\\n" +'."\n"
+ .' " ]\\n" +'."\n"
+ .' " }\\n" +'."\n"
+ .' " }\\n" +'."\n"
+ .' " ]\\n" +'."\n"
+ .' " }\\n" +'."\n"
+ .' " ]\\n" +'."\n"
+ .' "}";'."\n"
+ ."\n\n"
+ .' Config config = new Config();'."\n"
+ .' config.setAccessKeyId(ak).setAccessKeySecret(sk)'."\n"
+ .' .setEndpoint("qualitycheck.cn-hangzhou.aliyuncs.com")'."\n"
+ .' .setRegionId("cn-hangzhou").setProtocol("HTTPS");'."\n"
+ ."\n"
+ .' Client client = new Client(config);'."\n"
+ .' AddRuleV4Request result = new AddRuleV4Request();'."\n"
+ ."\n"
+ .' result.setJsonStrForRule(json);'."\n"
+ ."\n"
+ .' AddRuleV4Response response = client.addRuleV4(result);'."\n"
+ .' System.out.println(JSONObject.toJSONString(response));'."\n"
+ .' }'."\n"
+ ."\n"
+ .' public static void main(String[] args) throws Exception {'."\n"
+ .' addRule();'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddRuleV4'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'UploadData' => [
- 'summary' => '推荐使用UploadDataV4接口,支持更长的JsonStr,但仅支持POST方法.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AnalyzeLabel' => [
+ 'summary' => 'Performs tag categorization.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'deprecated' => true,
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREsca27EUYZ'],
],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the following details.', 'type' => 'string', 'required' => false, 'example' => '“”', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The business workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6F5934C7-C223-4F0F-BBF3-5B3594***',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6F5934C7-C223-4F0F-BBF3-5B3594****',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***'],
+ 'Data' => ['description' => 'The analysis task ID.', 'type' => 'string', 'example' => '20260629-DCC646E7-BE7F-114E-9F32-0C928292FC7F', 'title' => ''],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Other values indicate failure. You can use this field to determine the cause of the failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. true: The call was successful. false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Message' => ['description' => 'The error message, if any.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'substitutions' => [
- 'Qualitycheck::2019-01-15::UploadDataV4',
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"6F5934C7-C223-4F0F-BBF3-5B3594***\\",\\n \\"RequestId\\": \\"6F5934C7-C223-4F0F-BBF3-5B3594****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Tag categorization',
+ 'requestParamsDescription' => '# 1. Top-level fields'."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|------|------|------|------|'."\n"
+ .'| agentId | Long | Yes | Agent ID |'."\n"
+ .'| ticketsList | Array | Yes | The list of conversations to analyze. Currently only 1 conversation is supported. |'."\n"
+ .'| tagIds | Array<Long> | No | The list of parent tag IDs that have been matched at runtime. A maximum of 50 IDs are supported. Currently only the first ID takes effect. |'."\n"
+ .'| callbackUrl | String | No | The callback URL after the task is completed. |'."\n"
+ .'| modelType | String | No | The model type. Default value: TYXM_TURBO. |'."\n"
+ .'# 2. ticketsList[0] fields'."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|------|------|------|------|'."\n"
+ .'| tid | String | No | The unique identifier of the conversation. |'."\n"
+ .'| dialogueList | Array | Yes | The conversation content. |'."\n"
+ .'# 3. dialogueList fields'."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|------|------|------|------|'."\n"
+ .'| role | String | Yes | The role name, such as "customer" or "agent". |'."\n"
+ .'| words | String | Yes | The utterance content. |'."\n"
+ .'| identity | String | No | The supplementary identity information. |'."\n"
+ .'| type | String | No | The sentence type, such as TEXT. |'."\n"
+ .'| begin | Integer | No | The start offset, in milliseconds. |'."\n"
+ .'| end | Integer | No | The end offset, in milliseconds. |'."\n"
+ .'| beginTime | String | No | The start time. |',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Data\\": \\"20260629-DCC646E7-BE7F-114E-9F32-0C928292FC7F\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]',
],
- 'UpdateQualityCheckData' => [
- 'summary' => '更新会话随录数据',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- 'http',
- ],
+ 'ApplyWsToken' => [
+ 'summary' => 'Apply for the token required for real-time speech processing.'."\n",
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '257754',
+ 'abilityTreeNodes' => ['FEATUREscaKR8LQC'],
],
'parameters' => [
[
- 'name' => 'JsonStr',
+ 'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"taskId":"xxx"}',
- ],
+ 'schema' => ['description' => 'Workspace ID', 'type' => 'integer', 'required' => false, 'example' => '123456', 'format' => 'int64', 'title' => ''],
],
[
- 'name' => 'BaseMeAgentId',
+ 'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'Complete JSON string information. For details, see the following specifications. ', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .' "business": "test",'."\n"
+ .' "callType": 1,'."\n"
+ .' "callee": "13111111111",'."\n"
+ .' "caller": "13800000000",'."\n"
+ .' "skillGroupId": 1,'."\n"
+ .' "skillGroupName": "test",'."\n"
+ .' "taskConfigId": 399,'."\n"
+ .' "tid": "2025012412cb129e-1579-46b5-9326-1b2ececf8f30"'."\n"
+ .'}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6987D326-83D9-4A42-B9A5-0B27F9B40539'],
+ 'Code' => ['description' => 'Response code ', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'HTTP status code. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Data' => [
+ 'description' => 'Return Result ',
+ 'type' => 'object',
+ 'properties' => [
+ 'SessionId' => ['description' => 'Session ID. ', 'type' => 'string', 'example' => '42e59bcd-7206-44c5-ad34-525d364687c4', 'title' => ''],
+ 'Token' => ['description' => 'User access token ', 'type' => 'string', 'example' => '5607b21d1728700640', 'title' => ''],
+ 'WsEndpoint' => ['description' => 'WebSocket connection domain name ', 'type' => 'string', 'example' => 'wss://ws-gateway-real-voice.aliyuncs.com', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"xxx\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- ],
- 'AddRuleV4' => [
- 'summary' => 'V4创建规则',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Code\\": \\"200\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"SessionId\\": \\"42e59bcd-7206-44c5-ad34-525d364687c4\\",\\n \\"Token\\": \\"5607b21d1728700640\\",\\n \\"WsEndpoint\\": \\"wss://ws-gateway-real-voice.aliyuncs.com\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Apply for a Token for Real-Time Speech Quality Inspection '."\n",
+ 'requestParamsDescription' => '**Description of jsonStr properties:**'."\n"
+ ."\n"
+ .'| Property | Value Type | Required | Description |'."\n"
+ .'| :--- | :--- | :--- | :--- |'."\n"
+ .'| tid | string | Yes | The unique identifier (UUID) of the current conversation. Ensure its uniqueness. It can be understood as the call ID in your own operational system. The backend uses this identifier to merge segments into a complete conversation. The length must be at least 8 characters, and the first 8 characters must represent the date (YYYYMMDD) when the call occurred. For example, if the recording was made on July 5, 2020, the prefix should be 20200705. We recommend appending your own operational system’s call ID after this prefix, such as 20200705-234890134. The timestamp in the prefix must fall within one month before to one hour after the API call time. |'."\n"
+ .'| business | string | No | Line-of-business name. This is custom data used for categorization and statistics. |'."\n"
+ .'| callType | integer | No | Call type. Valid values: 1 (outbound, default); 3 (inbound); 4 (other). |'."\n"
+ .'| callee | string | No | Called number. For outbound calls, this refers to the customer\'s number; for inbound calls, it refers to the agent\'s number. |'."\n"
+ .'| caller | string | No | Calling number. For outbound calls, this refers to the agent\'s number; for inbound calls, it refers to the customer\'s number. |'."\n"
+ .'| skillGroupId | long | No | Skill group ID. |'."\n"
+ .'| skillGroupName | string | No | Skill group name. |'."\n"
+ .'| schemeTaskConfigId | integer | No | Job ID. |'."\n",
+ 'changeSet' => [
+ ['createdAt' => '2025-02-06T02:59:49.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApplyWsToken'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sca:ApplyWsToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'AssignReviewer' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'deprecated' => false,
+ 'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
- 'name' => 'JsonStrForRule',
- 'in' => 'formData',
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A complete JSON string. For details, see the following sections.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"assignmentList":[{"taskId":"1C21CF1E-2917-4236-A046-20E37B293B69","fileId":"7981b466fd6a4c70a7065da159739a5b"},{"taskId":"0111DDBC-5F10-47E0-B7D4-7175F47D626F","fileId":"1814eeae3cff41e989e31ab547f07561"}],"assignments":[{"reviewer":"255746168704895558"},{"reviewer":"268370362815185444"}]}', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'Result code. **200** means success. Any other value means failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the call fails. Returns successful if the call succeeds.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4D55C6', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. true means success. false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
+ 'title' => '',
'example' => '',
],
],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Assign Quality Inspector',
+ 'summary' => 'Manually assign quality reviewers.',
+ 'description' => 'You can manually assign files that have completed quality inspection to reviewers. Assignments can be made one file at a time or in batches:'."\n"
+ ."\n"
+ .'Single-file assignment: Assign a specific file to a specified reviewer.'."\n"
+ ."\n"
+ .'Batch assignment: Assign multiple filtered files to one or more reviewers. You can specify how many files each reviewer receives, or let the system distribute the files evenly among reviewers.',
+ 'requestParamsDescription' => '### JsonStr parameter details'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |'."\n"
+ .'| assignmentList | List | No | List of files to assign. Files are assigned one by one. This field and searchParam cannot both be empty. If both are provided, assignmentList takes precedence. For details, see **assignmentList structure** |'."\n"
+ .'| searchParam | Object | No | Filter conditions. These match the request parameters of [GetResult](https://help.aliyun.com/document_detail/142334.html). Use them to select files for batch assignment. |'."\n"
+ .'| assignments | List | No | Reviewer information. Used during batch assignment to specify reviewers. For details, see **Assignments structure** |'."\n"
+ ."\n"
+ .'#### assignmentList structure'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------- | :----- | :------- | :------------------------------------------------- |'."\n"
+ .'| taskId | String | Yes | Task ID of the file |'."\n"
+ .'| fileId | String | Yes | File ID |'."\n"
+ .'| reviewer | String | No | Reviewer ID. Used only for single-file assignment. |'."\n"
+ ."\n"
+ .'#### Assignments structure'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------- | :----- | :------- | :----------------------------------------------------------------- |'."\n"
+ .'| reviewer | String | Yes | Reviewer ID |'."\n"
+ .'| count | String | No | Number of files to assign. If empty, files are distributed evenly. |'."\n"
+ ."\n"
+ .'### Request examples'."\n"
+ ."\n"
+ .'#### 1. Distribute multiple files evenly among multiple reviewers'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "assignmentList":['."\n"
+ .' {'."\n"
+ .' "taskId":"1C21CF1E-2917-4236-A046-20E37B293B69",'."\n"
+ .' "fileId":"7981b466fd6a4c70a7065da159739a5b"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "taskId":"0111DDBC-5F10-47E0-B7D4-7175F47D626F",'."\n"
+ .' "fileId":"1814eeae3cff41e989e31ab547f07561"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "assignments":['."\n"
+ .' {'."\n"
+ .' "reviewer":"255746168704895558"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "reviewer":"268370362815185444"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'#### 2. Assign a specific number of files to each reviewer'."\n"
+ ."\n"
+ .'Assign multiple files to multiple reviewers, specifying how many files each reviewer receives.'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "assignmentList":['."\n"
+ .' {'."\n"
+ .' "taskId":"C97132A8-F0C5-4FA3-83C3-8C145CECB8C1",'."\n"
+ .' "fileId":"fae2f045162d459daa35f8ec5570c68e"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "taskId":"1C21CF1E-2917-4236-A046-20E37B293B69",'."\n"
+ .' "fileId":"7981b466fd6a4c70a7065da159739a5b"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "taskId":"0111DDBC-5F10-47E0-B7D4-7175F47D626F",'."\n"
+ .' "fileId":"1814eeae3cff41e989e31ab547f07561"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "assignments":['."\n"
+ .' {'."\n"
+ .' "reviewer":"255746168704895558",'."\n"
+ .' "count":1'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "reviewer":"268370362815185444",'."\n"
+ .' "count":2'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'#### 3. Batch assign files using filter conditions'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "searchParam":{'."\n"
+ .' "dataType":1,'."\n"
+ .' "sourceType":0,'."\n"
+ .' "startTime":"2020-03-07 00:00:00",'."\n"
+ .' "endTime":"2020-03-13 23:59:59"'."\n"
+ .' },'."\n"
+ .' "assignments":['."\n"
+ .' {'."\n"
+ .' "reviewer":"255746168704895558"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "reviewer":"268370362815185444"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'#### 4. Assign a single file'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "assignmentList":['."\n"
+ .' {'."\n"
+ .' "taskId":"C97132A8-F0C5-4FA3-83C3-8C145CECB8C1",'."\n"
+ .' "fileId":"fae2f045162d459daa35f8ec5570c68e",'."\n"
+ .' "reviewer":"255746168704895558"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AssignReviewer'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'AssignReviewerBySessionGroup' => [
+ 'summary' => 'Frontend location: Quality Check Plan Management > Task Results > Session Groups > Batch Assign. Apsara Stack URL: ip:port/api/job/AssignReviewerBySessionGroup.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'IsCopy',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '153845',
+ 'abilityTreeNodes' => ['FEATUREscaAJDYMI'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'jsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'For details, see Additional Information for Request Parameters.', 'type' => 'string', 'required' => false, 'example' => '{"sessionGroupParam":{"isSchemeData":1,"callStartTime":"2022-09-17 00:00:00","callEndTime":"2022-09-23 23:59:59","schemeTaskConfigId":24},"assignments":[{"reviewer":63,"count":4}],"isSchemeData":1}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -3108,1520 +1879,2073 @@
'description' => 'BaseResult',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Set to true for success. Set to false or null for failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. A value of 200 indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request failed. Returns successful if the request succeeded.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'Messages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Message' => [
- 'description' => '',
+ 'description' => 'Error details if the request failed. Used when multiple messages are returned.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'items' => ['description' => 'Error details if the request failed. Used when multiple messages are returned.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Data' => [
'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '',
'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 0\\n}","type":"json"}]',
+ 'staticInfo' => ['noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Assign Session Group ',
+ 'requestParamsDescription' => '### About jsonStr'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| ------------------------- | ----------------- | -------- | ------------------------------------------------------------------------------- |'."\n"
+ .'| sessionGroupParam | SessionGroupParam | Yes | Session group retrieval parameters. For more information, see ListSessionGroup. |'."\n"
+ .'| assignments | List<assignment> | Yes | Assignment parameters |'."\n"
+ .'| \\- assignments.reviewer | Long | Yes | Quality checker ID |'."\n"
+ .'| \\- assignments.count | Integer | Yes | Number of sessions to assign |'."\n"
+ .'| \\- assignments.percentage | Integer | Yes | Percentage of sessions to assign |',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AssignReviewerBySessionGroup'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'UpdateRuleV4' => [
- 'summary' => 'V4更新规则',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'BatchSubmitReviewInfo' => [
+ 'summary' => 'This operation implements the Batch Review feature, which is available in the frontend under Task Management > Task Result.'."\n"
+ .'For private cloud deployments, use the URL: ip:port/api/qcsBatchSubmitReviewInfo.json.'."\n"
+ .'You can use this operation to perform a batch review on all filtered data.'."\n"
+ .'Note: This operation updates a large volume of data. The changes may take some time to appear.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'RuleId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'JsonStrForRule',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '',
- ],
+ 'name' => 'jsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The request parameters are provided in JSON format. For more information, see the supplementary description.', 'type' => 'string', 'required' => false, 'example' => '{"isSchemeData":1,"schemeTaskConfigId":334,"sourceDataType":2,"startTime":"2022-08-25 00:00:00","endTime":"2022-09-23 23:59:59","sessionList":[{"taskId":"20220831-F8D7F4DF-0A16-1A1C-BA63-28F203922692","fileId":"20220831-164343"},{"taskId":"20220831-F2A50A72-82C4-1E3F-A1FD-52A662283D25","fileId":"20220831-164343"}]}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResult',
- 'description' => 'BaseResult。',
+ 'description' => 'BaseResult',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success. A value of \\`false\\` or \\`null\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Other values indicate failure. You can use this code to identify the cause of a failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error details if the request fails. If the request is successful, the value is \\`successful\\`.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'Messages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Message' => [
- 'description' => '',
+ 'description' => 'The error details if the request fails. This is used when multiple messages are returned.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'items' => ['description' => 'The error details if the request fails. This is used when multiple messages are returned.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'HttpStatusCode' => [
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 1\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Batch Review ',
+ 'requestParamsDescription' => '### JsonStr description'."\n"
+ ."\n"
+ .'To export all data, use the same parameters as the GetResult operation.'."\n"
+ .'<br>To export only selected data, see the following table.<br>'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| ----------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ |'."\n"
+ .'| sessionList | List | Yes | A list of selected quality check tasks for sessions. |'."\n"
+ .'| \\-- taskId | String | Yes | The ID of the quality check task for the selected session. |'."\n"
+ .'| \\-- fileId | String | Yes | The `tid`, `vic`, or `fileId` of the quality check task for the selected session. These parameters are equivalent. |',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:55.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'BatchSubmitReviewInfo'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'ListRulesV4' => [
- 'summary' => 'V4获得规则列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateAgent' => [
+ 'summary' => 'Creates an agent.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREscaFRLL5D'],
+ ],
'parameters' => [
[
- 'name' => 'Rid',
+ 'name' => 'BaseMeAgentId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '895EAD5312634F5AA708E3B3FA79662E',
- ],
+ 'schema' => ['description' => 'The business workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''],
],
[
- 'name' => 'RuleIdOrRuleName',
+ 'name' => 'JsonStr',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
+ 'schema' => ['description' => 'The complete **JSON string** information. For more information, see the following details.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''],
],
- [
- 'name' => 'BusinessName',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***'],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Any other value indicates failure. You can use this field to determine the cause of the failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message, if any.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => ['description' => 'The AgentId of the task.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
+ ],
'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Create an agent',
+ 'requestParamsDescription' => '---'."\n"
+ ."\n"
+ .'# Request parameter description.'."\n"
+ ."\n"
+ .'## 1. Overview'."\n"
+ ."\n"
+ .' The input parameter object for agent management requests, which consists of two parts: basic agent attribute configuration and instruction type parameters.'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'## 2. Top-level fields'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `agentName` | `String` | Yes | The agent name. |'."\n"
+ .'| `agentDescription` | `String` | No | The agent description. |'."\n"
+ .'| `modelType` | `String` | Yes | The large language model type. For valid values, see the `LLMCodeEnum` enumeration. |'."\n"
+ .'| `inputType` | `String` | Yes | The analysis object type. Valid values: `text`, `voice`, and `image`. |'."\n"
+ .'| `instructionType` | `String` | Yes | The instruction type code. For valid values, see the `AgentInstructionTypeEnum` enumeration (see the following table). |'."\n"
+ .'| `instructionTypeParam` | `InstructionTypeParam` | Yes | The detailed configuration parameters for the instruction type. Pass the corresponding sub-object based on the value of `instructionType`. |'."\n"
+ ."\n"
+ .'### instructionType enumeration values'."\n"
+ ."\n"
+ .'| code | Description | Corresponding Param |'."\n"
+ .'|------|------|-----------|'."\n"
+ .'| `serviceInspection` | Service quality inspection | `serviceInspectionParam` |'."\n"
+ .'| `field` | Key attribute extraction | `fieldsParam` |'."\n"
+ .'| `tagCategory` | Tag classification | `tagCategoryParam` |'."\n"
+ .'| `multiLevelTag` | Multi-level tag recognition | `tagTreeLevelParam` |'."\n"
+ .'| `customPrompt` | Custom instruction | `customPromptParam` |'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'## 3. InstructionTypeParam (instruction type parameters)'."\n"
+ ."\n"
+ .'`instructionTypeParam` is the configuration container for various instruction types. Based on the value of `instructionType`, **only pass the corresponding sub-object**. Other sub-objects can be null.'."\n"
+ ."\n"
+ .'| Field | Type | Description |'."\n"
+ .'|--------|------|------|'."\n"
+ .'| `fieldsParam` | `FieldsParam` | The key attribute extraction configuration. Pass this when `instructionType=field`. |'."\n"
+ .'| `serviceInspectionParam` | `ServiceInspectionParam` | The service quality inspection configuration. Pass this when `instructionType=serviceInspection`. |'."\n"
+ .'| `tagCategoryParam` | `TagCategoryParam` | The tag classification configuration. Pass this when `instructionType=tagCategory`. |'."\n"
+ .'| `tagTreeLevelParam` | `TagTreeLevelParam` | The multi-level tag analysis configuration. Pass this when `instructionType=multiLevelTag`. |'."\n"
+ .'| `customPromptParam` | `CustomPromptParam` | The custom instruction configuration. Pass this when `instructionType=customPrompt`. |'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'### 3.1 FieldsParam (key attribute extraction)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `nameDescPairList` | `List<NameDescPair>` | Yes | The list of key attribute dimensions to extract. |'."\n"
+ ."\n"
+ .'**NameDescPair structure:**'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `name` | `String` | Yes | The attribute name. |'."\n"
+ .'| `desc` | `String` | Yes | The attribute description. |'."\n"
+ .'| `value` | `String` | Yes | The attribute value. |'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'### 3.2 ServiceInspectionParam (service quality inspection)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `sceneName` | `String` | Yes | The quality inspection scenario name. |'."\n"
+ .'| `sceneDescription` | `String` | Yes | The quality inspection scenario description. |'."\n"
+ .'| `dimensions` | `List<Dimension>` | Yes | The list of quality inspection dimensions that define the specific inspection dimensions and their conditions. |'."\n"
+ ."\n"
+ .'**Dimension structure:**'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `dimension` | `String` | Yes | The dimension name. (`title` is also accepted as an alias during JSON deserialization.) |'."\n"
+ .'| `desc` | `String` | Yes | The dimension description. (`content` is also accepted as an alias during JSON deserialization.) |'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'### 3.3 TagCategoryParam (tag classification)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `nameDescPairList` | `List<NameDescValueListPair>` | Yes | The list of tag classification dimensions. Each dimension can contain multiple candidate tag values. |'."\n"
+ ."\n"
+ .'**NameDescValueListPair structure:**'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `name` | `String` | Yes | The dimension or classification name. |'."\n"
+ .'| `desc` | `String` | Yes | The dimension description. |'."\n"
+ .'| `valueList` | `List<String>` | Yes | The list of candidate tag values under this dimension. |'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'### 3.4 TagTreeLevelParam (multi-level tag recognition)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `tagIds` | `List<Long>` | Yes | The list of tag IDs passed at runtime. The first ID is used as the matched starting parent tag, and matching continues from its child nodes. |'."\n"
+ .'| `tagTreeLevels` | `List<TagTreeLevelInfoParam>` | Yes | The list of prompt configurations for each level, arranged in hierarchical order. |'."\n"
+ ."\n"
+ .'**TagTreeLevelInfoParam structure:**'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `tagTreeIds` | `List<Long>` | Yes | The list of candidate tag IDs for the current level. A value of `-1` indicates all tags at this level are selected. |'."\n"
+ .'| `prompt` | `String` | Yes | The analysis prompt for this level. This prompt is concatenated with tag data and sent to the large language model for analysis. |'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'### 3.5 CustomPromptParam (custom instruction)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `customPrompt` | `String` | Yes | The user-defined prompt instruction content. |'."\n"
+ .'| `nameDescPairList` | `List<NameDescPair>` | No | The list of custom fields used as additional variables referenced in the prompt. |'."\n"
+ ."\n"
+ .'**The NameDescPair structure is the same as in Section 3.1.**'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'## 4. Request example'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "id": 123,'."\n"
+ .' "userGroup": "default",'."\n"
+ .' "aliUid": 1000000001,'."\n"
+ .' "agentName": "客服质检Agent",'."\n"
+ .' "agentDescription": "用于客服对话质量的自动检测",'."\n"
+ .' "modelType": "qwen-max",'."\n"
+ .' "inputType": "text",'."\n"
+ .' "instructionType": "serviceInspection",'."\n"
+ .' "instructionTypeParam": {'."\n"
+ .' "serviceInspectionParam": {'."\n"
+ .' "sceneName": "售后客服场景",'."\n"
+ .' "sceneDescription": "检查售后客服对话的服务质量",'."\n"
+ .' "dimensions": ['."\n"
+ .' {'."\n"
+ .' "dimension": "服务态度",'."\n"
+ .' "desc": "检查客服是否使用礼貌用语",'."\n"
+ .' "includeCondition": "包含问候语和感谢语",'."\n"
+ .' "excludeCondition": "无明显不当用语则不排除"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"Data\\": 12\\n}","type":"json"}]',
+ ],
+ 'CreateAgentTask' => [
+ 'summary' => 'Creates an Agent batch task for conversation analysis. The application call supports HTTP calls to complete the customer response.',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Type',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'TypeName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREscaFRLL5D'],
+ ],
+ 'parameters' => [
[
- 'name' => 'BusinessRange',
+ 'name' => 'BaseMeAgentId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The ID of the business space.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''],
],
[
- 'name' => 'CreateEmpid',
+ 'name' => 'JsonStr',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The complete **JSON string** information. For details, see the following sections.', 'type' => 'string', 'required' => false, 'example' => '{\\"\\":\\"\\"}', 'title' => ''],
],
- [
- 'name' => 'CreateUserId',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647'],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Any other value indicates failure. You can use this field to determine the cause of the failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error details when the request fails. The value is **successful** when the request succeeds.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. You can use this field to determine whether the request succeeded: true indicates success. false/null indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '7C1DEF5F-2C18-4D36-99C6-8***', 'title' => ''],
+ 'Vid' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '6fa76916-3ce6-45d8-ac64-01b7f31***', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Create an agent task',
+ 'requestParamsDescription' => '## 1. Overview'."\n"
+ ."\n"
+ .'**Use case:** When calling the `createAgentTask` operation, serialize the fields of this class into JSON and pass them in. The server routes to different processing pipelines (text/audio) based on `inputType`, and routes to different instruction processors (key attribute extraction/service inspection/tag classification, etc.) based on `instructionType`.'."\n"
+ .'---'."\n"
+ ."\n"
+ .'## 2. Top-level field description'."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `vid` | `String` | No | The session ID. If not specified, a value is automatically generated using the current timestamp. |'."\n"
+ .'| `modelType` | `String` | Yes | The large model type. |'."\n"
+ .'| `agentId` | `Long` | Yes | The Agent configuration ID. |'."\n"
+ .'| `inputType` | `String` | Yes | The analysis object type. Valid values: audio (speech) and text. |'."\n"
+ .'| `instructionType` | `String` | Yes | The instruction type. Valid values: serviceInspection (service inspection), field (key attribute extraction), tagCategory (tag classification), and customPrompt (custom instruction). |'."\n"
+ .'| `instructionTypeParam` | `InstructionTypeParam` | Yes | The parameters corresponding to the instruction type. Different `instructionType` values require different sub-parameters (see §4.1). |'."\n"
+ .'| `taskParam` | `TaskParam` | Yes | The task data parameters, which contain text conversation or audio file information (see §3.1). |'."\n"
+ .'## 3. Nested class details.'."\n"
+ ."\n"
+ .'### 3.1 TaskParam — Task data parameters'."\n"
+ ."\n"
+ .'`AgentTaskParam.TaskParam` carries the input data for the task. Different sub-parameters are used depending on the value of `inputType`.'."\n"
+ ."\n"
+ .'| Field | Type | Description |'."\n"
+ .'|--------|------|------|'."\n"
+ .'| `textParam` | `TextParam` | The text parameters. Used when `inputType = "text"`. |'."\n"
+ .'| `audioParam` | `AudioParam` | The audio parameters. Used when `inputType = "audio"`. |'."\n"
+ .'| `callbackUrl` | `String` | The callback notification URL after the task is completed (optional). |'."\n"
+ ."\n"
+ .'**Usage rules:**'."\n"
+ .'- When `inputType = "text"`, you must provide `textParam`.'."\n"
+ .'- When `inputType = "audio"`, you must provide `audioParam`.'."\n"
+ .'- `textParam` and `audioParam` are mutually exclusive. Provide only one of them for a single task.'."\n"
+ ."\n"
+ .'### 3.2 TextParam — Text parameters'."\n"
+ ."\n"
+ .'`AgentTaskParam.TextParam` encapsulates text-type input data.'."\n"
+ ."\n"
+ .'| Field | Type | Description |'."\n"
+ .'|--------|------|------|'."\n"
+ .'| `dialogue` | `List<Dialogue>` | The dialogue list. Each entry is a `Dialogue` object. |'."\n"
+ ."\n"
+ .'**Dialogue object structure:**'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `role` | `String` | Yes | The speaker role, such as `"客户"` / `"客服"`. |'."\n"
+ .'| `words` | `String` | Yes | The dialogue text content. |'."\n"
+ .'| `identity` | `String` | No | The speaker identity identifier (such as the agent ID). |'."\n"
+ .'| `begin` | `Long` | No | The relative offset of the sentence start time (in milliseconds). |'."\n"
+ .'| `end` | `Long` | No | The relative offset of the sentence end time (in milliseconds). |'."\n"
+ .'| `beginTime` | `Date` | No | The absolute start time of the sentence (`yyyy-MM-dd HH:mm:ss`). |'."\n"
+ .'| `hourMinSec` | `String` | No | The time in hour:minute:second format (`HH:mm:ss`). Required for phone call scenarios. |'."\n"
+ .'| `emotionValue` | `Integer` | No | The emotion energy value (1-10). |'."\n"
+ .'| `speechRate` | `Integer` | No | The speech rate (words per minute). |'."\n"
+ .'| `silenceDuration` | `Integer` | No | The silence duration (in seconds). |'."\n"
+ ."\n"
+ .'### 3.3 AudioParam — Audio parameters'."\n"
+ ."\n"
+ .'`AgentTaskParam.AudioParam` encapsulates audio-type input data.'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `fileUrl` | `String` | Yes | The access URL of the audio file. |'."\n"
+ .'| `fileName` | `String` | No | The name of the audio file. |'."\n"
+ .'| `asrVersion` | `String` | No | The ASR (Automatic Speech Recognition) engine version. |'."\n"
+ ."\n"
+ .'---'."\n"
+ .'## 4. InstructionTypeParam — Instruction parameter details'."\n"
+ ."\n"
+ .'`AgentManageParam.InstructionTypeParam` carries different instruction configuration parameters based on the value of `instructionType`. **Only fill in the sub-parameters corresponding to the current `instructionType`. Leave the other fields empty.**'."\n"
+ ."\n"
+ .'### 4.1 FieldsParam — Key attribute extraction (`instructionType = "field"`)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `nameDescPairList` | `List<NameDescPair>` | Yes | The list of attribute dimensions to extract. |'."\n"
+ ."\n"
+ .'**NameDescPair structure:**'."\n"
+ ."\n"
+ .'| Field | Type | Description |'."\n"
+ .'|--------|------|------|'."\n"
+ .'| `name` | `String` | The attribute name (required). |'."\n"
+ .'| `desc` | `String` | The attribute description (optional). |'."\n"
+ ."\n"
+ .'### 4.2 ServiceInspectionParam — Service inspection (`instructionType = "serviceInspection"`)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `sceneName` | `String` | Yes | The inspection scenario name. |'."\n"
+ .'| `sceneDescription` | `String` | No | The inspection scenario description. |'."\n"
+ .'| `dimensions` | `List<Dimension>` | Yes | The list of inspection dimensions. |'."\n"
+ ."\n"
+ .'**Dimension structure:**'."\n"
+ ."\n"
+ .'| Field | Type | Description |'."\n"
+ .'|--------|------|------|'."\n"
+ .'| `dimension` | `String` | The dimension name (required). |'."\n"
+ .'| `desc` | `String` | The dimension description (optional). |'."\n"
+ ."\n"
+ .'### 4.3 TagCategoryParam — Tag classification (`instructionType = "tagCategory"`)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `nameDescPairList` | `List<NameDescValueListPair>` | Yes | The list of tag classification dimensions. |'."\n"
+ ."\n"
+ .'**NameDescValueListPair structure:**'."\n"
+ ."\n"
+ .'| Field | Type | Description |'."\n"
+ .'|--------|------|------|'."\n"
+ .'| `name` | `String` | The dimension name. |'."\n"
+ .'| `desc` | `String` | The dimension description. |'."\n"
+ .'| `valueList` | `List<String>` | The list of candidate tag values. |'."\n"
+ ."\n"
+ .'### 4.4 CustomPrompt — Custom instruction (`instructionType = "customPrompt"`)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `customPrompt` | `String` | Yes | The user-defined prompt template content. |'."\n"
+ ."\n"
+ .'---',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"7C1DEF5F-2C18-4D36-99C6-8***\\",\\n \\"Vid\\": \\"6fa76916-3ce6-45d8-ac64-01b7f31***\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'CreateAsrVocab' => [
+ 'summary' => 'Uploads a set of speech hotwords to the server and obtains the hotword ID in the response.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'UpdateUserId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '56145',
+ 'abilityTreeNodes' => ['FEATUREscaKR8LQC'],
+ ],
+ 'parameters' => [
[
- 'name' => 'LastUpdateEmpid',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Full JSON string. See the details below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"name":"热词名称"}', 'title' => ''],
],
[
- 'name' => 'Status',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
- [
- 'name' => 'CategoryName',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'Result code. **200** means success. Any other value means failure. Use this field to diagnose errors.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the call fails. Returns **successful** on success.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'Hotword ID', 'type' => 'string', 'example' => '71b1795ac8634bd8bdf4d3878480c7c2', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '96138D8D-8D26-4E41-BFF4-77AED1088BBD', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. true means success. **false** or **null** means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => false,
+ 'title' => '',
'example' => '',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"71b1795ac8634bd8bdf4d3878480c7c2\\",\\n \\"RequestId\\": \\"96138D8D-8D26-4E41-BFF4-77AED1088BBD\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Create Hotword Group ',
+ 'description' => '> Hotwords help improve recognition accuracy for specific terms, such as names, place names, or technical terms. [Learn more](https://help.aliyun.com/document_detail/213249.html).',
+ 'requestParamsDescription' => '**JSON request parameter details**'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------- | :----- | :------- | :----------- |'."\n"
+ .'| name | String | Yes | Hotword name |'."\n"
+ .'| words | List | Yes | Hotword list |'."\n"
+ ."\n"
+ .'**Details for words**'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| word | String | Yes | Hotword |'."\n"
+ .'| weight | Integer | No | Weight. Default: 2. Valid values are integers from -6 to 5. A positive weight increases the chance that the word is recognized. A negative weight decreases it. A weight of -6 means the word should rarely be recognized. A weight of 2 works well in most cases. If results are weak, increase the weight slightly. Very high weights may reduce accuracy for other words. |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '### Sample Invocation'."\n"
+ .'```'."\n"
+ .'public void testCreateAsrVocab() throws ClientException {'."\n"
+ .' CreateAsrVocabRequest request = new CreateAsrVocabRequest();'."\n"
+ .' Map<String, Object> param = new HashMap<>(2);'."\n"
+ .' List<Map<String, Object>> words = new ArrayList<>(2);'."\n"
+ .' Map<String, Object> w1 = new HashMap<>(2);'."\n"
+ .' w1.put("word", "萝卜");'."\n"
+ .' w1.put("weight", 2);'."\n"
+ .' words.add(w1);'."\n"
+ .' w1 = new HashMap<>(2);'."\n"
+ .' w1.put("word", "地瓜");'."\n"
+ .' w1.put("weight", 2);'."\n"
+ .' words.add(w1);'."\n"
+ .' param.put("words", words);'."\n"
+ .' param.put("name", "测试热词1");'."\n"
+ .' request.setJsonStr(JSON.toJSONString(param));'."\n"
+ .' CreateAsrVocabResponse response = client.getAcsResponse(request);'."\n"
+ .' Assert.assertEquals(true, response.getSuccess());'."\n"
+ .' vocabId = response.getData();'."\n"
+ .' }'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-21T12:56:34.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAsrVocab'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'CreateCheckTypeToScheme' => [
+ 'summary' => 'UI path: Quality Check Plan Management > Add or Edit Quality Check Dimension > Add Quality Check Dimension. Apsara Stack API endpoint: ip:port/api/qcs/CreateCheckTypeToScheme.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'SourceType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- [
- 'name' => 'RuleType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'UpdateStartTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2021-11-29 16:11:09',
- ],
+ 'AK' => [],
],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
[
- 'name' => 'UpdateEndTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2021-11-29 18:11:09',
- ],
+ 'name' => 'jsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Request parameter in JSON format. For details, see the additional information about request parameters.', 'type' => 'string', 'required' => false, 'example' => '{"schemeId":"187","checkName":"质检维度名","sourceScore":20}', 'title' => ''],
],
[
- 'name' => 'SchemeId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1000000090',
- ],
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
- [
- 'name' => 'RequireInfos',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
+ 'title' => 'PlainResult<Long>',
+ 'description' => 'PlainResult\\<long>',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => ['description' => 'Quality check dimension ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Callers can use this field to determine success: true means success. false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. **200** means success. Any other value means failure. Callers can use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details when the request fails. Returns **successful** on success.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Messages' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Message' => [
+ 'description' => 'Error details when the request fails. Use this field when multiple messages are returned.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Error details when the request fails. Use this field when multiple messages are returned.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
- 'required' => false,
- 'maxItems' => 10,
- ],
- ],
- [
- 'name' => 'RuleScoreSingleType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
+ 'example' => '',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 5,\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Add Quality Inspection Dimension ',
+ 'requestParamsDescription' => '### About jsonStr'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| ----------- | ------- | -------- | ---------------------------- |'."\n"
+ .'| schemeId | integer | Yes | Quality check plan ID |'."\n"
+ .'| checkName | string | Yes | Quality check dimension name |'."\n"
+ .'| sourceScore | integer | Yes | Quality check score |',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCheckTypeToScheme'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'CreateMiningTask' => [
+ 'summary' => 'Creates a label mining task.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'CurrentPage',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '272674',
+ 'abilityTreeNodes' => ['FEATUREscaLN3HHV'],
+ ],
+ 'parameters' => [
[
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''],
],
[
- 'name' => 'CountTotal',
+ 'name' => 'FilePath',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'File path', 'type' => 'string', 'required' => false, 'example' => '123.22.com/11.csv', 'title' => ''],
],
[
- 'name' => 'StartTime',
+ 'name' => 'TaskType',
'in' => 'formData',
'schema' => [
- 'description' => '',
+ 'description' => 'Task type',
'type' => 'string',
+ 'enum' => ['demandMining', 'sopMining', 'satisfactionAnalysisReport', 'dissatisfactionAnalysis', 'vocAnalysis'],
'required' => false,
- 'example' => '2021-11-29 18:11:09',
+ 'example' => 'demandMining',
+ 'title' => '',
],
],
[
- 'name' => 'EndTime',
+ 'name' => 'Param',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2021-11-29 19:11:09',
- ],
+ 'schema' => ['description' => 'Task parameters', 'type' => 'string', 'required' => false, 'example' => '{"startDate":"20250505"}', 'title' => ''],
],
[
- 'name' => 'BaseMeAgentId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'name' => 'CallbackUrl',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Webhook address', 'type' => 'string', 'required' => false, 'example' => 'https://xxxxxxxxk.com', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'RulePageResult<RuleCountInfo>',
- 'description' => 'RulePageResult<RuleCountInfo>',
+ 'title' => 'Schema of Response',
+ 'description' => 'Response schema',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '219',
- ],
- 'BusinessType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647'],
+ 'Success' => ['description' => 'Indicates whether the call succeeded', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. A value of **200** indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the call failed. Returns successful if the call succeeded.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'string', 'example' => '200', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- '$ref' => '#/components/schemas/RuleCountInfo',
- ],
- ],
- 'Count' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '219',
- ],
- 'CurrentPage' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '96138D8D-8D26-4E41-BFF4-77AED1088BBD',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Messages' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
+ 'description' => 'Response data',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => '7C1DEF5F-2C18-4D36-99C6-8C27*****', 'title' => ''],
],
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 219,\\n \\"BusinessType\\": 0,\\n \\"Data\\": [\\n {\\n \\"Rid\\": 0,\\n \\"Name\\": \\"\\",\\n \\"Type\\": 0,\\n \\"Status\\": 0,\\n \\"CheckNumber\\": 0,\\n \\"HitNumber\\": 0,\\n \\"HitRate\\": 0,\\n \\"ReviewAccuracyRate\\": 0,\\n \\"ReviewRate\\": 0,\\n \\"PreReviewNumber\\": 0,\\n \\"ReviewNumber\\": 0,\\n \\"UnReviewNumber\\": 0,\\n \\"ProblemNumber\\": 0,\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"CreateEmpid\\": \\"\\",\\n \\"CreateEmpName\\": \\"\\",\\n \\"LastUpdateEmpid\\": \\"\\",\\n \\"LastUpdateEmpName\\": \\"\\",\\n \\"LastUpdateTime\\": \\"\\",\\n \\"BusinessRange\\": [\\n 0\\n ],\\n \\"BusinessCategoryBasicInfoList\\": [\\n {\\n \\"Bid\\": 0,\\n \\"ServiceType\\": 0,\\n \\"Name\\": \\"\\",\\n \\"OriginalId\\": 0\\n }\\n ],\\n \\"BusinessCategoryNameList\\": [\\n \\"\\"\\n ],\\n \\"IsDelete\\": 0,\\n \\"TypeName\\": \\"\\",\\n \\"JobName\\": \\"\\",\\n \\"Comments\\": \\"\\",\\n \\"RealViolationNumber\\": 0,\\n \\"HitRealViolationRate\\": 0,\\n \\"ReviewStatusName\\": \\"\\",\\n \\"Deny\\": 0,\\n \\"ScoreSubId\\": 0,\\n \\"AutoReview\\": 0,\\n \\"RuleScoreType\\": 0,\\n \\"UserGroup\\": \\"\\",\\n \\"OperationMode\\": 0,\\n \\"IsSelect\\": true,\\n \\"RuleType\\": 0,\\n \\"Effective\\": 0,\\n \\"FullCycle\\": 0,\\n \\"EffectiveStartTime\\": \\"\\",\\n \\"EffectiveEndTime\\": \\"\\",\\n \\"QualityCheckType\\": 0,\\n \\"GraphFlow\\": \\"\\",\\n \\"RuleScoreSingleType\\": 0,\\n \\"TargetType\\": 0\\n }\\n ],\\n \\"Count\\": 219,\\n \\"CurrentPage\\": 10,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"96138D8D-8D26-4E41-BFF4-77AED1088BBD\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": [\\n \\"无\\"\\n ],\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- ],
- 'GetRuleV4' => [
- 'summary' => 'V4获取规则',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"7C1DEF5F-2C18-4D36-99C6-8C27*****\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Create a mining analysis job ',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-15T09:24:23.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-07-30T05:55:19.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-07-30T02:45:15.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
],
+ 'ramActions' => [],
+ ],
+ 'CreateQualityCheckScheme' => [
+ 'summary' => 'You can access this operation from the Quality Check Plan Management page in the console. The Apsara Stack endpoint is ip:port/api/qcs/CreateQualityCheckScheme.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'RuleId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '',
- ],
+ 'name' => 'jsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'JSON request body. For details, see the parameter description in the request parameters section.', 'type' => 'string', 'required' => true, 'example' => '{"dataType":1,"name":"质检方案A","type":1}', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'Workspace ID', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<RulesInfo>',
- 'description' => 'PlainResult<RulesInfo>',
+ 'description' => 'PlainResult\\<long>',
+ 'title' => 'PlainResult<Long> ',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'enumValueTitles' => [],
- '$ref' => '#/components/schemas/RulesInfo',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Data' => ['description' => 'ID of the created quality check plan.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '76DB5D8C-5BD9-42A7-B527-5AF3A5F****', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. If true, the request succeeded. If false or null, the request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. A value of 200 indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request failed. If the request succeeded, the value is **successful**.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'Messages' => [
+ 'itemNode' => true,
'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => [
+ 'description' => 'List of messages. Ignore this field.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Message. Ignore this field.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
],
+ 'title' => '',
+ 'example' => '',
],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
- 'enumValueTitles' => [],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Conditions\\": [\\n {\\n \\"Cid\\": \\"\\",\\n \\"Id\\": 0,\\n \\"Rid\\": \\"\\",\\n \\"Check_range\\": {\\n \\"RoleId\\": 0,\\n \\"Role\\": \\"\\",\\n \\"Anchor\\": {\\n \\"Cid\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"Hit_time\\": 0\\n },\\n \\"Range\\": {\\n \\"From\\": 0,\\n \\"To\\": 0\\n },\\n \\"Absolute\\": true,\\n \\"AllSentencesSatisfy\\": true\\n },\\n \\"Operators\\": [\\n {\\n \\"Oid\\": \\"\\",\\n \\"Id\\": 0,\\n \\"Type\\": \\"\\",\\n \\"Param\\": {\\n \\"CustomerParam\\": {\\n \\"Field\\": \\"\\",\\n \\"FieldType\\": 0,\\n \\"DataType\\": 0,\\n \\"Symbol\\": 0,\\n \\"Value\\": \\"\\",\\n \\"ActualValue\\": \\"\\",\\n \\"ExpressionMetaDesc\\": {\\n \\"LeftFieldType\\": 0,\\n \\"LeftOperand\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"RightFieldType\\": 0,\\n \\"RightOperand\\": \\"\\",\\n \\"RoundingMode\\": \\"\\"\\n }\\n },\\n \\"Keywords\\": [\\n \\"\\"\\n ],\\n \\"Regex\\": \\"\\",\\n \\"NotRegex\\": \\"\\",\\n \\"Phrase\\": \\"\\",\\n \\"References\\": [\\n \\"\\"\\n ],\\n \\"Interval\\": 0,\\n \\"IntervalEnd\\": 0,\\n \\"Threshold\\": 0,\\n \\"In_sentence\\": true,\\n \\"Target\\": 0,\\n \\"From_end\\": true,\\n \\"Different_role\\": true,\\n \\"Target_role\\": \\"\\",\\n \\"RoleId\\": 0,\\n \\"Velocity\\": 0,\\n \\"VelocityInMint\\": 0,\\n \\"KeywordExtension\\": 0,\\n \\"Synonyms\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n },\\n \\"Case_sensitive\\": true,\\n \\"Near_dialogue\\": true,\\n \\"MinWordSize\\": 0,\\n \\"Hit_time\\": 0,\\n \\"Excludes\\": [\\n \\"\\"\\n ],\\n \\"From\\": 0,\\n \\"CheckFirstSentence\\": true,\\n \\"Average\\": true,\\n \\"BeginType\\": \\"\\",\\n \\"EndType\\": \\"\\",\\n \\"CompareOperator\\": \\"\\",\\n \\"Pkey\\": \\"\\",\\n \\"Poutput_type\\": 0,\\n \\"SimilarlySentences\\": [\\n \\"\\"\\n ],\\n \\"LgfSentences\\": [\\n \\"\\"\\n ],\\n \\"Score\\": 0,\\n \\"ContextChatMatch\\": true,\\n \\"KeywordMatchSize\\": 0,\\n \\"MaxEmotionChangeValue\\": 0,\\n \\"CheckType\\": 0,\\n \\"KnowledgeTargetId\\": \\"\\",\\n \\"CategoryPathCode\\": \\"\\",\\n \\"KnowledgeTargetType\\": 0,\\n \\"KnowledgeTargetName\\": \\"\\",\\n \\"QuestionThreshold\\": \\"\\",\\n \\"AnswerThreshold\\": \\"\\",\\n \\"KnowledgeSentenceNum\\": 0,\\n \\"KnowledgeInfo\\": \\"\\",\\n \\"BotId\\": \\"\\",\\n \\"UseEasAlgorithm\\": true,\\n \\"Pvalues\\": [\\n \\"\\"\\n ],\\n \\"Similarity_threshold\\": 0,\\n \\"AntModelInfo\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"DelayTime\\": 0,\\n \\"Knowledges\\": \\"\\",\\n \\"LlmModelCode\\": \\"\\",\\n \\"HitCondition\\": \\"\\",\\n \\"SceneName\\": \\"\\",\\n \\"Dimensions\\": [\\n {\\n \\"Dimension\\": \\"\\",\\n \\"Desc\\": \\"\\",\\n \\"ExcludeCondition\\": \\"\\",\\n \\"IncludeCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\",\\n \\"QualityCheckType\\": 0\\n }\\n ],\\n \\"Lambda\\": \\"\\",\\n \\"Exclusion\\": 0,\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\"\\n }\\n ],\\n \\"Rules\\": [\\n {\\n \\"Status\\": 0,\\n \\"IsDelete\\": 0,\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"Weight\\": \\"\\",\\n \\"IsOnline\\": 0,\\n \\"CreateEmpid\\": \\"\\",\\n \\"CreateEmpName\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"LastUpdateTime\\": \\"\\",\\n \\"LastUpdateEmpid\\": \\"\\",\\n \\"LastUpdateEmpName\\": \\"\\",\\n \\"Comments\\": \\"\\",\\n \\"Deny\\": 0,\\n \\"ScoreSubId\\": 0,\\n \\"ScoreName\\": \\"\\",\\n \\"ScoreSubName\\": \\"\\",\\n \\"ScoreNum\\": 0,\\n \\"ScoreType\\": 0,\\n \\"ScoreDeleted\\": true,\\n \\"OperationMode\\": 0,\\n \\"Meet\\": 0,\\n \\"Effective\\": 0,\\n \\"FullCycle\\": 0,\\n \\"EffectiveStartTime\\": \\"\\",\\n \\"EffectiveEndTime\\": \\"\\",\\n \\"QualityCheckType\\": 0,\\n \\"Level\\": 0,\\n \\"GraphFlow\\": \\"\\",\\n \\"TaskFlowType\\": 0,\\n \\"CheckType\\": 0,\\n \\"SchemeCheckType\\": {\\n \\"CheckType\\": 0,\\n \\"CheckName\\": \\"\\",\\n \\"SourceScore\\": 0,\\n \\"Score\\": 0,\\n \\"Enable\\": 0,\\n \\"SchemeId\\": 0,\\n \\"SchemeScoreInfoList\\": [\\n {\\n \\"Rid\\": 0,\\n \\"Name\\": \\"\\",\\n \\"TaskFlowId\\": 0,\\n \\"TaskFlowName\\": \\"\\",\\n \\"ScoreType\\": 0,\\n \\"ScoreNumType\\": 0,\\n \\"ScoreNum\\": 0,\\n \\"ScoreRuleHitType\\": 0\\n }\\n ],\\n \\"TaskFlowScoreInfoList\\": [\\n {\\n \\"TaskFlowId\\": 0,\\n \\"TaskFlowName\\": \\"\\",\\n \\"TaskFlowType\\": 0,\\n \\"SchemeScoreInfoList\\": [\\n {\\n \\"Rid\\": 0,\\n \\"Name\\": \\"\\",\\n \\"TaskFlowId\\": 0,\\n \\"TaskFlowName\\": \\"\\",\\n \\"ScoreType\\": 0,\\n \\"ScoreNumType\\": 0,\\n \\"ScoreNum\\": 0,\\n \\"ScoreRuleHitType\\": 0\\n }\\n ]\\n }\\n ]\\n },\\n \\"TargetType\\": 0,\\n \\"ConfigType\\": 0,\\n \\"ScoreNumType\\": 0,\\n \\"ScoreRuleHitType\\": 0,\\n \\"SchemeId\\": 0,\\n \\"SchemeRuleMappingId\\": 0,\\n \\"SchemeName\\": \\"\\",\\n \\"ModifyType\\": 0,\\n \\"SortIndex\\": 0,\\n \\"RuleType\\": 0,\\n \\"Rid\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"TaskFlowId\\": 0,\\n \\"Lambda\\": \\"\\",\\n \\"ExternalProperty\\": 0,\\n \\"Type\\": 0,\\n \\"RuleCategoryName\\": \\"\\",\\n \\"AutoReview\\": 0,\\n \\"RuleScoreType\\": 0,\\n \\"ScoreId\\": 0,\\n \\"PreqRule\\": {\\n \\"Rid\\": \\"\\"\\n },\\n \\"BusinessCategoryNameList\\": [\\n \\"\\"\\n ],\\n \\"Dialogues\\": [\\n {\\n \\"Id\\": 0,\\n \\"Content\\": [\\n {\\n \\"HourMinSec\\": \\"\\",\\n \\"Role\\": \\"\\",\\n \\"Identity\\": \\"\\",\\n \\"EmotionValue\\": 0,\\n \\"SpeechRate\\": 0,\\n \\"Words\\": \\"\\",\\n \\"End\\": 0,\\n \\"SilenceDuration\\": 0,\\n \\"BeginTime\\": 0,\\n \\"Begin\\": 0\\n }\\n ],\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\"\\n }\\n ],\\n \\"Triggers\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"Dialogues\\": [\\n {\\n \\"Id\\": 0,\\n \\"Content\\": [\\n {\\n \\"HourMinSec\\": \\"\\",\\n \\"Role\\": \\"\\",\\n \\"Identity\\": \\"\\",\\n \\"EmotionValue\\": 0,\\n \\"SpeechRate\\": 0,\\n \\"Words\\": \\"\\",\\n \\"End\\": 0,\\n \\"SilenceDuration\\": 0,\\n \\"BeginTime\\": 0,\\n \\"Begin\\": 0\\n }\\n ],\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\"\\n }\\n ],\\n \\"Count\\": 0,\\n \\"PageSize\\": 0,\\n \\"PageNumber\\": 0\\n },\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": [\\n \\"无\\"\\n ],\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 12,\\n \\"RequestId\\": \\"76DB5D8C-5BD9-42A7-B527-5AF3A5F****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Create Quality Inspection Plan',
+ 'requestParamsDescription' => 'For more information, see [`Quality Check Plan Object Description`](https://help.aliyun.com/document_detail/453310.html).'."\n"
+ ."\n"
+ .'## Sample request body'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "dataType": 1,'."\n"
+ .' "name": "New Quality Check Plan",'."\n"
+ .' "type": 1'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Sample Java code'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'public class sca {'."\n"
+ ."\n"
+ .' private static String ak = "YOUR_ACCESS_KEY_ID";'."\n"
+ .' private static String sk = "YOUR_ACCESS_KEY_SECRET";'."\n"
+ ."\n"
+ .' private static void addScheme() throws Exception {'."\n"
+ .' String json="{\\"dataType\\":1,\\"name\\":\\"siqi-test2\\",\\"type\\":1}";'."\n"
+ ."\n"
+ .' Config config = new Config();'."\n"
+ .' config.setAccessKeyId(ak).setAccessKeySecret(sk)'."\n"
+ .' .setEndpoint("qualitycheck.cn-hangzhou.aliyuncs.com")'."\n"
+ .' .setRegionId("cn-hangzhou").setProtocol("HTTPS");'."\n"
+ ."\n"
+ .' Client client = new Client(config);'."\n"
+ .' CreateQualityCheckSchemeRequest result = new CreateQualityCheckSchemeRequest();'."\n"
+ ."\n"
+ .' result.setJsonStr(json);'."\n"
+ ."\n"
+ .' CreateQualityCheckSchemeResponse response = client.createQualityCheckScheme(result);'."\n"
+ .' System.out.println(JSONObject.toJSONString(response));'."\n"
+ .' }'."\n"
+ ."\n"
+ .' public static void main(String[] args) throws Exception {'."\n"
+ .' addScheme();'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateQualityCheckScheme'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'DeleteRuleV4' => [
- 'summary' => 'V4删除规则',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateSchemeTaskConfig' => [
+ 'summary' => 'Corresponding frontend feature location: Plan Management > Create Quality Inspection Job. Apsara Stack URL: ip:port/api/task/CreateSchemeTaskConfig.json. ',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '153838',
+ 'abilityTreeNodes' => ['FEATUREscaFRLL5D', 'FEATUREsca81P1AQ'],
+ ],
'parameters' => [
[
- 'name' => 'RuleId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'ForceDelete',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'name' => 'jsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Input parameter in JSON format. For details, see Request Parameters.', 'type' => 'string', 'required' => false, 'example' => '{"manualReview":0,"name":"检测任务 2022-09-21 16:59:50","asrTaskPriority":2,"modeCustomizationId":"englishxxx","vocabId":"xxxx5b98d98f8405xxxxxe5dbb383ca1df","dataConfig":{"assignConfigs":[{"assignConfigContests":[{"name":"fileName","symbol":1,"value":["1"],"dataType":2}]}]},"schemeIdList":[187],"sourceDataType":1}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'baseMeAgentId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BaseResult',
- 'description' => 'BaseResult',
+ 'title' => 'PlainResult<Long>',
+ 'description' => 'PlainResult<Long>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Data' => ['description' => 'ID of the newly created quality inspection job.', 'type' => 'integer', 'format' => 'int64', 'example' => '22', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** ', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. The caller can use this field to determine the request outcome: true indicates success; false or null indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. **200** indicates success. Any other value indicates failure. The caller can use this field to determine the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'When an error occurs, this field provides error details. When the operation succeeds, the value is "successful".', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'Messages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Message' => [
- 'description' => '',
+ 'description' => 'When an error occurs, this field provides error details. It is used when multiple messages are returned.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'items' => ['description' => 'When an error occurs, this field provides error details. It is used when multiple messages are returned.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'HttpStatusCode' => [
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- ],
- 'TestRuleV4' => [
- 'summary' => '测试规则',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 22,\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Create Quality Inspection Job',
+ 'requestParamsDescription' => 'For more information, see the document [`Task Object Description`](https://help.aliyun.com/document_detail/453292.html). '."\n"
+ .'## Sample Input Parameters '."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "manualReview": 0,'."\n"
+ .' "name": "Create Detection Job",'."\n"
+ .' "asrTaskPriority": 1,'."\n"
+ .' "modeCustomizationId": "cdae396590bb479a9ec40f3476e274fc",'."\n"
+ .' "vocabId": "3814930c648c48a79a43aaaf3ac937d7",'."\n"
+ .' "dataConfig": {'."\n"
+ .' "assignConfigs": ['."\n"
+ .' {'."\n"
+ .' "assignConfigContests": ['."\n"
+ .' {'."\n"
+ .' "name": "customerServiceName",'."\n"
+ .' "symbol": 1,'."\n"
+ .' "value": ['."\n"
+ .' "siqi"'."\n"
+ .' ],'."\n"
+ .' "dataType": 2'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "schemeIdList": ['."\n"
+ .' 198'."\n"
+ .' ],'."\n"
+ .' "sourceDataType": 1'."\n"
+ .'}'."\n"
+ .'``` '."\n"
+ .'## Sample Code '."\n"
+ .'```java'."\n"
+ .'public class sca {'."\n"
+ ."\n"
+ .' private static String ak = "YOUR_ACCESS_KEY_ID";'."\n"
+ .' private static String sk = "YOUR_ACCESS_KEY_SECRET";'."\n"
+ ."\n"
+ .' private static void addSchemeTaskConfig() throws Exception {'."\n"
+ .' String json="{"manualReview":0,"name":"Detection Job siqi-test","asrTaskPriority":1,"modeCustomizationId":"cdae396590bb479a9ec40f3476e274fc","vocabId":"3814930c648c48a79a43aaaf3ac937d7","dataConfig":{"assignConfigs":[{"assignConfigContests":[{"name":"customerServiceName","symbol":1,"value":["siqi"],"dataType":2}]}]},"schemeIdList":[198],"sourceDataType":1}";'."\n"
+ ."\n"
+ .' Config config = new Config();'."\n"
+ .' config.setAccessKeyId(ak).setAccessKeySecret(sk)'."\n"
+ .' .setEndpoint("qualitycheck.cn-hangzhou.aliyuncs.com")'."\n"
+ .' .setRegionId("cn-hangzhou").setProtocol("HTTPS");'."\n"
+ ."\n"
+ .' Client client = new Client(config);'."\n"
+ .' CreateSchemeTaskConfigRequest result = new CreateSchemeTaskConfigRequest();'."\n"
+ ."\n"
+ .' result.setJsonStr(json);'."\n"
+ ."\n"
+ .' CreateSchemeTaskConfigResponse response = client.createSchemeTaskConfig(result);'."\n"
+ .' System.out.println(JSONObject.toJSONString(response));'."\n"
+ .' }'."\n"
+ ."\n\n"
+ .' public static void main(String[] args) throws Exception {'."\n"
+ .' addSchemeTaskConfig();'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSchemeTaskConfig'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sca:CreateSchemeTaskConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateSkillGroupConfig' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'deprecated' => false,
- 'systemTags' => [],
+ 'operationType' => 'write',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '56147',
+ 'abilityTreeNodes' => ['FEATUREsca6QWO0D', 'FEATUREscaKR8LQC'],
+ ],
'parameters' => [
[
- 'name' => 'IsSchemeData',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A JSON-formatted string. For details, see the following table.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"skillGroupFrom":0,"qualityCheckType":0,"modelId":746,"name":"test","rid":"2493","vocabId":"267","skillGroupList":[{"skillGroupId":"0903","skillGroupName":"0903"}]}', 'title' => ''],
],
[
- 'name' => 'TestJson',
- 'in' => 'formData',
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'Result code. A value of 200 indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the call fails. Returns successful if the call succeeds.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'ID of the newly created configuration.', 'type' => 'integer', 'format' => 'int64', 'example' => '223', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** ', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. true means success. false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
+ 'title' => '',
'example' => '',
],
],
],
+ 'staticInfo' => ['noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": 223,\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Create Configuration',
+ 'summary' => 'Create a configuration.',
+ 'requestParamsDescription' => '**JSON string fields**'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :--------------- | :------ | :------- | :------------------------------------------------------------------------------------- |'."\n"
+ .'| skillGroupFrom | Integer | Yes | Source of the skill group. Set to 0. |'."\n"
+ .'| qualityCheckType | Integer | Yes | Quality check type. Set to 0. |'."\n"
+ .'| modelId | Integer | No | Language model ID |'."\n"
+ .'| name | String | Yes | Configuration name |'."\n"
+ .'| rid | String | Yes | Quality check rules. Separate multiple rules with commas. Use -2 to specify all rules. |'."\n"
+ .'| vocabId | String | No | Hotword model ID |'."\n"
+ .'| skillGroupList | List | Yes | Skill information. For details, see the skillGroupList field description below. |'."\n"
+ ."\n"
+ .'**skillGroupList field description**'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------------- | :------ | :------- | :--------------- |'."\n"
+ .'| skillGroupId | Integer | Yes | Skill group ID |'."\n"
+ .'| skillGroupName | String | Yes | Skill group name |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-29T06:47:50.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSkillGroupConfig'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'CreateTag' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREsca27EUYZ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The complete **JSON string** information. For more information, see the following details.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The business space ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<OverviewResult>',
- 'description' => 'PlainResult<OverviewResult>',
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***'],
'Data' => [
- 'description' => '',
+ 'description' => 'The returned result.',
'type' => 'object',
'properties' => [
- 'HitRuleReviewInfoList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Rid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '451',
- ],
- 'Lambda' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'a&&b',
- ],
- 'ConditionHitInfoList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Cid' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- ],
- 'Phrase' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Role' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Identity' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Words' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Begin' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '72000',
- ],
- 'End' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '80000',
- ],
- 'BeginTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-11-25 15:37:16',
- ],
- 'HourMinSec' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10:00:00',
- ],
- 'EmotionValue' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '7',
- ],
- 'EmotionFineGrainedValue' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '',
- ],
- 'SilenceDuration' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1000',
- ],
- 'SpeechRate' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'ChannelId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Pid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'RenterId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '',
- ],
- 'Uuid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'HitStatus' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Sid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '',
- ],
- ],
- ],
- 'KeyWords' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'OperatorKey' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Val' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Pid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '13',
- ],
- 'From' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'To' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'Tid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Oid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'Uuid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SimilarPhrase' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Cid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4',
- ],
- 'CustomizeCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'ConditionInfoList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- '$ref' => '#/components/schemas/ConditionBasicInfo',
- ],
- ],
- 'BranchHitId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'BranchInfoList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Index' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'NextNodeId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'Situation' => [
- 'description' => '',
- '$ref' => '#/components/schemas/NextNodeSituations',
- ],
- 'Lambda' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'a&&b',
- ],
- 'CheckType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Triggers' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'a',
- ],
- ],
- ],
- ],
- ],
- 'RuleScoreType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TaskFlowId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'ScoreNumType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Matched' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'NodeType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'JudgeNodeName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'RuleName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- 'HitTaskFlowList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'GraphFlow' => [
- 'description' => '',
- '$ref' => '#/components/schemas/TaskGraphFlow',
- ],
- 'TaskFlowType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- ],
- ],
- ],
- 'UnhitRuleReviewInfoList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Rid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'ConditionInfoList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- '$ref' => '#/components/schemas/ConditionBasicInfo',
- ],
- ],
- 'Matched' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TaskFlowType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '',
- ],
- ],
- ],
- ],
+ 'TagId' => ['description' => 'The label ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '128', 'title' => ''],
+ 'Name' => ['description' => 'The label name.', 'type' => 'string', 'example' => '售后问题', 'title' => ''],
+ 'Description' => ['description' => 'The label description.', 'type' => 'string', 'example' => '用于归集售后服务相关的所有意图与 FAQ', 'title' => ''],
+ 'ParentTagId' => ['description' => 'The parent label node ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the label node was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1748428991000', 'title' => ''],
+ 'ModifyTime' => ['description' => 'The time when the label node was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1748428991000', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- 'RequestId' => [
- 'title' => '请求Id。',
- 'description' => '',
- 'type' => 'string',
- 'example' => '96138D8D-XXXX-4E41-XXXX-77AED1088BBD',
- ],
- 'Success' => [
- 'title' => '请求是否成功,调用方可根据此字段来判断请求是否成功:true表示成功;false/null表示失败。',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '结果代码,200表示成功,若为别的值则表示失败,调用方可根据此字段判断失败原因。',
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '出错时表示出错详情,成功时为successful。',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'title' => 'HTTP状态码。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Other values indicate failure. You can use this field to determine the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Message' => ['description' => 'The error message, if any.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"HitRuleReviewInfoList\\": [\\n {\\n \\"Rid\\": 451,\\n \\"Lambda\\": \\"a&&b\\",\\n \\"ConditionHitInfoList\\": [\\n {\\n \\"Cid\\": [\\n \\"1\\"\\n ],\\n \\"Phrase\\": {\\n \\"Role\\": \\"客服\\",\\n \\"Identity\\": \\"客服\\",\\n \\"Words\\": \\"你好,请问有什么可以帮您\\",\\n \\"Begin\\": 72000,\\n \\"End\\": 80000,\\n \\"BeginTime\\": \\"2019-11-25 15:37:16\\",\\n \\"HourMinSec\\": \\"10:00:00\\",\\n \\"EmotionValue\\": 7,\\n \\"EmotionFineGrainedValue\\": 0,\\n \\"SilenceDuration\\": 1000,\\n \\"SpeechRate\\": 100,\\n \\"ChannelId\\": 0,\\n \\"Pid\\": 3,\\n \\"RenterId\\": 0,\\n \\"Uuid\\": \\"无\\",\\n \\"HitStatus\\": 1,\\n \\"Sid\\": 0\\n },\\n \\"KeyWords\\": [\\n {\\n \\"OperatorKey\\": \\"无\\",\\n \\"Val\\": \\"你好\\",\\n \\"Pid\\": 13,\\n \\"From\\": 1,\\n \\"To\\": 3,\\n \\"Tid\\": \\"无\\",\\n \\"Oid\\": \\"123\\",\\n \\"Uuid\\": \\"无\\",\\n \\"SimilarPhrase\\": \\"您好\\",\\n \\"Cid\\": \\"4\\",\\n \\"CustomizeCode\\": \\"无\\"\\n }\\n ]\\n }\\n ],\\n \\"ConditionInfoList\\": [\\n {\\n \\"Cid\\": \\"\\",\\n \\"Id\\": 0,\\n \\"Rid\\": \\"\\",\\n \\"Check_range\\": {\\n \\"RoleId\\": 0,\\n \\"Role\\": \\"\\",\\n \\"Anchor\\": {\\n \\"Cid\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"Hit_time\\": 0\\n },\\n \\"Range\\": {\\n \\"From\\": 0,\\n \\"To\\": 0\\n },\\n \\"Absolute\\": true,\\n \\"AllSentencesSatisfy\\": true\\n },\\n \\"Operators\\": [\\n {\\n \\"Oid\\": \\"\\",\\n \\"Id\\": 0,\\n \\"Type\\": \\"\\",\\n \\"Param\\": {\\n \\"CustomerParam\\": {\\n \\"Field\\": \\"\\",\\n \\"FieldType\\": 0,\\n \\"DataType\\": 0,\\n \\"Symbol\\": 0,\\n \\"Value\\": \\"\\",\\n \\"ActualValue\\": \\"\\",\\n \\"ExpressionMetaDesc\\": {\\n \\"LeftFieldType\\": 0,\\n \\"LeftOperand\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"RightFieldType\\": 0,\\n \\"RightOperand\\": \\"\\",\\n \\"RoundingMode\\": \\"\\"\\n }\\n },\\n \\"Keywords\\": [\\n \\"\\"\\n ],\\n \\"Regex\\": \\"\\",\\n \\"NotRegex\\": \\"\\",\\n \\"Phrase\\": \\"\\",\\n \\"References\\": [\\n \\"\\"\\n ],\\n \\"Interval\\": 0,\\n \\"IntervalEnd\\": 0,\\n \\"Threshold\\": 0,\\n \\"In_sentence\\": true,\\n \\"Target\\": 0,\\n \\"From_end\\": true,\\n \\"Different_role\\": true,\\n \\"Target_role\\": \\"\\",\\n \\"RoleId\\": 0,\\n \\"Velocity\\": 0,\\n \\"VelocityInMint\\": 0,\\n \\"KeywordExtension\\": 0,\\n \\"Synonyms\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n },\\n \\"Case_sensitive\\": true,\\n \\"Near_dialogue\\": true,\\n \\"MinWordSize\\": 0,\\n \\"Hit_time\\": 0,\\n \\"Excludes\\": [\\n \\"\\"\\n ],\\n \\"From\\": 0,\\n \\"CheckFirstSentence\\": true,\\n \\"Average\\": true,\\n \\"BeginType\\": \\"\\",\\n \\"EndType\\": \\"\\",\\n \\"CompareOperator\\": \\"\\",\\n \\"Pkey\\": \\"\\",\\n \\"Poutput_type\\": 0,\\n \\"SimilarlySentences\\": [\\n \\"\\"\\n ],\\n \\"LgfSentences\\": [\\n \\"\\"\\n ],\\n \\"Score\\": 0,\\n \\"ContextChatMatch\\": true,\\n \\"KeywordMatchSize\\": 0,\\n \\"MaxEmotionChangeValue\\": 0,\\n \\"CheckType\\": 0,\\n \\"KnowledgeTargetId\\": \\"\\",\\n \\"CategoryPathCode\\": \\"\\",\\n \\"KnowledgeTargetType\\": 0,\\n \\"KnowledgeTargetName\\": \\"\\",\\n \\"QuestionThreshold\\": \\"\\",\\n \\"AnswerThreshold\\": \\"\\",\\n \\"KnowledgeSentenceNum\\": 0,\\n \\"KnowledgeInfo\\": \\"\\",\\n \\"BotId\\": \\"\\",\\n \\"UseEasAlgorithm\\": true,\\n \\"Pvalues\\": [\\n \\"\\"\\n ],\\n \\"Similarity_threshold\\": 0,\\n \\"AntModelInfo\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"DelayTime\\": 0,\\n \\"Knowledges\\": \\"\\",\\n \\"LlmModelCode\\": \\"\\",\\n \\"HitCondition\\": \\"\\",\\n \\"SceneName\\": \\"\\",\\n \\"Dimensions\\": [\\n {\\n \\"Dimension\\": \\"\\",\\n \\"Desc\\": \\"\\",\\n \\"ExcludeCondition\\": \\"\\",\\n \\"IncludeCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\",\\n \\"QualityCheckType\\": 0\\n }\\n ],\\n \\"Lambda\\": \\"\\",\\n \\"Exclusion\\": 0,\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\"\\n }\\n ],\\n \\"BranchHitId\\": 1,\\n \\"BranchInfoList\\": [\\n {\\n \\"Index\\": 1,\\n \\"Name\\": \\"节点A\\",\\n \\"NextNodeId\\": 2,\\n \\"Situation\\": {\\n \\"ConditionGroup\\": [\\n {\\n \\"Conditions\\": [\\n {\\n \\"Field\\": \\"\\",\\n \\"FieldType\\": 0,\\n \\"DataType\\": 0,\\n \\"Symbol\\": 0,\\n \\"Value\\": \\"\\",\\n \\"ActualValue\\": \\"\\",\\n \\"ExpressionMetaDesc\\": {\\n \\"LeftFieldType\\": 0,\\n \\"LeftOperand\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"RightFieldType\\": 0,\\n \\"RightOperand\\": \\"\\",\\n \\"RoundingMode\\": \\"\\"\\n }\\n }\\n ],\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"Type\\": \\"\\"\\n },\\n \\"Lambda\\": \\"a&&b\\",\\n \\"CheckType\\": 0,\\n \\"Triggers\\": [\\n \\"a\\"\\n ]\\n }\\n ],\\n \\"RuleScoreType\\": 1,\\n \\"TaskFlowId\\": 1,\\n \\"ScoreNumType\\": 1,\\n \\"Matched\\": true,\\n \\"NodeType\\": \\"0\\",\\n \\"JudgeNodeName\\": \\"判断节点A\\",\\n \\"RuleName\\": \\"规则A\\"\\n }\\n ],\\n \\"HitTaskFlowList\\": [\\n {\\n \\"GraphFlow\\": {\\n \\"Id\\": 0,\\n \\"Rid\\": 0,\\n \\"RuleName\\": \\"\\",\\n \\"SkipWhenFirstSessionNodeMiss\\": true,\\n \\"FlowRuleScoreType\\": 0,\\n \\"ShowProperties\\": \\"\\",\\n \\"Nodes\\": [\\n {\\n \\"Id\\": 0,\\n \\"Rid\\": 0,\\n \\"Name\\": \\"\\",\\n \\"NodeType\\": \\"\\",\\n \\"Index\\": 0,\\n \\"Content\\": \\"\\",\\n \\"Properties\\": {\\n \\"Type\\": \\"\\",\\n \\"Role\\": \\"\\",\\n \\"SayType\\": \\"\\",\\n \\"RuleScoreType\\": 0,\\n \\"ScoreNum\\": 0,\\n \\"ScoreType\\": 0,\\n \\"ScoreRuleHitType\\": 0,\\n \\"AutoReview\\": 0,\\n \\"ScoreNumType\\": 0,\\n \\"Lambda\\": \\"\\",\\n \\"CheckType\\": 0,\\n \\"Triggers\\": [\\n \\"\\"\\n ],\\n \\"BranchJudge\\": true,\\n \\"CheckMoreSize\\": 0\\n },\\n \\"Conditions\\": [\\n {\\n \\"Cid\\": \\"\\",\\n \\"Id\\": 0,\\n \\"Rid\\": \\"\\",\\n \\"Check_range\\": {\\n \\"RoleId\\": 0,\\n \\"Role\\": \\"\\",\\n \\"Anchor\\": {\\n \\"Cid\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"Hit_time\\": 0\\n },\\n \\"Range\\": {\\n \\"From\\": 0,\\n \\"To\\": 0\\n },\\n \\"Absolute\\": true,\\n \\"AllSentencesSatisfy\\": true\\n },\\n \\"Operators\\": [\\n {\\n \\"Oid\\": \\"\\",\\n \\"Id\\": 0,\\n \\"Type\\": \\"\\",\\n \\"Param\\": {\\n \\"CustomerParam\\": {\\n \\"Field\\": \\"\\",\\n \\"FieldType\\": 0,\\n \\"DataType\\": 0,\\n \\"Symbol\\": 0,\\n \\"Value\\": \\"\\",\\n \\"ActualValue\\": \\"\\",\\n \\"ExpressionMetaDesc\\": {\\n \\"LeftFieldType\\": 0,\\n \\"LeftOperand\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"RightFieldType\\": 0,\\n \\"RightOperand\\": \\"\\",\\n \\"RoundingMode\\": \\"\\"\\n }\\n },\\n \\"Keywords\\": [\\n \\"\\"\\n ],\\n \\"Regex\\": \\"\\",\\n \\"NotRegex\\": \\"\\",\\n \\"Phrase\\": \\"\\",\\n \\"References\\": [\\n \\"\\"\\n ],\\n \\"Interval\\": 0,\\n \\"IntervalEnd\\": 0,\\n \\"Threshold\\": 0,\\n \\"In_sentence\\": true,\\n \\"Target\\": 0,\\n \\"From_end\\": true,\\n \\"Different_role\\": true,\\n \\"Target_role\\": \\"\\",\\n \\"RoleId\\": 0,\\n \\"Velocity\\": 0,\\n \\"VelocityInMint\\": 0,\\n \\"KeywordExtension\\": 0,\\n \\"Synonyms\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n },\\n \\"Case_sensitive\\": true,\\n \\"Near_dialogue\\": true,\\n \\"MinWordSize\\": 0,\\n \\"Hit_time\\": 0,\\n \\"Excludes\\": [\\n \\"\\"\\n ],\\n \\"From\\": 0,\\n \\"CheckFirstSentence\\": true,\\n \\"Average\\": true,\\n \\"BeginType\\": \\"\\",\\n \\"EndType\\": \\"\\",\\n \\"CompareOperator\\": \\"\\",\\n \\"Pkey\\": \\"\\",\\n \\"Poutput_type\\": 0,\\n \\"SimilarlySentences\\": [\\n \\"\\"\\n ],\\n \\"LgfSentences\\": [\\n \\"\\"\\n ],\\n \\"Score\\": 0,\\n \\"ContextChatMatch\\": true,\\n \\"KeywordMatchSize\\": 0,\\n \\"MaxEmotionChangeValue\\": 0,\\n \\"CheckType\\": 0,\\n \\"KnowledgeTargetId\\": \\"\\",\\n \\"CategoryPathCode\\": \\"\\",\\n \\"KnowledgeTargetType\\": 0,\\n \\"KnowledgeTargetName\\": \\"\\",\\n \\"QuestionThreshold\\": \\"\\",\\n \\"AnswerThreshold\\": \\"\\",\\n \\"KnowledgeSentenceNum\\": 0,\\n \\"KnowledgeInfo\\": \\"\\",\\n \\"BotId\\": \\"\\",\\n \\"UseEasAlgorithm\\": true,\\n \\"Pvalues\\": [\\n \\"\\"\\n ],\\n \\"Similarity_threshold\\": 0,\\n \\"AntModelInfo\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"DelayTime\\": 0,\\n \\"Knowledges\\": \\"\\",\\n \\"LlmModelCode\\": \\"\\",\\n \\"HitCondition\\": \\"\\",\\n \\"SceneName\\": \\"\\",\\n \\"Dimensions\\": [\\n {\\n \\"Dimension\\": \\"\\",\\n \\"Desc\\": \\"\\",\\n \\"ExcludeCondition\\": \\"\\",\\n \\"IncludeCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\",\\n \\"QualityCheckType\\": 0\\n }\\n ],\\n \\"Lambda\\": \\"\\",\\n \\"Exclusion\\": 0,\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\"\\n }\\n ],\\n \\"NextNodes\\": [\\n {\\n \\"Index\\": 0,\\n \\"Name\\": \\"\\",\\n \\"NextNodeId\\": 0,\\n \\"Lambda\\": \\"\\",\\n \\"CheckType\\": 0,\\n \\"Triggers\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"UseConditions\\": true\\n }\\n ]\\n },\\n \\"TaskFlowType\\": 0,\\n \\"Rid\\": 1\\n }\\n ],\\n \\"UnhitRuleReviewInfoList\\": [\\n {\\n \\"Rid\\": 2,\\n \\"ConditionInfoList\\": [\\n {\\n \\"Cid\\": \\"\\",\\n \\"Id\\": 0,\\n \\"Rid\\": \\"\\",\\n \\"Check_range\\": {\\n \\"RoleId\\": 0,\\n \\"Role\\": \\"\\",\\n \\"Anchor\\": {\\n \\"Cid\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"Hit_time\\": 0\\n },\\n \\"Range\\": {\\n \\"From\\": 0,\\n \\"To\\": 0\\n },\\n \\"Absolute\\": true,\\n \\"AllSentencesSatisfy\\": true\\n },\\n \\"Operators\\": [\\n {\\n \\"Oid\\": \\"\\",\\n \\"Id\\": 0,\\n \\"Type\\": \\"\\",\\n \\"Param\\": {\\n \\"Keywords\\": [\\n \\"\\"\\n ],\\n \\"Regex\\": \\"\\",\\n \\"NotRegex\\": \\"\\",\\n \\"Phrase\\": \\"\\",\\n \\"References\\": [\\n \\"\\"\\n ],\\n \\"Interval\\": 0,\\n \\"IntervalEnd\\": 0,\\n \\"Threshold\\": 0,\\n \\"In_sentence\\": true,\\n \\"Target\\": 0,\\n \\"From_end\\": true,\\n \\"Different_role\\": true,\\n \\"Target_role\\": \\"\\",\\n \\"RoleId\\": 0,\\n \\"Velocity\\": 0,\\n \\"VelocityInMint\\": 0,\\n \\"KeywordExtension\\": 0,\\n \\"Synonyms\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n },\\n \\"Case_sensitive\\": true,\\n \\"Near_dialogue\\": true,\\n \\"MinWordSize\\": 0,\\n \\"Hit_time\\": 0,\\n \\"Excludes\\": [\\n \\"\\"\\n ],\\n \\"From\\": 0,\\n \\"CheckFirstSentence\\": true,\\n \\"Average\\": true,\\n \\"BeginType\\": \\"\\",\\n \\"EndType\\": \\"\\",\\n \\"CompareOperator\\": \\"\\",\\n \\"Pkey\\": \\"\\",\\n \\"Poutput_type\\": 0,\\n \\"SimilarlySentences\\": [\\n \\"\\"\\n ],\\n \\"LgfSentences\\": [\\n \\"\\"\\n ],\\n \\"Score\\": 0,\\n \\"ContextChatMatch\\": true,\\n \\"KeywordMatchSize\\": 0,\\n \\"MaxEmotionChangeValue\\": 0,\\n \\"CheckType\\": 0,\\n \\"KnowledgeTargetId\\": \\"\\",\\n \\"CategoryPathCode\\": \\"\\",\\n \\"KnowledgeTargetType\\": 0,\\n \\"KnowledgeTargetName\\": \\"\\",\\n \\"QuestionThreshold\\": \\"\\",\\n \\"AnswerThreshold\\": \\"\\",\\n \\"KnowledgeSentenceNum\\": 0,\\n \\"KnowledgeInfo\\": \\"\\",\\n \\"BotId\\": \\"\\",\\n \\"UseEasAlgorithm\\": true,\\n \\"Pvalues\\": [\\n \\"\\"\\n ],\\n \\"Similarity_threshold\\": 0,\\n \\"AntModelInfo\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"DelayTime\\": 0,\\n \\"Knowledges\\": \\"\\",\\n \\"LlmModelCode\\": \\"\\",\\n \\"HitCondition\\": \\"\\",\\n \\"SceneName\\": \\"\\",\\n \\"Dimensions\\": [\\n {\\n \\"Dimension\\": \\"\\",\\n \\"Desc\\": \\"\\",\\n \\"ExcludeCondition\\": \\"\\",\\n \\"IncludeCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\",\\n \\"QualityCheckType\\": 0\\n }\\n ],\\n \\"Lambda\\": \\"\\",\\n \\"Exclusion\\": 0,\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\"\\n }\\n ],\\n \\"Matched\\": true,\\n \\"TaskFlowType\\": 0\\n }\\n ]\\n },\\n \\"RequestId\\": \\"96138D8D-XXXX-4E41-XXXX-77AED1088BBD\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Create a label node',
+ 'summary' => 'Creates a label node.',
+ 'requestParamsDescription' => '| Field | Type | Required | Value | Description |'."\n"
+ .'|------|------|------|------|------|'."\n"
+ .'| name | String | Yes | "After-sales issues" | The label name. The name must be 1 to 64 characters in length and must be unique under the same parent node. |'."\n"
+ .'| description | String | No | "Used to aggregate all intents and FAQs related to after-sales service" | The node description. |'."\n"
+ .'| parentTagId | Long | No | -1 | The parent label node ID. A value of -1 indicates that the node is created under the root node. Default value: -1. |',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Data\\": {\\n \\"TagId\\": 128,\\n \\"Name\\": \\"售后问题\\",\\n \\"Description\\": \\"用于归集售后服务相关的所有意图与 FAQ\\",\\n \\"ParentTagId\\": -1,\\n \\"CreateTime\\": 1748428991000,\\n \\"ModifyTime\\": 1748428991000\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]',
],
- 'DeleteCheckTypeToScheme' => [
- 'summary' => '删除质检唯独',
- 'methods' => [
- 'post',
+ 'CreateTaskAssignRule' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A complete JSON string. For details, see the parameter descriptions below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"callType":"0","durationMin":1,"durationMax":300,"agents":[{"agentId":"202526561358712105","agentName":"agent"}],"rules":[{"rid":15659}],"reviewers":[{"reviewerId":"255746168704895558","reviewerName":"0917质检员"},{"reviewerId":"268370362815185444","reviewerName":"0710质检员"}],"skillGroups":[{"skillName":"客服组"}],"priority":5}', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
],
- 'schemes' => [
- 'https',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'Result code. A value of **200** indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request fails. Returns "successful" on success.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'ID of the created rule.', 'type' => 'string', 'example' => '54', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. A value of true means success. A value of false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"54\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Create an automatic allocation rule for review jobs',
+ 'summary' => 'Creates an automatic allocation rule for quality review tasks.',
+ 'requestParamsDescription' => '## Input parameters'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :---------- | :--- | :------- | :----------------------------------------------------------------------------------- |'."\n"
+ .'| agents | List | Yes | List of agents. **See the Agent field description below.** |'."\n"
+ .'| skillGroups | List | Yes | List of skill groups. **See the SkillGroup field description below.** |'."\n"
+ .'| durationMin | Long | No | Minimum call duration, in seconds. |'."\n"
+ .'| durationMax | Long | No | Maximum call duration, in seconds. A value of 0 means no limit. |'."\n"
+ .'| callType | Byte | No | Call type. Valid values: 1 (outbound), 3 (inbound), or unspecified. |'."\n"
+ .'| rules | List | No | Rules that must match for task assignment. **See the Rule field description below.** |'."\n"
+ .'| reviewers | List | Yes | Reviewers. **See the Reviewer field description below.** |'."\n"
+ ."\n"
+ .'### SkillGroup field description'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :-------- | :----- | :------- | :----------------------- |'."\n"
+ .'| skillName | String | Yes | Name of the skill group. |'."\n"
+ ."\n"
+ .'### Rule field description'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------- | :----- | :------- | :---------- |'."\n"
+ .'| rid | String | Yes | Rule ID. |'."\n"
+ ."\n"
+ .'### Agent field description'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :-------- | :----- | :------- | :---------- |'."\n"
+ .'| agentId | Long | Yes | Agent ID. |'."\n"
+ .'| agentName | String | Yes | Agent name. |'."\n"
+ ."\n"
+ .'### Reviewer field description'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :----------- | :----- | :------- | :---------------- |'."\n"
+ .'| reviewerId | Long | Yes | Reviewer user ID. |'."\n"
+ .'| reviewerName | String | Yes | Reviewer name. |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateTaskAssignRule'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'CreateUser' => [
+ 'summary' => 'Create a user',
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
- 'abilityTreeCode' => '251541',
- 'abilityTreeNodes' => [
- 'FEATUREscaKR8LQC',
- 'FEATUREsca6QWO0D',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREsca8WDKR3'],
],
'parameters' => [
[
'name' => 'BaseMeAgentId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123456',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''],
],
[
'name' => 'JsonStr',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"schemeId":"1376","checkType":"4"}',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => 'A complete **JSON string**. For details, see the table below.', 'type' => 'string', 'required' => false, 'example' => '[{"aliUid":123,"roleName":"AGENT","userName":"kefu01"}]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'Response schema',
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '48864',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Messages' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4*** '],
+ 'Code' => ['description' => 'The result code. A value of 200 indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message if the request fails. The value is successful if the request succeeds.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. A value of true means success. A value of false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"48864\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": [\\n \\"xxx\\"\\n ]\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Create a user',
+ 'description' => 'Alibaba Cloud uses Resource Access Management (RAM) for unified account management. Before you create a user in Smart Conversation Analysis, first create the user in [RAM](https://ram.console.aliyun.com). Then, obtain the user’s UID, username, and display name. Finally, add the RAM user to Smart Conversation Analysis to grant them access to the Smart Conversation Analysis service.',
+ 'requestParamsDescription' => '**Each element in the JSON array of request parameters is a JSON object.**'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :---------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| userName | String | Yes | Username |'."\n"
+ .'| displayName | String | Yes | Display name |'."\n"
+ .'| aliUid | Integer | Yes | UID |'."\n"
+ .'| roleName | String | Yes | Role name. Valid values: ADMIN (administrator), QUALITY_INSPECTOR (quality inspector), and AGENT (customer service representative). |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-01-02T09:21:32.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4***\\\\t\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'CreateQualityCheckScheme' => [
- 'summary' => '新增质检方案',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateWarningConfig' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'deprecated' => false,
+ 'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
- 'name' => 'jsonStr',
+ 'name' => 'JsonStr',
'in' => 'query',
+ 'schema' => ['description' => 'Complete JSON string information. See the following details for specific content.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"ridList":[15670],"configName":"投诉预警","channels":[{"type":1,"url":"https://xxx"}]}', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'Result code. **200** indicates success. Other values indicate failure. The caller can determine the failure reason based on this field.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details when an error occurs. Returns \'successful\' on success.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'The ID of the warning configuration successfully created.', 'type' => 'string', 'example' => '30', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4D55C6', 'title' => ''],
+ 'Success' => ['description' => 'Whether the request was successful. The caller can determine if the request was successful based on this field: true indicates success, false/null indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
+ 'title' => '',
'example' => '',
],
],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"30\\",\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Create Alert Configuration',
+ 'summary' => 'Create a warning configuration.',
+ 'requestParamsDescription' => '## Input Parameter Details'."\n"
+ ."\n"
+ .'| Property | Value Type | Required | Description |'."\n"
+ .'| :--------- | :--------- | :------- | :----------------------------------------------------------------------------------- |'."\n"
+ .'| configName | String | Yes | Configuration name. |'."\n"
+ .'| channels | Channel | Yes | Subscription channel list. **For details, see the Channel field description below.** |'."\n"
+ .'| ridList | Yes | List | Selected rule ridList. |'."\n"
+ ."\n"
+ .'### Channel Field Description'."\n"
+ ."\n"
+ .'| Property | Value Type | Required | Description |'."\n"
+ .'| :------- | :--------- | :------- | :-------------------------------------------------------------------- |'."\n"
+ .'| type | Byte | Yes | Subscription method. Possible values: 0 for DingTalk; 1 for callback. |'."\n"
+ .'| url | String | Yes | URL address. |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateWarningConfig'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'DelRuleCategory' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the details below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"type":"规则类型ID"}', 'title' => ''],
+ ],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Long>',
- 'description' => 'PlainResult<Long>',
'type' => 'object',
'properties' => [
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '76DB5D8C-5BD9-42A7-B527-5AF3A5F****',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Messages' => [
+ 'description' => 'The returned data.',
'type' => 'object',
- 'itemNode' => true,
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
+ 'Select' => ['description' => 'Indicates whether to select a new rule category.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
],
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 12,\\n \\"RequestId\\": \\"76DB5D8C-5BD9-42A7-B527-5AF3A5F****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"xxx\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Select\\": false\\n }\\n}","type":"json"}]',
+ 'title' => 'Delete rule category ',
+ 'summary' => 'Deletes a rule category.',
+ 'requestParamsDescription' => '**Information about the JsonStr request parameter**'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| :------- | :--------- | :------- | :--------------------------- |'."\n"
+ .'| type | Integer | Yes | The ID of the rule category. |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '### Sample invocation '."\n"
+ .'``` '."\n"
+ .' DelRuleCategoryRequest delRuleCategoryRequest = new DelRuleCategoryRequest(); '."\n"
+ .' delRuleCategoryRequest.setAcceptFormat(FormatType.JSON); '."\n"
+ .' Map<String, Object> map = Maps.newHashMap(); '."\n"
+ .' map.put("type", 1); '."\n"
+ .' delRuleCategoryRequest.setJsonStr(JSON.toJSONString(map)); '."\n"
+ .' DelRuleCategoryReqsponse response = client.getAcsResponse(delRuleCategoryRequest); '."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DelRuleCategory'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'UpdateQualityCheckScheme' => [
- 'summary' => '更新质检方案',
- 'methods' => [
- 'post',
- 'get',
+ 'DeleteAgent' => [
+ 'summary' => 'Deletes an agent.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREscaFRLL5D'],
],
+ 'parameters' => [
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'baseMeAgentId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''],
+ ],
+ [
+ 'name' => 'JsonStr',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'A JSON-formatted string. For more information about the complete JSON string, see the following details.', 'type' => 'string', 'required' => false, 'example' => '{\\"id\\":486}', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E'],
+ 'Code' => ['description' => 'The status code. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message, if any.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true: The request was successful. false/null: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => ['description' => 'The returned data.', 'type' => 'boolean', 'example' => '无', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Delete an agent',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'DeleteAsrVocab' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'deprecated' => false,
+ 'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
- 'name' => 'jsonStr',
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A complete JSON string. For details, see the table below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"vocabId":"指定热词Id"}', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'BaseMeAgentId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The result code. A value of **200** means success. Any other value means failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Details about the error if the request fails. If the request succeeds, the value is **successful**.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'The hotword ID you specified as vocabId.', 'type' => 'string', 'example' => '71b1795ac8634bd8bdf4d3878480c7c2', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4987D326-83D9-4A42-B9A5-0B27F9B40539', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Use this field to check the result:'."\n"
+ ."\n"
+ .'- **true** means success.'."\n"
+ ."\n"
+ .'- false or **null** means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => false,
+ 'title' => '',
'example' => '',
],
],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"71b1795ac8634bd8bdf4d3878480c7c2\\",\\n \\"RequestId\\": \\"4987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Delete a hotword group',
+ 'summary' => 'Deletes a hotword group.',
+ 'requestParamsDescription' => '**Request parameter JSON string**'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------- | :----- | :------- | :-------------- |'."\n"
+ .'| vocabId | String | Yes | The hotword ID. |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:54.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteAsrVocab'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'DeleteBusinessCategory' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the details below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"bid ":"适用业务ID"}', 'title' => ''],
+ ],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BaseResult',
- 'description' => 'BaseResult',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '96138D8D-8D26-4E41-BFF4-77AED1088BBD',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Messages' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates that the request was successful. Other values indicate that the request failed. Use this field to determine the cause of the failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'If the request fails, this parameter returns the error details. If the request is successful, this parameter returns **successful**.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'The returned result.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4987D326-83D9-4A42-B9A5-0B27F9B40539', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.'."\n"
+ ."\n"
+ .'Use this field to determine whether the request was successful:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- false or **null**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"96138D8D-8D26-4E41-BFF4-77AED1088BBD\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"4987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Delete the applicable business',
+ 'summary' => 'Deletes a business category.',
+ 'requestParamsDescription' => '**Details of the JsonStr request parameter**'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| :------- | :--------- | :------- | :------------------------ |'."\n"
+ .'| bid | Integer | Yes | The business category ID. |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteBusinessCategory'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'GetQualityCheckScheme' => [
- 'summary' => '获取质检方案',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteCheckTypeToScheme' => [
+ 'summary' => 'Deletes a dimension from a quality inspection scheme.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4630,523 +3954,334 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
- 'abilityTreeCode' => '153732',
- 'abilityTreeNodes' => [
- 'FEATUREscaKR8LQC',
- 'FEATUREsca6QWO0D',
- ],
+ 'abilityTreeCode' => '251541',
+ 'abilityTreeNodes' => ['FEATUREscaKR8LQC', 'FEATUREsca6QWO0D'],
],
'parameters' => [
[
- 'name' => 'jsonStr',
+ 'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"schemeId":"187","ruleRequireInfos":["BusinessNameInfo","RuleCategory"]}',
- ],
+ 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''],
],
[
- 'name' => 'BaseMeAgentId',
+ 'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'A JSON string that contains the custom parameters for the operation. For more information, see the **jsonStr properties** section below.', 'type' => 'string', 'required' => false, 'example' => '{"schemeId":"1376","checkType":"4"}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<QualityCheckScheme>',
- 'description' => 'PlainResult<QualityCheckScheme>',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'SchemeId' => [
- 'title' => '质检方案id',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '112**',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SchemeTemplateId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'DataType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Type' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TemplateType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RuleIds' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1302493',
- ],
- ],
- 'RuleList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- '$ref' => '#/components/schemas/RulesInfo',
- ],
- ],
- 'CreateUserName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1616113198000',
- ],
- 'UpdateUserName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'UpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1616113198000',
- ],
- 'Version' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1616113198000',
- ],
- 'SchemeCheckTypeList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'CheckType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'CheckName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SourceScore' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Score' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'Enable' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'SchemeId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '32',
- ],
- ],
- ],
- ],
- 'InitScore' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '96138D8D-8D26-4E41-BFF4-77AED1088BBD',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E'],
+ 'Success' => ['description' => 'Indicates whether the request was successful. A value of true indicates success. A value of false or null indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => ['description' => 'The returned data.', 'type' => 'string', 'example' => '48864', 'title' => ''],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates that the request was successful. Other values indicate that the request failed.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned. If the request is successful, \\`successful\\` is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'Messages' => [
- 'description' => '',
+ 'description' => 'A list of returned messages.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'items' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"SchemeId\\": 0,\\n \\"Name\\": \\"xxx\\",\\n \\"Description\\": \\"售前使用\\",\\n \\"SchemeTemplateId\\": 1,\\n \\"DataType\\": 1,\\n \\"Type\\": 1,\\n \\"TemplateType\\": 1,\\n \\"Status\\": 1,\\n \\"RuleIds\\": [\\n \\"1302493\\"\\n ],\\n \\"RuleList\\": [\\n {\\n \\"Conditions\\": [\\n {\\n \\"Cid\\": \\"\\",\\n \\"Id\\": 0,\\n \\"Rid\\": \\"\\",\\n \\"Check_range\\": {\\n \\"RoleId\\": 0,\\n \\"Role\\": \\"\\",\\n \\"Anchor\\": {\\n \\"Cid\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"Hit_time\\": 0\\n },\\n \\"Range\\": {\\n \\"From\\": 0,\\n \\"To\\": 0\\n },\\n \\"Absolute\\": true,\\n \\"AllSentencesSatisfy\\": true\\n },\\n \\"Operators\\": [\\n {\\n \\"Oid\\": \\"\\",\\n \\"Id\\": 0,\\n \\"Type\\": \\"\\",\\n \\"Param\\": {\\n \\"CustomerParam\\": {\\n \\"Field\\": \\"\\",\\n \\"FieldType\\": 0,\\n \\"DataType\\": 0,\\n \\"Symbol\\": 0,\\n \\"Value\\": \\"\\",\\n \\"ActualValue\\": \\"\\",\\n \\"ExpressionMetaDesc\\": {\\n \\"LeftFieldType\\": 0,\\n \\"LeftOperand\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"RightFieldType\\": 0,\\n \\"RightOperand\\": \\"\\",\\n \\"RoundingMode\\": \\"\\"\\n }\\n },\\n \\"Keywords\\": [\\n \\"\\"\\n ],\\n \\"Regex\\": \\"\\",\\n \\"NotRegex\\": \\"\\",\\n \\"Phrase\\": \\"\\",\\n \\"References\\": [\\n \\"\\"\\n ],\\n \\"Interval\\": 0,\\n \\"IntervalEnd\\": 0,\\n \\"Threshold\\": 0,\\n \\"In_sentence\\": true,\\n \\"Target\\": 0,\\n \\"From_end\\": true,\\n \\"Different_role\\": true,\\n \\"Target_role\\": \\"\\",\\n \\"RoleId\\": 0,\\n \\"Velocity\\": 0,\\n \\"VelocityInMint\\": 0,\\n \\"KeywordExtension\\": 0,\\n \\"Synonyms\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n },\\n \\"Case_sensitive\\": true,\\n \\"Near_dialogue\\": true,\\n \\"MinWordSize\\": 0,\\n \\"Hit_time\\": 0,\\n \\"Excludes\\": [\\n \\"\\"\\n ],\\n \\"From\\": 0,\\n \\"CheckFirstSentence\\": true,\\n \\"Average\\": true,\\n \\"BeginType\\": \\"\\",\\n \\"EndType\\": \\"\\",\\n \\"CompareOperator\\": \\"\\",\\n \\"Pkey\\": \\"\\",\\n \\"Poutput_type\\": 0,\\n \\"SimilarlySentences\\": [\\n \\"\\"\\n ],\\n \\"LgfSentences\\": [\\n \\"\\"\\n ],\\n \\"Score\\": 0,\\n \\"ContextChatMatch\\": true,\\n \\"KeywordMatchSize\\": 0,\\n \\"MaxEmotionChangeValue\\": 0,\\n \\"CheckType\\": 0,\\n \\"KnowledgeTargetId\\": \\"\\",\\n \\"CategoryPathCode\\": \\"\\",\\n \\"KnowledgeTargetType\\": 0,\\n \\"KnowledgeTargetName\\": \\"\\",\\n \\"QuestionThreshold\\": \\"\\",\\n \\"AnswerThreshold\\": \\"\\",\\n \\"KnowledgeSentenceNum\\": 0,\\n \\"KnowledgeInfo\\": \\"\\",\\n \\"BotId\\": \\"\\",\\n \\"UseEasAlgorithm\\": true,\\n \\"Pvalues\\": [\\n \\"\\"\\n ],\\n \\"Similarity_threshold\\": 0,\\n \\"AntModelInfo\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"DelayTime\\": 0,\\n \\"Knowledges\\": \\"\\",\\n \\"LlmModelCode\\": \\"\\",\\n \\"HitCondition\\": \\"\\",\\n \\"SceneName\\": \\"\\",\\n \\"Dimensions\\": [\\n {\\n \\"Dimension\\": \\"\\",\\n \\"Desc\\": \\"\\",\\n \\"ExcludeCondition\\": \\"\\",\\n \\"IncludeCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\",\\n \\"QualityCheckType\\": 0\\n }\\n ],\\n \\"Lambda\\": \\"\\",\\n \\"Exclusion\\": 0,\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\"\\n }\\n ],\\n \\"Rules\\": [\\n {\\n \\"Status\\": 0,\\n \\"IsDelete\\": 0,\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"Weight\\": \\"\\",\\n \\"IsOnline\\": 0,\\n \\"CreateEmpid\\": \\"\\",\\n \\"CreateEmpName\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"LastUpdateTime\\": \\"\\",\\n \\"LastUpdateEmpid\\": \\"\\",\\n \\"LastUpdateEmpName\\": \\"\\",\\n \\"Comments\\": \\"\\",\\n \\"Deny\\": 0,\\n \\"ScoreSubId\\": 0,\\n \\"ScoreName\\": \\"\\",\\n \\"ScoreSubName\\": \\"\\",\\n \\"ScoreNum\\": 0,\\n \\"ScoreType\\": 0,\\n \\"ScoreDeleted\\": true,\\n \\"OperationMode\\": 0,\\n \\"Meet\\": 0,\\n \\"Effective\\": 0,\\n \\"FullCycle\\": 0,\\n \\"EffectiveStartTime\\": \\"\\",\\n \\"EffectiveEndTime\\": \\"\\",\\n \\"QualityCheckType\\": 0,\\n \\"Level\\": 0,\\n \\"GraphFlow\\": \\"\\",\\n \\"TaskFlowType\\": 0,\\n \\"CheckType\\": 0,\\n \\"SchemeCheckType\\": {\\n \\"CheckType\\": 0,\\n \\"CheckName\\": \\"\\",\\n \\"SourceScore\\": 0,\\n \\"Score\\": 0,\\n \\"Enable\\": 0,\\n \\"SchemeId\\": 0,\\n \\"SchemeScoreInfoList\\": [\\n {\\n \\"Rid\\": 0,\\n \\"Name\\": \\"\\",\\n \\"TaskFlowId\\": 0,\\n \\"TaskFlowName\\": \\"\\",\\n \\"ScoreType\\": 0,\\n \\"ScoreNumType\\": 0,\\n \\"ScoreNum\\": 0,\\n \\"ScoreRuleHitType\\": 0\\n }\\n ],\\n \\"TaskFlowScoreInfoList\\": [\\n {\\n \\"TaskFlowId\\": 0,\\n \\"TaskFlowName\\": \\"\\",\\n \\"TaskFlowType\\": 0,\\n \\"SchemeScoreInfoList\\": [\\n {\\n \\"Rid\\": 0,\\n \\"Name\\": \\"\\",\\n \\"TaskFlowId\\": 0,\\n \\"TaskFlowName\\": \\"\\",\\n \\"ScoreType\\": 0,\\n \\"ScoreNumType\\": 0,\\n \\"ScoreNum\\": 0,\\n \\"ScoreRuleHitType\\": 0\\n }\\n ]\\n }\\n ]\\n },\\n \\"TargetType\\": 0,\\n \\"ConfigType\\": 0,\\n \\"ScoreNumType\\": 0,\\n \\"ScoreRuleHitType\\": 0,\\n \\"SchemeId\\": 0,\\n \\"SchemeRuleMappingId\\": 0,\\n \\"SchemeName\\": \\"\\",\\n \\"ModifyType\\": 0,\\n \\"SortIndex\\": 0,\\n \\"RuleType\\": 0,\\n \\"Rid\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"TaskFlowId\\": 0,\\n \\"Lambda\\": \\"\\",\\n \\"ExternalProperty\\": 0,\\n \\"Type\\": 0,\\n \\"RuleCategoryName\\": \\"\\",\\n \\"AutoReview\\": 0,\\n \\"RuleScoreType\\": 0,\\n \\"ScoreId\\": 0,\\n \\"PreqRule\\": {\\n \\"Rid\\": \\"\\"\\n },\\n \\"BusinessCategoryNameList\\": [\\n \\"\\"\\n ],\\n \\"Dialogues\\": [\\n {\\n \\"Id\\": 0,\\n \\"Content\\": [\\n {\\n \\"HourMinSec\\": \\"\\",\\n \\"Role\\": \\"\\",\\n \\"Identity\\": \\"\\",\\n \\"EmotionValue\\": 0,\\n \\"SpeechRate\\": 0,\\n \\"Words\\": \\"\\",\\n \\"End\\": 0,\\n \\"SilenceDuration\\": 0,\\n \\"BeginTime\\": 0,\\n \\"Begin\\": 0\\n }\\n ],\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\"\\n }\\n ],\\n \\"Triggers\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"Dialogues\\": [\\n {\\n \\"Id\\": 0,\\n \\"Content\\": [\\n {\\n \\"HourMinSec\\": \\"\\",\\n \\"Role\\": \\"\\",\\n \\"Identity\\": \\"\\",\\n \\"EmotionValue\\": 0,\\n \\"SpeechRate\\": 0,\\n \\"Words\\": \\"\\",\\n \\"End\\": 0,\\n \\"SilenceDuration\\": 0,\\n \\"BeginTime\\": 0,\\n \\"Begin\\": 0\\n }\\n ],\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\"\\n }\\n ],\\n \\"Count\\": 0,\\n \\"PageSize\\": 0,\\n \\"PageNumber\\": 0\\n }\\n ],\\n \\"CreateUserName\\": \\"xxx\\",\\n \\"CreateTime\\": \\"1616113198000\\",\\n \\"UpdateUserName\\": \\"xxx\\",\\n \\"UpdateTime\\": \\"1616113198000\\",\\n \\"Version\\": 1616113198000,\\n \\"SchemeCheckTypeList\\": [\\n {\\n \\"CheckType\\": 0,\\n \\"CheckName\\": \\"服务规范性检测\\",\\n \\"SourceScore\\": 10,\\n \\"Score\\": 20,\\n \\"Enable\\": 1,\\n \\"SchemeId\\": 32\\n }\\n ],\\n \\"InitScore\\": \\"100\\"\\n },\\n \\"RequestId\\": \\"96138D8D-8D26-4E41-BFF4-77AED1088BBD\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": [\\n \\"xxx\\"\\n ],\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"48864\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": [\\n \\"xxx\\"\\n ]\\n}","type":"json"}]',
+ 'title' => 'Delete a quality inspection scheme dimension ',
+ 'requestParamsDescription' => '| Property | Type | Required | Description | Example |'."\n"
+ .'| --------- | ---- | -------- | ---------------------------------------- | ------- |'."\n"
+ .'| schemeId | Long | Yes | The ID of the quality inspection scheme. | 187 |'."\n"
+ .'| checkType | Long | Yes | The quality inspection dimension. | 1 |',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'ListQualityCheckScheme' => [
- 'summary' => '质检方案列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteCustomizationConfig' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
+ 'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
+ 'schema' => ['description' => 'A complete JSON string. For details, see the table that follows.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"modelId":"2412"}', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The result code. A value of **200** means the call succeeded. Any other value means the call failed. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Details about the error if the call fails. If the call succeeds, this value is **successful**.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'The model ID.', 'type' => 'string', 'example' => '252', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9987D326-83D9-4A42-B9A5-0B27F9B40539', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Use this field to check the result: true means success and **false** or **null** means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
+ 'title' => '',
'example' => '',
],
],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"252\\",\\n \\"RequestId\\": \\"9987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Delete Language Model',
+ 'summary' => 'Deletes a language model.',
+ 'requestParamsDescription' => '## Request parameters'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------- | :--- | :------- | :------------ |'."\n"
+ .'| modelId | Long | Yes | The model ID. |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCustomizationConfig'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'DeleteDataSet' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '56154',
+ 'abilityTreeNodes' => ['FEATUREsca81P1AQ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A complete JSON string. For details, see the following information.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"setId":"234"}', 'title' => ''],
+ ],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The result code. **200** indicates success. Other values indicate failure. The caller can determine the cause of failure based on this field.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if an error occurs, or **successful** if the operation succeeds.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '9987D326-83D9-4A42-B9A5-0B27F9B40539', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. The caller can determine if the request was successful based on this field: **true** indicates success, and **false/null** indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
+ 'staticInfo' => ['noSubstitutionReason' => '暂无替代API,请关注后续API最新发布。'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"9987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Delete a dataset',
+ 'summary' => 'Deletes a dataset.',
+ 'requestParamsDescription' => '**Details of the request parameter JSON string**'."\n"
+ ."\n"
+ .'| Property | Value Type | Required | Description |'."\n"
+ .'| :------- | :--------- | :------- | :---------- |'."\n"
+ .'| setId | Long | Yes | Dataset ID. |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-11-05T08:04:48.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDataSet'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'DeletePrecisionTask' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A complete JSON string. For details, see the input parameter description below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"{"taskId": "7C1DEF5F-2C18-4D36-99C6*******"}"', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4*** ',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ResultCountId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Count' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '22',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'SchemeId' => [
- 'title' => '质检方案Id',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '112**',
- ],
- 'Name' => [
- 'title' => '质检方案名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Description' => [
- 'title' => '描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'DataType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Type' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TemplateType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CreateUserName' => [
- 'title' => '创建人',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2022-05-10T09:34Z',
- ],
- 'UpdateUserName' => [
- 'title' => '更新人',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'UpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2022-05-10T10:34Z',
- ],
- 'SchemeCheckTypeList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'CheckType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Enable' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CheckName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'TargetType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Score' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- ],
- ],
- ],
- 'RuleList' => [
- 'title' => '规则列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Rules' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Rid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'RuleScoreType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ScoreNum' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'ScoreType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CheckType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TargetType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'ScoreNumType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'Version' => [
- 'title' => '质检方案版本',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message if the request fails. If the request succeeds, the value is successful.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. A value of true means success. A value of false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4***\\\\t\\",\\n \\"Success\\": true,\\n \\"ResultCountId\\": \\"XXX\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Count\\": 22,\\n \\"Data\\": [\\n {\\n \\"SchemeId\\": 0,\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"售前使用\\",\\n \\"DataType\\": 1,\\n \\"Type\\": 1,\\n \\"TemplateType\\": 1,\\n \\"Status\\": 1,\\n \\"CreateUserName\\": \\"张三\\",\\n \\"CreateTime\\": \\"2022-05-10T09:34Z\\",\\n \\"UpdateUserName\\": \\"李四\\",\\n \\"UpdateTime\\": \\"2022-05-10T10:34Z\\",\\n \\"SchemeCheckTypeList\\": [\\n {\\n \\"CheckType\\": 1,\\n \\"Enable\\": 1,\\n \\"CheckName\\": \\"服务规范性检测\\",\\n \\"TargetType\\": 10,\\n \\"Score\\": 20\\n }\\n ],\\n \\"RuleList\\": [\\n {\\n \\"Rules\\": [\\n {\\n \\"Rid\\": 12,\\n \\"Name\\": \\"测试规则\\",\\n \\"RuleScoreType\\": 1,\\n \\"ScoreNum\\": 2,\\n \\"ScoreType\\": 1,\\n \\"CheckType\\": 1,\\n \\"TargetType\\": 10,\\n \\"ScoreNumType\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Version\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListQualityCheckSchemeResponse>\\n <RequestId>82C91484-B2D5-4D2A-A21F-A6D73F4***\\t</RequestId>\\n <Success>true</Success>\\n <ResultCountId>XXX</ResultCountId>\\n <Code>200</Code>\\n <Message>successful</Message>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <Count>22</Count>\\n <Data>\\n <Name>test</Name>\\n <Description>售前使用</Description>\\n <DataType>1</DataType>\\n <Type>1</Type>\\n <TemplateType>1</TemplateType>\\n <Status>1</Status>\\n <CreateUserName>张三</CreateUserName>\\n <CreateTime>2022-05-10T09:34Z</CreateTime>\\n <UpdateUserName>李四</UpdateUserName>\\n <UpdateTime>2022-05-10T10:34Z</UpdateTime>\\n <SchemeCheckTypeList>\\n <CheckType>1</CheckType>\\n <Enable>1</Enable>\\n <CheckName>服务规范性检测</CheckName>\\n <TargetType>10</TargetType>\\n <Score>20</Score>\\n </SchemeCheckTypeList>\\n <RuleList>\\n <Rules>\\n <Rid>12</Rid>\\n <Name>测试规则</Name>\\n <RuleScoreType>1</RuleScoreType>\\n <ScoreNum>2</ScoreNum>\\n <ScoreType>1</ScoreType>\\n <CheckType>1</CheckType>\\n </Rules>\\n </RuleList>\\n </Data>\\n</ListQualityCheckSchemeResponse>","errorExample":""}]',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Delete a speech recognition detection job',
+ 'summary' => 'Delete a speech recognition quality check task.',
+ 'requestParamsDescription' => '## Input parameters'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------- | :----- | :------- | :---------------------------- |'."\n"
+ .'| taskId | String | Yes | The ID of the task to delete. |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeletePrecisionTask'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
'DeleteQualityCheckScheme' => [
- 'summary' => '删除质检方案',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'You can delete a quality check plan from the Quality Check Plan Management page by clicking the Delete button on the right side of the plan. The Apsara Stack API endpoint is ip:port/api/qcs/DeleteQualityCheckScheme.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5158,23 +4293,12 @@
[
'name' => 'jsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"schemeId":191}',
- ],
+ 'schema' => ['description' => 'JSON request body. For details, see the parameter description below.', 'type' => 'string', 'required' => false, 'example' => '{"schemeId":191}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -5184,162 +4308,204 @@
'description' => 'BaseResult',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. If true, the request succeeded. If **false** or **null**, the request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. A value of 200 means success. Any other value means failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request failed. Returns "successful" if the request succeeded.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'Messages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Message' => [
- 'description' => '',
+ 'description' => 'List of messages. Ignore this field.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- ],
+ 'items' => ['description' => 'A message. Ignore this field.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'HttpStatusCode' => [
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Delete Quality Check Scheme ',
+ 'requestParamsDescription' => '### About jsonStr'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| -------- | ------- | -------- | --------------------- |'."\n"
+ .'| schemeId | Integer | Yes | Quality check plan ID |',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteQualityCheckScheme'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'UpdateRuleToScheme' => [
- 'summary' => '更新质检方案的规则',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteRule' => [
+ 'summary' => 'This operation deletes a quality check rule. You can access it from the Quality Check Rule Configuration page in the Apsara Stack console. The API endpoint is ip:port/api/client/DeleteRule.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [],
+ 'operationType' => 'write',
+ 'deprecated' => true,
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'jsonStr',
- 'in' => 'query',
+ 'name' => 'RuleId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'ForceDelete',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Whether to delete the rule even if it is associated with a quality check task.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'IsSchemeData',
+ 'in' => 'formData',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'Indicates whether this is the new version of quality check. 0: old version. 1: new version. Default is 1.',
+ 'enumValueTitles' => ['Old version quality check', 'New version quality check'],
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'example' => '{"schemeId":"10","schemeRules":[{"ruleId":229,"checkType":0}]}',
+ 'default' => '1',
+ 'example' => '1',
+ 'title' => '',
],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Long>',
- 'description' => 'PlainResult<Long>',
+ 'title' => 'BaseResult',
+ 'description' => 'BaseResult',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '30',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9987D326-83D9-4A42-B9A5-0B27F9B40539',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Use this field to determine request status: true means success. **false** or **null** means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. **200** indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Details of the error if the request failed. If the request succeeded, the value is "successful".', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'Messages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Message' => [
- 'description' => '',
+ 'description' => 'Provides the details of an error. This field is returned when the Outputs parameter contains multiple messages.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- ],
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'HttpStatusCode' => [
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 30,\\n \\"RequestId\\": \\"9987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- ],
- 'CreateCheckTypeToScheme' => [
- 'summary' => '创建质检方案中的质检维度',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => [
+ 'substitutions' => ['Qualitycheck::2019-01-15::DeleteRuleV4'],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Delete Quality Inspection Rule ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-10-20T03:53:04.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-10-08T08:23:12.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteRule'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'DeleteRuleV4' => [
+ 'summary' => 'Frontend feature location: Quality Inspection Rule Configuration — Delete. Apsara Stack URL: ip:port/api/client/DeleteRule.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5349,313 +4515,372 @@
'systemTags' => [],
'parameters' => [
[
- 'name' => 'jsonStr',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'name' => 'RuleId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'ForceDelete',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Whether to delete the rule even if it is associated with quality inspection tasks.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Long>',
- 'description' => 'PlainResult<Long>',
+ 'title' => 'BaseResult',
+ 'description' => 'BaseResult',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Callers can use this field to determine if the request succeeded: true means success; false/null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The result code. **200** indicates success. Other values indicate failure. Callers can use this field to determine the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Provides error details if an error occurs. If successful, the value is **successful**.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'Messages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Message' => [
- 'description' => '',
+ 'description' => 'Provides error details if an error occurs. Use this field when multiple messages are output.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'items' => ['description' => 'Provides error details if an error occurs. Use this field when multiple messages are output.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'HttpStatusCode' => [
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 5,\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Delete Rule (New Quality Inspection) ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-10-21T01:28:25.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteRuleV4'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'UpdateCheckTypeToScheme' => [
- 'summary' => '更新质检方案中的质检维度',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteSchemeTaskConfig' => [
+ 'summary' => 'This feature is not available on the frontend. The Apsara Stack API endpoint is ip:port/api/task/DeleteSchemeTaskConfig.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'jsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'A JSON object that contains the request parameters. For more information, see the parameter details.', 'type' => 'string', 'required' => false, 'example' => '{"schemeId":"329"}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Long>',
- 'description' => 'PlainResult<Long>',
+ 'title' => 'BaseResult',
+ 'description' => 'BaseResult',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4D55C6', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. A value of true indicates success. A value of false or null indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The status code of the response. A value of **200** indicates that the request was successful. Other values indicate that the request failed.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the request. If the request is successful, successful is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'Messages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Message' => [
- 'description' => '',
+ 'description' => 'A list of messages. This parameter can be ignored.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- ],
+ 'items' => ['description' => 'A message. This parameter can be ignored.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'HttpStatusCode' => [
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code. A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 4,\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Delete Quality Inspection Job ',
+ 'requestParamsDescription' => '### JsonStr details'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| -------- | ---------- | -------- | ---------------------------- |'."\n"
+ .'| schemeId | Long | Yes | The quality check scheme ID. |',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSchemeTaskConfig'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'AddRuleCategory' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteSkillGroupConfig' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
+ 'deprecated' => true,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '56157',
+ 'abilityTreeNodes' => ['FEATUREscaKR8LQC', 'FEATUREsca6QWO0D'],
],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
+ 'schema' => ['description' => 'Full JSON string. For details, see the following table.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"id":552}', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'Result code. A value of 200 indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the call fails. Returns successful if the call succeeds.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** ', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. A value of true means success. A value of false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
+ 'title' => '',
'example' => '',
],
],
+ ],
+ 'staticInfo' => ['noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Delete Configuration',
+ 'summary' => 'Delete a configuration.',
+ 'requestParamsDescription' => '## JSON string for request parameters'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------- | :------ | :------- | :--------------- |'."\n"
+ .'| id | Integer | Yes | Configuration ID |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-29T06:47:50.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:53.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSkillGroupConfig'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'DeleteTag' => [
+ 'summary' => 'Deletes a label node.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREsca27EUYZ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A complete JSON string. For more information, see the following detailed information.', 'type' => 'string', 'required' => false, 'example' => '“”', 'title' => ''],
+ ],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The ID of the business space.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Select' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => '',
- ],
- 'Type' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***'],
+ 'Code' => ['description' => 'The response code. **200** indicates success. Other values indicate failure. You can use this field to determine the cause of the failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. true: The call was successful. false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Message' => ['description' => 'The error message, if any.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"D10B9203-1A6A-49DA-AE56-4D160DD37DBC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Select\\": false,\\n \\"Type\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddRuleCategoryResponse>\\r\\n <Data>\\r\\n <Select>false</Select>\\r\\n </Data>\\r\\n <Message>successful</Message>\\r\\n <RequestId>D10B9203-1A6A-49DA-AE56-4D160DD37DBC</RequestId>\\r\\n <Success>true</Success>\\r\\n <Code>200</Code>\\r\\n</AddRuleCategoryResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- ],
- 'GetRuleCategory' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Delete a label node',
+ 'requestParamsDescription' => '| Field | Type | Required | Example | Description |'."\n"
+ .'|------|------|------|------|------|'."\n"
+ .'| tagId | Long | Yes | 100231 | The ID of the label node to delete. |',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteTaskAssignRule' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '""',
- ],
+ 'schema' => ['description' => 'A complete JSON string. For details, see the input parameter description below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"ruleId": 24}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -5663,76 +4888,70 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'RuleCountInfo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '22',
- ],
- 'TypeName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Select' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => 'The result code. **200** means the operation succeeded. Any other value means the operation failed. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error details if the operation failed. If the operation succeeded, the value is successful.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. A value of true means success. A value of false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RuleCountInfo\\": [\\n {\\n \\"Type\\": 22,\\n \\"TypeName\\": \\"客服组\\",\\n \\"Select\\": false\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message>successful</Message>\\n<RequestId>85CE3532-DC0D-4EE8-B4F1-563A377BAC51</RequestId>\\n<Data>\\n <RuleCountInfo>\\n <Type>1</Type>\\n <TypeName>服务规范</TypeName>\\n <Select>false</Select>\\n </RuleCountInfo>\\n <RuleCountInfo>\\n <Type>29</Type>\\n <TypeName>类型1</TypeName>\\n <Select>false</Select>\\n </RuleCountInfo>\\n <RuleCountInfo>\\n <Type>30</Type>\\n <TypeName>类型2</TypeName>\\n <Select>false</Select>\\n </RuleCountInfo>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]',
- 'requestParamsDescription' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Delete the automatic allocation rule for review tasks ',
+ 'summary' => 'Deletes an automatic allocation rule for review tasks.',
+ 'requestParamsDescription' => '## Input parameters'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------- | :--- | :------- | :------------------------------------------------------------------ |'."\n"
+ .'| ruleId | Long | Yes | The ID of the automatic allocation rule for review tasks to delete. |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteTaskAssignRule'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'DelRuleCategory' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteWarningConfig' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5744,1746 +4963,1840 @@
[
'name' => 'JsonStr',
'in' => 'query',
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the details below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"configId": "31"}', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The result code. A value of **200** indicates that the request was successful. Other values indicate that the request failed. You can use this field to determine the cause of the failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'If the request fails, this field provides the error details. If the request is successful, the value is \\`successful\\`.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4D55C6', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success. A value of \\`false\\` or \\`null\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
+ 'title' => '',
'example' => '',
],
],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Delete Alert Configuration',
+ 'summary' => 'Deletes a warning configuration.',
+ 'requestParamsDescription' => '## Request parameter details'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------- | :--- | :------- | :--------------------------------------------- |'."\n"
+ .'| configId | Long | Yes | The ID of the warning configuration to delete. |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteWarningConfig'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'ExecuteAgent' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREscaFRLL5D'],
+ ],
+ 'parameters' => [
[
'name' => 'BaseMeAgentId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the business workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''],
+ ],
+ [
+ 'name' => 'JsonStr',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the following detailed description.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''],
+ ],
+ [
+ 'name' => 'Stream',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Specifies whether to enable Server-Sent Events (SSE) responses. Set to true to enable SSE responses. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E'],
+ 'Code' => ['description' => 'The status code. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when an error occurs.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. The caller can use this field to determine whether the request was successful. Valid values: **true**: The request was successful. **false/null**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The returned result.',
'type' => 'object',
'properties' => [
- 'Select' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'LlmRequestId' => ['description' => 'The request ID returned by the large language model service.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***', 'title' => ''],
+ 'FinishReason' => ['description' => 'If streaming output is used, this value is null during generation. When generation is complete, the value is stop if the generation ended due to a stop token.', 'type' => 'string', 'example' => 'stop', 'title' => ''],
+ 'Text' => ['description' => 'The result returned by the large language model.', 'type' => 'string', 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。', 'title' => ''],
+ 'InputTokens' => ['description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'OutputTokens' => ['description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'TotalTokens' => ['description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '300', 'title' => ''],
+ 'TyxmTurboCount' => ['description' => 'The number of times the turbo model was used.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'TyxmPlusCount' => ['description' => 'The number of times the plus model was used.', 'type' => 'string', 'example' => '1', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"xxx\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Select\\": false\\n }\\n}","errorExample":""},{"type":"xml","example":"<DelRuleCategoryResponse>\\r\\n <code>200</code>\\r\\n <data>\\r\\n <select>false</select>\\r\\n </data>\\r\\n <message>successful</message>\\r\\n <requestId>xxx</requestId>\\r\\n <success>true</success>\\r\\n</DelRuleCategoryResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid Param %s .', 'description' => 'Illegal parameter'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Run an agent',
+ 'summary' => 'Runs an agent.',
+ 'requestParamsDescription' => '## 1. Overview'."\n"
+ ."\n"
+ .'**Scenarios:** When you invoke the `ExecuteAgent` operation, serialize the fields of this class into JSON and pass them in. The server routes to different instruction processors (key attribute extraction, service inspection, tag classification, and others) based on the `instructionType` value.'."\n"
+ .'---'."\n"
+ ."\n"
+ .'## 2. Top-level field description'."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `vid` | `String` | No | The session ID. If not specified, a value is automatically generated based on the current timestamp. |'."\n"
+ .'| `modelType` | `String` | Yes | The large language model type. |'."\n"
+ .'| `agentId` | `Long` | Yes | The agent configuration ID. |'."\n"
+ .'| `inputType` | `String` | Yes | The type of the analysis object. Valid values: text |'."\n"
+ .'| `instructionType` | `String` | Yes | The instruction type. Valid values: serviceInspection: service inspection. field: key attribute extraction. tagCategory: tag classification. customPrompt: custom instruction. |'."\n"
+ .'| `instructionTypeParam` | `InstructionTypeParam` | Yes | The parameters corresponding to the instruction type. Different `instructionType` values require different sub-parameters. For more information, see §4.1. |'."\n"
+ .'| `taskParam` | `TaskParam` | Yes | The task data parameters, which contain text dialogue or audio file information. For more information, see §3.1. |'."\n"
+ .'## 3. Detailed description of nested classes.'."\n"
+ ."\n"
+ .'### 3.1 TaskParam — Task data parameters'."\n"
+ ."\n"
+ .'`AgentTaskParam.TaskParam` carries the input data for the current task. Different sub-parameters are used based on the `inputType` value.'."\n"
+ ."\n"
+ .'| Field | Type | Description |'."\n"
+ .'|--------|------|------|'."\n"
+ .'| `textParam` | `TextParam` | The text parameters. Used when `inputType = "text"`. |'."\n"
+ .'| `callbackUrl` | `String` | The callback URL for notification after the task is complete. Optional. |'."\n"
+ ."\n"
+ .'### 3.2 TextParam — Text parameters'."\n"
+ ."\n"
+ .'`AgentTaskParam.TextParam` encapsulates text-type input data.'."\n"
+ ."\n"
+ .'| Field | Type | Description |'."\n"
+ .'|--------|------|------|'."\n"
+ .'| `dialogue` | `List<Dialogue>` | The dialogue list. Each comment is a `Dialogue` object. |'."\n"
+ ."\n"
+ .'**Dialogue object structure:**'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `role` | `String` | Yes | The speaker role, such as `"客户"` / `"客服"`. |'."\n"
+ .'| `words` | `String` | Yes | The dialogue text content. |'."\n"
+ .'| `identity` | `String` | No | The speaker identity, such as the agent ID. |'."\n"
+ .'| `begin` | `Long` | No | The relative offset of the start time of this sentence, in milliseconds. |'."\n"
+ .'| `end` | `Long` | No | The relative offset of the end time of this sentence, in milliseconds. |'."\n"
+ .'| `beginTime` | `Date` | No | The absolute start time of this sentence (`yyyy-MM-dd HH:mm:ss`). |'."\n"
+ .'| `hourMinSec` | `String` | No | The time in `HH:mm:ss` format. Required for phone call scenarios. |'."\n"
+ .'| `emotionValue` | `Integer` | No | The emotion energy value (1-10). |'."\n"
+ .'| `speechRate` | `Integer` | No | The speech rate in words per minute. |'."\n"
+ .'| `silenceDuration` | `Integer` | No | The silence duration in seconds. |'."\n"
+ ."\n"
+ .'---'."\n"
+ .'## 4. InstructionTypeParam — Detailed description of instruction parameters'."\n"
+ ."\n"
+ .'`AgentManageParam.InstructionTypeParam` carries different instruction configuration parameters based on the `instructionType` value. **You only need to specify the sub-parameters corresponding to the current `instructionType`. Leave the other fields empty.**'."\n"
+ ."\n"
+ .'### 4.1 FieldsParam — Key attribute extraction (`instructionType = "field"`)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `nameDescPairList` | `List<NameDescPair>` | Yes | The list of attribute dimensions to extract. |'."\n"
+ ."\n"
+ .'**NameDescPair structure:**'."\n"
+ ."\n"
+ .'| Field | Type | Description |'."\n"
+ .'|--------|------|------|'."\n"
+ .'| `name` | `String` | The attribute name. Required. |'."\n"
+ .'| `desc` | `String` | The attribute description. Optional. |'."\n"
+ ."\n"
+ .'### 4.2 ServiceInspectionParam — Service inspection (`instructionType = "serviceInspection"`)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `sceneName` | `String` | Yes | The name of the inspection scenario. |'."\n"
+ .'| `sceneDescription` | `String` | No | The description of the inspection scenario. |'."\n"
+ .'| `dimensions` | `List<Dimension>` | Yes | The list of inspection dimensions. |'."\n"
+ ."\n"
+ .'**Dimension structure:**'."\n"
+ ."\n"
+ .'| Field | Type | Description |'."\n"
+ .'|--------|------|------|'."\n"
+ .'| `dimension` | `String` | The dimension name. Required. |'."\n"
+ .'| `desc` | `String` | The dimension description. Optional. |'."\n"
+ ."\n"
+ .'### 4.3 TagCategoryParam — Tag classification (`instructionType = "tagCategory"`)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `nameDescPairList` | `List<NameDescValueListPair>` | Yes | The list of tag classification dimensions. |'."\n"
+ ."\n"
+ .'**NameDescValueListPair structure:**'."\n"
+ ."\n"
+ .'| Field | Type | Description |'."\n"
+ .'|--------|------|------|'."\n"
+ .'| `name` | `String` | The dimension name. |'."\n"
+ .'| `desc` | `String` | The dimension description. |'."\n"
+ .'| `valueList` | `List<String>` | The list of candidate tag values. |'."\n"
+ ."\n"
+ .'### 4.4 CustomPrompt — Custom instruction (`instructionType = "customPrompt"`)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `customPrompt` | `String` | Yes | The custom prompt template content. |'."\n"
+ ."\n"
+ .'---',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LlmRequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"FinishReason\\": \\"stop\\",\\n \\"Text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。\\",\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 200,\\n \\"TotalTokens\\": 300,\\n \\"TyxmTurboCount\\": \\"1\\",\\n \\"TyxmPlusCount\\": \\"1\\"\\n }\\n}","type":"json"}]',
],
- 'AddBusinessCategory' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GenerateLabel' => [
+ 'summary' => 'Generates labels.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'systemTags' => [],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREsca27EUYZ'],
+ ],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the following details.', 'type' => 'string', 'required' => false, 'example' => '“”'."\n", 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The ID of the business space.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '348193421',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '76DB5D8C-5BD9-42A7-B527-5AF3A5F83F12',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** '],
+ 'Code' => ['description' => 'The response code. A value of **200** indicates success. Other values indicate failure. You can use this field to determine the cause of the failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when an error occurs.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => ['description' => 'The ID of the generation task.', 'type' => 'string', 'example' => '20260616-4955F615-A74E-171E-86ED-080F60C72EC9', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"348193421\\",\\n \\"RequestId\\": \\"76DB5D8C-5BD9-42A7-B527-5AF3A5F83F12\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddBusinessCategoryResponse>\\r\\n <code>200</code>\\r\\n <data>348193421</data>\\r\\n <message>successful</message>\\r\\n <requestId>76DB5D8C-5BD9-42A7-B527-5AF3A5F83F12</requestId>\\r\\n <success>true</success>\\r\\n</AddBusinessCategoryResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- ],
- 'DeleteBusinessCategory' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Generate labels',
+ 'requestParamsDescription' => '| Field | Type | Required | Description |'."\n"
+ .'|---|---|---|---|'."\n"
+ .'| `sourceTagIds` | `Array<Long>` | Yes | The list of root label IDs, which are used to recursively expand the entire label tree. |'."\n"
+ .'| `inputFileUrl` | `String` | Yes | The URL of the input file. |'."\n"
+ .'| `businessDocPath` | `String` | No | The path of the business document. This parameter is passed through to downstream algorithms. |',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"20260616-4955F615-A74E-171E-86ED-080F60C72EC9\\"\\n}","type":"json"}]',
+ ],
+ 'GetAgent' => [
+ 'summary' => 'Retrieves the details of an agent.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'systemTags' => [],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREscaFRLL5D'],
+ ],
'parameters' => [
[
- 'name' => 'JsonStr',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'baseMeAgentId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''],
],
[
- 'name' => 'BaseMeAgentId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'name' => 'JsonStr',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the following details.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4987D326-83D9-4A42-B9A5-0B27F9B40539',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6987D326-83D9-4A42-B9A5-0B27F9B40539'],
+ 'Code' => ['description' => 'The response code. A value of **200** indicates success. Other values indicate failure. You can use this field to determine the cause of the failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when an error occurs.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- true: The call was successful.'."\n"
+ .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => ['description' => 'The returned result.', '$ref' => '#/components/schemas/AgentInfo', 'title' => '', 'example' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"4987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteBusinessCategoryResponse>\\r\\n <code>200</code>\\r\\n <message>successful</message>\\r\\n <requestId>4987D326-83D9-4A42-B9A5-0B27F9B40539</requestId>\\r\\n <success>true</success>\\r\\n</DeleteBusinessCategoryResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'GetBusinessCategoryList' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Get agent details',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 0,\\n \\"AgentName\\": \\"\\",\\n \\"AgentDescription\\": \\"\\",\\n \\"ModelType\\": \\"\\",\\n \\"InputType\\": \\"\\",\\n \\"InstructionType\\": \\"\\",\\n \\"InstructionTypeParam\\": {\\n \\"FieldsParam\\": {\\n \\"NameDescPairList\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Desc\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ]\\n },\\n \\"ServiceInspectionParam\\": {\\n \\"SceneName\\": \\"\\",\\n \\"SceneDescription\\": \\"\\",\\n \\"Dimensions\\": [\\n {\\n \\"Dimension\\": \\"\\",\\n \\"Desc\\": \\"\\"\\n }\\n ]\\n },\\n \\"TagCategoryParam\\": {\\n \\"NameDescPairList\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Desc\\": \\"\\",\\n \\"ValueList\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n },\\n \\"CustomPromptParam\\": {\\n \\"CustomPrompt\\": \\"\\",\\n \\"NameDescPairList\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ]\\n }\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'GetAgentTaskResult' => [
+ 'summary' => 'Retrieves the task result of an agent node.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'systemTags' => [],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREscaFRLL5D'],
+ ],
'parameters' => [
[
'name' => 'JsonStr',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '""',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the following details.', 'type' => 'string', 'required' => false, 'example' => '{\\"vid\\":\\"sip-11-1766561862.293393\\",\\"taskId\\":\\"20251224-D3B32484-2D53-5B53-A618-483A7941029E\\"}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ID of the business space.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'A186A419-FDBE-464C-AED4-7121CAC73BF1',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E'],
+ 'Code' => ['description' => 'The status code. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when an error occurs.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. You can use this field to determine whether the request was successful:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ .'- **false/null**: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'Data' => [
+ 'description' => 'The returned result.',
'type' => 'object',
- 'itemNode' => true,
'properties' => [
- 'BusinessCategoryBasicInfo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'BusinessName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'A6BEC8D-9A5B-4BE5-8432-4F635E***', 'title' => ''],
+ 'Vid' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '6fa76916-3ce6-45d8-ac64-01b7f31***', 'title' => ''],
+ 'Status' => ['description' => 'The task status. Valid values:'."\n"
+ ."\n"
+ .'- 1: pending'."\n"
+ .'- 2: running'."\n"
+ .'- 3: succeeded'."\n"
+ .'- 4: failed', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'Response' => [
+ 'description' => 'The result of the computing task.',
+ 'type' => 'object',
+ 'properties' => [
+ 'FieldResponse' => [
+ 'description' => 'The property extraction result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'FieldVoList' => [
+ 'description' => 'The list of properties.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The property.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'The property name.', 'type' => 'string', 'example' => 'phone', 'title' => ''],
+ 'Value' => ['description' => 'The property value.', 'type' => 'string', 'example' => '1234561', 'title' => ''],
+ 'Remarks' => ['description' => 'The reasoning for the judgment.', 'type' => 'string', 'example' => '通过客服第一句话判断', 'title' => ''],
+ 'OriginalUtterances' => [
+ 'description' => 'The sentences referenced in the reasoning.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The index of the sentence referenced in the reasoning.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
],
- 'ServiceType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TagCategoryResponse' => [
+ 'description' => 'The tag categorization result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagCategoryVoList' => [
+ 'description' => 'The list of labels.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The label.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Dimension' => ['description' => 'The label dimension.', 'type' => 'string', 'example' => '客户意图', 'title' => ''],
+ 'IsMatch' => ['description' => 'Indicates whether a match is found.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ResultLabels' => [
+ 'description' => 'The list of matched labels.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The matched label.', 'type' => 'string', 'example' => '退货', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Remarks' => ['description' => 'The reasoning for the judgment.', 'type' => 'string', 'example' => '通过客服第一句话判断', 'title' => ''],
+ 'OriginalUtterances' => [
+ 'description' => 'The sentences referenced in the reasoning.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The index of the sentence referenced in the reasoning.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
],
- 'Bid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ServiceInspectionResponse' => [
+ 'description' => 'The service quality inspection result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ServiceInspectionVoList' => [
+ 'description' => 'The list of inspection items.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The inspection item.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Dimension' => ['description' => 'The inspection dimension.', 'type' => 'string', 'example' => '服务态度', 'title' => ''],
+ 'IsMatch' => ['description' => 'Indicates whether a match is found.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Remarks' => ['description' => 'The reasoning for the judgment.', 'type' => 'string', 'example' => '通过客服第一句话判断', 'title' => ''],
+ 'OriginalUtterances' => [
+ 'description' => 'The sentences referenced in the reasoning.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The index of the sentence referenced in the reasoning.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'CustomerPromptResponse' => [
+ 'description' => 'The result of the custom prompt.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Text' => ['description' => 'The result returned by the large language model.', 'type' => 'string', 'example' => '175/xl面料摸着很舒服,穿起来看着也挺修身的挺好的好衣服超好看,质量手感没得说一级棒,很满意的一次购物。', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'LlmRequestId' => ['description' => 'The request ID returned by the large language model service.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***', 'title' => ''],
+ 'InputTokens' => ['description' => 'The number of input tokens.', 'type' => 'string', 'example' => '100', 'title' => ''],
+ 'OutputTokens' => ['description' => 'The number of output tokens.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'TotalTokens' => ['description' => 'The total number of tokens.', 'type' => 'string', 'example' => '300', 'title' => ''],
+ 'TyxmTurboCount' => ['description' => 'The number of times the turbo model is used.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'TyxmPlusCount' => ['description' => 'The number of times the plus model is used.', 'type' => 'string', 'example' => '1', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"A186A419-FDBE-464C-AED4-7121CAC73BF1\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"BusinessCategoryBasicInfo\\": [\\n {\\n \\"BusinessName\\": \\"所有业务\\",\\n \\"ServiceType\\": 0,\\n \\"Bid\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message>successful</Message>\\n<RequestId>1850E47E-C331-435E-930E-356A684F1338</RequestId>\\n<Data>\\n <BusinessCategoryBasicInfo>\\n <BusinessName>业务1</BusinessName>\\n <ServiceType>0</ServiceType>\\n <Bid>805782250</Bid>\\n </BusinessCategoryBasicInfo>\\n <BusinessCategoryBasicInfo>\\n <BusinessName>业务2</BusinessName>\\n <ServiceType>0</ServiceType>\\n <Bid>805788011</Bid>\\n </BusinessCategoryBasicInfo>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'GetSchemeTaskConfig' => [
- 'summary' => '获取质检任务配置详情',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve agent task result',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"A6BEC8D-9A5B-4BE5-8432-4F635E***\\",\\n \\"Vid\\": \\"6fa76916-3ce6-45d8-ac64-01b7f31***\\",\\n \\"Status\\": \\"1\\",\\n \\"Response\\": {\\n \\"FieldResponse\\": {\\n \\"FieldVoList\\": [\\n {\\n \\"Name\\": \\"phone\\",\\n \\"Value\\": \\"1234561\\",\\n \\"Remarks\\": \\"通过客服第一句话判断\\",\\n \\"OriginalUtterances\\": [\\n 1\\n ]\\n }\\n ]\\n },\\n \\"TagCategoryResponse\\": {\\n \\"TagCategoryVoList\\": [\\n {\\n \\"Dimension\\": \\"客户意图\\",\\n \\"IsMatch\\": true,\\n \\"ResultLabels\\": [\\n \\"退货\\"\\n ],\\n \\"Remarks\\": \\"通过客服第一句话判断\\",\\n \\"OriginalUtterances\\": [\\n \\"1\\"\\n ]\\n }\\n ]\\n },\\n \\"ServiceInspectionResponse\\": {\\n \\"ServiceInspectionVoList\\": [\\n {\\n \\"Dimension\\": \\"服务态度\\",\\n \\"IsMatch\\": true,\\n \\"Remarks\\": \\"通过客服第一句话判断\\",\\n \\"OriginalUtterances\\": [\\n \\"1\\"\\n ]\\n }\\n ]\\n },\\n \\"CustomerPromptResponse\\": {\\n \\"Text\\": \\"175/xl面料摸着很舒服,穿起来看着也挺修身的挺好的好衣服超好看,质量手感没得说一级棒,很满意的一次购物。\\"\\n }\\n },\\n \\"LlmRequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"InputTokens\\": \\"100\\",\\n \\"OutputTokens\\": \\"200\\",\\n \\"TotalTokens\\": \\"300\\",\\n \\"TyxmTurboCount\\": \\"1\\",\\n \\"TyxmPlusCount\\": \\"1\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'GetAsrVocab' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '274602',
- 'abilityTreeNodes' => [
- 'FEATUREscaFRLL5D',
- 'FEATUREsca81P1AQ',
- ],
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '56172',
+ 'abilityTreeNodes' => ['FEATUREscaKR8LQC'],
],
'parameters' => [
[
- 'name' => 'BaseMeAgentId',
+ 'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12345',
- ],
+ 'schema' => ['description' => 'A complete JSON string. For details, see the following information.', 'type' => 'string', 'required' => false, 'example' => '{"vocabId":"指定热词Id"}', 'title' => ''],
],
[
- 'name' => 'JsonStr',
+ 'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"sourceDataType":3,"id":588}',
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Response data',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** ',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'Code' => ['description' => 'The result code. A value of **200** means success. Any other value means failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request fails. If successful, the value is **successful**.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** ', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Use this field to check the result:'."\n"
+ ."\n"
+ .'- **true** means success'."\n"
+ ."\n"
+ .'- false or **null** means failure', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The response data.',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3',
- ],
- 'SchemeTaskConfigId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'SourceDataType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'SchemeIdList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '13xxx',
- ],
- ],
- 'SchemeList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'SchemeId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '158',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- 'DataConfig' => [
- 'description' => '',
+ 'Name' => ['description' => 'The hotword group name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'Words' => [
'type' => 'object',
+ 'itemNode' => true,
'properties' => [
- 'Index' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'AssignConfigs' => [
- 'description' => '',
+ 'Word' => [
+ 'description' => 'The hotword list.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The hotword list.',
'type' => 'object',
'properties' => [
- 'AssignConfigContests' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'callStartTime',
- ],
- 'DataType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'Symbol' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"start\\":\\"2022-09-01 00:00:00\\",\\"end\\":\\"2022-09-30 00:00:00\\"}',
- ],
- 'ListObject' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'any',
- 'example' => 'xx',
- ],
- ],
- ],
- ],
- ],
+ 'Weight' => ['description' => 'The weight.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Word' => ['description' => 'The hotword.', 'type' => 'string', 'example' => '你好', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'ResultParam' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'DataSets' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '[]',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'AssignType' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ManualReview' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'AsrTaskPriority' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ModeCustomizationId' => [
- 'type' => 'string',
- ],
- 'ModelName' => [
- 'type' => 'string',
- ],
+ 'AsrVersion' => ['description' => 'The ASR version.'."\n"
+ ."\n"
+ .'- 2 or **null**: V2 (Intelligent Speech Interaction ASR)'."\n"
+ ."\n"
+ .'- **3**: V3 (Paraformer ASR)', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'ModelCustomizationId' => ['description' => 'The language model ID. This field appears only for V3.', 'type' => 'string', 'example' => 'paraformer-8k-v2', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"Id\\": 3,\\n \\"SchemeTaskConfigId\\": 123,\\n \\"Name\\": \\"test\\",\\n \\"SourceDataType\\": \\"1\\",\\n \\"Status\\": \\"1\\",\\n \\"SchemeIdList\\": [\\n 0\\n ],\\n \\"SchemeList\\": [\\n {\\n \\"SchemeId\\": 158,\\n \\"Name\\": \\"质检方案B\\"\\n }\\n ],\\n \\"DataConfig\\": {\\n \\"Index\\": 0,\\n \\"AssignConfigs\\": [\\n {\\n \\"AssignConfigContests\\": [\\n {\\n \\"Name\\": \\"callStartTime\\",\\n \\"DataType\\": 3,\\n \\"Symbol\\": 4,\\n \\"Value\\": \\"{\\\\\\\\\\\\\\"start\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2022-09-01 00:00:00\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"end\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2022-09-30 00:00:00\\\\\\\\\\\\\\"}\\",\\n \\"ListObject\\": [\\n \\"xx\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"ResultParam\\": \\"{}\\",\\n \\"DataSets\\": \\"[]\\"\\n },\\n \\"AssignType\\": 0,\\n \\"ManualReview\\": 0,\\n \\"AsrTaskPriority\\": 2,\\n \\"ModeCustomizationId\\": \\"cdae396590b*****ec40f3476e274fc\\",\\n \\"ModelName\\": \\"自定义模型\\"\\n }\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Name\\": \\"test\\",\\n \\"Words\\": {\\n \\"Word\\": [\\n {\\n \\"Weight\\": 0,\\n \\"Word\\": \\"你好\\"\\n }\\n ]\\n },\\n \\"AsrVersion\\": 3,\\n \\"ModelCustomizationId\\": \\"paraformer-8k-v2\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Retrieve the details of a specified hotword group ',
+ 'summary' => 'Retrieves details for a specified hotword group.',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-21T12:56:33.000Z', 'description' => 'Response parameters changed, Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:52.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetAsrVocab'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'CreateSchemeTaskConfig' => [
- 'summary' => '新建质检任务',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetBusinessCategoryList' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '153838',
- 'abilityTreeNodes' => [
- 'FEATUREscaFRLL5D',
- 'FEATUREsca81P1AQ',
- ],
- ],
+ 'operationType' => 'read',
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'jsonStr',
+ 'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Pass an empty string as the value.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '""', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'Workspace ID', 'title' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Long>',
- 'description' => 'PlainResult<Long>',
'type' => 'object',
'properties' => [
+ 'Code' => ['description' => 'Result code. The value **200** indicates success. Any other value indicates failure, and the caller can determine the cause of failure based on this field.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'When an error occurs, this field provides error details; when successful, the value is **successful**.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'A186A419-FDBE-464C-AED4-7121CAC73BF1', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. The caller can use this field to determine the request outcome:'."\n"
+ ."\n"
+ .'- **true** indicates success'."\n"
+ .'- **false/null** indicates failure', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '22',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** ',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Messages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'Message' => [
- 'description' => '',
+ 'BusinessCategoryBasicInfo' => [
+ 'description' => 'Applicable businesses',
'type' => 'array',
'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'BusinessName' => ['description' => 'Business Name', 'type' => 'string', 'example' => '所有业务', 'title' => ''],
+ 'ServiceType' => ['description' => 'ID of the top-level business category', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Bid' => ['description' => 'Business ID', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'HttpStatusCode' => [
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 22,\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- ],
- 'UpdateSchemeTaskConfig' => [
- 'summary' => '更新质检任务',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"A186A419-FDBE-464C-AED4-7121CAC73BF1\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"BusinessCategoryBasicInfo\\": [\\n {\\n \\"BusinessName\\": \\"所有业务\\",\\n \\"ServiceType\\": 0,\\n \\"Bid\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain the list of applicable businesses',
+ 'summary' => 'Obtain the list of applicable businesses.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-02-21T02:36:43.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetBusinessCategoryList'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:GetBusinessCategoryList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetCustomizationConfigList' => [
+ 'summary' => 'Retrieves a list of language models.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'deprecated' => false,
+ 'operationType' => 'read',
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '153837',
- 'abilityTreeNodes' => [
- 'FEATUREsca81P1AQ',
- 'FEATUREscaFRLL5D',
- ],
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '56177',
+ 'abilityTreeNodes' => ['FEATUREscaKR8LQC'],
],
'parameters' => [
[
- 'name' => 'jsonStr',
+ 'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Set this parameter to an empty string.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '""', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BaseResult',
- 'description' => 'BaseResult',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Messages' => [
+ 'Code' => ['description' => 'The result code. A value of **200** indicates that the request succeeded. Other values indicate failure. Use this field to identify the cause of a failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'If an error occurs, this field contains error details. If the request succeeds, the value is \\`successful\\`.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Use this field to check the request status. A value of \\`true\\` means success. A value of \\`false\\` or \\`null\\` means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'Message' => [
- 'description' => '',
+ 'ModelCustomizationDataSetPo' => [
+ 'description' => 'The detailed data returned.',
'type' => 'array',
'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskType' => ['description' => 'This field is deprecated. Ignore it.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the model was created.', 'type' => 'string', 'example' => '2019-01-08', 'title' => ''],
+ 'ModelStatus' => ['description' => 'The status of the model. Valid values: 1 (training), 5 (Normal), and 3 (training failed).', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'ModelName' => ['description' => 'The model name.', 'type' => 'string', 'example' => '自定义模型', 'title' => ''],
+ 'ModelId' => ['description' => 'This field is deprecated. Ignore it.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'ModeCustomizationId' => ['description' => 'The language model ID.', 'type' => 'string', 'example' => 'cdae396590bb479a9ec40f3476e274fc', 'title' => ''],
+ 'AsrVersion' => ['description' => 'The Automatic Speech Recognition (ASR) version.'."\n"
+ ."\n"
+ .'- **2/null**: Version 2 (Intelligent Speech Interaction ASR)'."\n"
+ ."\n"
+ .'- **3**: Version 3 (Paraformer ASR)', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'HttpStatusCode' => [
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ModelCustomizationDataSetPo\\": [\\n {\\n \\"TaskType\\": 1,\\n \\"CreateTime\\": \\"2019-01-08\\",\\n \\"ModelStatus\\": 5,\\n \\"ModelName\\": \\"自定义模型\\",\\n \\"ModelId\\": 1,\\n \\"ModeCustomizationId\\": \\"cdae396590bb479a9ec40f3476e274fc\\",\\n \\"AsrVersion\\": 3\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain language model List',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-21T12:56:33.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetCustomizationConfigList'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'ListSchemeTaskConfig' => [
- 'summary' => '获取质检任务列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetLabelAnalysisResult' => [
+ 'summary' => 'Queries the results of tag categorization analysis.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '153835',
- 'abilityTreeNodes' => [
- 'FEATUREscaFRLL5D',
- 'FEATUREsca81P1AQ',
- ],
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREsca27EUYZ'],
],
'parameters' => [
[
- 'name' => 'jsonStr',
+ 'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"pageNumber":1,"pageSize":10,"sourceDataType":"1"}',
- ],
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the following detailed description.', 'type' => 'string', 'required' => false, 'example' => '“”', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The business space ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'ListResult<SchemeTaskConfig>',
- 'description' => 'ListResult<SchemeTaskConfig>',
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** '],
+ 'Code' => ['description' => 'The response code. **200** indicates success. Other values indicate failure. You can use this field to determine the cause of the failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- true: The call was successful.'."\n"
+ .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
+ 'description' => 'The returned result.',
'type' => 'object',
- 'itemNode' => true,
'properties' => [
- 'Data' => [
- 'description' => '',
+ 'TagList' => [
+ 'description' => 'The tree-structured tag results.',
'type' => 'array',
'items' => [
- 'description' => 'SchemeTaskConfig',
+ 'description' => 'The tree-structured tag results.',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123',
- ],
- 'SchemeTaskConfigId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SourceDataType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ManualReview' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'AssignType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'DataConfig' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Index' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'AssignConfigs' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'AssignConfig' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'AssignConfigContests' => [
+ 'TagName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => '千问×高德', 'title' => ''],
+ 'Remarks' => ['description' => 'The description of the tag analysis.', 'type' => 'string', 'example' => '用户在千问内通过高德打车支付17元失败,转支付宝后变原价;客服围绕支付失败与余额、实名认证、授权绑定进行排查。问题发生在千问调用高德打车场景,属千问×高德。', 'title' => ''],
+ 'Children' => [
+ 'description' => 'The list of child nodes.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of child nodes.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => '千问×高德', 'title' => ''],
+ 'Remarks' => ['description' => 'The description of the tag analysis.', 'type' => 'string', 'example' => '用户在千问内通过高德打车支付17元失败,转支付宝后变原价;客服围绕支付失败与余额、实名认证、授权绑定进行排查。问题发生在千问调用高德打车场景,属千问×高德。', 'title' => ''],
+ 'Children' => [
+ 'description' => 'The list of child nodes.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of child nodes.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => '千问×高德', 'title' => ''],
+ 'Remarks' => ['description' => 'The description of the tag analysis.', 'type' => 'string', 'example' => '用户在千问内通过高德打车支付17元失败,转支付宝后变原价;客服围绕支付失败与余额、实名认证、授权绑定进行排查。问题发生在千问调用高德打车场景,属千问×高德。', 'title' => ''],
+ 'Children' => [
+ 'description' => 'The list of child nodes.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of child nodes.',
'type' => 'object',
- 'itemNode' => true,
'properties' => [
- 'AssignConfigContest' => [
- 'description' => '',
+ 'TagName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => ' '."\n"
+ .'千问×高德'."\n", 'title' => ''],
+ 'Remarks' => ['description' => 'The description of the tag analysis.', 'type' => 'string', 'example' => '用户在千问内通过高德打车支付17元失败,转支付宝后变原价;客服围绕支付失败与余额、实名认证、授权绑定进行排查。问题发生在千问调用高德打车场景,属千问×高德。', 'title' => ''],
+ 'Children' => [
+ 'description' => 'The list of child nodes.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The list of child nodes.',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'callStartTime',
- ],
- 'DataType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'Symbol' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"start\\":\\"2022-09-01 00:00:00\\",\\"end\\":\\"2022-09-30 00:00:00\\"}',
- ],
- 'ListObject' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'ListObject' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'any',
- 'example' => 'xx',
- ],
- ],
- ],
- ],
+ 'TagName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => '无效会话', 'title' => ''],
+ 'Remarks' => ['description' => 'The description of the tag analysis.', 'type' => 'string', 'example' => '当前层级未命中有效标签', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
- 'ResultParam' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'DataSets' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '[]',
- ],
- ],
- ],
- 'SchemeIdList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'SchemeIdList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '158',
- ],
- ],
- ],
- ],
- 'SchemeList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'SchemeList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'SchemeId' => [
- 'title' => '质检方案id',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '158',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'AsrTaskPriority' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'ModeCustomizationId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cdae396590b*****ec40f3476e274fc',
- ],
- 'ModelName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'VocabId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9f90b3efa2****0a49acec226eafc17',
- ],
- 'VocabName' => [
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
- 'UserGroup' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'CreateUser' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1650418039000',
- ],
- 'UpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1650418039000',
- ],
- 'UpdateUser' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Type' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'NumberSum' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1000',
- ],
- 'NumberSuccess' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1000',
- ],
- 'NumberFail' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'FinishRate' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '100',
- ],
- 'NumberExecuting' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'AsrVersion' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
],
- ],
- ],
- ],
- ],
- 'Count' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '22',
- ],
- 'CurrentPage' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ResultCountId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'LastDataId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4B0A8DCD-0DDF-5E80-8B9C-0A2F68B3403B',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Messages' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
+ 'TyxmPlusCount' => ['description' => 'The total number of Qwen-Plus model calls accumulated during this task.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''],
+ 'TyxmTurboCount' => ['description' => 'The total number of Qwen-Turbo model calls accumulated during this task.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'InputTokens' => ['description' => 'The total number of input tokens accumulated during this task.', 'type' => 'integer', 'format' => 'int64', 'example' => '7371', 'title' => ''],
+ 'OutputTokens' => ['description' => 'The total number of output tokens accumulated during this task.', 'type' => 'integer', 'format' => 'int64', 'example' => '355', 'title' => ''],
+ 'TotalTokens' => ['description' => 'The total number of tokens accumulated during this task.', 'type' => 'integer', 'format' => 'int64', 'example' => '7726', 'title' => ''],
],
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Data\\": [\\n {\\n \\"Id\\": 123,\\n \\"SchemeTaskConfigId\\": 123,\\n \\"Name\\": \\"检测任务A\\",\\n \\"SourceDataType\\": 2,\\n \\"Status\\": 1,\\n \\"ManualReview\\": 0,\\n \\"AssignType\\": 0,\\n \\"DataConfig\\": {\\n \\"Index\\": 0,\\n \\"AssignConfigs\\": {\\n \\"AssignConfig\\": [\\n {\\n \\"AssignConfigContests\\": {\\n \\"AssignConfigContest\\": [\\n {\\n \\"Name\\": \\"callStartTime\\",\\n \\"DataType\\": 3,\\n \\"Symbol\\": 4,\\n \\"Value\\": \\"{\\\\\\\\\\\\\\"start\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2022-09-01 00:00:00\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"end\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2022-09-30 00:00:00\\\\\\\\\\\\\\"}\\",\\n \\"ListObject\\": {\\n \\"ListObject\\": [\\n \\"xx\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"ResultParam\\": \\"{}\\",\\n \\"DataSets\\": \\"[]\\"\\n },\\n \\"SchemeIdList\\": {\\n \\"SchemeIdList\\": [\\n 158\\n ]\\n },\\n \\"SchemeList\\": {\\n \\"SchemeList\\": [\\n {\\n \\"SchemeId\\": 158,\\n \\"Name\\": \\"质检方案B\\"\\n }\\n ]\\n },\\n \\"AsrTaskPriority\\": 2,\\n \\"ModeCustomizationId\\": \\"cdae396590b*****ec40f3476e274fc\\",\\n \\"ModelName\\": \\"语言模型A\\",\\n \\"VocabId\\": \\"9f90b3efa2****0a49acec226eafc17\\",\\n \\"VocabName\\": \\"热词模型A\\",\\n \\"UserGroup\\": \\"1\\",\\n \\"CreateUser\\": 1,\\n \\"CreateTime\\": \\"1650418039000\\",\\n \\"UpdateTime\\": \\"1650418039000\\",\\n \\"UpdateUser\\": 1,\\n \\"Type\\": 0,\\n \\"NumberSum\\": 1000,\\n \\"NumberSuccess\\": 1000,\\n \\"NumberFail\\": 0,\\n \\"FinishRate\\": 100,\\n \\"NumberExecuting\\": 0,\\n \\"AsrVersion\\": 3\\n }\\n ]\\n },\\n \\"Count\\": 22,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ResultCountId\\": \\"忽略\\",\\n \\"LastDataId\\": \\"xxx\\",\\n \\"RequestId\\": \\"4B0A8DCD-0DDF-5E80-8B9C-0A2F68B3403B\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- ],
- 'SubmitQualityCheckTask' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query tag categorization analysis results',
+ 'requestParamsDescription' => '| Field | Type | Required | Description |'."\n"
+ .'|---|---|---|---|'."\n"
+ .'| `taskId` | `String` | Yes | The task ID returned by `AnalyzeLabel`. |',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TagList\\": [\\n {\\n \\"TagName\\": \\"千问×高德\\",\\n \\"Remarks\\": \\"用户在千问内通过高德打车支付17元失败,转支付宝后变原价;客服围绕支付失败与余额、实名认证、授权绑定进行排查。问题发生在千问调用高德打车场景,属千问×高德。\\",\\n \\"Children\\": [\\n {\\n \\"TagName\\": \\"千问×高德\\",\\n \\"Remarks\\": \\"用户在千问内通过高德打车支付17元失败,转支付宝后变原价;客服围绕支付失败与余额、实名认证、授权绑定进行排查。问题发生在千问调用高德打车场景,属千问×高德。\\",\\n \\"Children\\": [\\n {\\n \\"TagName\\": \\"千问×高德\\",\\n \\"Remarks\\": \\"用户在千问内通过高德打车支付17元失败,转支付宝后变原价;客服围绕支付失败与余额、实名认证、授权绑定进行排查。问题发生在千问调用高德打车场景,属千问×高德。\\",\\n \\"Children\\": [\\n {\\n \\"TagName\\": \\"\\\\t\\\\n千问×高德\\\\n\\",\\n \\"Remarks\\": \\"用户在千问内通过高德打车支付17元失败,转支付宝后变原价;客服围绕支付失败与余额、实名认证、授权绑定进行排查。问题发生在千问调用高德打车场景,属千问×高德。\\",\\n \\"Children\\": [\\n {\\n \\"TagName\\": \\"无效会话\\",\\n \\"Remarks\\": \\"当前层级未命中有效标签\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"TyxmPlusCount\\": 4,\\n \\"TyxmTurboCount\\": 0,\\n \\"InputTokens\\": 7371,\\n \\"OutputTokens\\": 355,\\n \\"TotalTokens\\": 7726\\n }\\n}","type":"json"}]',
+ ],
+ 'GetLabelGeneratedResult' => [
+ 'summary' => 'Queries the result of a label generation task.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'systemTags' => [],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREsca27EUYZ'],
+ ],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the following details.', 'type' => 'string', 'required' => false, 'example' => '“”', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The ID of the business workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***'],
+ 'Message' => ['description' => 'The error message returned when the request fails.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Other values indicate failure. You can use this field to determine the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. true: The call was successful. false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F6C2B68F-2311-4495-82AC-DAE86C9****',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '00A044A2-D59B-4104-96BA-84060AE8345F',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => 'The returned data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => 'The ID of the generation task.', 'type' => 'string', 'example' => '20260616-4955F615-A74E-171E-86ED-080F60C72EC9', 'title' => ''],
+ 'ResultFileUrl' => ['description' => 'The pre-signed download URL of the result file.', 'type' => 'string', 'example' => 'https://sca-eas-mining.oss-cn-beijing.aliyuncs.com/xxx.xlsx?Expires=...', 'title' => ''],
+ 'LlmCallNum' => ['description' => 'The number of LLM calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
+ 'InputTokens' => ['description' => 'The number of input tokens for the LLM.', 'type' => 'integer', 'format' => 'int32', 'example' => '7371', 'title' => ''],
+ 'OutputTokens' => ['description' => 'The number of output tokens for the LLM.', 'type' => 'integer', 'format' => 'int32', 'example' => '355', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"F6C2B68F-2311-4495-82AC-DAE86C9****\\",\\n \\"RequestId\\": \\"00A044A2-D59B-4104-96BA-84060AE8345F\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SubmitQualityCheckTaskResponse>\\n <Message>successful</Message>\\n <RequestId>00A044A2-D59B-4104-96BA-84060AE8345F</RequestId>\\n <Data>F6C2B68F-2311-4495-82AC-DAE86C9931CA</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</SubmitQualityCheckTaskResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'SaveConfigDataSet' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query label generation result',
+ 'requestParamsDescription' => '| Field | Type | Required | Description |'."\n"
+ .'|---|---|---|---|'."\n"
+ .'| `taskId` | `String` | Yes | The task ID returned by `GenerateLabel`. |',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"20260616-4955F615-A74E-171E-86ED-080F60C72EC9\\",\\n \\"ResultFileUrl\\": \\"https://sca-eas-mining.oss-cn-beijing.aliyuncs.com/xxx.xlsx?Expires=...\\",\\n \\"LlmCallNum\\": 4,\\n \\"InputTokens\\": 7371,\\n \\"OutputTokens\\": 355\\n }\\n}","type":"json"}]',
+ ],
+ 'GetMiningTaskResult' => [
+ 'summary' => 'Retrieve the result of a tag mining task.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'deprecated' => true,
+ 'operationType' => 'read',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '56228',
- 'abilityTreeNodes' => [
- 'FEATUREsca81P1AQ',
- ],
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '272684',
+ 'abilityTreeNodes' => ['FEATUREscaLN3HHV'],
],
'parameters' => [
[
- 'name' => 'JsonStr',
+ 'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''],
],
[
- 'name' => 'BaseMeAgentId',
+ 'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'Task ID', 'type' => 'string', 'required' => false, 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'ID of the request', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***'],
+ 'Message' => ['description' => 'Details of the error if an error occurs. Otherwise, **successful**.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Code' => ['description' => 'Result code. **200** indicates success. Any other value indicates failure. Use this field to determine the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. true means success. false or null means failure.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'Data' => [
+ 'description' => 'Quality inspection task ID.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => '20201231de3d34ec-40fa-4a55-8d27-76ea*****', 'title' => ''],
+ 'FilePath' => ['description' => 'File path', 'type' => 'string', 'example' => '123.22.com/manager/static/login-back.jpg', 'title' => ''],
+ 'FilePathMd' => ['description' => 'Markdown file path', 'type' => 'string', 'example' => '123.22.com/manager/static/login-back.md', 'title' => ''],
+ 'TaskStatus' => ['description' => 'Task status', 'type' => 'string', 'example' => 'finish', 'title' => ''],
+ 'FilePathList' => [
+ 'description' => 'List of returned file paths',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'FileUrl' => ['description' => 'Generated file URL', 'type' => 'string', 'example' => 'http://vxxxcustomer-pop.oss-cn-shanghai.aliyuncs.com/100.csv', 'title' => ''],
+ 'FileType' => ['description' => 'Generated file type', 'type' => 'string', 'example' => 'CSV', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
'example' => '',
],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'noSubstitutionReason' => '暂无替代API,请关注后续API最新发布。',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F050E835-4E5B-4799-BAE3-D622DC529AB3\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SaveConfigDataSetResponse>\\n <Message>successful</Message>\\n <RequestId>F050E835-4E5B-4799-BAE3-D622DC529AB3</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</SaveConfigDataSetResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ListDataSet' => [
- 'summary' => '获取数据集列表',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"20201231de3d34ec-40fa-4a55-8d27-76ea*****\\",\\n \\"FilePath\\": \\"123.22.com/manager/static/login-back.jpg\\",\\n \\"FilePathMd\\": \\"123.22.com/manager/static/login-back.md\\",\\n \\"TaskStatus\\": \\"finish\\",\\n \\"FilePathList\\": [\\n {\\n \\"FileUrl\\": \\"http://vxxxcustomer-pop.oss-cn-shanghai.aliyuncs.com/100.csv\\",\\n \\"FileType\\": \\"CSV\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain Mining Analysis Job Result',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-07T11:49:35.000Z', 'description' => 'Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
],
+ 'ramActions' => [],
+ ],
+ 'GetNextResultToVerify' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'deprecated' => true,
- 'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '154557',
- 'abilityTreeNodes' => [
- 'FEATUREsca81P1AQ',
- ],
- ],
+ 'operationType' => 'read',
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'title' => '入参json字符串',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"pageNumber":1,"pageSize":10}',
- ],
+ 'schema' => ['description' => 'Complete JSON string information. See the details below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"{"pageNumber":1,"pageSize":1,"taskId":"593A04C0-E6E9-4CDC-8C9*****","original":1}"', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PageResult<DataSet>',
- 'description' => 'PageResult<DataSet>',
'type' => 'object',
'properties' => [
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Other values indicate failure. The caller can determine the cause of failure using this field.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if an error occurs. If successful, the value is \'successful\'.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. The caller can determine if the request was successful using this field: \\`true\\` indicates success; \\`false\\`/\\`null\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
+ 'description' => 'File details.',
'type' => 'object',
- 'itemNode' => true,
'properties' => [
- 'Data' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'SetId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'SetName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SetDomain' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '“”',
- ],
- 'SetRoleArn' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '“”',
- ],
- 'SetBucketName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '“”',
- ],
- 'SetFolderName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '“”',
- ],
- 'SetNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RoleConfigStatus' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [
- '',
- '',
- '',
- ],
- 'example' => '1',
- ],
- 'ChannelId0' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ChannelId1' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RoleConfigTask' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'IsDelete' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-06-20T17:33Z',
- ],
- 'UpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2022-05-10T10:34Z',
- ],
- 'ChannelType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'SubDir' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'CreateType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [
- '',
- '',
- ],
- 'example' => '0',
- ],
- 'UserGroup' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'RoleConfigProp' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'filesFromLocal/ef7ff45c147a4a5e882c925f9a75ac43',
- ],
- 'AutoTranscoding' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'SetType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [
- '',
- '',
+ 'Index' => ['description' => 'The index of the current file. Pass this value when manually verifying the next data entry. It starts from 1, so the first entry has a value of 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'Status' => ['description' => 'File status. Possible values: 0: Not completed; 1: Not completed; 2: Completed; 3: Completed.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'AudioScheme' => ['description' => 'The protocol of the audio URL. Possible values: http, https.', 'type' => 'string', 'example' => 'http', 'title' => ''],
+ 'AudioURL' => ['description' => 'The audio URL, excluding http/https.', 'type' => 'string', 'example' => 'sca-bucket.oss-cn-hangzhou.aliyuncs.com/upload_1173636551461420/dateset_1584674455133_SzC/%E4%BA%BA%E5%B7%A5%E6%A0%A1%E9%AA%8C%E6%B5%8B%E8%AF%95-%E6%9F%A5%E5%8C%97%E4%BA%AC%E5%A4%A9%E6%B0%94.wav?Expires=1584847372&amp;OSSAccessKeyId=*****&amp;Signature=HccAKnLOJwoYvzE*********', 'title' => ''],
+ 'UpdateTime' => ['description' => 'Last update time.', 'type' => 'string', 'example' => '2020-03-20T11:26Z', 'title' => ''],
+ 'IncorrectWords' => ['description' => 'The number of incorrect words in the transcription.', 'type' => 'integer', 'format' => 'int32', 'example' => '23', 'title' => ''],
+ 'VerifiedCount' => ['description' => 'The total number of verified files.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'Verified' => ['description' => 'Indicates whether manual verification has been performed. Possible values: \\`false\\`: Not yet verified; \\`true\\`: Already verified.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'FileName' => ['description' => 'File name.', 'type' => 'string', 'example' => 'xxx.wav', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of files for this task.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'Precision' => ['description' => 'Current recognition accuracy.', 'type' => 'number', 'format' => 'float', 'example' => '0.97079998', 'title' => ''],
+ 'FileId' => ['description' => 'File ID.', 'type' => 'string', 'example' => 'e790e6c919d84b82b64ee*****', 'title' => ''],
+ 'Duration' => ['description' => 'The total duration of files in the current task, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '23421', 'title' => ''],
+ 'Dialogues' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Dialogue' => [
+ 'description' => 'Dialogue data. This field has a value when \\`status\\` is 2 or 3.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Dialogue data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Words' => ['description' => 'The transcribed content of this sentence.', 'type' => 'string', 'example' => '你好有什么可以帮您', 'title' => ''],
+ 'Identity' => ['description' => 'The role of the speaker.', 'type' => 'string', 'example' => '某客服', 'title' => ''],
+ 'IncorrectWords' => ['description' => 'The number of incorrect words in the transcription of this sentence. This is returned only after the sentence has been verified.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'BeginTime' => ['description' => 'Deprecated field. Ignore it.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
+ 'SourceWords' => ['description' => 'The correct content of this sentence. This is returned only after the sentence has been verified.', 'type' => 'string', 'example' => '您好有什么可以帮您', 'title' => ''],
+ 'End' => ['description' => 'The offset of this sentence\'s end time relative to the overall dialogue start time, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3422', 'title' => ''],
+ 'SpeechRate' => ['description' => 'Speech rate value, in words per minute.', 'type' => 'integer', 'format' => 'int32', 'example' => '332', 'title' => ''],
+ 'HourMinSec' => ['description' => 'The start time of this sentence in HH:mm:ss format.', 'type' => 'string', 'example' => '00:00:07', 'title' => ''],
+ 'SourceRole' => ['description' => 'The correct role after manual verification.', 'type' => 'string', 'example' => '客服', 'title' => ''],
+ 'Begin' => ['description' => 'The offset of this sentence\'s start time relative to the overall dialogue start time, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '980', 'title' => ''],
+ 'EmotionValue' => ['description' => 'Emotion energy value. Range: 1-10. A higher value indicates stronger emotion.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''],
+ 'Role' => ['description' => 'The role of this sentence. Possible values: Customer service, Customer.', 'type' => 'string', 'example' => '客户', 'title' => ''],
+ 'SilenceDuration' => ['description' => 'Deprecated field. Ignore it.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Deltas' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Delta' => [
+ 'description' => 'Errors in the dialogue text after manual verification.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Errors in the dialogue text after manual verification.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The type of error. Possible values: CHANGE: Error, INSERT: Extra word, DELETE: Missing word.', 'type' => 'string', 'example' => 'CHANGE', 'title' => ''],
+ 'Source' => [
+ 'description' => 'The correct dialogue content after manual verification.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Position' => ['description' => 'The position of the word.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'Line' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Line' => [
+ 'description' => 'The specific word.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The specific word.', 'type' => 'string', 'example' => '这里是阿里云', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Target' => [
+ 'description' => 'The original transcribed dialogue content.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Position' => ['description' => 'The position of the word.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'Line' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Line' => [
+ 'description' => 'The specific word.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The specific word.', 'type' => 'string', 'example' => '这里是服务台', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
],
- 'example' => '1',
- ],
- 'DataSetType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'SourceDataType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '11',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- 'Count' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '23',
- ],
- 'CurrentPage' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '96138D8D-8D26-4E41-BFF4-77AED1088BBD',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Messages' => [
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Index\\": 2,\\n \\"Status\\": 3,\\n \\"AudioScheme\\": \\"http\\",\\n \\"AudioURL\\": \\"sca-bucket.oss-cn-hangzhou.aliyuncs.com/upload_1173636551461420/dateset_1584674455133_SzC/%E4%BA%BA%E5%B7%A5%E6%A0%A1%E9%AA%8C%E6%B5%8B%E8%AF%95-%E6%9F%A5%E5%8C%97%E4%BA%AC%E5%A4%A9%E6%B0%94.wav?Expires=1584847372&amp;OSSAccessKeyId=*****&amp;Signature=HccAKnLOJwoYvzE*********\\",\\n \\"UpdateTime\\": \\"2020-03-20T11:26Z\\",\\n \\"IncorrectWords\\": 23,\\n \\"VerifiedCount\\": 2,\\n \\"Verified\\": true,\\n \\"FileName\\": \\"xxx.wav\\",\\n \\"TotalCount\\": 3,\\n \\"Precision\\": 0.97079998,\\n \\"FileId\\": \\"e790e6c919d84b82b64ee*****\\",\\n \\"Duration\\": 23421,\\n \\"Dialogues\\": {\\n \\"Dialogue\\": [\\n {\\n \\"Words\\": \\"你好有什么可以帮您\\",\\n \\"Identity\\": \\"某客服\\",\\n \\"IncorrectWords\\": 2,\\n \\"BeginTime\\": \\"XXX\\",\\n \\"SourceWords\\": \\"您好有什么可以帮您\\",\\n \\"End\\": 3422,\\n \\"SpeechRate\\": 332,\\n \\"HourMinSec\\": \\"00:00:07\\",\\n \\"SourceRole\\": \\"客服\\",\\n \\"Begin\\": 980,\\n \\"EmotionValue\\": 6,\\n \\"Role\\": \\"客户\\",\\n \\"SilenceDuration\\": 1,\\n \\"Deltas\\": {\\n \\"Delta\\": [\\n {\\n \\"Type\\": \\"CHANGE\\",\\n \\"Source\\": {\\n \\"Position\\": 5,\\n \\"Line\\": {\\n \\"Line\\": [\\n \\"这里是阿里云\\"\\n ]\\n }\\n },\\n \\"Target\\": {\\n \\"Position\\": 5,\\n \\"Line\\": {\\n \\"Line\\": [\\n \\"这里是服务台\\"\\n ]\\n }\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain details of the next file for manual validation',
+ 'summary' => 'Retrieve the next file details for manual verification.',
+ 'requestParamsDescription' => '### Request Parameter JSON String Information'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| :--------- | :--------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| taskId | String | Yes | The ID of the precision comparison task. This is `precisions.taskId` in the return value of the `ListPrecisionTask` API. |'."\n"
+ .'| pageNumber | Integer | No | The current page number. The next data entry on the current page is returned. If empty, the first unverified data entry for the task is returned. For subsequent calls, get the `index` value from the previous `GetNextResultToVerify` return. For example, if you pass 1, the second data entry is returned. If you pass -1, the first data entry is returned. |'."\n"
+ .'| pageSize | Integer | No | Always pass 1. |'."\n"
+ .'| original | Integer | No | Whether to return the original (correct) text. Valid values: 0 (No), 1 (Yes). Default is 0. |'."\n"
+ .'| fileName | String | No | The file name. If not specified, it is equivalent to clicking \'Next\'. If specified, the result for this file is returned. |',
+ 'responseParamsDescription' => '## Response Parameters'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| :------------- | :--------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| status | Integer | Yes | File status. 0 or 1 indicates not completed; 2 or 3 indicates completed. |'."\n"
+ .'| audioURL | String | No | The audio URL, excluding http/https. |'."\n"
+ .'| audioScheme | String | No | The protocol of the audio URL. Possible values: http, https. |'."\n"
+ .'| fileName | String | No | File name. |'."\n"
+ .'| fileId | String | Yes | File ID. |'."\n"
+ .'| verified | Boolean | Yes | Indicates whether manual verification has been performed. Possible values: `false`: Not yet verified; `true`: Already verified. |'."\n"
+ .'| dialogues | List | No | Dialogue data. This field has a value when `status` is 2 or 3. For details, see the Dialogue data description below. |'."\n"
+ .'| totalCount | Integer | Yes | The total number of files for this task. |'."\n"
+ .'| verifiedCount | Integer | Yes | The total number of verified files. |'."\n"
+ .'| incorrectWords | Integer | Yes | The number of incorrect words in the transcription. |'."\n"
+ .'| precision | Float | Yes | Current recognition accuracy. |'."\n"
+ .'| updateTime | String | Yes | Last update time. |'."\n"
+ .'| duration | Integer | Yes | The total duration of files in the current task, in seconds. |'."\n"
+ .'| index | Integer | Yes | The index of the current file. The frontend passes this value when retrieving the next entry. It starts from 1, so the first entry has a value of 1. |'."\n"
+ ."\n"
+ .'### Dialogue Data Description'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| :------------- | :--------- | :------- | :------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| begin | Long | Yes | The offset of this sentence\'s start time relative to the overall dialogue start time, in milliseconds. |'."\n"
+ .'| beginTime | Long | Yes | The start time of this sentence. |'."\n"
+ .'| end | Long | Yes | The offset of this sentence\'s end time relative to the overall dialogue start time, in milliseconds. |'."\n"
+ .'| hourMinSec | String | Yes | The start time of this sentence in HH:mm:ss format. |'."\n"
+ .'| role | String | Yes | The speaker\'s role. |'."\n"
+ .'| sourceRole | String | No | The correct role. |'."\n"
+ .'| identity | String | Yes | Role ARN. |'."\n"
+ .'| words | String | Yes | The transcribed content of this sentence. |'."\n"
+ .'| sourceWords | String | No | The correct content of this sentence. This is returned only after the sentence has been verified. |'."\n"
+ .'| delta | List | No | Errors in the text. For details, see the Delta properties description below. |'."\n"
+ .'| incorrectWords | Integer | No | The number of incorrect words in the transcription of this sentence. This is returned only after the sentence has been verified. |'."\n"
+ ."\n"
+ .'### Delta Properties Description'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| :------- | :--------- | :------- | :--------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| source | Chunk | Yes | The correct dialogue content after manual verification. For details, see the Chunk properties description below. |'."\n"
+ .'| target | Chunk | Yes | The transcribed dialogue content. For details, see the Chunk properties description below. |'."\n"
+ .'| type | String | Yes | The type of error. Possible values: CHANGE: Error, INSERT: Extra word, DELETE: Missing word. |'."\n"
+ ."\n"
+ .'### Chunk Properties Description'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| :------- | :--------- | :------- | :------------------------ |'."\n"
+ .'| line | List | Yes | The specific word. |'."\n"
+ .'| position | Integer | Yes | The position of the word. |',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetNextResultToVerify'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'GetPrecisionTask' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the details below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"{"taskId":"593A04C0-E6E9-4CDC-8C9****"}"', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The result code. A value of **200** indicates that the request was successful. Other values indicate that the request failed. Use this field to determine the cause of the failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'If the request fails, this field provides the error details. If the request is successful, the value is \\`successful\\`.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success. A value of \\`false\\` or \\`null\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The task details.',
'type' => 'object',
- 'itemNode' => true,
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
+ 'Status' => ['description' => 'The task status. Possible values: 0: Transcribing. 1: Transcription complete.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'UpdateTime' => ['description' => 'The time when the task was last updated.', 'type' => 'string', 'example' => '2020-03-10 20:26:29', 'title' => ''],
+ 'IncorrectWords' => ['description' => 'The number of incorrectly transcribed words.', 'type' => 'integer', 'format' => 'int32', 'example' => '23', 'title' => ''],
+ 'DataSetId' => ['description' => 'If the source is a dataset, this is the dataset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1212', 'title' => ''],
+ 'VerifiedCount' => ['description' => 'The total number of verified files.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'Duration' => ['description' => 'The total duration of the audio recording.', 'type' => 'integer', 'format' => 'int32', 'example' => '3423', 'title' => ''],
+ 'DataSetName' => ['description' => 'If the source is a dataset, this is the dataset name.', 'type' => 'string', 'example' => '数据集名称', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of files in the task.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'Source' => ['description' => 'The source of the file. Possible values: 3: Dataset. 0: Call center.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'Name' => ['description' => 'The task name.', 'type' => 'string', 'example' => '任务名称', 'title' => ''],
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '7C1DEF5F-2C18-4D36-99C6-8C27*****', 'title' => ''],
+ 'Precisions' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Precision' => [
+ 'description' => 'A list of tasks executed by each language model.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The task status. Possible values: 0: Transcribing. 1: Transcription complete.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ModelName' => ['description' => 'The model name.', 'type' => 'string', 'example' => '模型名称', 'title' => ''],
+ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '593A04C0-E6E9-4CDC-8C99-B120C******', 'title' => ''],
+ 'Precision' => ['description' => 'The accuracy rate, such as 0.98.', 'type' => 'number', 'format' => 'float', 'example' => '0.98', 'title' => ''],
+ 'ModelId' => ['description' => 'The model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2311', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'noSubstitutionReason' => '暂无替代API,请关注后续API最新发布。',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Data\\": [\\n {\\n \\"SetId\\": 1,\\n \\"SetName\\": \\"数据集A\\",\\n \\"SetDomain\\": \\"“”\\",\\n \\"SetRoleArn\\": \\"“”\\",\\n \\"SetBucketName\\": \\"“”\\",\\n \\"SetFolderName\\": \\"“”\\",\\n \\"SetNumber\\": 1,\\n \\"RoleConfigStatus\\": 1,\\n \\"ChannelId0\\": 0,\\n \\"ChannelId1\\": 1,\\n \\"RoleConfigTask\\": \\"xx\\",\\n \\"IsDelete\\": 0,\\n \\"CreateTime\\": \\"2019-06-20T17:33Z\\",\\n \\"UpdateTime\\": \\"2022-05-10T10:34Z\\",\\n \\"ChannelType\\": 1,\\n \\"SubDir\\": \\"xx\\",\\n \\"CreateType\\": 0,\\n \\"UserGroup\\": \\"1\\",\\n \\"RoleConfigProp\\": \\"filesFromLocal/ef7ff45c147a4a5e882c925f9a75ac43\\",\\n \\"AutoTranscoding\\": 1,\\n \\"SetType\\": 1,\\n \\"DataSetType\\": 3,\\n \\"SourceDataType\\": 11\\n }\\n ]\\n },\\n \\"Count\\": 23,\\n \\"CurrentPage\\": 10,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"96138D8D-8D26-4E41-BFF4-77AED1088BBD\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": 1,\\n \\"UpdateTime\\": \\"2020-03-10 20:26:29\\",\\n \\"IncorrectWords\\": 23,\\n \\"DataSetId\\": 1212,\\n \\"VerifiedCount\\": 2,\\n \\"Duration\\": 3423,\\n \\"DataSetName\\": \\"数据集名称\\",\\n \\"TotalCount\\": 3,\\n \\"Source\\": 3,\\n \\"Name\\": \\"任务名称\\",\\n \\"TaskId\\": \\"7C1DEF5F-2C18-4D36-99C6-8C27*****\\",\\n \\"Precisions\\": {\\n \\"Precision\\": [\\n {\\n \\"Status\\": 1,\\n \\"ModelName\\": \\"模型名称\\",\\n \\"TaskId\\": \\"593A04C0-E6E9-4CDC-8C99-B120C******\\",\\n \\"Precision\\": 0.98,\\n \\"ModelId\\": 2311\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain details of a speech recognition Detection Job ',
+ 'summary' => 'Retrieves the details of a (speech recognition) detection task.',
+ 'requestParamsDescription' => '## Request parameter details'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| :------- | :--------- | :------- | :----------- |'."\n"
+ .'| taskId | String | Yes | The task ID. |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:51.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetPrecisionTask'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'DeleteDataSet' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetQualityCheckScheme' => [
+ 'summary' => 'This operation implements the query feature in quality check plan management on the frontend. The Apsara Stack URL is ip:port/api/qcs/GetQualityCheckScheme.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'deprecated' => true,
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '56154',
- 'abilityTreeNodes' => [
- 'FEATUREsca81P1AQ',
- ],
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '153732',
+ 'abilityTreeNodes' => ['FEATUREscaKR8LQC', 'FEATUREsca6QWO0D'],
],
'parameters' => [
[
- 'name' => 'JsonStr',
+ 'name' => 'jsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"setId":"234"}',
- ],
+ 'schema' => ['description' => 'The request parameters in JSON format. For more information, see the additional information for request parameters.', 'type' => 'string', 'required' => false, 'example' => '{"schemeId":"187","ruleRequireInfos":["BusinessNameInfo","RuleCategory"]}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'baseMeAgentId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'PlainResult<QualityCheckScheme>',
+ 'description' => 'PlainResult',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9987D326-83D9-4A42-B9A5-0B27F9B40539',
+ 'Data' => [
+ 'description' => 'The QualityCheckScheme object. This is the JSON object of the quality check plan. For more information, see [`Description of quality check task objects`](~~453292~~).',
+ 'type' => 'object',
+ 'properties' => [
+ 'SchemeId' => ['description' => 'The quality check plan ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '112**'],
+ 'Name' => ['description' => 'The name of the quality check plan.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '售前使用', 'title' => ''],
+ 'SchemeTemplateId' => ['description' => 'The quality check plan template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'DataType' => ['description' => 'The data type of the quality check plan. Valid values: 0 (text) and 1 (audio).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Type' => ['description' => 'The type of the quality check plan. Valid values: 0 (system-built) and 1 (custom).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TemplateType' => ['description' => 'The type of the quality check plan template. Valid values: 1 (system-built) and 2 (custom).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Status' => ['description' => 'The status. Valid values: 0 (deleted), 1 (published), 2 (unpublished), and 3 (updated but not published). Default value: 2.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RuleIds' => [
+ 'description' => 'The list of associated rule IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The rule ID.', 'type' => 'string', 'example' => '1302493', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RuleList' => [
+ 'description' => 'The list of rules.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The JSON object of the rule. For more information, see [`Description of rule objects`](https://help.aliyun.com/document_detail/453053.html).', '$ref' => '#/components/schemas/RulesInfo', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'CreateUserName' => ['description' => 'The username of the creator.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the task was created.', 'type' => 'string', 'example' => '1616113198000', 'title' => ''],
+ 'UpdateUserName' => ['description' => 'The username of the user who last updated the plan.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'UpdateTime' => ['description' => 'The time when the plan was last updated.', 'type' => 'string', 'example' => '1616113198000', 'title' => ''],
+ 'Version' => ['description' => 'The version number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1616113198000', 'title' => ''],
+ 'SchemeCheckTypeList' => [
+ 'description' => 'The list of quality check dimensions.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A quality check dimension.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CheckType' => ['description' => 'The ID of the quality check dimension type.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'CheckName' => ['description' => 'The name of the quality check dimension.', 'type' => 'string', 'example' => '服务规范性检测', 'title' => ''],
+ 'SourceScore' => ['description' => 'The original score.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Score' => ['description' => 'The score of the quality check dimension.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'Enable' => ['description' => 'The status. Valid values: 0 (disabled) and 1 (enabled).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'SchemeId' => ['description' => 'The quality check plan ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'InitScore' => ['description' => 'The total score of the quality check plan.', 'type' => 'string', 'example' => '100', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '96138D8D-8D26-4E41-BFF4-77AED1088BBD', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. A value of true indicates success. A value of false or null indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The result code. A value of 200 indicates success. Other values indicate failure. Use this code to determine the cause of a failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'If an error occurs, this field provides details about the error. If the request is successful, the value is **successful**.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Messages' => [
+ 'description' => 'The list of returned messages.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'noSubstitutionReason' => '暂无替代API,请关注后续API最新发布。',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"9987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteDataSetResponse>\\r\\n <message>successful</message>\\r\\n <requestId>76DB5D8C-5BD9-42A7-B527-5AF3A5F83F12</requestId>\\r\\n <code>200</code>\\r\\n <success>true</success>\\r\\n</DeleteDataSetResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'title' => 'Obtain Quality Inspection Plan Details',
+ 'requestParamsDescription' => '| Property | Value type | Required | Description | Example |'."\n"
+ .'| --------------------- | ---------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |'."\n"
+ .'| schemeId | Long | Yes | The quality check plan ID. | 187 |'."\n"
+ .'| ruleRequireInfos | List | No | The required information. | \\["BusinessNameInfo","RuleCategory"] |'."\n"
+ .'| ruleRequireInfos.item | String | | Options: ConditionInfo (condition information), OperatorInfo (operator information), GraphFlowInfos (advanced flow information), GraphFlowInterruptRule (break rule information), BusinessNameInfo (business type information), ScoreInfo (score information), RuleCategory (rule type information), and SchemeNames (quality check plan name). | |',
+ 'changeSet' => [
+ ['createdAt' => '2024-11-14T06:32:36.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:40.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-10-20T06:34:02.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetQualityCheckScheme'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"SchemeId\\": 0,\\n \\"Name\\": \\"xxx\\",\\n \\"Description\\": \\"售前使用\\",\\n \\"SchemeTemplateId\\": 1,\\n \\"DataType\\": 1,\\n \\"Type\\": 1,\\n \\"TemplateType\\": 1,\\n \\"Status\\": 1,\\n \\"RuleIds\\": [\\n \\"1302493\\"\\n ],\\n \\"RuleList\\": [\\n {\\n \\"Conditions\\": [\\n {\\n \\"Cid\\": \\"a\\",\\n \\"Id\\": 1,\\n \\"Rid\\": \\"1\\",\\n \\"Check_range\\": {\\n \\"RoleId\\": 1,\\n \\"Role\\": \\"客服\\",\\n \\"Anchor\\": {\\n \\"Cid\\": \\"a\\",\\n \\"Location\\": \\"BEFORE\\",\\n \\"Hit_time\\": 1\\n },\\n \\"Range\\": {\\n \\"From\\": 1,\\n \\"To\\": 2\\n },\\n \\"Absolute\\": true,\\n \\"AllSentencesSatisfy\\": true\\n },\\n \\"Operators\\": [\\n {\\n \\"Oid\\": \\"a\\",\\n \\"Id\\": 1,\\n \\"Type\\": \\"HIT_ANY_KEYWORDS\\",\\n \\"Param\\": {\\n \\"CustomerParam\\": {\\n \\"Field\\": \\"remark1\\",\\n \\"FieldType\\": 1,\\n \\"DataType\\": 1,\\n \\"Symbol\\": 1,\\n \\"Value\\": \\"xxx\\",\\n \\"ActualValue\\": \\"xx\\",\\n \\"ExpressionMetaDesc\\": {\\n \\"LeftFieldType\\": 0,\\n \\"LeftOperand\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"RightFieldType\\": 0,\\n \\"RightOperand\\": \\"\\",\\n \\"RoundingMode\\": \\"\\"\\n }\\n },\\n \\"Keywords\\": [\\n \\"你好\\"\\n ],\\n \\"Regex\\": \\"质疑.*\\",\\n \\"NotRegex\\": \\"优秀.*\\",\\n \\"Phrase\\": \\"你好,请问\\",\\n \\"References\\": [\\n \\"你好.{0,10}\\"\\n ],\\n \\"Interval\\": 1,\\n \\"IntervalEnd\\": 2,\\n \\"Threshold\\": 90,\\n \\"In_sentence\\": true,\\n \\"Target\\": 1,\\n \\"From_end\\": true,\\n \\"Different_role\\": true,\\n \\"Target_role\\": \\"客服\\",\\n \\"RoleId\\": 1,\\n \\"Velocity\\": 111,\\n \\"VelocityInMint\\": 1,\\n \\"KeywordExtension\\": 1,\\n \\"Synonyms\\": {\\n \\"key\\": [\\n \\"售卖\\"\\n ]\\n },\\n \\"Case_sensitive\\": true,\\n \\"Near_dialogue\\": true,\\n \\"MinWordSize\\": 1,\\n \\"Hit_time\\": 2,\\n \\"Excludes\\": [\\n \\"负向\\"\\n ],\\n \\"From\\": 0,\\n \\"CheckFirstSentence\\": true,\\n \\"Average\\": true,\\n \\"BeginType\\": \\"1\\",\\n \\"EndType\\": \\"2\\",\\n \\"CompareOperator\\": \\"gt\\",\\n \\"Pkey\\": \\"xx\\",\\n \\"Poutput_type\\": 1,\\n \\"SimilarlySentences\\": [\\n \\"我要购买\\"\\n ],\\n \\"LgfSentences\\": [\\n \\"你好{1}\\"\\n ],\\n \\"Score\\": 70,\\n \\"ContextChatMatch\\": true,\\n \\"KeywordMatchSize\\": 1,\\n \\"MaxEmotionChangeValue\\": 3,\\n \\"CheckType\\": 1,\\n \\"KnowledgeTargetId\\": \\"1\\",\\n \\"CategoryPathCode\\": \\"xx\\",\\n \\"KnowledgeTargetType\\": 1,\\n \\"KnowledgeTargetName\\": \\"订单\\",\\n \\"QuestionThreshold\\": \\"90\\",\\n \\"AnswerThreshold\\": \\"90\\",\\n \\"KnowledgeSentenceNum\\": 1,\\n \\"KnowledgeInfo\\": \\"下单\\",\\n \\"BotId\\": \\"chatbot-cn-xxx\\",\\n \\"UseEasAlgorithm\\": true,\\n \\"Pvalues\\": [\\n \\"\\"\\n ],\\n \\"Similarity_threshold\\": 90,\\n \\"AntModelInfo\\": {\\n \\"key\\": \\"xxx\\"\\n },\\n \\"DelayTime\\": 10,\\n \\"Knowledges\\": \\"\\",\\n \\"LlmModelCode\\": \\"\\",\\n \\"HitCondition\\": \\"\\",\\n \\"SceneName\\": \\"\\",\\n \\"Dimensions\\": [\\n {\\n \\"Dimension\\": \\"\\",\\n \\"Desc\\": \\"\\",\\n \\"ExcludeCondition\\": \\"\\",\\n \\"IncludeCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"Name\\": \\"a\\",\\n \\"UserGroup\\": \\"xxx\\",\\n \\"QualityCheckType\\": 0\\n }\\n ],\\n \\"Lambda\\": \\"a\\",\\n \\"Exclusion\\": 0,\\n \\"Name\\": \\"xx\\",\\n \\"UserGroup\\": \\"xxxx\\"\\n }\\n ],\\n \\"Rules\\": [\\n {\\n \\"Status\\": 1,\\n \\"IsDelete\\": 1,\\n \\"StartTime\\": \\"1641277321000\\",\\n \\"EndTime\\": \\"1641277321000\\",\\n \\"Weight\\": \\"1\\",\\n \\"IsOnline\\": 1,\\n \\"CreateEmpid\\": \\"1\\",\\n \\"CreateEmpName\\": \\"张三\\",\\n \\"CreateTime\\": \\"1641277321000\\",\\n \\"LastUpdateTime\\": \\"1641277321000\\",\\n \\"LastUpdateEmpid\\": \\"1\\",\\n \\"LastUpdateEmpName\\": \\"张三\\",\\n \\"Comments\\": \\"违规\\",\\n \\"Deny\\": 1,\\n \\"ScoreSubId\\": 1,\\n \\"ScoreName\\": \\"违规\\",\\n \\"ScoreSubName\\": \\"1\\",\\n \\"ScoreNum\\": 1,\\n \\"ScoreType\\": 1,\\n \\"ScoreDeleted\\": true,\\n \\"OperationMode\\": 1,\\n \\"Meet\\": 1,\\n \\"Effective\\": 1,\\n \\"FullCycle\\": 1,\\n \\"EffectiveStartTime\\": \\"OperationMode\\",\\n \\"EffectiveEndTime\\": \\"OperationMode\\",\\n \\"QualityCheckType\\": 1,\\n \\"Level\\": 1,\\n \\"GraphFlow\\": \\"{}\\",\\n \\"TaskFlowType\\": 1,\\n \\"CheckType\\": 3,\\n \\"SchemeCheckType\\": {\\n \\"CheckType\\": 1,\\n \\"CheckName\\": \\"流程规则\\",\\n \\"SourceScore\\": 1,\\n \\"Score\\": 50,\\n \\"Enable\\": 1,\\n \\"SchemeId\\": 1,\\n \\"SchemeScoreInfoList\\": [\\n {\\n \\"Rid\\": 1,\\n \\"Name\\": \\"xx\\",\\n \\"TaskFlowId\\": 1,\\n \\"TaskFlowName\\": \\"xx\\",\\n \\"ScoreType\\": 1,\\n \\"ScoreNumType\\": 0,\\n \\"ScoreNum\\": 1,\\n \\"ScoreRuleHitType\\": 0\\n }\\n ],\\n \\"TaskFlowScoreInfoList\\": [\\n {\\n \\"TaskFlowId\\": 1,\\n \\"TaskFlowName\\": \\"xx\\",\\n \\"TaskFlowType\\": 1,\\n \\"SchemeScoreInfoList\\": [\\n {\\n \\"Rid\\": 1,\\n \\"Name\\": \\"xx\\",\\n \\"TaskFlowId\\": 1,\\n \\"TaskFlowName\\": \\"xx\\",\\n \\"ScoreType\\": 1,\\n \\"ScoreNumType\\": 0,\\n \\"ScoreNum\\": 11,\\n \\"ScoreRuleHitType\\": 0\\n }\\n ]\\n }\\n ]\\n },\\n \\"TargetType\\": 10,\\n \\"ConfigType\\": 1,\\n \\"ScoreNumType\\": 1,\\n \\"ScoreRuleHitType\\": 0,\\n \\"SchemeId\\": 1,\\n \\"SchemeRuleMappingId\\": 1,\\n \\"SchemeName\\": \\"通用方案\\",\\n \\"ModifyType\\": 1,\\n \\"SortIndex\\": 1,\\n \\"RuleType\\": 1,\\n \\"Rid\\": \\"1\\",\\n \\"Name\\": \\"开头语规则\\",\\n \\"TaskFlowId\\": 111111111,\\n \\"Lambda\\": \\"a&&b\\",\\n \\"ExternalProperty\\": 1,\\n \\"Type\\": 2,\\n \\"RuleCategoryName\\": \\"正向规则\\",\\n \\"AutoReview\\": 1,\\n \\"RuleScoreType\\": 3,\\n \\"ScoreId\\": 1,\\n \\"PreqRule\\": {\\n \\"Rid\\": \\"\\"\\n },\\n \\"BusinessCategoryNameList\\": [\\n \\"全部\\"\\n ],\\n \\"Dialogues\\": [\\n {\\n \\"Id\\": 1,\\n \\"Content\\": [\\n {\\n \\"HourMinSec\\": \\"00:00:00\\",\\n \\"Role\\": \\"客户\\",\\n \\"Identity\\": \\"客户\\",\\n \\"EmotionValue\\": 1,\\n \\"SpeechRate\\": 100,\\n \\"Words\\": \\"方便\\",\\n \\"End\\": 1360,\\n \\"SilenceDuration\\": 100,\\n \\"BeginTime\\": 350,\\n \\"Begin\\": 360\\n }\\n ],\\n \\"Name\\": \\"xx\\",\\n \\"UserGroup\\": \\"xx\\"\\n }\\n ],\\n \\"Triggers\\": [\\n \\"a\\"\\n ]\\n }\\n ],\\n \\"Dialogues\\": [\\n {\\n \\"Id\\": 1,\\n \\"Content\\": [\\n {\\n \\"HourMinSec\\": \\"00:00:00\\",\\n \\"Role\\": \\"客户\\",\\n \\"Identity\\": \\"客户\\",\\n \\"EmotionValue\\": 1,\\n \\"SpeechRate\\": 100,\\n \\"Words\\": \\"方便\\",\\n \\"End\\": 1360,\\n \\"SilenceDuration\\": 100,\\n \\"BeginTime\\": 350,\\n \\"Begin\\": 360\\n }\\n ],\\n \\"Name\\": \\"xx\\",\\n \\"UserGroup\\": \\"xx\\"\\n }\\n ],\\n \\"Count\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n ],\\n \\"CreateUserName\\": \\"xxx\\",\\n \\"CreateTime\\": \\"1616113198000\\",\\n \\"UpdateUserName\\": \\"xxx\\",\\n \\"UpdateTime\\": \\"1616113198000\\",\\n \\"Version\\": 1616113198000,\\n \\"SchemeCheckTypeList\\": [\\n {\\n \\"CheckType\\": 0,\\n \\"CheckName\\": \\"服务规范性检测\\",\\n \\"SourceScore\\": 10,\\n \\"Score\\": 20,\\n \\"Enable\\": 1,\\n \\"SchemeId\\": 32\\n }\\n ],\\n \\"InitScore\\": \\"100\\"\\n },\\n \\"RequestId\\": \\"96138D8D-8D26-4E41-BFF4-77AED1088BBD\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": [\\n \\"xxx\\"\\n ],\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
],
'GetResult' => [
- 'summary' => '获取质检结果',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Query quality inspection results. Some fields require the requiredFields parameter to be explicitly specified in the request. Set the service endpoint (Region) to Hangzhou (cn-hangzhou).',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7496,33 +6809,18 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '56188',
- 'abilityTreeNodes' => [
- 'FEATUREscaFRLL5D',
- 'FEATUREsca81P1AQ',
- ],
+ 'abilityTreeNodes' => ['FEATUREscaFRLL5D', 'FEATUREsca81P1AQ'],
],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"pageNumber":1,"pageSize":10,"excludeFields":"hitResult.hits, recording.url","requiredFields":"agent,status,errorMessage,reviewStatus,reviewResult,score,taskId,reviewer,resolver,recording.name,recording.duration,hitResult,business","dataType":1,"sourceType":0,"startTime":"2020-06-25 00:00:00","endTime":"2020-07-01 23:59:59"}',
- ],
+ 'schema' => ['description' => 'Full JSON string. See the detailed description below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"pageNumber":1,"pageSize":10,"excludeFields":"hitResult.hits, recording.url","requiredFields":"agent,status,errorMessage,reviewStatus,reviewResult,score,taskId,reviewer,resolver,recording.name,recording.duration,hitResult,business","dataType":1,"sourceType":0,"startTime":"2020-06-25 00:00:00","endTime":"2020-07-01 23:59:59"}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345'],
],
],
'responses' => [
@@ -7530,238 +6828,91 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3CEA0495-341B-4482-9AD9-8191EF4***',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ResultCountId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Count' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'RequestId' => ['description' => 'Unique request ID.', 'type' => 'string', 'example' => '3CEA0495-341B-4482-9AD9-8191EF4***', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. A value of true means success. A value of false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ResultCountId' => ['description' => 'Reserved field. Ignore this field.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
+ 'Code' => ['description' => 'Result code. `200` indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request failed. Returns successful if the request succeeded.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'PageNumber' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Count' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ResultInfo' => [
- 'description' => '',
+ 'description' => 'Query results.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'AssignmentTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-03-02T14:37Z',
- ],
- 'LastDataId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4498420@a_z@93EAADF1-01D3-44BD-8AC9-F57F447EFCE8_1614*****',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Reviewer' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-07-24T19:31Z',
- ],
- 'ReviewStatus' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ReviewTimeLong' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1602743090',
- ],
- 'TaskName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'ReviewResult' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Score' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'CreateTimeLong' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1602743090',
- ],
- 'ReviewTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-07-24T19:31Z',
- ],
- 'Comments' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'A6BEC8D-9A5B-4BE5-8432-4F635E***',
- ],
- 'ReviewType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Resolver' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
+ 'Status' => ['description' => 'Current task status: 0 for incomplete; 1 for complete. Use this field to determine completion. Values other than 0 or 1 indicate an error. Check the errorMessage field for details.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'AssignmentTime' => ['description' => 'Time the quality inspector was assigned.', 'type' => 'string', 'example' => '2021-03-02T14:37Z', 'title' => ''],
+ 'LastDataId' => ['description' => 'ID of the current record. When querying more than 10,000 records, include the lastDataId value from the last record of the previous response in each request.', 'type' => 'string', 'example' => '4498420@a_z@93EAADF1-01D3-44BD-8AC9-F57F447EFCE8_1614*****', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'Error details when status is not 0 or 1.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'Reviewer' => ['description' => 'Assigned quality inspector.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'CreateTime' => ['description' => 'Time the task was created.', 'type' => 'string', 'example' => '2019-07-24T19:31Z', 'title' => ''],
+ 'ReviewStatus' => ['description' => 'Review status: 0 for not reviewed; 1 for reviewed.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ReviewTimeLong' => ['description' => 'Time of the most recent review submission, in UNIX timestamp format.', 'type' => 'string', 'example' => '1602743090', 'title' => ''],
+ 'TaskName' => ['description' => 'Task name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'ReviewResult' => ['description' => 'Review accuracy: 0 for incorrect; 1 for correct; 2 for partially correct; 3 for pending review.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Score' => ['description' => 'Final file score. Maximum possible score is 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'CreateTimeLong' => ['description' => 'Time the task was created, in UNIX timestamp format.', 'type' => 'string', 'example' => '1602743090', 'title' => ''],
+ 'ReviewTime' => ['description' => 'Time of the most recent review submission.', 'type' => 'string', 'example' => '2019-07-24T19:31Z', 'title' => ''],
+ 'Comments' => ['description' => 'Review comments.', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'TaskId' => ['description' => 'Task ID.', 'type' => 'string', 'example' => 'A6BEC8D-9A5B-4BE5-8432-4F635E***', 'title' => ''],
+ 'ReviewType' => ['description' => 'Review method: 1 for automatic review; 2 for manual review.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Resolver' => ['description' => 'Actual reviewer.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
'AsrResult' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AsrResult' => [
- 'description' => '',
+ 'description' => 'ASR transcription result.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Words' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Begin' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10000',
- ],
- 'EmotionValue' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'End' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'SpeechRate' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
- ],
- 'Role' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Identity' => [
- 'type' => 'string',
- ],
+ 'Words' => ['description' => 'Dialogue content.', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'Begin' => ['description' => 'Start time of this sentence relative to the entire dialogue, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''],
+ 'EmotionValue' => ['description' => 'Emotion value for this sentence. Range is 0 to 10. Higher values indicate stronger emotion.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'End' => ['description' => 'End time of this sentence relative to the entire dialogue, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'SpeechRate' => ['description' => 'Speech rate for this sentence, in characters per minute.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
+ 'Role' => ['description' => 'Speaker role: customer service or customer.', 'type' => 'string', 'example' => '客户', 'title' => ''],
+ 'Identity' => ['description' => 'Specific identity of the speaker.', 'type' => 'string', 'example' => 'OPERATOR_001', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'HitResult' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'HitResult' => [
- 'description' => '',
+ 'description' => 'Rule hit results.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ReviewResult' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1276',
- ],
+ 'Type' => ['description' => 'Rule category. ><notice>Include hitResult.type in requiredFields.></notice>', 'type' => 'string', 'example' => '0417回归类型', 'title' => ''],
+ 'ReviewResult' => ['description' => 'Review accuracy: 0 for incorrect; 1 for correct.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Name' => ['description' => 'Name of the matched rule.', 'type' => 'string', 'example' => '20190417回归3', 'title' => ''],
+ 'Rid' => ['description' => 'ID of the matched rule.', 'type' => 'string', 'example' => '1276', 'title' => ''],
'Hits' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Hit' => [
- 'description' => '',
+ 'description' => 'Matched rules.',
'type' => 'array',
'items' => [
'type' => 'object',
@@ -7771,211 +6922,127 @@
'itemNode' => true,
'properties' => [
'KeyWord' => [
- 'description' => '',
+ 'description' => 'Matched keywords (for keyword and regular expression operators).',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'From' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'To' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Val' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Cid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
+ 'From' => ['description' => 'Starting position of the keyword.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'To' => ['description' => 'Ending position of the keyword.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'Val' => ['description' => 'Key information matched by the operator. See **Details about Val** below.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'Cid' => ['description' => 'ID of the matched condition.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'Cid' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Cid' => [
- 'description' => '',
+ 'description' => 'List of matched condition IDs.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
+ 'items' => ['description' => 'Matched condition ID.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'Phrase' => [
- 'description' => '',
+ 'description' => 'Matched sentence information.',
'type' => 'object',
'properties' => [
- 'EmotionValue' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'End' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '300',
- ],
- 'Words' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Role' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Begin' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '300',
- ],
+ 'EmotionValue' => ['description' => 'Emotion value for this sentence. Range is 0 to 10. Higher values indicate stronger emotion.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'End' => ['description' => 'End time of this sentence relative to the entire dialogue, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'title' => ''],
+ 'Words' => ['description' => 'Dialogue content.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'Role' => ['description' => 'Speaker role: customer service or customer.', 'type' => 'string', 'example' => '客服', 'title' => ''],
+ 'Begin' => ['description' => 'Start time of this sentence relative to the entire dialogue, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '300', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'SchemeId' => [
'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123xx',
- ],
- 'SchemeVersion' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '11xx',
+ 'title' => '',
+ 'example' => '',
],
+ 'SchemeId' => ['description' => 'Quality inspection scheme ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123xx', 'title' => ''],
+ 'SchemeVersion' => ['description' => 'Quality inspection scheme version.', 'type' => 'integer', 'format' => 'int64', 'example' => '11xx', 'title' => ''],
'Conditions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Conditions' => [
+ 'description' => 'Logical relationship between operators in the condition.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Cid' => [
- 'title' => '条件id,可能是db中的主键,也可能是转换成的a, b, c',
- 'description' => '条件id,可能是db中的主键,也可能是转换成的a, b, c',
- 'type' => 'string',
- ],
- 'Id' => [
- 'title' => '在db中的主键',
- 'description' => '在db中的主键',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'Rid' => [
- 'title' => '条件所属的规则id',
- 'description' => '条件所属的规则id',
- 'type' => 'string',
- ],
+ 'Cid' => ['title' => '条件id,可能是db中的主键,也可能是转换成的a, b, c', 'description' => 'Condition ID. May be a database primary key or a converted value such as a, b, or c.', 'type' => 'string', 'example' => 'a'],
+ 'Id' => ['title' => '在db中的主键', 'description' => 'Primary key in the database.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Rid' => ['title' => '条件所属的规则id', 'description' => 'Rule ID associated with this condition.', 'type' => 'string', 'example' => '1'],
'Check_range' => [
'title' => '检测范围',
- 'description' => '检测范围',
+ 'description' => 'Detection range.',
'type' => 'object',
'properties' => [
- 'RoleId' => [
- 'title' => '对应 RoleType.id',
- 'description' => '对应 RoleType.id',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'Role' => [
- 'title' => '对应 RoleType.type',
- 'description' => '对应 RoleType.type',
- 'type' => 'string',
- ],
+ 'RoleId' => ['title' => '对应 RoleType.id', 'description' => 'Corresponds to RoleType.id.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Role' => ['title' => '对应 RoleType.type', 'description' => 'Corresponds to RoleType.type.', 'type' => 'string', 'example' => '客服'],
'Anchor' => [
'title' => '前置后置条件',
- 'description' => '前置后置条件',
+ 'description' => 'Precondition or postcondition.',
'type' => 'object',
'properties' => [
- 'Cid' => [
- 'title' => '条件ID',
- 'description' => '条件ID',
- 'type' => 'string',
- ],
- 'Location' => [
- 'title' => '位置',
- 'description' => '位置',
- 'type' => 'string',
- ],
- 'Hit_time' => [
- 'title' => '命中次数',
- 'description' => '命中次数',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'Cid' => ['title' => '条件ID', 'description' => 'Condition ID.', 'type' => 'string', 'example' => '1'],
+ 'Location' => ['title' => '位置', 'description' => 'Location', 'type' => 'string', 'example' => 'BEFORE'],
+ 'Hit_time' => ['title' => '命中次数', 'description' => 'Number of hits.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
+ 'example' => '',
],
'Range' => [
'title' => '相对范围',
- 'description' => '相对范围',
+ 'description' => 'Relative range.',
'type' => 'object',
'properties' => [
- 'From' => [
- 'title' => '对话开始索引',
- 'description' => '对话开始索引',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'To' => [
- 'title' => '对话结束索引',
- 'description' => '对话结束索引',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'From' => ['title' => '对话开始索引', 'description' => 'Start index of the dialogue.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'To' => ['title' => '对话结束索引', 'description' => 'End index of the dialogue.', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
],
+ 'example' => '',
],
'TimeRange' => [
'type' => 'object',
'properties' => [
- 'From' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'To' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'From' => ['description' => 'Start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1733277928', 'title' => ''],
+ 'To' => ['description' => 'End time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1733277928', 'title' => ''],
],
+ 'description' => 'Time range.',
+ 'title' => '',
+ 'example' => '',
],
- 'Absolute' => [
- 'title' => 'false: 相对位置; 会结合anchor以及角色来决定句子位置',
- 'description' => 'false: 相对位置; 会结合anchor以及角色来决定句子位置',
- 'type' => 'boolean',
- ],
- 'AllSentencesSatisfy' => [
- 'title' => 'true: 每句话都必须满足条件;',
- 'description' => 'true: 每句话都必须满足条件;',
- 'type' => 'boolean',
- ],
+ 'Absolute' => ['title' => 'false: 相对位置; 会结合anchor以及角色来决定句子位置', 'description' => 'false: Relative position. Position depends on anchor and role.', 'type' => 'boolean', 'example' => 'false'],
+ 'AllSentencesSatisfy' => ['title' => 'true: 每句话都必须满足条件;', 'description' => 'true: Every sentence must satisfy the condition.', 'type' => 'boolean', 'example' => 'true'],
],
+ 'example' => '',
],
'Operators' => [
'type' => 'object',
@@ -7983,30 +7050,17 @@
'properties' => [
'Operator' => [
'title' => '算子列表',
- 'description' => '算子列表',
+ 'description' => 'List of operators.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Oid' => [
- 'title' => '可能是主键id,也可能是前端生成的id',
- 'description' => '可能是主键id,也可能是前端生成的id',
- 'type' => 'string',
- ],
- 'Id' => [
- 'title' => '主键id',
- 'description' => '主键id',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'Type' => [
- 'title' => '算子类别',
- 'description' => '算子类别',
- 'type' => 'string',
- ],
+ 'Oid' => ['title' => '可能是主键id,也可能是前端生成的id', 'description' => 'ID. May be a database primary key or an ID generated by the frontend.', 'type' => 'string', 'example' => '1'],
+ 'Id' => ['title' => '主键id', 'description' => 'Primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Type' => ['title' => '算子类别', 'description' => 'Operator category.', 'type' => 'string', 'example' => 'ABUSE_MODEL'],
'Param' => [
'title' => '算子参数',
- 'description' => '算子参数',
+ 'description' => 'Operator parameters.',
'type' => 'object',
'properties' => [
'Keywords' => [
@@ -8015,648 +7069,585 @@
'properties' => [
'Keyword' => [
'title' => '关键词',
- 'description' => '关键词',
+ 'description' => 'Keywords.',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
+ 'items' => ['description' => 'Keyword.', 'type' => 'string', 'example' => '你好', 'title' => ''],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'Regex' => [
- 'title' => '正则表达式',
- 'description' => '正则表达式',
- 'type' => 'string',
- ],
- 'NotRegex' => [
- 'title' => '排除的正则表达式',
- 'description' => '排除的正则表达式',
- 'type' => 'string',
- ],
- 'Phrase' => [
- 'title' => '语句',
- 'description' => '语句',
- 'type' => 'string',
- ],
- 'Interval' => [
- 'title' => 'interval代表区间范围开始',
- 'description' => 'interval代表区间范围开始',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'IntervalEnd' => [
- 'title' => 'intervalEnd 代表区间范围结束',
- 'description' => 'intervalEnd 代表区间范围结束',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'Threshold' => [
- 'title' => '阈值',
- 'description' => '阈值',
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'In_sentence' => [
- 'title' => '生效句子, true单个句子,false多个句子',
- 'description' => '生效句子, true单个句子,false多个句子',
- 'type' => 'boolean',
- ],
- 'Target' => [
- 'title' => 'target',
- 'description' => 'target',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'From_end' => [
- 'title' => 'from_end',
- 'description' => 'from_end',
- 'type' => 'boolean',
- ],
- 'KeywordExtension' => [
- 'title' => '关键字扩展',
- 'description' => '关键字扩展',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'Case_sensitive' => [
- 'title' => '区分大小写',
- 'description' => '区分大小写',
- 'type' => 'boolean',
- ],
- 'Near_dialogue' => [
- 'title' => 'true表示取不同角色相邻的两句话,false表示取不同角色的第一句话比较响应时间(默认)',
- 'description' => 'true表示取不同角色相邻的两句话,false表示取不同角色的第一句话比较响应时间(默认)',
- 'type' => 'boolean',
- ],
- 'MinWordSize' => [
- 'title' => '句子中最少字数,小于此字数的句子不检查',
- 'description' => '句子中最少字数,小于此字数的句子不检查',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'Hit_time' => [
- 'title' => '上下文重复算子:重复几次',
- 'description' => '上下文重复算子:重复几次',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'Regex' => ['title' => '正则表达式', 'description' => 'Regular expression.', 'type' => 'string', 'example' => 'a&&b'],
+ 'NotRegex' => ['title' => '排除的正则表达式', 'description' => 'Excluded regular expression.', 'type' => 'string', 'example' => 'c&&d'],
+ 'Phrase' => ['title' => '语句', 'description' => 'Sentence.', 'type' => 'string', 'example' => '你好'],
+ 'Interval' => ['title' => 'interval代表区间范围开始', 'description' => 'Start value for the interval range.', 'type' => 'integer', 'format' => 'int32', 'example' => '1733277928'],
+ 'IntervalEnd' => ['title' => 'intervalEnd 代表区间范围结束', 'description' => 'End value for the interval range.', 'type' => 'integer', 'format' => 'int32', 'example' => '1733277928'],
+ 'Threshold' => ['title' => '阈值', 'description' => 'Threshold value.', 'type' => 'number', 'format' => 'float', 'example' => '1'],
+ 'In_sentence' => ['title' => '生效句子, true单个句子,false多个句子', 'description' => 'Applies to single sentence (true) or multiple sentences (false).', 'type' => 'boolean', 'example' => 'true'],
+ 'Target' => ['title' => 'target', 'description' => 'Target value.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'From_end' => ['title' => 'from_end', 'description' => 'Indicates whether to count from the end.', 'type' => 'boolean', 'example' => '1'],
+ 'KeywordExtension' => ['title' => '关键字扩展', 'description' => 'Keyword extension.', 'type' => 'integer', 'format' => 'int32', 'example' => '你好'],
+ 'Case_sensitive' => ['title' => '区分大小写', 'description' => 'Whether case-sensitive matching is enabled.', 'type' => 'boolean', 'example' => 'false'],
+ 'Near_dialogue' => ['title' => 'true表示取不同角色相邻的两句话,false表示取不同角色的第一句话比较响应时间(默认)', 'description' => 'true: Compare two adjacent sentences spoken by different roles. false: Compare the first sentence spoken by each role (default).', 'type' => 'boolean', 'example' => 'false'],
+ 'MinWordSize' => ['title' => '句子中最少字数,小于此字数的句子不检查', 'description' => 'The minimum number of words that a sentence must contain to be checked.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'Hit_time' => ['title' => '上下文重复算子:重复几次', 'description' => 'Number of times context repeats.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'Excludes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Exclude' => [
'title' => '上下文重复算子:排除掉某些对话',
- 'description' => '上下文重复算子:排除掉某些对话',
+ 'description' => 'Dialogues to exclude for context repeat detection.',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
+ 'items' => ['description' => 'Dialogue to exclude for context repeat detection.', 'type' => 'string', 'example' => '你好', 'title' => ''],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'From' => [
- 'title' => '上下文重复算子:检测当前句的前from句是否有重复;0表示前面的所有句',
- 'description' => '上下文重复算子:检测当前句的前from句是否有重复;0表示前面的所有句',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'CheckFirstSentence' => [
- 'title' => '静音检测:要不要检测第一句话',
- 'description' => '静音检测:要不要检测第一句话',
- 'type' => 'boolean',
- ],
- 'Average' => [
- 'title' => '语速检测,是否计算整个对话平均语速,默认false',
- 'description' => '语速检测,是否计算整个对话平均语速,默认false',
- 'type' => 'boolean',
- ],
- 'BeginType' => [
- 'title' => '时长算子,时长计算开始类型,录音开始,还是某句对话开始',
- 'description' => '时长算子,时长计算开始类型,录音开始,还是某句对话开始',
- 'type' => 'string',
- ],
- 'EndType' => [
- 'title' => '时长算子,时长计算结束类型,录音结束,还是某句对话结束',
- 'description' => '时长算子,时长计算结束类型,录音结束,还是某句对话结束',
- 'type' => 'string',
- ],
- 'CompareOperator' => [
- 'title' => '大于,还是小于,gt/lt',
- 'description' => '大于,还是小于,gt/lt',
- 'type' => 'string',
- ],
- 'ContextChatMatch' => [
- 'title' => '是否单句话匹配;',
- 'description' => '是否单句话匹配;',
- 'type' => 'boolean',
- ],
- 'KeywordMatchSize' => [
- 'title' => '匹配到的关键字数量',
- 'description' => '匹配到的关键字数量',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'MaxEmotionChangeValue' => [
- 'title' => '能量值变化,默认3, 1~9',
- 'description' => '能量值变化,默认3, 1~9',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'CheckType' => [
- 'title' => '检测方式,1 相邻句能量波动 2 最大能量跨度 默认1',
- 'description' => '检测方式,1 相邻句能量波动 2 最大能量跨度 默认1',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'DelayTime' => [
- 'title' => '抢话算子 延时时长',
- 'description' => '抢话算子 延时时长',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'From' => ['title' => '上下文重复算子:检测当前句的前from句是否有重复;0表示前面的所有句', 'description' => 'Number of previous sentences to check for repetition. 0 means check all previous sentences.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'CheckFirstSentence' => ['title' => '静音检测:要不要检测第一句话', 'description' => 'Whether to check the first sentence for silence detection.', 'type' => 'boolean', 'example' => 'false'],
+ 'Average' => ['title' => '语速检测,是否计算整个对话平均语速,默认false', 'description' => 'Whether to calculate the average speech rate across the entire dialogue. Default is false.', 'type' => 'boolean', 'example' => 'false'],
+ 'BeginType' => ['title' => '时长算子,时长计算开始类型,录音开始,还是某句对话开始', 'description' => 'Start type for duration calculation: 0 for call start; 1 for sentence start.', 'type' => 'string', 'example' => '0'],
+ 'EndType' => ['title' => '时长算子,时长计算结束类型,录音结束,还是某句对话结束', 'description' => 'The duration operator specifies whether duration calculation ends when the recording ends or when a specific utterance ends.', 'type' => 'string', 'example' => '0'],
+ 'CompareOperator' => ['title' => '大于,还是小于,gt/lt', 'description' => 'Comparison operator: gt for greater than; lt for less than.', 'type' => 'string', 'example' => 'gt'],
+ 'ContextChatMatch' => ['title' => '是否单句话匹配;', 'description' => 'Whether to match a single sentence.', 'type' => 'boolean', 'example' => 'true'],
+ 'KeywordMatchSize' => ['title' => '匹配到的关键字数量', 'description' => 'Number of matched keywords.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'MaxEmotionChangeValue' => ['title' => '能量值变化,默认3, 1~9', 'description' => 'Maximum emotion change value. Default is 3. Range is 1 to 9.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'CheckType' => ['title' => '检测方式,1 相邻句能量波动 2 最大能量跨度 默认1', 'description' => 'Detection method: 1 for energy fluctuation between adjacent sentences; 2 for maximum energy span. Default is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'DelayTime' => ['title' => '抢话算子 延时时长', 'description' => 'Delay time for interruption detection, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
'FlowNodePrerequisiteParam' => [
'title' => '流程节点前置条件参数',
- 'description' => '流程节点前置条件参数',
+ 'description' => 'Prerequisite parameters for flow nodes.',
'type' => 'object',
'properties' => [
- 'NodeId' => [
- 'title' => '节点id',
- 'description' => '节点id',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'NodeName' => [
- 'title' => '冗余的节点名称',
- 'description' => '冗余的节点名称',
- 'type' => 'string',
- ],
- 'NodeMatchStatus' => [
- 'title' => '节点匹配状态。',
- 'description' => '节点匹配状态。',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'NodeId' => ['title' => '节点id', 'description' => 'Node ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'NodeName' => ['title' => '冗余的节点名称', 'description' => 'Redundant node name.', 'type' => 'string', 'example' => '开始节点'],
+ 'NodeMatchStatus' => ['title' => '节点匹配状态。', 'description' => 'Node match status.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
+ 'example' => '',
],
'IntentModelCheckParm' => [
'title' => '意图模型检查参数',
- 'description' => '意图模型检查参数',
+ 'description' => 'Intent model check parameters.',
'type' => 'object',
'properties' => [
- 'ModelScene' => [
- 'title' => '模型应用的场景 AGENT:客户场景、CUSTOMER:客服场景 (CUSTOMER: 客户场景, AGENT: 坐席场景)',
- 'description' => '模型应用的场景 AGENT:客户场景、CUSTOMER:客服场景 (CUSTOMER: 客户场景, AGENT: 坐席场景)',
- 'type' => 'string',
- ],
+ 'ModelScene' => ['title' => '模型应用的场景 AGENT:客户场景、CUSTOMER:客服场景 (CUSTOMER: 客户场景, AGENT: 坐席场景)', 'description' => 'Scenarios for model application include AGENT (customer scenario) and CUSTOMER (customer service scenario).', 'type' => 'string', 'example' => 'AGENT'],
'Intents' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Intent' => [
'title' => '引用的意图模型',
- 'description' => '引用的意图模型',
+ 'description' => 'Referenced intent models.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '意图模型ID',
- 'description' => '意图模型ID',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'Name' => [
- 'title' => '意图模型名称',
- 'description' => '意图模型名称',
- 'type' => 'string',
- ],
+ 'Id' => ['title' => '意图模型ID', 'description' => 'Intent model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'cn-north-2-gov-1'],
+ 'Name' => ['title' => '意图模型名称', 'description' => 'Intent model name.', 'type' => 'string', 'example' => 'fvt-eci-copy-5c703091'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
- 'Name' => [
- 'title' => '算子名',
- 'description' => '算子名',
- 'type' => 'string',
- ],
+ 'Name' => ['title' => '算子名', 'description' => 'Operator name.', 'type' => 'string', 'example' => '关键字检测'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'Lambda' => [
- 'title' => 'Lambda表达式:例如:a&&b',
- 'description' => 'Lambda表达式:例如:a&&b',
- 'type' => 'string',
- ],
- 'Exclusion' => [
- 'title' => '排除',
- 'description' => '排除',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'Lambda' => ['title' => 'Lambda表达式:例如:a&&b', 'description' => 'Lambda expression. Example: `a&&b`.', 'type' => 'string', 'example' => 'a&&b'],
+ 'Exclusion' => ['title' => '排除', 'description' => 'Exclusion', 'type' => 'integer', 'format' => 'int32', 'example' => 'c&&d'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'Score' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'MachineHitResult' => [
- 'title' => '机检命中结果',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'FinalHitResult' => [
- 'title' => '最终命中结果',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'ArtificialRule' => [
- 'title' => '是否人工规则',
- 'type' => 'string',
- 'example' => 'turn',
- ],
+ 'Score' => ['description' => 'Score. Positive values add points. Negative values subtract points.', 'type' => 'integer', 'format' => 'int32', 'example' => '-5', 'title' => ''],
+ 'MachineHitResult' => ['title' => 'Machine inspection hit result', 'type' => 'string', 'example' => '1', 'description' => ''],
+ 'FinalHitResult' => ['title' => 'Final hit result', 'type' => 'string', 'example' => '1', 'description' => ''],
+ 'ArtificialRule' => ['title' => 'Is Artificial Rule', 'type' => 'string', 'example' => 'turn', 'description' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'HitScore' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'HitScore' => [
- 'description' => '',
+ 'description' => 'Scoring items triggered for this file, including those associated with rules and manually added scoring items.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'ScoreName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ScoreNumber' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-20',
- ],
- 'ScoreId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123456',
- ],
- 'RuleId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
- ],
+ 'ScoreName' => ['description' => 'Name of the scoring item.', 'type' => 'string', 'example' => '投诉', 'title' => ''],
+ 'ScoreNumber' => ['description' => 'Score for the scoring item. Positive values add points. Negative values subtract points.', 'type' => 'string', 'example' => '-20', 'title' => ''],
+ 'ScoreId' => ['description' => 'ID of the scoring item.', 'type' => 'string', 'example' => '123456', 'title' => ''],
+ 'RuleId' => ['description' => 'ID of the rule that triggered this scoring item. If present, the scoring item is rule-associated. If absent, it was manually added.', 'type' => 'string', 'example' => '123', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'Recording' => [
- 'description' => '',
+ 'description' => 'Recording file information.',
'type' => 'object',
'properties' => [
- 'Remark13' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'Callee' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1888888****',
- ],
- 'DialogueSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '32',
- ],
- 'PrimaryId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3437500',
- ],
- 'Remark12' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'Remark1' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'Remark7' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'Remark8' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'Remark2' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'CallId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXX',
- ],
- 'Remark9' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123456.mkv',
- ],
- 'Remark6' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'Remark10' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'Business' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Remark3' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'Url' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'http://aliyun.com/audio.wav',
- ],
- 'Remark11' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'Remark4' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'CallType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Caller' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0108888****',
- ],
- 'DataSetName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXX',
- ],
- 'Duration' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '60',
- ],
- 'Remark5' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1232',
- ],
- 'Id' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXXXX',
- ],
- 'CallTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1563967699000',
- ],
- 'TaskConfigId' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'TaskConfigName' => [
- 'type' => 'string',
- ],
- 'CustomerName' => [
- 'type' => 'string',
- ],
+ 'Remark13' => ['description' => 'Custom data 13.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
+ 'Callee' => ['description' => 'Callee number.', 'type' => 'string', 'example' => '1888888****', 'title' => ''],
+ 'DialogueSize' => ['description' => 'Number of dialogue turns.', 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''],
+ 'PrimaryId' => ['description' => 'Recording file ID.', 'type' => 'string', 'example' => '3437500', 'title' => ''],
+ 'Remark12' => ['description' => 'Custom data 12.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
+ 'Remark1' => ['description' => 'Custom data 1.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
+ 'Remark7' => ['description' => 'Custom data 7.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
+ 'Remark8' => ['description' => 'Custom data 8.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
+ 'Remark2' => ['description' => 'Custom data 2.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
+ 'CallId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'XXXX', 'title' => ''],
+ 'Remark9' => ['description' => 'Custom data 9.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
+ 'Name' => ['description' => 'Recording file name.', 'type' => 'string', 'example' => '123456.mkv', 'title' => ''],
+ 'Remark6' => ['description' => 'Custom data 6.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
+ 'Remark10' => ['description' => 'Custom data 10.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
+ 'Business' => ['description' => 'Business line name, used for classification and statistics.', 'type' => 'string', 'example' => '客服业务线', 'title' => ''],
+ 'Remark3' => ['description' => 'Custom data 3.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
+ 'Url' => ['description' => 'File URL.', 'type' => 'string', 'example' => 'http://aliyun.com/audio.wav', 'title' => ''],
+ 'Remark11' => ['description' => 'Custom data 11.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
+ 'Remark4' => ['description' => 'Custom data 4.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
+ 'CallType' => ['description' => 'Call type: 1 for outbound; 3 for inbound.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Caller' => ['description' => 'Caller number.', 'type' => 'string', 'example' => '0108888****', 'title' => ''],
+ 'DataSetName' => ['description' => 'Name of the dataset containing the file. Present only when the file is uploaded from a dataset.', 'type' => 'string', 'example' => 'XXXX', 'title' => ''],
+ 'Duration' => ['description' => 'Call duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
+ 'Remark5' => ['description' => 'Custom data 5.', 'type' => 'integer', 'format' => 'int64', 'example' => '1232', 'title' => ''],
+ 'Id' => ['description' => 'File ID. Same as the callId request parameter. If not specified, a random ID is generated.', 'type' => 'string', 'example' => '6fa76916-3ce6-45d8-ac64-01b7f31***', 'title' => ''],
+ 'CallTime' => ['description' => 'Timestamp when the recording was created, accurate to the millisecond.', 'type' => 'string', 'example' => '1563967699000', 'title' => ''],
+ 'TaskConfigId' => ['description' => 'Task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''],
+ 'TaskConfigName' => ['description' => 'Task name.', 'type' => 'string', 'example' => '任务A', 'title' => ''],
+ 'CustomerName' => ['description' => 'Customer name.', 'type' => 'string', 'example' => '张三', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'Agent' => [
- 'description' => '',
+ 'description' => 'Customer service agent information.',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SkillGroup' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Id' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '28240****15643',
- ],
+ 'Name' => ['description' => 'Customer service agent name.', 'type' => 'string', 'example' => '智能对话分析客服', 'title' => ''],
+ 'SkillGroup' => ['description' => 'Skill group name.', 'type' => 'string', 'example' => '质检技能', 'title' => ''],
+ 'Id' => ['description' => 'Customer service agent ID.', 'type' => 'string', 'example' => '28240****15643', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'SchemeIdList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SchemeIdList' => [
- 'description' => '',
+ 'description' => 'List of quality inspection scheme IDs.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '13xxx',
- ],
+ 'items' => ['description' => 'Quality inspection scheme ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '13xxx', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'SchemeNameList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SchemeNameList' => [
- 'description' => '',
+ 'description' => 'List of quality inspection scheme names.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'items' => ['description' => 'Quality inspection scheme name.', 'type' => 'string', 'example' => '售前通用方案', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'ReviewHistoryList' => [
- 'type' => 'object',
'itemNode' => true,
+ 'description' => '',
+ 'type' => 'object',
'properties' => [
'ReviewHistory' => [
+ 'description' => 'Review history.',
'type' => 'array',
'items' => [
+ 'description' => 'Review history.',
'type' => 'object',
'properties' => [
- 'Type' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'OperatorName' => [
- 'type' => 'string',
- ],
- 'TimeStr' => [
- 'type' => 'string',
- ],
- 'Score' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ReviewResult' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ComplainResult' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'OldScore' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ReviewManagerType' => [
- 'type' => 'string',
- ],
- 'Time' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'Comments' => [
- 'type' => 'string',
- ],
+ 'Type' => ['description' => 'Review type: 0 for automatic review; 1 for manual review.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'OperatorName' => ['description' => 'Reviewer username.', 'type' => 'string', 'example' => '张三', 'title' => ''],
+ 'TimeStr' => ['description' => 'Review time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2019-10-28 15:21:00', 'title' => ''],
+ 'Score' => ['description' => 'Score after review.', 'type' => 'integer', 'format' => 'int32', 'example' => '95', 'title' => ''],
+ 'ReviewResult' => ['description' => 'Review result: 1 if all checks passed; 0 if at least one check failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ComplainResult' => ['description' => 'Appeal result: 1 if all appeals were approved; 0 if at least one was rejected.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'OldScore' => ['description' => 'Score before review.', 'type' => 'integer', 'format' => 'int32', 'example' => '90', 'title' => ''],
+ 'ReviewManagerType' => ['description' => 'Review type details.', 'type' => 'string', 'example' => '[一个类别][二类别:第一类目,第一类目->下一集]', 'title' => ''],
+ 'Time' => ['description' => 'Timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1722396376000', 'title' => ''],
+ 'Comments' => ['description' => 'Comments.', 'type' => 'string', 'example' => '车险理赔外呼16', 'title' => ''],
'ReviewRightRule' => [
- 'type' => 'object',
'itemNode' => true,
+ 'description' => '',
+ 'type' => 'object',
'properties' => [
'ReviewRightRule' => [
+ 'description' => 'The rule that was determined to be correct during the review.',
'type' => 'array',
'items' => [
+ 'description' => '',
'type' => 'object',
'properties' => [
- 'ruleName' => [
- 'type' => 'string',
- ],
- 'rid' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'ruleName' => ['description' => 'Rule name.', 'type' => 'string', 'example' => '问候语规则', 'title' => ''],
+ 'rid' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '21', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- 'Operator' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'Operator' => ['description' => 'Operator ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '83197', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
'ReviewTypeIdList' => [
- 'type' => 'object',
'itemNode' => true,
+ 'description' => '',
+ 'type' => 'object',
'properties' => [
'ReviewTypeIdList' => [
+ 'description' => 'List of review types.',
'type' => 'array',
'items' => [
+ 'description' => '',
'type' => 'object',
'properties' => [
'ReviewKeyIdList' => [
- 'type' => 'object',
'itemNode' => true,
+ 'description' => '',
+ 'type' => 'object',
'properties' => [
'ReviewKeyIdList' => [
+ 'description' => 'List of review tag IDs.',
'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'items' => ['description' => 'Review tag.', 'type' => 'integer', 'format' => 'int64', 'example' => '[4, 5]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- 'ReviewTypeId' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'ReviewTypeId' => ['description' => 'Review category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- 'Vid' => [
- 'type' => 'string',
- ],
+ 'Vid' => ['description' => 'File ID.', 'type' => 'string', 'example' => '6fa76916-3ce6-45d8-ac64-01b7f31***', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\",\\n \\"Success\\": true,\\n \\"ResultCountId\\": \\"XXX\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Count\\": 1,\\n \\"Data\\": {\\n \\"ResultInfo\\": [\\n {\\n \\"Status\\": 0,\\n \\"AssignmentTime\\": \\"2021-03-02T14:37Z\\",\\n \\"LastDataId\\": \\"4498420@a_z@93EAADF1-01D3-44BD-8AC9-F57F447EFCE8_1614*****\\",\\n \\"ErrorMessage\\": \\"xxx\\",\\n \\"Reviewer\\": \\"xxx\\",\\n \\"CreateTime\\": \\"2019-07-24T19:31Z\\",\\n \\"ReviewStatus\\": 1,\\n \\"ReviewTimeLong\\": \\"1602743090\\",\\n \\"TaskName\\": \\"test\\",\\n \\"ReviewResult\\": 0,\\n \\"Score\\": 100,\\n \\"CreateTimeLong\\": \\"1602743090\\",\\n \\"ReviewTime\\": \\"2019-07-24T19:31Z\\",\\n \\"Comments\\": \\"xx\\",\\n \\"TaskId\\": \\"A6BEC8D-9A5B-4BE5-8432-4F635E***\\",\\n \\"ReviewType\\": 1,\\n \\"Resolver\\": \\"XXX\\",\\n \\"AsrResult\\": {\\n \\"AsrResult\\": [\\n {\\n \\"Words\\": \\"xx\\",\\n \\"Begin\\": 10000,\\n \\"EmotionValue\\": 1,\\n \\"End\\": 0,\\n \\"SpeechRate\\": 50,\\n \\"Role\\": \\"客户\\",\\n \\"Identity\\": \\"OPERATOR_001\\"\\n }\\n ]\\n },\\n \\"HitResult\\": {\\n \\"HitResult\\": [\\n {\\n \\"Type\\": \\"0417回归类型\\",\\n \\"ReviewResult\\": 0,\\n \\"Name\\": \\"20190417回归3\\",\\n \\"Rid\\": \\"1276\\",\\n \\"Hits\\": {\\n \\"Hit\\": [\\n {\\n \\"KeyWords\\": {\\n \\"KeyWord\\": [\\n {\\n \\"From\\": 1,\\n \\"To\\": 2,\\n \\"Val\\": \\"test\\",\\n \\"Cid\\": \\"xxxx\\"\\n }\\n ]\\n },\\n \\"Cid\\": {\\n \\"Cid\\": [\\n \\"xxxx\\"\\n ]\\n },\\n \\"Phrase\\": {\\n \\"EmotionValue\\": 0,\\n \\"End\\": 300,\\n \\"Words\\": \\"xxx\\",\\n \\"Role\\": \\"客服\\",\\n \\"Begin\\": 300\\n }\\n }\\n ]\\n },\\n \\"SchemeId\\": 0,\\n \\"SchemeVersion\\": 0,\\n \\"Conditions\\": {\\n \\"Conditions\\": [\\n {\\n \\"Cid\\": \\"a\\",\\n \\"Id\\": 1,\\n \\"Rid\\": \\"1\\",\\n \\"Check_range\\": {\\n \\"RoleId\\": 1,\\n \\"Role\\": \\"客服\\",\\n \\"Anchor\\": {\\n \\"Cid\\": \\"1\\",\\n \\"Location\\": \\"BEFORE\\",\\n \\"Hit_time\\": 1\\n },\\n \\"Range\\": {\\n \\"From\\": 2,\\n \\"To\\": 4\\n },\\n \\"TimeRange\\": {\\n \\"From\\": 1733277928,\\n \\"To\\": 1733277928\\n },\\n \\"Absolute\\": false,\\n \\"AllSentencesSatisfy\\": true\\n },\\n \\"Operators\\": {\\n \\"Operator\\": [\\n {\\n \\"Oid\\": \\"1\\",\\n \\"Id\\": 1,\\n \\"Type\\": \\"ABUSE_MODEL\\",\\n \\"Param\\": {\\n \\"Keywords\\": {\\n \\"Keyword\\": [\\n \\"你好\\"\\n ]\\n },\\n \\"Regex\\": \\"a&&b\\",\\n \\"NotRegex\\": \\"c&&d\\",\\n \\"Phrase\\": \\"你好\\",\\n \\"Interval\\": 1733277928,\\n \\"IntervalEnd\\": 1733277928,\\n \\"Threshold\\": 1,\\n \\"In_sentence\\": true,\\n \\"Target\\": 0,\\n \\"From_end\\": true,\\n \\"KeywordExtension\\": 0,\\n \\"Case_sensitive\\": false,\\n \\"Near_dialogue\\": false,\\n \\"MinWordSize\\": 2,\\n \\"Hit_time\\": 2,\\n \\"Excludes\\": {\\n \\"Exclude\\": [\\n \\"你好\\"\\n ]\\n },\\n \\"From\\": 0,\\n \\"CheckFirstSentence\\": false,\\n \\"Average\\": false,\\n \\"BeginType\\": \\"0\\",\\n \\"EndType\\": \\"0\\",\\n \\"CompareOperator\\": \\"gt\\",\\n \\"ContextChatMatch\\": true,\\n \\"KeywordMatchSize\\": 1,\\n \\"MaxEmotionChangeValue\\": 2,\\n \\"CheckType\\": 1,\\n \\"DelayTime\\": 1000,\\n \\"FlowNodePrerequisiteParam\\": {\\n \\"NodeId\\": 1,\\n \\"NodeName\\": \\"开始节点\\",\\n \\"NodeMatchStatus\\": 1\\n },\\n \\"IntentModelCheckParm\\": {\\n \\"ModelScene\\": \\"AGENT\\",\\n \\"Intents\\": {\\n \\"Intent\\": [\\n {\\n \\"Id\\": 0,\\n \\"Name\\": \\"fvt-eci-copy-5c703091\\"\\n }\\n ]\\n }\\n }\\n },\\n \\"Name\\": \\"关键字检测\\"\\n }\\n ]\\n },\\n \\"Lambda\\": \\"a&&b\\",\\n \\"Exclusion\\": 0\\n }\\n ]\\n },\\n \\"Score\\": -5,\\n \\"MachineHitResult\\": \\"1\\",\\n \\"FinalHitResult\\": \\"1\\",\\n \\"ArtificialRule\\": \\"turn\\"\\n }\\n ]\\n },\\n \\"HitScore\\": {\\n \\"HitScore\\": [\\n {\\n \\"ScoreName\\": \\"投诉\\",\\n \\"ScoreNumber\\": \\"-20\\",\\n \\"ScoreId\\": \\"123456\\",\\n \\"RuleId\\": \\"123\\"\\n }\\n ]\\n },\\n \\"Recording\\": {\\n \\"Remark13\\": \\"XXX\\",\\n \\"Callee\\": \\"1888888****\\",\\n \\"DialogueSize\\": 32,\\n \\"PrimaryId\\": \\"3437500\\",\\n \\"Remark12\\": \\"XXX\\",\\n \\"Remark1\\": \\"XXX\\",\\n \\"Remark7\\": \\"XXX\\",\\n \\"Remark8\\": \\"XXX\\",\\n \\"Remark2\\": \\"XXX\\",\\n \\"CallId\\": \\"XXXX\\",\\n \\"Remark9\\": \\"XXX\\",\\n \\"Name\\": \\"123456.mkv\\",\\n \\"Remark6\\": \\"XXX\\",\\n \\"Remark10\\": \\"XXX\\",\\n \\"Business\\": \\"客服业务线\\",\\n \\"Remark3\\": \\"XXX\\",\\n \\"Url\\": \\"http://aliyun.com/audio.wav\\",\\n \\"Remark11\\": \\"XXX\\",\\n \\"Remark4\\": \\"XXX\\",\\n \\"CallType\\": 1,\\n \\"Caller\\": \\"0108888****\\",\\n \\"DataSetName\\": \\"XXXX\\",\\n \\"Duration\\": 60,\\n \\"Remark5\\": 1232,\\n \\"Id\\": \\"6fa76916-3ce6-45d8-ac64-01b7f31***\\",\\n \\"CallTime\\": \\"1563967699000\\",\\n \\"TaskConfigId\\": 123,\\n \\"TaskConfigName\\": \\"任务A\\",\\n \\"CustomerName\\": \\"张三\\"\\n },\\n \\"Agent\\": {\\n \\"Name\\": \\"智能对话分析客服\\",\\n \\"SkillGroup\\": \\"质检技能\\",\\n \\"Id\\": \\"28240****15643\\"\\n },\\n \\"SchemeIdList\\": {\\n \\"SchemeIdList\\": [\\n 0\\n ]\\n },\\n \\"SchemeNameList\\": {\\n \\"SchemeNameList\\": [\\n \\"售前通用方案\\"\\n ]\\n },\\n \\"ReviewHistoryList\\": {\\n \\"ReviewHistory\\": [\\n {\\n \\"Type\\": 1,\\n \\"OperatorName\\": \\"张三\\",\\n \\"TimeStr\\": \\"2019-10-28 15:21:00\\",\\n \\"Score\\": 95,\\n \\"ReviewResult\\": 1,\\n \\"ComplainResult\\": 1,\\n \\"OldScore\\": 90,\\n \\"ReviewManagerType\\": \\"[一个类别][二类别:第一类目,第一类目->下一集]\\",\\n \\"Time\\": 1722396376000,\\n \\"Comments\\": \\"车险理赔外呼16\\",\\n \\"ReviewRightRule\\": {\\n \\"ReviewRightRule\\": [\\n {\\n \\"ruleName\\": \\"问候语规则\\",\\n \\"rid\\": 21\\n }\\n ]\\n },\\n \\"Operator\\": 83197\\n }\\n ]\\n },\\n \\"ReviewTypeIdList\\": {\\n \\"ReviewTypeIdList\\": [\\n {\\n \\"ReviewKeyIdList\\": {\\n \\"ReviewKeyIdList\\": [\\n 0\\n ]\\n },\\n \\"ReviewTypeId\\": 1\\n }\\n ]\\n },\\n \\"Vid\\": \\"6fa76916-3ce6-45d8-ac64-01b7f31***\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetResultResponse>\\n <code>200</code>\\n <pageNumber>1</pageNumber>\\n <data>\\n <score>105</score>\\n <agent>\\n <skillGroup>Default</skillGroup>\\n <name>张三</name>\\n <id>88888888</id>\\n </agent>\\n <createTime>2019-11-22T16:46Z</createTime>\\n <reviewResult>0</reviewResult>\\n <recording>\\n <callId>88888</callId>\\n <duration>14</duration>\\n <callee>1888888****</callee>\\n <name>audio.wav</name>\\n <id>5defd588-6162-449f-a24f-cea***</id>\\n <primaryId>123</primaryId>\\n <callTime>1574412217000</callTime>\\n <callType>1</callType>\\n <url>http://aliyun.com/audio.wav</url>\\n </recording>\\n <reviewStatus>0</reviewStatus>\\n <hitResult>\\n <name>20190417回归3</name>\\n <rid>1277</rid>\\n </hitResult>\\n <taskId>EB414A60-815F-441A-B0A8-BD14****</taskId>\\n <status>1</status>\\n </data>\\n <requestId>5AFBE205-A482-4EFE-9CE0-26A9542AE8F7</requestId>\\n <success>true</success>\\n <count>1</count>\\n <pageSize>10</pageSize>\\n <message>successful</message>\\n</GetResultResponse>","errorExample":""}]',
+ 'title' => 'Retrieve Quality Inspection Results',
+ 'description' => 'You can query data uploaded using [UploadAudioData](https://help.aliyun.com/document_detail/139399.html) or [UploadData](https://help.aliyun.com/document_detail/111394.html). You can also query data from dataset-based quality inspection tasks created with [SubmitQualityCheckTask](https://help.aliyun.com/document_detail/158890.html). You can search by task ID (taskId) or by time range.',
+ 'requestParamsDescription' => '### Request Parameter JSON String Details'."\n"
+ ."\n"
+ .'| Parameter | Type | Required | Description |'."\n"
+ .'| ------------------------ | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| isSchemeData | Integer | No | Set to 1 to upload data to the new version of Smart Conversation Analysis. Set to 0 for the legacy version. Default is 0. |'."\n"
+ .'| pageSize | Integer | No | Number of records per page. Must be greater than 0 and less than 100. Default is 10. |'."\n"
+ .'| pageNumber | Integer | No | Page number to return. Default is 1. For queries beyond 10,000 records, you cannot skip pages. You must fetch pages sequentially and include the lastDataId value from the last record of the previous response. |'."\n"
+ .'| requiredFields | String | No | Comma-separated list of fields to include in the response. Optional fields include the following: taskId, score, status, recording, recording.dataSet, asrResult, hitResult, comments, agent. Default is score,status,taskId,hitResult. |'."\n"
+ .'| excludeFields | String | No | Comma-separated list of subfields to exclude. Example: hitResult.hits. |'."\n"
+ .'| taskId | String | No | Task ID returned after uploading data for inspection. |'."\n"
+ .'| startTime | String | No | Start time of the time range to query, based on the task upload time (API call time). Format: yyyy-MM-dd HH:mm:ss. |'."\n"
+ .'| endTime | String | No | End time of the time range to query, based on the task upload time (API call time). Format: yyyy-MM-dd HH:mm:ss. |'."\n"
+ .'| callStartTime | String | No | Start time of the time range to query, based on the call start time (specified when uploading data). Format: yyyy-MM-dd HH:mm:ss. |'."\n"
+ .'| callEndTime | String | No | End time of the time range to query, based on the call start time (specified when uploading data). Format: yyyy-MM-dd HH:mm:ss. |'."\n"
+ .'| assignmentStartTime | String | No | Start time of the time range to query, based on the assignment time (the most recent time a quality inspector was assigned). Format: yyyy-MM-dd HH:mm:ss. |'."\n"
+ .'| assignmentEndTime | String | No | End time of the time range to query, based on the assignment time (the most recent time a quality inspector was assigned). Format: yyyy-MM-dd HH:mm:ss. |'."\n"
+ .'| reviewStartTime | String | No | Start time of the time range to query, based on the review time (the most recent time a review was saved). Format: yyyy-MM-dd HH:mm:ss. |'."\n"
+ .'| reviewEndTime | String | No | End time of the time range to query, based on the review time (the most recent time a review was saved). Format: yyyy-MM-dd HH:mm:ss. |'."\n"
+ .'| datasetId | Long | No | Dataset ID. Required only when sourceType=3. |'."\n"
+ .'| sourceType | Integer | No | Source type: 0 for contact center (API upload); 3 for dataset. |'."\n"
+ .'| dataType | Integer | No | File type: 0 for text; 1 for audio. |'."\n"
+ .'| sourceDataType | Integer | No | Inspection result type: 1 for offline speech inspection; 2 for offline text inspection; 3 for real-time speech inspection; 4 for real-time text inspection; 5 for contact center secondary inspection; 51 for contact center speech secondary inspection; 52 for contact center text secondary inspection; 11 for dataset speech; 12 for dataset text. **Applies only to the new version of Smart Conversation Analysis.** |'."\n"
+ .'| customerName | String | No | Customer name. **Applies only to the new version of Smart Conversation Analysis.** |'."\n"
+ .'| customerId | String | No | Customer ID. **Applies only to the new version of Smart Conversation Analysis.** |'."\n"
+ .'| sessionGroupId | String | No | Session group ID. **Applies only to the new version of Smart Conversation Analysis.** |'."\n"
+ .'| sessionGroupExists | Boolean | No | Whether the record belongs to a session group. **Applies only to the new version of Smart Conversation Analysis.** |'."\n"
+ .'| customerServiceName | String | No | Customer service agent name. Returns only results for this agent. |'."\n"
+ .'| customerServiceId | String | No | Customer service agent ID. Returns only results for this agent. |'."\n"
+ .'| skillGroupName | String | No | Skill group name. |'."\n"
+ .'| caller | String | No | Caller number. |'."\n"
+ .'| callee | String | No | Callee number. |'."\n"
+ .'| callId | String | No | Call ID. |'."\n"
+ .'| fileName | String | No | Full file name. Fuzzy search is not supported. |'."\n"
+ .'| ruleIds | List | No | List of rule IDs that triggered a match. Returns results that matched at least one of these rules. |'."\n"
+ .'| schemeIdList | List | No | Search by quality inspection scheme ID used in the task. **Applies only to the new version of Smart Conversation Analysis.** |'."\n"
+ .'| schemeTaskConfigId | Integer | No | Quality inspection task ID. **Applies only to the new version of Smart Conversation Analysis.** |'."\n"
+ .'| resolver | String | No | Reviewer account ID. Returns only results reviewed by this reviewer. |'."\n"
+ .'| reviewer | String | No | Assigned quality inspector account ID. Returns only results assigned to this inspector. |'."\n"
+ .'| status | Integer | No | Execution status: 0 for in progress; 1 for completed; 6 for failed. |'."\n"
+ .'| hitStatus | Integer | No | Hit status: 0 for no rule hit; 1 for at least one rule hit. |'."\n"
+ .'| reviewStatus | Integer | No | Review status: 0 for not reviewed; 1 for reviewed; 3 for appeal in progress; 4 for appeal approved; 5 for appeal rejected. |'."\n"
+ .'| complainStatus | Integer | No | Appeal status: 0 for no appeal; 1 for appealed. |'."\n"
+ .'| scoreType | Integer | No | Filter by inspection score. Use with totalScore: 1 for equal to; 3 for greater than; 5 for less than. |'."\n"
+ .'| totalScore | Integer | No | Filter by inspection score. Use with scoreType. |'."\n"
+ .'| duration | Integer | No | Call duration in seconds. Use with durationType and endDuration. |'."\n"
+ .'| durationType | Integer | No | Duration filter type: 1 for equal to; 3 for greater than; 5 for less than; 7 for range. |'."\n"
+ .'| endDuration | Integer | No | End value for duration range filtering. Use duration as the start value. |'."\n"
+ .'| dialogueSize | Integer | No | Number of dialogue turns. Use with dialogueSizeType and endDialogueSize. |'."\n"
+ .'| dialogueSizeType | Integer | No | Dialogue turn filter type: 1 for equal to; 3 for greater than; 5 for less than; 7 for range. |'."\n"
+ .'| endDialogueSize | Integer | No | End value for dialogue turn range filtering. Use dialogueSize as the start value. |'."\n"
+ .'| lastDataId | String | No | Value of lastDataId from the last record of the previous query. Include this in each request when querying more than 10,000 records. |'."\n"
+ .'| fileId | String | No | Corresponding phone or ticket ID. Returns only results matching this ID. |'."\n"
+ .'| sortField | String | No | Sort field. Supported values: score, remark1, remark2, remark3, remark4, remark5. |'."\n"
+ .'| sortType | String | No | Sort order: desc for descending; asc for ascending. |'."\n"
+ .'| remark1 | String | No | Custom data 1. |'."\n"
+ .'| remark2 | String | No | Custom data 2. |'."\n"
+ .'| remark3 | String | No | Custom data 3. |'."\n"
+ .'| remark4 | String | No | Custom data 4. |'."\n"
+ .'| remark5 | Long | No | Custom data 5. Supports exact and range queries. Use with remark5Type and endRemark5. |'."\n"
+ .'| remark5Type | Integer | No | Range query type for custom data 5: 3 for greater than; 5 for less than; 7 for range. Default is equal to (exact query). |'."\n"
+ .'| endRemark5 | Long | No | End value for custom data 5 range query. Use remark5 as the start value. |'."\n"
+ .'| remark6 | String | No | Custom data 6. |'."\n"
+ .'| remark7 | String | No | Custom data 7. |'."\n"
+ .'| remark8 | String | No | Custom data 8. |'."\n"
+ .'| remark9 | String | No | Custom data 9. |'."\n"
+ .'| remark10 | String | No | Custom data 10. |'."\n"
+ .'| remark11 | String | No | Custom data 11. |'."\n"
+ .'| remark12 | String | No | Custom data 12. |'."\n"
+ .'| remark13 | Long | No | Custom data 13. Supports exact and range queries. Use with remark13Type and endRemark13. |'."\n"
+ .'| remark13Type | Integer | No | Range query type for custom data 13: 3 for greater than; 5 for less than; 7 for range. Default is equal to (exact query). |'."\n"
+ .'| endRemark13 | Long | No | End value for custom data 13 range query. Use remark13 as the start value. |'."\n"
+ .'| remark14 | Long | No | Custom data 14. Supports exact and range queries. Use with remark14Type and endRemark14. |'."\n"
+ .'| remark14Type | Integer | No | Range query type for custom data 14: 3 for greater than; 5 for less than; 7 for range. Default is equal to (exact query). |'."\n"
+ .'| endRemark14 | Long | No | End value for custom data 14 range query. Use remark14 as the start value. |'."\n"
+ .'| remark15 | String | No | Custom data 15. |'."\n"
+ .'| remark16 | String | No | Custom data 16. |'."\n"
+ .'| remark17 | String | No | Custom data 17. |'."\n"
+ .'| remark18 | String | No | Custom data 18. |'."\n"
+ .'| remark19 | String | No | Custom data 19. |'."\n"
+ .'| remark20 | String | No | Custom data 20. |'."\n"
+ .'| remark21 | String | No | Custom data 21. |'."\n"
+ .'| remark22 | String | No | Custom data 22. |'."\n"
+ .'| remark23 | String | No | Custom data 23. |'."\n"
+ .'| remark24 | String | No | Custom data 24. |'."\n"
+ .'| remark25 | String | No | Custom data 25. |'."\n"
+ .'| remark1List~remark25List | List | No | Batch query for custom data 1 to 25. For example, remark1List:[1,2,3] matches records where custom data 1 equals 1, 2, or 3. |'."\n"
+ ."\n"
+ .'## Sample Request Parameters'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "excludeFields": "recording.url,finalHitRuleIds,hitResult.lambda,hitResult.schemeId,hitResult.schemeVersion,hitResult.targetType,hitResult.hits,hitResult.level,hitResult.taskFlowId",'."\n"
+ .' "requiredFields": "agent,status,errorMessage,reviewStatus,reviewResult,score,taskId,reviewer,resolver,recording.name,recording.duration,hitResult,business,assignmentTime,recording.jsonParamStr",'."\n"
+ .' "schemeTaskConfigId": 4878,'."\n"
+ .' "pageNumber": 1,'."\n"
+ .' "pageSize": 10,'."\n"
+ .' "startTime": "2024-12-22 00:00:00",'."\n"
+ .' "endTime": "2025-01-20 17:27:19",'."\n"
+ .' "sourceDataTypeList": ['."\n"
+ .' 1'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Sample Code'."\n"
+ ."\n"
+ .'```java'."\n"
+ ."\n"
+ .'import com.alibaba.fastjson.JSONObject;'."\n"
+ .'import com.aliyun.qualitycheck20190115.Client;'."\n"
+ .'import com.aliyun.qualitycheck20190115.models.*;'."\n"
+ .'import com.aliyun.teaopenapi.models.Config;'."\n"
+ ."\n\n"
+ .'public class sca {'."\n"
+ ."\n"
+ .' private static String ak = "YOUR_ACCESS_KEY_ID";'."\n"
+ .' private static String sk = "YOUR_ACCESS_KEY_SECRET";'."\n"
+ ."\n"
+ .' private static void getResult() throws Exception {'."\n"
+ .' Config config = new Config();'."\n"
+ .' config.setAccessKeyId(ak).setAccessKeySecret(sk)'."\n"
+ .' .setEndpoint("qualitycheck.cn-hangzhou.aliyuncs.com")'."\n"
+ .' .setRegionId("cn-hangzhou").setProtocol("HTTPS");'."\n"
+ .' Client client = new Client(config);'."\n"
+ .' String json = "{\\"excludeFields\\":\\"recording.url,finalHitRuleIds,hitResult.lambda,hitResult.schemeId,hitResult.schemeVersion,hitResult.targetType,hitResult.hits,hitResult.level,hitResult.taskFlowId\\",\\"requiredFields\\":\\"agent,status,errorMessage,reviewStatus,reviewResult,score,taskId,reviewer,resolver,recording.name,recording.duration,hitResult,business,assignmentTime,recording.jsonParamStr\\",\\"schemeTaskConfigId\\":4878,\\"pageNumber\\":1,\\"pageSize\\":10,\\"startTime\\":\\"2024-12-22 00:00:00\\",\\"endTime\\":\\"2025-01-20 17:27:19\\",\\"sourceDataTypeList\\":[1]}";'."\n"
+ .' GetResultRequest request = new GetResultRequest();'."\n"
+ .' request.setJsonStr(json);'."\n"
+ .' GetResultResponse response = client.getResult(request);'."\n"
+ .' System.out.println(JSONObject.toJSONString(response));'."\n"
+ .' }'."\n"
+ ."\n"
+ .' public static void main(String[] args) throws Exception {'."\n"
+ .' getResult();'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'responseParamsDescription' => '## Details about Val'."\n"
+ ."\n"
+ .'| Operator Name | Sample Val | Description |'."\n"
+ .'| --------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| Text Check - Keyword Check | Hello | The text in the current sentence that matched this operator. This is the text highlighted in red when viewing the hit location on the review page. |'."\n"
+ .'| Text Check - Text Similarity Check | 82 | Similarity score. |'."\n"
+ .'| Text Check - Regular Expression Check | Hello | The text in the current sentence that matched this operator. This is the text highlighted in red when viewing the hit location on the review page. |'."\n"
+ .'| Text Check - Context Repetition Check | Hello | The text in the current sentence that matched this operator. This is the text highlighted in red when viewing the hit location on the review page. |'."\n"
+ .'| Speech Check - Call Silence Check | 3200 | Silence duration (in milliseconds). |'."\n"
+ .'| Speech Check - Speech Rate Check | 365 | Speech rate value for the current sentence. |'."\n"
+ .'| Speech Check - Interruption Check | 2:8 | Format is "m:n", where m is the interruption duration (in seconds), which is the overlapping speech time between the agent and customer, and n is the number of characters in the current sentence. |'."\n"
+ .'| Speech Check - Role Detection | Hello | The text in the current sentence that matched this operator. This is the text highlighted in red when viewing the hit location on the review page. |'."\n"
+ .'| Speech Check - Abnormal Hang-up | 3567 | Time in milliseconds from the end of the last sentence to the hang-up time. |'."\n"
+ .'| Speech Check - Recording Duration Check | 56088 | Recording duration in milliseconds. |'."\n"
+ .'| Model Check - Emotion Detection Model | Abuse | Specific emotion type, such as abuse or high-risk. |'."\n"
+ .'| Model Check - Agent Violation Detection Model | Sarcasm | Specific agent violation type, such as sarcasm, rhetorical question, or abuse. |',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-04T03:25:33.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-11-04T06:42:35.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-07-30T09:47:13.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-07-22T08:34:20.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-07-15T07:53:59.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-07-15T07:41:12.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-07-15T03:50:18.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-12-07T03:18:03.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-04-12T12:03:46.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-05-30T12:54:38.000Z', 'description' => 'Response parameters changed, Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetResult'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\",\\n \\"Success\\": true,\\n \\"ResultCountId\\": \\"XXX\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Count\\": 1,\\n \\"Data\\": {\\n \\"ResultInfo\\": [\\n {\\n \\"Status\\": 0,\\n \\"AssignmentTime\\": \\"2021-03-02T14:37Z\\",\\n \\"LastDataId\\": \\"4498420@a_z@93EAADF1-01D3-44BD-8AC9-F57F447EFCE8_1614*****\\",\\n \\"ErrorMessage\\": \\"xxx\\",\\n \\"Reviewer\\": \\"xxx\\",\\n \\"CreateTime\\": \\"2019-07-24T19:31Z\\",\\n \\"ReviewStatus\\": 1,\\n \\"ReviewTimeLong\\": \\"1602743090\\",\\n \\"TaskName\\": \\"test\\",\\n \\"ReviewResult\\": 0,\\n \\"Score\\": 100,\\n \\"CreateTimeLong\\": \\"1602743090\\",\\n \\"ReviewTime\\": \\"2019-07-24T19:31Z\\",\\n \\"Comments\\": \\"xx\\",\\n \\"TaskId\\": \\"A6BEC8D-9A5B-4BE5-8432-4F635E***\\",\\n \\"ReviewType\\": 1,\\n \\"Resolver\\": \\"XXX\\",\\n \\"AsrResult\\": {\\n \\"AsrResult\\": [\\n {\\n \\"Words\\": \\"xx\\",\\n \\"Begin\\": 10000,\\n \\"EmotionValue\\": 1,\\n \\"End\\": 0,\\n \\"SpeechRate\\": 50,\\n \\"Role\\": \\"客户\\",\\n \\"Identity\\": \\"OPERATOR_001\\"\\n }\\n ]\\n },\\n \\"HitResult\\": {\\n \\"HitResult\\": [\\n {\\n \\"Type\\": \\"0417回归类型\\",\\n \\"ReviewResult\\": 0,\\n \\"Name\\": \\"20190417回归3\\",\\n \\"Rid\\": \\"1276\\",\\n \\"Hits\\": {\\n \\"Hit\\": [\\n {\\n \\"KeyWords\\": {\\n \\"KeyWord\\": [\\n {\\n \\"From\\": 1,\\n \\"To\\": 2,\\n \\"Val\\": \\"test\\",\\n \\"Cid\\": \\"xxxx\\"\\n }\\n ]\\n },\\n \\"Cid\\": {\\n \\"Cid\\": [\\n \\"xxxx\\"\\n ]\\n },\\n \\"Phrase\\": {\\n \\"EmotionValue\\": 0,\\n \\"End\\": 300,\\n \\"Words\\": \\"xxx\\",\\n \\"Role\\": \\"客服\\",\\n \\"Begin\\": 300\\n }\\n }\\n ]\\n },\\n \\"SchemeId\\": 0,\\n \\"SchemeVersion\\": 0,\\n \\"Conditions\\": {\\n \\"Conditions\\": [\\n {\\n \\"Cid\\": \\"a\\",\\n \\"Id\\": 1,\\n \\"Rid\\": \\"1\\",\\n \\"Check_range\\": {\\n \\"RoleId\\": 1,\\n \\"Role\\": \\"客服\\",\\n \\"Anchor\\": {\\n \\"Cid\\": \\"1\\",\\n \\"Location\\": \\"BEFORE\\",\\n \\"Hit_time\\": 1\\n },\\n \\"Range\\": {\\n \\"From\\": 2,\\n \\"To\\": 4\\n },\\n \\"TimeRange\\": {\\n \\"From\\": 1733277928,\\n \\"To\\": 1733277928\\n },\\n \\"Absolute\\": false,\\n \\"AllSentencesSatisfy\\": true\\n },\\n \\"Operators\\": {\\n \\"Operator\\": [\\n {\\n \\"Oid\\": \\"1\\",\\n \\"Id\\": 1,\\n \\"Type\\": \\"ABUSE_MODEL\\",\\n \\"Param\\": {\\n \\"Keywords\\": {\\n \\"Keyword\\": [\\n \\"你好\\"\\n ]\\n },\\n \\"Regex\\": \\"a&&b\\",\\n \\"NotRegex\\": \\"c&&d\\",\\n \\"Phrase\\": \\"你好\\",\\n \\"Interval\\": 1733277928,\\n \\"IntervalEnd\\": 1733277928,\\n \\"Threshold\\": 1,\\n \\"In_sentence\\": true,\\n \\"Target\\": 0,\\n \\"From_end\\": true,\\n \\"KeywordExtension\\": 0,\\n \\"Case_sensitive\\": false,\\n \\"Near_dialogue\\": false,\\n \\"MinWordSize\\": 2,\\n \\"Hit_time\\": 2,\\n \\"Excludes\\": {\\n \\"Exclude\\": [\\n \\"你好\\"\\n ]\\n },\\n \\"From\\": 0,\\n \\"CheckFirstSentence\\": false,\\n \\"Average\\": false,\\n \\"BeginType\\": \\"0\\",\\n \\"EndType\\": \\"0\\",\\n \\"CompareOperator\\": \\"gt\\",\\n \\"ContextChatMatch\\": true,\\n \\"KeywordMatchSize\\": 1,\\n \\"MaxEmotionChangeValue\\": 2,\\n \\"CheckType\\": 1,\\n \\"DelayTime\\": 1000,\\n \\"FlowNodePrerequisiteParam\\": {\\n \\"NodeId\\": 1,\\n \\"NodeName\\": \\"开始节点\\",\\n \\"NodeMatchStatus\\": 1\\n },\\n \\"IntentModelCheckParm\\": {\\n \\"ModelScene\\": \\"AGENT\\",\\n \\"Intents\\": {\\n \\"Intent\\": [\\n {\\n \\"Id\\": 0,\\n \\"Name\\": \\"fvt-eci-copy-5c703091\\"\\n }\\n ]\\n }\\n }\\n },\\n \\"Name\\": \\"关键字检测\\"\\n }\\n ]\\n },\\n \\"Lambda\\": \\"a&&b\\",\\n \\"Exclusion\\": 0\\n }\\n ]\\n },\\n \\"Score\\": -5,\\n \\"MachineHitResult\\": \\"1\\",\\n \\"FinalHitResult\\": \\"1\\",\\n \\"ArtificialRule\\": \\"turn\\"\\n }\\n ]\\n },\\n \\"HitScore\\": {\\n \\"HitScore\\": [\\n {\\n \\"ScoreName\\": \\"投诉\\",\\n \\"ScoreNumber\\": \\"-20\\",\\n \\"ScoreId\\": \\"123456\\",\\n \\"RuleId\\": \\"123\\"\\n }\\n ]\\n },\\n \\"Recording\\": {\\n \\"Remark13\\": \\"XXX\\",\\n \\"Callee\\": \\"1888888****\\",\\n \\"DialogueSize\\": 32,\\n \\"PrimaryId\\": \\"3437500\\",\\n \\"Remark12\\": \\"XXX\\",\\n \\"Remark1\\": \\"XXX\\",\\n \\"Remark7\\": \\"XXX\\",\\n \\"Remark8\\": \\"XXX\\",\\n \\"Remark2\\": \\"XXX\\",\\n \\"CallId\\": \\"XXXX\\",\\n \\"Remark9\\": \\"XXX\\",\\n \\"Name\\": \\"123456.mkv\\",\\n \\"Remark6\\": \\"XXX\\",\\n \\"Remark10\\": \\"XXX\\",\\n \\"Business\\": \\"客服业务线\\",\\n \\"Remark3\\": \\"XXX\\",\\n \\"Url\\": \\"http://aliyun.com/audio.wav\\",\\n \\"Remark11\\": \\"XXX\\",\\n \\"Remark4\\": \\"XXX\\",\\n \\"CallType\\": 1,\\n \\"Caller\\": \\"0108888****\\",\\n \\"DataSetName\\": \\"XXXX\\",\\n \\"Duration\\": 60,\\n \\"Remark5\\": 1232,\\n \\"Id\\": \\"6fa76916-3ce6-45d8-ac64-01b7f31***\\",\\n \\"CallTime\\": \\"1563967699000\\",\\n \\"TaskConfigId\\": 123,\\n \\"TaskConfigName\\": \\"任务A\\",\\n \\"CustomerName\\": \\"张三\\"\\n },\\n \\"Agent\\": {\\n \\"Name\\": \\"智能对话分析客服\\",\\n \\"SkillGroup\\": \\"质检技能\\",\\n \\"Id\\": \\"28240****15643\\"\\n },\\n \\"SchemeIdList\\": {\\n \\"SchemeIdList\\": [\\n 0\\n ]\\n },\\n \\"SchemeNameList\\": {\\n \\"SchemeNameList\\": [\\n \\"售前通用方案\\"\\n ]\\n },\\n \\"ReviewHistoryList\\": {\\n \\"ReviewHistory\\": [\\n {\\n \\"Type\\": 1,\\n \\"OperatorName\\": \\"张三\\",\\n \\"TimeStr\\": \\"2019-10-28 15:21:00\\",\\n \\"Score\\": 95,\\n \\"ReviewResult\\": 1,\\n \\"ComplainResult\\": 1,\\n \\"OldScore\\": 90,\\n \\"ReviewManagerType\\": \\"[一个类别][二类别:第一类目,第一类目->下一集]\\",\\n \\"Time\\": 1722396376000,\\n \\"Comments\\": \\"车险理赔外呼16\\",\\n \\"ReviewRightRule\\": {\\n \\"ReviewRightRule\\": [\\n {\\n \\"ruleName\\": \\"问候语规则\\",\\n \\"rid\\": 21\\n }\\n ]\\n },\\n \\"Operator\\": 83197\\n }\\n ]\\n },\\n \\"ReviewTypeIdList\\": {\\n \\"ReviewTypeIdList\\": [\\n {\\n \\"ReviewKeyIdList\\": {\\n \\"ReviewKeyIdList\\": [\\n 0\\n ]\\n },\\n \\"ReviewTypeId\\": 1\\n }\\n ]\\n },\\n \\"Vid\\": \\"6fa76916-3ce6-45d8-ac64-01b7f31***\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'GetResultToReview' => [
- 'summary' => '获取质检结果详情用于复核',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8669,32 +7660,18 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '56192',
- 'abilityTreeNodes' => [
- 'FEATUREsca27EUYZ',
- ],
+ 'abilityTreeNodes' => ['FEATUREsca27EUYZ'],
],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Full JSON string. See the detailed description below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"taskId":"任务ID",“ fileId”:"文件ID"}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345'],
],
],
'responses' => [
@@ -8702,209 +7679,82 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4***',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'Result code. **200** means success. Any other value means failure. Use this field to identify the cause.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the call fails. Returns **successful** on success.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4***', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. true means success. **false** or **null** means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'Detailed response data.',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'AudioScheme' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https',
- ],
- 'AudioURL' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sca-ccc-test.oss-cn-beijing.aliyuncs.com/xxxxx',
- ],
- 'TotalScore' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '99',
- ],
- 'FileId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'e790e6c919d84b82b64ee*****',
- ],
- 'FileMergeName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx.wav',
- ],
- 'Comments' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Vid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6fa76916-3ce6-45d8-ac64-01b7f31***',
- ],
+ 'Status' => ['description' => 'Current task status. 0: incomplete. 1: complete. Use this field to check completion. Any other value indicates an error.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'AudioScheme' => ['description' => 'Protocol used in the audio URL. Possible values: http, https.', 'type' => 'string', 'example' => 'https', 'title' => ''],
+ 'AudioURL' => ['description' => 'Audio URL without the protocol prefix (http\\:// or https\\://). Combine with AudioScheme to form the full URL.', 'type' => 'string', 'example' => 'sca-ccc-test.oss-cn-beijing.aliyuncs.com/xxxxx', 'title' => ''],
+ 'TotalScore' => ['description' => 'Quality inspection score.', 'type' => 'integer', 'format' => 'int32', 'example' => '99', 'title' => ''],
+ 'FileId' => ['description' => 'File ID.', 'type' => 'string', 'example' => 'e790e6c919d84b82b64ee*****', 'title' => ''],
+ 'FileMergeName' => ['description' => 'File name.', 'type' => 'string', 'example' => 'xxx.wav', 'title' => ''],
+ 'Comments' => ['description' => 'Review comments.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'Vid' => ['description' => 'File ID.', 'type' => 'string', 'example' => '6fa76916-3ce6-45d8-ac64-01b7f31***', 'title' => ''],
'Dialogues' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Dialogue' => [
- 'description' => '',
+ 'description' => 'Dialogue data.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'Dialogue data.',
'type' => 'object',
'properties' => [
- 'Words' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Identity' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Begin' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '72000',
- ],
- 'BeginTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-10-01 11:12:01',
- ],
- 'EmotionValue' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '7',
- ],
- 'End' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '80000',
- ],
- 'SpeechRate' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Role' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SilenceDuration' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'HourMinSec' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '00:08',
- ],
- 'BeginTimeMs' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'Words' => ['description' => 'Dialogue text.', 'type' => 'string', 'example' => '你好有什么可以帮您', 'title' => ''],
+ 'Identity' => ['description' => 'Role identifier. In offline voice scenarios, roles are only agent or customer. In offline text inspection scenarios, this is the identity passed when uploading data.', 'type' => 'string', 'example' => '客服', 'title' => ''],
+ 'Begin' => ['description' => 'Start time offset in milliseconds from the beginning of the dialogue. For example, if the total recording length is 2 minutes 10 seconds, and the customer starts speaking at 1 minute 12 seconds and stops at 1 minute 20 seconds, then Begin is 72000 and End is 80000.', 'type' => 'integer', 'format' => 'int64', 'example' => '72000', 'title' => ''],
+ 'BeginTime' => ['description' => 'Absolute start time of this utterance.'."\n"
+ .'><notice>Format is TZ. We recommend using BeginTimeMs instead.></notice>', 'type' => 'string', 'example' => '2019-10-01T11:12Z', 'title' => ''],
+ 'EmotionValue' => ['description' => 'Emotion intensity value. Calculated as volume in decibels divided by 10. Range: \\[1, 10]. Higher values indicate stronger emotion.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''],
+ 'End' => ['description' => 'End time offset in milliseconds from the beginning of the dialogue. For example, if the total recording length is 2 minutes 10 seconds, and the customer starts speaking at 1 minute 12 seconds and stops at 1 minute 20 seconds, then Begin is 72000 and End is 80000.', 'type' => 'integer', 'format' => 'int64', 'example' => '80000', 'title' => ''],
+ 'SpeechRate' => ['description' => 'Average speech rate for this utterance, in characters per minute.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Role' => ['description' => 'Role of this utterance. Possible values: agent, customer.', 'type' => 'string', 'example' => '客服', 'title' => ''],
+ 'SilenceDuration' => ['description' => 'Silence duration in seconds between two consecutive utterances by the same role.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'HourMinSec' => ['description' => 'Start time of this utterance in hh:mm:ss format.', 'type' => 'string', 'example' => '00:08', 'title' => ''],
+ 'BeginTimeMs' => ['description' => 'Absolute start time of this utterance, in milliseconds since the Unix epoch.', 'type' => 'integer', 'format' => 'int64', 'example' => '1569899521000', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'HitRuleReviewInfoList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'HitRuleReviewInfo' => [
- 'description' => '',
+ 'description' => 'Details of detected rule hits.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'Details of hit rules.',
'type' => 'object',
'properties' => [
- 'ScoreSubName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'ScoreNum' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '-10',
- ],
- 'AutoReview' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ScoreSubId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'xxx',
- ],
- 'Complainable' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ScoreId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'xxx',
- ],
- 'RuleName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '451',
- ],
+ 'ScoreSubName' => ['description' => 'Legacy field. Ignore.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'ScoreNum' => ['description' => 'Score value.', 'type' => 'integer', 'format' => 'int32', 'example' => '-10', 'title' => ''],
+ 'AutoReview' => ['description' => 'Whether auto-review is enabled. Possible values: 1 (disabled), 3 (enabled).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ScoreSubId' => ['description' => 'Legacy field. Ignore.', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx', 'title' => ''],
+ 'Complainable' => ['description' => 'Whether the agent can submit an appeal for this scoring item. No further appeals allowed after final review.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ScoreId' => ['description' => 'Legacy field. Ignore.', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx', 'title' => ''],
+ 'RuleName' => ['description' => 'Name of the check item.', 'type' => 'string', 'example' => '你好', 'title' => ''],
+ 'Rid' => ['description' => 'Check item ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '451', 'title' => ''],
'ConditionHitInfoList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ConditionHitInfo' => [
- 'description' => '',
+ 'description' => 'Details of matched conditions.',
'type' => 'array',
'items' => [
'type' => 'object',
@@ -8914,506 +7764,447 @@
'itemNode' => true,
'properties' => [
'KeyWord' => [
- 'description' => '',
+ 'description' => 'Matched key information. Highlighted in the review UI. Examples include keywords matched by keyword-check operators, or category names matched by agent-model-check operators.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'From' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Val' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Pid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Tid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6fa76916-3ce6-45d8-ac64-01b7f31c7295',
- ],
- 'Cid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2000',
- ],
- 'To' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'CustomizeCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'IsMatch' => [
- 'type' => 'boolean',
- ],
+ 'From' => ['description' => 'Character index where highlighting starts. Indexes start at 0. Maximum value is the total number of characters in the utterance minus 1. The character at the From index is included in the highlight.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Val' => ['description' => 'Key information matched by the operator. See **Details of Val values** below.', 'type' => 'string', 'example' => '你好', 'title' => ''],
+ 'Pid' => ['description' => 'Index of this utterance in the full list of utterances. This is the index of the utterance in the dialogue array passed in the request. Indexes start at 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'Tid' => ['description' => 'Voice ID.', 'type' => 'string', 'example' => '6fa76916-3ce6-45d8-ac64-01b7f31c7295', 'title' => ''],
+ 'Cid' => ['description' => 'Condition ID.', 'type' => 'string', 'example' => '2000', 'title' => ''],
+ 'To' => ['description' => 'The end position of the highlighted keyword, expressed as a zero-based, exclusive index. The maximum value is one less than the total number of characters in the sentence. For example, in the sentence "This is a sample", if from is 0 and to is 4, the highlighted keyword is "This".', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'CustomizeCode' => ['description' => 'Internal field. Ignore.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'IsMatch' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'Cid' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Cid' => [
- 'description' => '',
+ 'description' => 'List of matched condition IDs.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2000',
- ],
+ 'items' => ['description' => 'Condition ID.', 'type' => 'string', 'example' => '2000', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'Phrase' => [
- 'description' => '',
+ 'description' => 'Details of the utterance that triggered this check item.',
'type' => 'object',
'properties' => [
- 'Words' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Begin' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '72000',
- ],
- 'Identity' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Pid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'EmotionValue' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '7',
- ],
- 'End' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '80000',
- ],
- 'Role' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'Words' => ['description' => 'Dialogue text.', 'type' => 'string', 'example' => '你好,请问有什么可以帮您', 'title' => ''],
+ 'Begin' => ['description' => 'Start time offset in milliseconds from the beginning of the dialogue. For example, if the total recording length is 2 minutes 10 seconds, and the customer starts speaking at 1 minute 12 seconds and stops at 1 minute 20 seconds, then Begin is 72000 and End is 80000.', 'type' => 'integer', 'format' => 'int64', 'example' => '72000', 'title' => ''],
+ 'Identity' => ['description' => 'Role identifier. In offline voice scenarios, roles are only agent or customer. In offline text inspection scenarios, this is the identity passed when uploading data.', 'type' => 'string', 'example' => '客服', 'title' => ''],
+ 'Pid' => ['description' => 'Index of this utterance in the full list of utterances. This is the index of the utterance in the dialogue array passed in the request. Indexes start at 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'EmotionValue' => ['description' => 'Emotion intensity value. Calculated as volume in decibels divided by 10. Range: \\[1, 10]. Higher values indicate stronger emotion.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''],
+ 'End' => ['description' => 'End time offset in milliseconds from the beginning of the dialogue. For example, if the total recording length is 2 minutes 10 seconds, and the customer starts speaking at 1 minute 12 seconds and stops at 1 minute 20 seconds, then Begin is 72000 and End is 80000.', 'type' => 'integer', 'format' => 'int64', 'example' => '80000', 'title' => ''],
+ 'Role' => ['description' => 'Role of this utterance. Possible values: agent, customer.', 'type' => 'string', 'example' => '客服', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'ComplainHistories' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ComplainHistories' => [
- 'description' => '',
+ 'description' => 'Appeal history.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Comments' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Operator' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- ],
- 'OperationTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-10-16T11:13Z',
- ],
- 'OperationType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'OperatorName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'Comments' => ['description' => 'Reason for appeal or reason for appeal resolution.', 'type' => 'string', 'example' => '请听一下录音,重新判定。', 'title' => ''],
+ 'Operator' => ['description' => 'Account ID of the person who submitted or processed the appeal.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''],
+ 'OperationTime' => ['description' => 'Processing time.', 'type' => 'string', 'example' => '2020-10-16T11:13Z', 'title' => ''],
+ 'OperationType' => ['description' => 'Status. 3: under appeal. 4: appeal rejected. 5: appeal approved.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'OperatorName' => ['description' => 'Username of the person who submitted or processed the appeal.', 'type' => 'string', 'example' => '张三', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'ReviewInfo' => [
- 'description' => '',
+ 'description' => 'Review information.',
'type' => 'object',
'properties' => [
- 'ReviewResult' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ReviewTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-10-12 17:06:00',
- ],
- 'HitId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '013c68142fec4f0899fa6ee0exxx',
- ],
- 'Reviewer' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '451',
- ],
- 'Comment' => [
- 'type' => 'string',
- ],
+ 'ReviewResult' => ['description' => 'Review result. 0: incorrect. 1: correct.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ReviewTime' => ['description' => 'Review time, in yyyy-mm-dd hh:mm:ss format.', 'type' => 'string', 'example' => '2019-10-12 17:06:00', 'title' => ''],
+ 'HitId' => ['description' => 'Hit ID.', 'type' => 'string', 'example' => '013c68142fec4f0899fa6ee0exxx', 'title' => ''],
+ 'Reviewer' => ['description' => 'Reviewer ID.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'Rid' => ['description' => 'Check item ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '451', 'title' => ''],
+ 'Comment' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'SentenceReviewResults' => [
- 'type' => 'object',
'itemNode' => true,
+ 'type' => 'object',
'properties' => [
'SentenceReviewResults' => [
- 'title' => '句子复核结果',
'type' => 'array',
'items' => [
- 'title' => '句子复核结果',
'type' => 'object',
'properties' => [
- 'Sid' => [
- 'title' => '关联ix',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Rid' => [
- 'title' => '规则id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Cid' => [
- 'title' => '条件id'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Pid' => [
- 'title' => '句子id'."\n",
- 'type' => 'string',
- 'example' => '1',
- ],
- 'HitStatus' => [
- 'title' => '是否命中',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ReviewDimensionType' => [
- 'title' => '复核类型',
- 'type' => 'string',
- 'example' => '2',
- ],
- 'OriginTaskId' => [
- 'title' => '任务id',
- 'type' => 'string',
- 'example' => '122-122-22-333',
- ],
- 'OriginVid' => [
- 'title' => 'sessionid',
- 'type' => 'string',
- 'example' => '1001',
- ],
- 'Comment' => [
- 'title' => '复核意见',
- 'type' => 'string',
- 'example' => '无意见',
- ],
- 'Changed' => [
- 'title' => '是否改变',
- 'type' => 'boolean',
- ],
+ 'Sid' => ['type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => '', 'title' => ''],
+ 'Rid' => ['type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => '', 'title' => ''],
+ 'Cid' => ['type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => '', 'title' => ''],
+ 'Pid' => ['type' => 'string', 'example' => '1', 'description' => '', 'title' => ''],
+ 'HitStatus' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '', 'title' => ''],
+ 'ReviewDimensionType' => ['type' => 'string', 'example' => '2', 'description' => '', 'title' => ''],
+ 'OriginTaskId' => ['type' => 'string', 'example' => '122-122-22-333', 'description' => '', 'title' => ''],
+ 'OriginVid' => ['type' => 'string', 'example' => '1001', 'description' => '', 'title' => ''],
+ 'Comment' => ['type' => 'string', 'example' => '无意见', 'description' => '', 'title' => ''],
+ 'Changed' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- 'MachineHitResult' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ReviewHitResult' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'MachineHitResult' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'ReviewHitResult' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'ManualScoreInfoList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ManualScoreInfo' => [
- 'description' => '',
+ 'description' => 'Manually added check items.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'ScoreSubName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Complainable' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ScoreNum' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '-10',
- ],
- 'ScoreSubId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'xxx',
- ],
- 'ScoreId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'xxx',
- ],
+ 'ScoreSubName' => ['description' => 'Legacy field. Ignore.', 'type' => 'string', 'example' => '投诉', 'title' => ''],
+ 'Complainable' => ['description' => 'Whether the agent can submit an appeal for this scoring item. No further appeals allowed after final review.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ScoreNum' => ['description' => 'Score value.', 'type' => 'integer', 'format' => 'int32', 'example' => '-10', 'title' => ''],
+ 'ScoreSubId' => ['description' => 'Legacy field. Ignore.', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx', 'title' => ''],
+ 'ScoreId' => ['description' => 'Legacy field. Ignore.', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx', 'title' => ''],
'ComplainHistories' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ComplainHistories' => [
- 'description' => '',
+ 'description' => 'Appeal history.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Comments' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Operator' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- ],
- 'OperationTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-10-16T11:13Z',
- ],
- 'OperationType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'OperatorName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'Comments' => ['description' => 'Reason for appeal or reason for appeal resolution.', 'type' => 'string', 'example' => '请听一下录音,重新判定。', 'title' => ''],
+ 'Operator' => ['description' => 'Account ID of the person who submitted or processed the appeal.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''],
+ 'OperationTime' => ['description' => 'Processing time.', 'type' => 'string', 'example' => '2020-10-16T11:13Z', 'title' => ''],
+ 'OperationType' => ['description' => 'Status. 3: under appeal. 4: appeal rejected. 5: appeal approved.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'OperatorName' => ['description' => 'Username of the person who submitted or processed the appeal.', 'type' => 'string', 'example' => '张三', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'ReviewHistoryList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ReviewHistory' => [
- 'description' => '',
+ 'description' => 'Review history.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Type' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'OperatorName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'TimeStr' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-10-28 15:21:00',
- ],
- 'Score' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '95',
- ],
- 'ReviewResult' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ComplainResult' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'OldScore' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '90',
- ],
- 'ReviewManagerType' => [
- 'type' => 'string',
- ],
- 'Time' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'Comments' => [
- 'type' => 'string',
- ],
+ 'Type' => ['description' => 'Review type. 0: automatic review. 1: manual review.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'OperatorName' => ['description' => 'Reviewer username.', 'type' => 'string', 'example' => '张三', 'title' => ''],
+ 'TimeStr' => ['description' => 'Review time, in yyyy-mm-dd hh:mm:ss format.', 'type' => 'string', 'example' => '2019-10-28 15:21:00', 'title' => ''],
+ 'Score' => ['description' => 'Score after review.', 'type' => 'integer', 'format' => 'int32', 'example' => '95', 'title' => ''],
+ 'ReviewResult' => ['description' => 'Review result. 1: all check items are correct. 0: at least one check item is incorrect.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ComplainResult' => ['description' => 'Appeal resolution result. 1: all appeals approved. 0: at least one appeal rejected.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'OldScore' => ['description' => 'Score before review.', 'type' => 'integer', 'format' => 'int32', 'example' => '90', 'title' => ''],
+ 'ReviewManagerType' => ['description' => 'Detailed review type.', 'type' => 'string', 'example' => '[一个类别][二类别:第一类目,第一类目->下一集]', 'title' => ''],
+ 'Time' => ['description' => 'Timestamp for display.', 'type' => 'integer', 'format' => 'int64', 'example' => '1722396376000'."\n", 'title' => ''],
+ 'Comments' => ['description' => 'Comment.', 'type' => 'string', 'example' => '请写明学校名称,谢谢', 'title' => ''],
'ReviewRightRule' => [
- 'type' => 'object',
'itemNode' => true,
+ 'description' => '',
+ 'type' => 'object',
'properties' => [
'ReviewRightRule' => [
+ 'description' => 'Rules correctly matched after review.',
'type' => 'array',
'items' => [
+ 'description' => 'Rules correctly matched after review.',
'type' => 'object',
'properties' => [
- 'ruleName' => [
- 'type' => 'string',
- ],
- 'rid' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'ruleName' => ['description' => 'Rule name.', 'type' => 'string', 'example' => '问候语规则', 'title' => ''],
+ 'rid' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12恶', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- 'Operator' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'Operator' => ['description' => 'Operator ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '78404', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'ReviewTypeIdList' => [
- 'type' => 'object',
'itemNode' => true,
+ 'description' => '',
+ 'type' => 'object',
'properties' => [
'ReviewTypeIdList' => [
+ 'description' => 'List of review type IDs.',
'type' => 'array',
'items' => [
+ 'description' => 'List of review type IDs.',
'type' => 'object',
'properties' => [
'ReviewKeyIdList' => [
- 'type' => 'object',
'itemNode' => true,
+ 'description' => '',
+ 'type' => 'object',
'properties' => [
'ReviewKeyIdList' => [
+ 'description' => 'List of review tag IDs.',
'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'items' => ['description' => 'List of review tag IDs.', 'type' => 'integer', 'format' => 'int64', 'example' => '[4, 5]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- 'ReviewTypeId' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'ReviewTypeId' => ['description' => 'Main review category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4***\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": 1,\\n \\"AudioScheme\\": \\"https\\",\\n \\"AudioURL\\": \\"sca-ccc-test.oss-cn-beijing.aliyuncs.com/xxxxx\\",\\n \\"TotalScore\\": 99,\\n \\"FileId\\": \\"e790e6c919d84b82b64ee*****\\",\\n \\"FileMergeName\\": \\"xxx.wav\\",\\n \\"Comments\\": \\"xxx\\",\\n \\"Vid\\": \\"6fa76916-3ce6-45d8-ac64-01b7f31***\\",\\n \\"Dialogues\\": {\\n \\"Dialogue\\": [\\n {\\n \\"Words\\": \\"你好有什么可以帮您\\",\\n \\"Identity\\": \\"客服\\",\\n \\"Begin\\": 72000,\\n \\"BeginTime\\": \\"2019-10-01T11:12Z\\",\\n \\"EmotionValue\\": 7,\\n \\"End\\": 80000,\\n \\"SpeechRate\\": 200,\\n \\"Role\\": \\"客服\\",\\n \\"SilenceDuration\\": 1,\\n \\"HourMinSec\\": \\"00:08\\",\\n \\"BeginTimeMs\\": 1569899521000\\n }\\n ]\\n },\\n \\"HitRuleReviewInfoList\\": {\\n \\"HitRuleReviewInfo\\": [\\n {\\n \\"ScoreSubName\\": \\"xxx\\",\\n \\"ScoreNum\\": -10,\\n \\"AutoReview\\": 1,\\n \\"ScoreSubId\\": 0,\\n \\"Complainable\\": true,\\n \\"ScoreId\\": 0,\\n \\"RuleName\\": \\"你好\\",\\n \\"Rid\\": 451,\\n \\"ConditionHitInfoList\\": {\\n \\"ConditionHitInfo\\": [\\n {\\n \\"KeyWords\\": {\\n \\"KeyWord\\": [\\n {\\n \\"From\\": 1,\\n \\"Val\\": \\"你好\\",\\n \\"Pid\\": 2,\\n \\"Tid\\": \\"6fa76916-3ce6-45d8-ac64-01b7f31c7295\\",\\n \\"Cid\\": \\"2000\\",\\n \\"To\\": 3,\\n \\"CustomizeCode\\": \\"xxx\\",\\n \\"IsMatch\\": true\\n }\\n ]\\n },\\n \\"Cid\\": {\\n \\"Cid\\": [\\n \\"2000\\"\\n ]\\n },\\n \\"Phrase\\": {\\n \\"Words\\": \\"你好,请问有什么可以帮您\\",\\n \\"Begin\\": 72000,\\n \\"Identity\\": \\"客服\\",\\n \\"Pid\\": 3,\\n \\"EmotionValue\\": 7,\\n \\"End\\": 80000,\\n \\"Role\\": \\"客服\\"\\n }\\n }\\n ]\\n },\\n \\"ComplainHistories\\": {\\n \\"ComplainHistories\\": [\\n {\\n \\"Comments\\": \\"请听一下录音,重新判定。\\",\\n \\"Operator\\": 123456,\\n \\"OperationTime\\": \\"2020-10-16T11:13Z\\",\\n \\"OperationType\\": 5,\\n \\"OperatorName\\": \\"张三\\"\\n }\\n ]\\n },\\n \\"ReviewInfo\\": {\\n \\"ReviewResult\\": 1,\\n \\"ReviewTime\\": \\"2019-10-12 17:06:00\\",\\n \\"HitId\\": \\"013c68142fec4f0899fa6ee0exxx\\",\\n \\"Reviewer\\": \\"123\\",\\n \\"Rid\\": 451,\\n \\"Comment\\": \\"\\",\\n \\"SentenceReviewResults\\": {\\n \\"SentenceReviewResults\\": [\\n {\\n \\"Sid\\": 1,\\n \\"Rid\\": 1,\\n \\"Cid\\": 1,\\n \\"Pid\\": \\"1\\",\\n \\"HitStatus\\": 1,\\n \\"ReviewDimensionType\\": \\"2\\",\\n \\"OriginTaskId\\": \\"122-122-22-333\\",\\n \\"OriginVid\\": \\"1001\\",\\n \\"Comment\\": \\"无意见\\",\\n \\"Changed\\": true\\n }\\n ]\\n }\\n },\\n \\"MachineHitResult\\": 0,\\n \\"ReviewHitResult\\": 0\\n }\\n ]\\n },\\n \\"ManualScoreInfoList\\": {\\n \\"ManualScoreInfo\\": [\\n {\\n \\"ScoreSubName\\": \\"投诉\\",\\n \\"Complainable\\": true,\\n \\"ScoreNum\\": -10,\\n \\"ScoreSubId\\": 0,\\n \\"ScoreId\\": 0,\\n \\"ComplainHistories\\": {\\n \\"ComplainHistories\\": [\\n {\\n \\"Comments\\": \\"请听一下录音,重新判定。\\",\\n \\"Operator\\": 123456,\\n \\"OperationTime\\": \\"2020-10-16T11:13Z\\",\\n \\"OperationType\\": 5,\\n \\"OperatorName\\": \\"张三\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"ReviewHistoryList\\": {\\n \\"ReviewHistory\\": [\\n {\\n \\"Type\\": 1,\\n \\"OperatorName\\": \\"张三\\",\\n \\"TimeStr\\": \\"2019-10-28 15:21:00\\",\\n \\"Score\\": 95,\\n \\"ReviewResult\\": 1,\\n \\"ComplainResult\\": 1,\\n \\"OldScore\\": 90,\\n \\"ReviewManagerType\\": \\"[一个类别][二类别:第一类目,第一类目->下一集]\\",\\n \\"Time\\": 1722396376000,\\n \\"Comments\\": \\"请写明学校名称,谢谢\\",\\n \\"ReviewRightRule\\": {\\n \\"ReviewRightRule\\": [\\n {\\n \\"ruleName\\": \\"问候语规则\\",\\n \\"rid\\": 0\\n }\\n ]\\n },\\n \\"Operator\\": 78404\\n }\\n ]\\n },\\n \\"ReviewTypeIdList\\": {\\n \\"ReviewTypeIdList\\": [\\n {\\n \\"ReviewKeyIdList\\": {\\n \\"ReviewKeyIdList\\": [\\n 0\\n ]\\n },\\n \\"ReviewTypeId\\": 1\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain quality inspection result details for review',
+ 'summary' => 'Retrieves the quality inspection results for a specified file. The response includes the transcript, audio URL, and details of detected rule hits. You can use this information to review the file by listening to the audio, reading the transcript, and locating where rules were triggered.',
+ 'requestParamsDescription' => '## Request parameters for GetResultToReviewRequest'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------- | :----- | :------- | :---------------------------------------------------------------------------- |'."\n"
+ .'| taskId | String | Yes | Task ID. Returned after you upload data for inspection. |'."\n"
+ .'| fileId | String | Yes | File ID. Get this from the GetResult API response, in the recording.id field. |'."\n"
+ ."\n"
+ .'## Sample request parameters'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "taskId": "20250108-038D8892-C18A-1E29-8809-402D286DD899",'."\n"
+ .' "fileId": "97ae1805ed2c4c438f480bb9def541ab"'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Sample Java code'."\n"
+ ."\n"
+ .'```java'."\n"
+ ."\n"
+ .'import com.alibaba.fastjson.JSONObject;'."\n"
+ .'import com.aliyun.qualitycheck20190115.Client;'."\n"
+ .'import com.aliyun.qualitycheck20190115.models.*;'."\n"
+ .'import com.aliyun.teaopenapi.models.Config;'."\n"
+ ."\n\n"
+ .'public class sca {'."\n"
+ ."\n"
+ .' private static String ak = "YOUR_ACCESS_KEY_ID";'."\n"
+ .' private static String sk = "YOUR_ACCESS_KEY_SECRET";'."\n"
+ ."\n"
+ .' private static void getResultToReview() throws Exception {'."\n"
+ .' Config config = new Config();'."\n"
+ .' config.setAccessKeyId(ak).setAccessKeySecret(sk)'."\n"
+ .' .setEndpoint("qualitycheck.cn-hangzhou.aliyuncs.com")'."\n"
+ .' .setRegionId("cn-hangzhou").setProtocol("HTTPS");'."\n"
+ .' Client client = new Client(config);'."\n"
+ .' GetResultToReviewRequest result = new GetResultToReviewRequest();'."\n"
+ .' String rr = "{\\"taskId\\":\\"20250108-038D8892-C18A-1E29-8809-402D286DD899\\",\\"fileId\\":\\"97ae1805ed2c4c438f480bb9def541ab\\"}";'."\n"
+ .' result.setJsonStr(rr);'."\n"
+ .' GetResultToReviewResponse response = client.getResultToReview(result);'."\n"
+ .' System.out.println(JSONObject.toJSONString(response));'."\n"
+ .' }'."\n"
+ ."\n\n"
+ .' public static void main(String[] args) throws Exception {'."\n"
+ .' getResultToReview();'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'responseParamsDescription' => '## Description of Val values'."\n"
+ ."\n"
+ .'| Operator name | Example Val value | Description |'."\n"
+ .'| --------------------------------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| Text Check – Keyword Check | Hello | The text in this utterance that matched the operator. This is the text highlighted in red on the review page. |'."\n"
+ .'| Text Check – Text Similarity Check | 82 | Similarity score. |'."\n"
+ .'| Text Check – Regular Expression Check | Hello | The text in this utterance that matched the operator. This is the text highlighted in red on the review page. |'."\n"
+ .'| Text Check – Context Repetition Check | Hello | The text in this utterance that matched the operator. This is the text highlighted in red on the review page. |'."\n"
+ .'| Voice Check – Call Silence Check | 3200 | The silence duration in milliseconds. |'."\n"
+ .'| Voice Check – Speech Rate Check | 365 | The speech rate for this utterance. |'."\n"
+ .'| Voice Check – Interruption Check | 2:8 | The format is "m:n", where m is the interruption duration in seconds (the overlap between the agent and customer speech), and n is the character count for this utterance. |'."\n"
+ .'| Voice Check – Role Identification | Hello | The text in this utterance that matched the operator. This is the text highlighted in red on the review page. |'."\n"
+ .'| Voice Check – Abnormal Hang-up | 3567 | The duration in milliseconds from the end of the last utterance to the hang-up time. |'."\n"
+ .'| Voice Check – Recording Duration Check | 56088 | The recording duration in milliseconds. |'."\n"
+ .'| Model Check – Emotion Detection Model | Insult | A specific emotion type, such as insult or high-risk. |'."\n"
+ .'| Model Check – Agent Violation Detection Model | Sarcasm | A specific agent violation type, such as sarcasm, follow-up question, or insult. |',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-22T09:15:12.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-12-04T03:25:33.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-07-22T08:34:19.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-07-15T07:53:59.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-07-15T07:41:12.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-07-15T03:50:18.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-05-30T12:54:38.000Z', 'description' => 'Response parameters changed, Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetResultToReview'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4***\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": 1,\\n \\"AudioScheme\\": \\"https\\",\\n \\"AudioURL\\": \\"sca-ccc-test.oss-cn-beijing.aliyuncs.com/xxxxx\\",\\n \\"TotalScore\\": 99,\\n \\"FileId\\": \\"e790e6c919d84b82b64ee*****\\",\\n \\"FileMergeName\\": \\"xxx.wav\\",\\n \\"Comments\\": \\"xxx\\",\\n \\"Vid\\": \\"6fa76916-3ce6-45d8-ac64-01b7f31***\\",\\n \\"Dialogues\\": {\\n \\"Dialogue\\": [\\n {\\n \\"Words\\": \\"你好有什么可以帮您\\",\\n \\"Identity\\": \\"客服\\",\\n \\"Begin\\": 72000,\\n \\"BeginTime\\": \\"2019-10-01T11:12Z\\",\\n \\"EmotionValue\\": 7,\\n \\"End\\": 80000,\\n \\"SpeechRate\\": 200,\\n \\"Role\\": \\"客服\\",\\n \\"SilenceDuration\\": 1,\\n \\"HourMinSec\\": \\"00:08\\",\\n \\"BeginTimeMs\\": 1569899521000\\n }\\n ]\\n },\\n \\"HitRuleReviewInfoList\\": {\\n \\"HitRuleReviewInfo\\": [\\n {\\n \\"ScoreSubName\\": \\"xxx\\",\\n \\"ScoreNum\\": -10,\\n \\"AutoReview\\": 1,\\n \\"ScoreSubId\\": 0,\\n \\"Complainable\\": true,\\n \\"ScoreId\\": 0,\\n \\"RuleName\\": \\"你好\\",\\n \\"Rid\\": 451,\\n \\"ConditionHitInfoList\\": {\\n \\"ConditionHitInfo\\": [\\n {\\n \\"KeyWords\\": {\\n \\"KeyWord\\": [\\n {\\n \\"From\\": 1,\\n \\"Val\\": \\"你好\\",\\n \\"Pid\\": 2,\\n \\"Tid\\": \\"6fa76916-3ce6-45d8-ac64-01b7f31c7295\\",\\n \\"Cid\\": \\"2000\\",\\n \\"To\\": 3,\\n \\"CustomizeCode\\": \\"xxx\\",\\n \\"IsMatch\\": false\\n }\\n ]\\n },\\n \\"Cid\\": {\\n \\"Cid\\": [\\n \\"2000\\"\\n ]\\n },\\n \\"Phrase\\": {\\n \\"Words\\": \\"你好,请问有什么可以帮您\\",\\n \\"Begin\\": 72000,\\n \\"Identity\\": \\"客服\\",\\n \\"Pid\\": 3,\\n \\"EmotionValue\\": 7,\\n \\"End\\": 80000,\\n \\"Role\\": \\"客服\\"\\n }\\n }\\n ]\\n },\\n \\"ComplainHistories\\": {\\n \\"ComplainHistories\\": [\\n {\\n \\"Comments\\": \\"请听一下录音,重新判定。\\",\\n \\"Operator\\": 123456,\\n \\"OperationTime\\": \\"2020-10-16T11:13Z\\",\\n \\"OperationType\\": 5,\\n \\"OperatorName\\": \\"张三\\"\\n }\\n ]\\n },\\n \\"ReviewInfo\\": {\\n \\"ReviewResult\\": 1,\\n \\"ReviewTime\\": \\"2019-10-12 17:06:00\\",\\n \\"HitId\\": \\"013c68142fec4f0899fa6ee0exxx\\",\\n \\"Reviewer\\": \\"123\\",\\n \\"Rid\\": 451,\\n \\"Comment\\": \\"\\",\\n \\"SentenceReviewResults\\": {\\n \\"SentenceReviewResults\\": [\\n {\\n \\"Sid\\": 1,\\n \\"Rid\\": 1,\\n \\"Cid\\": 1,\\n \\"Pid\\": \\"1\\",\\n \\"HitStatus\\": 1,\\n \\"ReviewDimensionType\\": \\"2\\",\\n \\"OriginTaskId\\": \\"122-122-22-333\\",\\n \\"OriginVid\\": \\"1001\\",\\n \\"Comment\\": \\"无意见\\",\\n \\"Changed\\": false\\n }\\n ]\\n }\\n },\\n \\"MachineHitResult\\": 0,\\n \\"ReviewHitResult\\": 0\\n }\\n ]\\n },\\n \\"ManualScoreInfoList\\": {\\n \\"ManualScoreInfo\\": [\\n {\\n \\"ScoreSubName\\": \\"投诉\\",\\n \\"Complainable\\": true,\\n \\"ScoreNum\\": -10,\\n \\"ScoreSubId\\": 0,\\n \\"ScoreId\\": 0,\\n \\"ComplainHistories\\": {\\n \\"ComplainHistories\\": [\\n {\\n \\"Comments\\": \\"请听一下录音,重新判定。\\",\\n \\"Operator\\": 123456,\\n \\"OperationTime\\": \\"2020-10-16T11:13Z\\",\\n \\"OperationType\\": 5,\\n \\"OperatorName\\": \\"张三\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"ReviewHistoryList\\": {\\n \\"ReviewHistory\\": [\\n {\\n \\"Type\\": 1,\\n \\"OperatorName\\": \\"张三\\",\\n \\"TimeStr\\": \\"2019-10-28 15:21:00\\",\\n \\"Score\\": 95,\\n \\"ReviewResult\\": 1,\\n \\"ComplainResult\\": 1,\\n \\"OldScore\\": 90,\\n \\"ReviewManagerType\\": \\"[一个类别][二类别:第一类目,第一类目->下一集]\\",\\n \\"Time\\": 1722396376000,\\n \\"Comments\\": \\"请写明学校名称,谢谢\\",\\n \\"ReviewRightRule\\": {\\n \\"ReviewRightRule\\": [\\n {\\n \\"ruleName\\": \\"问候语规则\\",\\n \\"rid\\": 0\\n }\\n ]\\n },\\n \\"Operator\\": 78404\\n }\\n ]\\n },\\n \\"ReviewTypeIdList\\": {\\n \\"ReviewTypeIdList\\": [\\n {\\n \\"ReviewKeyIdList\\": {\\n \\"ReviewKeyIdList\\": [\\n 0\\n ]\\n },\\n \\"ReviewTypeId\\": 1\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
],
- 'ListSessionGroup' => [
- 'summary' => '获取会话组列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetRule' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -9421,638 +8212,1340 @@
],
'operationType' => 'read',
'deprecated' => true,
- 'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '153846',
- 'abilityTreeNodes' => [
- 'FEATUREscaAJDYMI',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'jsonStr',
+ 'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"isSchemeData":1,"pageNumber":1,"pageSize":10,"callStartTime":"2022-09-17 00:00:00","callEndTime":"2022-09-23 23:59:59","schemeTaskConfigId":368}',
- ],
+ 'schema' => ['description' => 'A complete JSON string. See the detailed information below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"ruleIds":"123"}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'ListResult<SessionGroupSummary>',
- 'description' => 'ListResult<SessionGroupSummary>',
'type' => 'object',
'properties' => [
+ 'Code' => ['description' => 'The result code. **200** means success. Any other value means failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request fails. Returns **successful** if the request succeeds.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID', 'type' => 'string', 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. true means success. **false** or **null** means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
+ 'description' => 'The response data',
'type' => 'object',
- 'itemNode' => true,
'properties' => [
- 'Data' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => 'SessionGroupSummary',
- 'type' => 'object',
- 'properties' => [
- 'SessionGroupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SessionGroupA',
- ],
- 'SchemeTaskConfigId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123',
- ],
- 'SchemeTaskConfigName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'CustomerServiceIdList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'CustomerServiceIdList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '15',
- ],
- ],
- ],
- ],
- 'CustomerServiceNameList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'CustomerServiceNameList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- 'CustomerIdList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'CustomerIdList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '13',
- ],
- ],
- ],
- ],
- 'CustomerNameList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'CustomerNameList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- 'CallerList' => [
+ 'Rules' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'RuleInfo' => [
+ 'description' => 'A list of rule information items',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A list of rules',
'type' => 'object',
- 'itemNode' => true,
'properties' => [
- 'CallerList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '05712****989',
+ 'Status' => ['description' => 'Status. Valid values: 0 (pending), 1 (active), or 2 (expired)', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Type' => ['description' => '\\[Deprecated] Rule type', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ScoreSubId' => ['description' => 'The ID of the scoring sub-item', 'type' => 'integer', 'format' => 'int32', 'example' => '22', 'title' => ''],
+ 'IsOnline' => ['description' => '\\[Deprecated] Indicates whether the rule is online. 0 means offline. 1 means online. This value is always 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the rule was created', 'type' => 'string', 'example' => '2016-08-05 10:37:10', 'title' => ''],
+ 'CreateEmpid' => ['description' => 'The ID of the user who created the rule', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'LastUpdateEmpid' => ['description' => 'The ID of the user who last updated the rule', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'IsDelete' => ['description' => 'Indicates whether the rule is deleted. Valid values: 0 (not deleted) or 1 (deleted)', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Rid' => ['description' => 'The rule ID', 'type' => 'string', 'example' => '4', 'title' => ''],
+ 'RuleScoreType' => ['description' => 'Indicates whether the rule contributes to scoring. Valid values: 1 (no score) or 3 (scored)', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'EndTime' => ['description' => 'The expiration time', 'type' => 'string', 'example' => '2016-08-05 10:37:10', 'title' => ''],
+ 'Weight' => ['description' => '\\[Deprecated] Rule weight', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'StartTime' => ['description' => 'The start time', 'type' => 'string', 'example' => '2016-08-05 10:37:10', 'title' => ''],
+ 'RuleLambda' => ['description' => '\\[Deprecated] Logical relationship between rule conditions', 'type' => 'string', 'example' => 'a && b', 'title' => ''],
+ 'ScoreSubName' => ['description' => 'The name of the scoring sub-item. This field appears only when `ruleScoreType=3`', 'type' => 'string', 'example' => '评分子项', 'title' => ''],
+ 'AutoReview' => ['description' => 'The review option. Valid values: 1 (manual review) or 3 (auto review)', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Comments' => ['description' => 'Remarks', 'type' => 'string', 'example' => '测试规则', 'title' => ''],
+ 'LastUpdateTime' => ['description' => 'The time when the rule was last updated', 'type' => 'string', 'example' => '2019-10-28 14:23:28', 'title' => ''],
+ 'ScoreName' => ['description' => 'The name of the scoring main item. This field appears only when `ruleScoreType=3`', 'type' => 'string', 'example' => '评分大项', 'title' => ''],
+ 'Name' => ['description' => 'The rule name', 'type' => 'string', 'example' => 'demo', 'title' => ''],
+ 'ScoreId' => ['description' => 'The ID of the scoring main item', 'type' => 'integer', 'format' => 'int32', 'example' => '123', 'title' => ''],
+ 'BusinessCategoryNameList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'BusinessCategoryNameList' => [
+ 'description' => 'A list of business categories',
+ 'type' => 'array',
+ 'items' => ['description' => 'A list of business categories', 'type' => 'string', 'example' => '["业务A","业务B"]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
],
- ],
- ],
- ],
- 'SkillGroupNameList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'SkillGroupNameList' => [
'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- 'Score' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'SessionCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'HitSessionCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CallStartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2022-09-26 10:09:14',
- ],
- 'ReviewStatus' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'AssignStatus' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ReviewerList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'ReviewerList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- 'SessionGroupReviewedOrComplained' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'LastDataId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4498420@a_z@93EAADF1-01D3-44BD-8AC9-F57F447EFCE8_1614*****',
- ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'Count' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2228',
- ],
- 'CurrentPage' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ResultCountId' => [
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
- 'LastDataId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'substitutions' => ['Qualitycheck::2019-01-15::GetRuleV4'],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Rules\\": {\\n \\"RuleInfo\\": [\\n {\\n \\"Status\\": 1,\\n \\"Type\\": 1,\\n \\"ScoreSubId\\": 22,\\n \\"IsOnline\\": 1,\\n \\"CreateTime\\": \\"2016-08-05 10:37:10\\",\\n \\"CreateEmpid\\": \\"123\\",\\n \\"LastUpdateEmpid\\": \\"123\\",\\n \\"IsDelete\\": 0,\\n \\"Rid\\": \\"4\\",\\n \\"RuleScoreType\\": 1,\\n \\"EndTime\\": \\"2016-08-05 10:37:10\\",\\n \\"Weight\\": \\"1\\",\\n \\"StartTime\\": \\"2016-08-05 10:37:10\\",\\n \\"RuleLambda\\": \\"a && b\\",\\n \\"ScoreSubName\\": \\"评分子项\\",\\n \\"AutoReview\\": 1,\\n \\"Comments\\": \\"测试规则\\",\\n \\"LastUpdateTime\\": \\"2019-10-28 14:23:28\\",\\n \\"ScoreName\\": \\"评分大项\\",\\n \\"Name\\": \\"demo\\",\\n \\"ScoreId\\": 123,\\n \\"BusinessCategoryNameList\\": {\\n \\"BusinessCategoryNameList\\": [\\n \\"[\\\\\\"业务A\\\\\\",\\\\\\"业务B\\\\\\"]\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Retrieve basic information about rules ',
+ 'summary' => 'Retrieves basic information about rules.',
+ 'description' => '> This operation returns basic rule information such as the **id** and **name**. You can use this information with [GetRuleDetails](~~142310~~).',
+ 'requestParamsDescription' => '**Request parameters in the JsonStr string**'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------------------- | :------------- | :------- | :------------------------------------------------------------------------------------ |'."\n"
+ .'| ruleIds | `List<String>` | No | Rule IDs. Separate multiple IDs with commas. |'."\n"
+ .'| businessCategoryName | `List<String>` | No | Business category names |'."\n"
+ .'| status | Integer | No | Status. Valid values: 0 (pending), 1 (active), 2 (expired), or 3 (all). Default is 1. |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-19T06:19:54.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetRule'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'GetRuleById' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'RuleId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '53', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The business space ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'PlainResult<RulesInfo>',
+ 'description' => 'PlainResult',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => ['description' => 'The detailed information about the rule.', '$ref' => '#/components/schemas/RulesInfo', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** ', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. A value of true indicates success, and false or null indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Other values indicate an error.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The returned message. A value of successful is returned on success, and an error message is returned on failure.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'Messages' => [
+ 'description' => 'Details about the error. This parameter is used when multiple messages are returned.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A single error message.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'substitutions' => ['Qualitycheck::2019-01-15::GetRuleV4'],
+ ],
+ 'title' => 'Get Rule Details by ID ',
+ 'summary' => 'Retrieves the details of a specific quality inspection rule. It corresponds to the **Edit** action on the **Quality Inspection Rule Configuration** page. The URL for this operation in a private cloud is `ip:port/api/client/GetRuleById.json`.',
+ 'responseParamsDescription' => 'The Data parameter contains the rule details. For more information, see the [`Rule Object Description`](https://help.aliyun.com/document_detail/453053.html) document.',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:39.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-10-20T06:34:02.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetRuleById'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Conditions\\": [\\n {\\n \\"Cid\\": \\"a\\",\\n \\"Id\\": 1,\\n \\"Rid\\": \\"1\\",\\n \\"Check_range\\": {\\n \\"RoleId\\": 1,\\n \\"Role\\": \\"客服\\",\\n \\"Anchor\\": {\\n \\"Cid\\": \\"a\\",\\n \\"Location\\": \\"BEFORE\\",\\n \\"Hit_time\\": 1\\n },\\n \\"Range\\": {\\n \\"From\\": 1,\\n \\"To\\": 2\\n },\\n \\"Absolute\\": true,\\n \\"AllSentencesSatisfy\\": true\\n },\\n \\"Operators\\": [\\n {\\n \\"Oid\\": \\"a\\",\\n \\"Id\\": 1,\\n \\"Type\\": \\"HIT_ANY_KEYWORDS\\",\\n \\"Param\\": {\\n \\"CustomerParam\\": {\\n \\"Field\\": \\"remark1\\",\\n \\"FieldType\\": 1,\\n \\"DataType\\": 1,\\n \\"Symbol\\": 1,\\n \\"Value\\": \\"xxx\\",\\n \\"ActualValue\\": \\"xx\\",\\n \\"ExpressionMetaDesc\\": {\\n \\"LeftFieldType\\": 0,\\n \\"LeftOperand\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"RightFieldType\\": 0,\\n \\"RightOperand\\": \\"\\",\\n \\"RoundingMode\\": \\"\\"\\n }\\n },\\n \\"Keywords\\": [\\n \\"你好\\"\\n ],\\n \\"Regex\\": \\"质疑.*\\",\\n \\"NotRegex\\": \\"优秀.*\\",\\n \\"Phrase\\": \\"你好,请问\\",\\n \\"References\\": [\\n \\"你好.{0,10}\\"\\n ],\\n \\"Interval\\": 1,\\n \\"IntervalEnd\\": 2,\\n \\"Threshold\\": 90,\\n \\"In_sentence\\": true,\\n \\"Target\\": 1,\\n \\"From_end\\": true,\\n \\"Different_role\\": true,\\n \\"Target_role\\": \\"客服\\",\\n \\"RoleId\\": 1,\\n \\"Velocity\\": 111,\\n \\"VelocityInMint\\": 1,\\n \\"KeywordExtension\\": 1,\\n \\"Synonyms\\": {\\n \\"key\\": [\\n \\"售卖\\"\\n ]\\n },\\n \\"Case_sensitive\\": true,\\n \\"Near_dialogue\\": true,\\n \\"MinWordSize\\": 1,\\n \\"Hit_time\\": 2,\\n \\"Excludes\\": [\\n \\"负向\\"\\n ],\\n \\"From\\": 0,\\n \\"CheckFirstSentence\\": true,\\n \\"Average\\": true,\\n \\"BeginType\\": \\"1\\",\\n \\"EndType\\": \\"2\\",\\n \\"CompareOperator\\": \\"gt\\",\\n \\"Pkey\\": \\"xx\\",\\n \\"Poutput_type\\": 1,\\n \\"SimilarlySentences\\": [\\n \\"我要购买\\"\\n ],\\n \\"LgfSentences\\": [\\n \\"你好{1}\\"\\n ],\\n \\"Score\\": 70,\\n \\"ContextChatMatch\\": true,\\n \\"KeywordMatchSize\\": 1,\\n \\"MaxEmotionChangeValue\\": 3,\\n \\"CheckType\\": 1,\\n \\"KnowledgeTargetId\\": \\"1\\",\\n \\"CategoryPathCode\\": \\"xx\\",\\n \\"KnowledgeTargetType\\": 1,\\n \\"KnowledgeTargetName\\": \\"订单\\",\\n \\"QuestionThreshold\\": \\"90\\",\\n \\"AnswerThreshold\\": \\"90\\",\\n \\"KnowledgeSentenceNum\\": 1,\\n \\"KnowledgeInfo\\": \\"下单\\",\\n \\"BotId\\": \\"chatbot-cn-xxx\\",\\n \\"UseEasAlgorithm\\": true,\\n \\"Pvalues\\": [\\n \\"\\"\\n ],\\n \\"Similarity_threshold\\": 90,\\n \\"AntModelInfo\\": {\\n \\"key\\": \\"xxx\\"\\n },\\n \\"DelayTime\\": 10,\\n \\"Knowledges\\": \\"\\",\\n \\"LlmModelCode\\": \\"\\",\\n \\"HitCondition\\": \\"\\",\\n \\"SceneName\\": \\"\\",\\n \\"Dimensions\\": [\\n {\\n \\"Dimension\\": \\"\\",\\n \\"Desc\\": \\"\\",\\n \\"ExcludeCondition\\": \\"\\",\\n \\"IncludeCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"Name\\": \\"a\\",\\n \\"UserGroup\\": \\"xxx\\",\\n \\"QualityCheckType\\": 0\\n }\\n ],\\n \\"Lambda\\": \\"a\\",\\n \\"Exclusion\\": 0,\\n \\"Name\\": \\"xx\\",\\n \\"UserGroup\\": \\"xxxx\\"\\n }\\n ],\\n \\"Rules\\": [\\n {\\n \\"Status\\": 1,\\n \\"IsDelete\\": 1,\\n \\"StartTime\\": \\"1641277321000\\",\\n \\"EndTime\\": \\"1641277321000\\",\\n \\"Weight\\": \\"1\\",\\n \\"IsOnline\\": 1,\\n \\"CreateEmpid\\": \\"1\\",\\n \\"CreateEmpName\\": \\"张三\\",\\n \\"CreateTime\\": \\"1641277321000\\",\\n \\"LastUpdateTime\\": \\"1641277321000\\",\\n \\"LastUpdateEmpid\\": \\"1\\",\\n \\"LastUpdateEmpName\\": \\"张三\\",\\n \\"Comments\\": \\"违规\\",\\n \\"Deny\\": 1,\\n \\"ScoreSubId\\": 1,\\n \\"ScoreName\\": \\"违规\\",\\n \\"ScoreSubName\\": \\"1\\",\\n \\"ScoreType\\": 1,\\n \\"ScoreDeleted\\": true,\\n \\"OperationMode\\": 1,\\n \\"Meet\\": 1,\\n \\"Effective\\": 1,\\n \\"FullCycle\\": 1,\\n \\"EffectiveStartTime\\": \\"OperationMode\\",\\n \\"EffectiveEndTime\\": \\"OperationMode\\",\\n \\"QualityCheckType\\": 1,\\n \\"Level\\": 1,\\n \\"GraphFlow\\": \\"{}\\",\\n \\"TaskFlowType\\": 1,\\n \\"CheckType\\": 3,\\n \\"SchemeCheckType\\": {\\n \\"CheckType\\": 1,\\n \\"CheckName\\": \\"流程规则\\",\\n \\"SourceScore\\": 1,\\n \\"Score\\": 50,\\n \\"Enable\\": 1,\\n \\"SchemeId\\": 1,\\n \\"SchemeScoreInfoList\\": [\\n {\\n \\"Rid\\": 1,\\n \\"Name\\": \\"xx\\",\\n \\"TaskFlowId\\": 1,\\n \\"TaskFlowName\\": \\"xx\\",\\n \\"ScoreType\\": 1,\\n \\"ScoreNumType\\": 0,\\n \\"ScoreNum\\": 1,\\n \\"ScoreRuleHitType\\": 0\\n }\\n ],\\n \\"TaskFlowScoreInfoList\\": [\\n {\\n \\"TaskFlowId\\": 1,\\n \\"TaskFlowName\\": \\"xx\\",\\n \\"TaskFlowType\\": 1,\\n \\"SchemeScoreInfoList\\": [\\n {\\n \\"Rid\\": 1,\\n \\"Name\\": \\"xx\\",\\n \\"TaskFlowId\\": 1,\\n \\"TaskFlowName\\": \\"xx\\",\\n \\"ScoreType\\": 1,\\n \\"ScoreNumType\\": 0,\\n \\"ScoreNum\\": 11,\\n \\"ScoreRuleHitType\\": 0\\n }\\n ]\\n }\\n ]\\n },\\n \\"TargetType\\": 10,\\n \\"ConfigType\\": 1,\\n \\"ScoreNumType\\": 1,\\n \\"ScoreRuleHitType\\": 0,\\n \\"SchemeId\\": 1,\\n \\"SchemeRuleMappingId\\": 1,\\n \\"SchemeName\\": \\"通用方案\\",\\n \\"ModifyType\\": 1,\\n \\"SortIndex\\": 1,\\n \\"RuleType\\": 1,\\n \\"Rid\\": \\"1\\",\\n \\"Name\\": \\"开头语规则\\",\\n \\"TaskFlowId\\": 111111111,\\n \\"Lambda\\": \\"a&&b\\",\\n \\"ExternalProperty\\": 1,\\n \\"Type\\": 2,\\n \\"RuleCategoryName\\": \\"正向规则\\",\\n \\"AutoReview\\": 1,\\n \\"RuleScoreType\\": 3,\\n \\"ScoreId\\": 1,\\n \\"PreqRule\\": {\\n \\"Rid\\": \\"\\"\\n },\\n \\"ScoreNum\\": 1,\\n \\"BusinessCategoryNameList\\": [\\n \\"全部\\"\\n ],\\n \\"Dialogues\\": [\\n {\\n \\"Id\\": 1,\\n \\"Content\\": [\\n {\\n \\"HourMinSec\\": \\"00:00:00\\",\\n \\"Role\\": \\"客户\\",\\n \\"Identity\\": \\"客户\\",\\n \\"EmotionValue\\": 1,\\n \\"SpeechRate\\": 100,\\n \\"Words\\": \\"方便\\",\\n \\"End\\": 1360,\\n \\"SilenceDuration\\": 100,\\n \\"BeginTime\\": 350,\\n \\"Begin\\": 360\\n }\\n ],\\n \\"Name\\": \\"xx\\",\\n \\"UserGroup\\": \\"xx\\"\\n }\\n ],\\n \\"Triggers\\": [\\n \\"a\\"\\n ]\\n }\\n ],\\n \\"Dialogues\\": [\\n {\\n \\"Id\\": 1,\\n \\"Content\\": [\\n {\\n \\"HourMinSec\\": \\"00:00:00\\",\\n \\"Role\\": \\"客户\\",\\n \\"Identity\\": \\"客户\\",\\n \\"EmotionValue\\": 1,\\n \\"SpeechRate\\": 100,\\n \\"Words\\": \\"方便\\",\\n \\"End\\": 1360,\\n \\"SilenceDuration\\": 100,\\n \\"BeginTime\\": 350,\\n \\"Begin\\": 360\\n }\\n ],\\n \\"Name\\": \\"xx\\",\\n \\"UserGroup\\": \\"xx\\"\\n }\\n ],\\n \\"Count\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n },\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": [\\n \\"无\\"\\n ],\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ ],
+ 'GetRuleCategory' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Set the value to an empty string.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '""', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Other values indicate failure. Use this field to determine the cause of a failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'If an error occurs, this field provides error details. If the call is successful, the value is \\`successful\\`.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. A value of \\`true\\` indicates success. A value of \\`false\\` or \\`null\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'Message' => [
- 'description' => '',
+ 'RuleCountInfo' => [
+ 'description' => 'The result data.',
'type' => 'array',
'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The rule type.', 'type' => 'integer', 'format' => 'int32', 'example' => '22', 'title' => ''],
+ 'TypeName' => ['description' => 'The name of the rule type.', 'type' => 'string', 'example' => '客服组', 'title' => ''],
+ 'Select' => ['description' => 'The selection status.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'HttpStatusCode' => [
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Data\\": [\\n {\\n \\"SessionGroupId\\": \\"SessionGroupA\\",\\n \\"SchemeTaskConfigId\\": 123,\\n \\"SchemeTaskConfigName\\": \\"质检任务A\\",\\n \\"CustomerServiceIdList\\": {\\n \\"CustomerServiceIdList\\": [\\n \\"15\\"\\n ]\\n },\\n \\"CustomerServiceNameList\\": {\\n \\"CustomerServiceNameList\\": [\\n \\"客服人员A\\"\\n ]\\n },\\n \\"CustomerIdList\\": {\\n \\"CustomerIdList\\": [\\n \\"13\\"\\n ]\\n },\\n \\"CustomerNameList\\": {\\n \\"CustomerNameList\\": [\\n \\"客户人员A\\"\\n ]\\n },\\n \\"CallerList\\": {\\n \\"CallerList\\": [\\n \\"05712****989\\"\\n ]\\n },\\n \\"SkillGroupNameList\\": {\\n \\"SkillGroupNameList\\": [\\n \\"技能组A\\"\\n ]\\n },\\n \\"Score\\": 100,\\n \\"SessionCount\\": 1,\\n \\"HitSessionCount\\": 1,\\n \\"CallStartTime\\": \\"2022-09-26 10:09:14\\",\\n \\"ReviewStatus\\": 1,\\n \\"AssignStatus\\": 1,\\n \\"ReviewerList\\": {\\n \\"ReviewerList\\": [\\n \\"复核人员A\\"\\n ]\\n },\\n \\"SessionGroupReviewedOrComplained\\": true,\\n \\"LastDataId\\": \\"4498420@a_z@93EAADF1-01D3-44BD-8AC9-F57F447EFCE8_1614*****\\"\\n }\\n ]\\n },\\n \\"Count\\": 2228,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ResultCountId\\": \\"忽略\\",\\n \\"LastDataId\\": \\"xxx\\",\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RuleCountInfo\\": [\\n {\\n \\"Type\\": 22,\\n \\"TypeName\\": \\"客服组\\",\\n \\"Select\\": false\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain the rule type list',
+ 'summary' => 'Retrieves a list of rule types.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetRuleCategory'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'AssignReviewerBySessionGroup' => [
- 'summary' => '会话组批量分配',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetRuleDetail' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => true,
- 'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '153845',
- 'abilityTreeNodes' => [
- 'FEATUREscaAJDYMI',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'jsonStr',
+ 'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"sessionGroupParam":{"isSchemeData":1,"callStartTime":"2022-09-17 00:00:00","callEndTime":"2022-09-23 23:59:59","schemeTaskConfigId":24},"assignments":[{"reviewer":63,"count":4}],"isSchemeData":1}',
- ],
+ 'schema' => ['description' => 'A complete JSON string. See the details below for the exact format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"ruleIds":"123"}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BaseResult',
- 'description' => 'BaseResult',
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Messages' => [
+ 'Code' => ['description' => 'The result code. **200** means success. Any other value means failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message if the request fails. If the request succeeds, the value is **successful**.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4987D326-83D9-4A42-B9A5-0B27F9B40539', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Use this field to check the result:'."\n"
+ ."\n"
+ .'- **true** means success.'."\n"
+ ."\n"
+ .'- false or **null** means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The response data.',
'type' => 'object',
- 'itemNode' => true,
'properties' => [
- 'Message' => [
+ 'PageSize' => ['description' => 'The number of items per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Count' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Conditions' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'ConditionBasicInfo' => [
+ 'description' => 'The configuration for all conditions.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The condition information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ConditionInfoCid' => ['description' => 'The condition ID.', 'type' => 'string', 'example' => '7', 'title' => ''],
+ 'OperLambda' => ['description' => 'The logical relationship between operators in the condition.', 'type' => 'string', 'example' => '7', 'title' => ''],
+ 'Operators' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OperatorBasicInfo' => [
+ 'description' => 'The operators included in the condition.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'An operator.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The operator type.', 'type' => 'string', 'example' => 'REGULAR_EXPRESSION', 'title' => ''],
+ 'Oid' => ['description' => 'The operator ID.', 'type' => 'string', 'example' => '8', 'title' => ''],
+ 'OperName' => ['description' => 'The operator name and description.', 'type' => 'string', 'example' => 'operator demo', 'title' => ''],
+ 'Param' => [
+ 'description' => 'The specific expression for the operator.',
+ 'type' => 'object',
+ 'properties' => [
+ 'DifferentRole' => ['description' => 'Used only for time-interval operators. If true, sentences spoken by the same role as the current sentence are excluded from the calculation.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Regex' => ['description' => 'The regular expression used for regular-expression operators.', 'type' => 'string', 'example' => '.*修改密码.*', 'title' => ''],
+ 'TargetRole' => ['description' => 'Used only for duplicate-sentence operators. If the current sentence matches this regular expression, the matched part is searched for in the sentence before the current one, specified by the target\\_role value.', 'type' => 'string', 'example' => '客户', 'title' => ''],
+ 'VelocityInMint' => ['description' => 'The words-per-minute threshold used for speech-rate checks. The system compares the current sentence\'s rate against this value.', 'type' => 'integer', 'format' => 'int32', 'example' => '280', 'title' => ''],
+ 'Average' => ['description' => 'The speech-rate check mode. Possible values: true checks the average rate across the entire conversation. false checks the rate of the current sentence only.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'KeywordExtension' => ['description' => 'For keyword-check operators, enables synonym expansion.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Score' => ['description' => 'The similarity score used for text-similarity operators.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''],
+ 'NotRegex' => ['description' => 'The regular expression to exclude in regex checks.', 'type' => 'string', 'example' => '发一下|告诉我', 'title' => ''],
+ 'CompareOperator' => ['description' => 'The comparison operator. Possible values: gt (greater than) and lt (less than). Default is gt.', 'type' => 'string', 'example' => 'gt', 'title' => ''],
+ 'DelayTime' => ['description' => 'The delay time used for interruption checks. For example, if set to 1000, an overlap is considered an interruption only if it occurs more than 1000 milliseconds after the other speaker starts. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''],
+ 'KeywordMatchSize' => ['description' => 'The number of keywords to match for keyword-check operators. The meaning depends on the detection type: 1 means match any one keyword. -1 means match all keywords. A positive integer N means match any N keywords. 0 means match none. The default value depends on the keyword detection type (type): HIT\\_ANY\\_KEYWORDS uses 1. INCLUDE\\_KEYWORDS uses -1.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'HitTime' => ['description' => 'For context-duplicate operators, the number of times a sentence must repeat before it counts as a violation. Default is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'BeginType' => ['description' => 'Used only for abnormal-hangup operators. Always pass DIALOGUE.', 'type' => 'string', 'example' => 'DIALOGUE', 'title' => ''],
+ 'Target' => ['description' => 'The number of previous sentences to check. If 0, the time interval equals the current sentence\'s end time minus its start time.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'MaxEmotionChangeValue' => ['description' => 'The energy value used for energy-detection operators. Valid range: 1–10.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''],
+ 'Threshold' => ['description' => 'The threshold used for edit-distance and matching-score operators.', 'type' => 'number', 'format' => 'float', 'example' => '4', 'title' => ''],
+ 'From' => ['description' => 'For context-duplicate operators, the maximum number of sentences between duplicates before it counts as a violation. Default is 2, meaning a duplicate within the last two sentences (inclusive) triggers a violation.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'FromEnd' => ['description' => 'For time-interval operators, determines whether the interval is calculated as the current sentence\'s end time minus the target sentence\'s end time.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'MinWordSize' => ['description' => 'The minimum number of words in a sentence before speech-rate checking begins.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
+ 'InSentence' => ['description' => 'Specifies whether to check the full sentence or just part of it.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Phrase' => ['description' => 'The reference sentence used for minimum-edit-distance operators.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'Similarity_threshold' => ['description' => 'This field is deprecated. Ignore it.', 'type' => 'number', 'format' => 'float', 'example' => '90', 'title' => ''],
+ 'CheckType' => ['description' => 'The detection method used for energy checks. Possible values: 1 (energy fluctuation between adjacent sentences), 2 (maximum energy span), and 3 (energy range detection). Default is 3.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Interval' => ['description' => 'The time interval used for time-interval operators.', 'type' => 'integer', 'format' => 'int32', 'example' => '5000', 'title' => ''],
+ 'ContextChatMatch' => ['description' => 'For keyword-check operators, enables multi-sentence analysis. Possible values: true for multi-sentence analysis. false for single-sentence analysis. Default is false. See the detailed explanation below.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Excludes' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Excludes' => [
+ 'description' => 'The list of exception sentences for context-duplicate operators.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The list of exception sentences for context-duplicate operators. Repeats of these sentences do not count as violations. Default is empty.', 'type' => 'string', 'example' => '[“好的”]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AntModelInfo' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'AntModelInfo' => [
+ 'description' => 'This field is deprecated. Ignore it.',
+ 'type' => 'array',
+ 'items' => ['description' => 'This field is deprecated. Ignore it.', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Pvalues' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Pvalues' => [
+ 'description' => 'This field is deprecated. Ignore it.',
+ 'type' => 'array',
+ 'items' => ['description' => 'This field is deprecated. Ignore it.', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'References' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Reference' => [
+ 'description' => 'Used for similarity matching.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The specific expression for similarity-matching operators.', 'type' => 'string', 'example' => '[“优惠力度特别大”,”特别的优惠”]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'SimilarlySentences' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SimilarlySentence' => [
+ 'description' => 'The collection of example sentences for text-similarity operators.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The collection of example sentences for text-similarity operators.', 'type' => 'string', 'example' => '[“优惠力度特别大”,”特别的优惠”]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'OperKeyWords' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'OperKeyWord' => [
+ 'description' => 'The keyword list.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The keyword list.', 'type' => 'string', 'example' => '[“你好”,”您好”,”上午好”]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'CheckRange' => [
+ 'description' => 'The scope for condition checking.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Absolute' => ['description' => 'Whether the condition is independent.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Role' => ['description' => 'The role for which the condition applies.', 'type' => 'string', 'example' => '客服', 'title' => ''],
+ 'Anchor' => [
+ 'description' => 'The anchor relationship for the condition.',
+ 'type' => 'object',
+ 'properties' => [
+ 'HitTime' => ['description' => '`1~N` means the first (Nth) time the condition hits. **-1** means the last time it hits.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Location' => ['description' => '- **CURRENT**: the current sentence where the condition hits.'."\n"
+ ."\n"
+ .'- **BEFORE**: before the sentence where the condition hits.'."\n"
+ ."\n"
+ .'- **AFTER**: after the sentence where the condition hits.', 'type' => 'string', 'example' => 'AFTER', 'title' => ''],
+ 'AnchorCid' => ['description' => 'The condition ID used to identify the anchor condition.', 'type' => 'string', 'example' => '7', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Range' => [
+ 'description' => 'The range defined by both Role and Anchor. `1~N` means the first (Nth) sentence within that range. -1 means the last sentence within that range.',
+ 'type' => 'object',
+ 'properties' => [
+ 'To' => ['description' => '`1~N` means the first (Nth) sentence within the range defined by anchor and role. **-1** means the last sentence within that range.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'From' => ['description' => '`1~N` means the first (Nth) sentence within the range defined by anchor and role. **-1** means the last sentence within that range.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Rules' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'RuleBasicInfo' => [
+ 'description' => 'The configuration for all rules.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of rules.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleLambda' => ['description' => 'The logical relationship between conditions in the rule.', 'type' => 'string', 'example' => '7&&!8', 'title' => ''],
+ 'Rid' => ['description' => 'The rule ID.', 'type' => 'string', 'example' => '4', 'title' => ''],
+ 'BusinessCategories' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'BusinessCategoryBasicInfo' => [
+ 'description' => 'The business categories associated with the rule.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The business categories associated with the rule.',
+ 'type' => 'object',
+ 'properties' => [
+ 'BusinessName' => ['description' => 'The name of the business category associated with the rule.', 'type' => 'string', 'example' => '业务A', 'title' => ''],
+ 'ServiceType' => ['description' => 'The service type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Bid' => ['description' => 'The business ID (BID) associated with the rule. Must be numeric.', 'type' => 'integer', 'format' => 'int32', 'example' => '264971810', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Triggers' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Trigger' => [
+ 'description' => 'The list of triggers.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The condition IDs whose content should be returned when the rule triggers. When you set a rule ID, the response includes the specific content that triggered the rule.', 'type' => 'string', 'example' => '["7","8"]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
'staticInfo' => [
- 'noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'substitutions' => ['Qualitycheck::2019-01-15::GetRuleV4'],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"4987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Count\\": 10,\\n \\"Conditions\\": {\\n \\"ConditionBasicInfo\\": [\\n {\\n \\"ConditionInfoCid\\": \\"7\\",\\n \\"OperLambda\\": \\"7\\",\\n \\"Operators\\": {\\n \\"OperatorBasicInfo\\": [\\n {\\n \\"Type\\": \\"REGULAR_EXPRESSION\\",\\n \\"Oid\\": \\"8\\",\\n \\"OperName\\": \\"operator demo\\",\\n \\"Param\\": {\\n \\"DifferentRole\\": true,\\n \\"Regex\\": \\".*修改密码.*\\",\\n \\"TargetRole\\": \\"客户\\",\\n \\"VelocityInMint\\": 280,\\n \\"Average\\": true,\\n \\"KeywordExtension\\": true,\\n \\"Score\\": 80,\\n \\"NotRegex\\": \\"发一下|告诉我\\",\\n \\"CompareOperator\\": \\"gt\\",\\n \\"DelayTime\\": 1000,\\n \\"KeywordMatchSize\\": 3,\\n \\"HitTime\\": 1,\\n \\"BeginType\\": \\"DIALOGUE\\",\\n \\"Target\\": 1,\\n \\"MaxEmotionChangeValue\\": 8,\\n \\"Threshold\\": 4,\\n \\"From\\": 3,\\n \\"FromEnd\\": true,\\n \\"MinWordSize\\": 4,\\n \\"InSentence\\": true,\\n \\"Phrase\\": \\"xxx\\",\\n \\"Similarity_threshold\\": 90,\\n \\"CheckType\\": 1,\\n \\"Interval\\": 5000,\\n \\"ContextChatMatch\\": true,\\n \\"Excludes\\": {\\n \\"Excludes\\": [\\n \\"[“好的”]\\"\\n ]\\n },\\n \\"AntModelInfo\\": {\\n \\"AntModelInfo\\": [\\n \\"xx\\"\\n ]\\n },\\n \\"Pvalues\\": {\\n \\"Pvalues\\": [\\n \\"xx\\"\\n ]\\n },\\n \\"References\\": {\\n \\"Reference\\": [\\n \\"[“优惠力度特别大”,”特别的优惠”]\\"\\n ]\\n },\\n \\"SimilarlySentences\\": {\\n \\"SimilarlySentence\\": [\\n \\"[“优惠力度特别大”,”特别的优惠”]\\"\\n ]\\n },\\n \\"OperKeyWords\\": {\\n \\"OperKeyWord\\": [\\n \\"[“你好”,”您好”,”上午好”]\\"\\n ]\\n }\\n }\\n }\\n ]\\n },\\n \\"CheckRange\\": {\\n \\"Absolute\\": true,\\n \\"Role\\": \\"客服\\",\\n \\"Anchor\\": {\\n \\"HitTime\\": 1,\\n \\"Location\\": \\"AFTER\\",\\n \\"AnchorCid\\": \\"7\\"\\n },\\n \\"Range\\": {\\n \\"To\\": 10,\\n \\"From\\": 1\\n }\\n }\\n }\\n ]\\n },\\n \\"Rules\\": {\\n \\"RuleBasicInfo\\": [\\n {\\n \\"RuleLambda\\": \\"7&&!8\\",\\n \\"Rid\\": \\"4\\",\\n \\"BusinessCategories\\": {\\n \\"BusinessCategoryBasicInfo\\": [\\n {\\n \\"BusinessName\\": \\"业务A\\",\\n \\"ServiceType\\": 1,\\n \\"Bid\\": 264971810\\n }\\n ]\\n },\\n \\"Triggers\\": {\\n \\"Trigger\\": [\\n \\"[\\\\\\"7\\\\\\",\\\\\\"8\\\\\\"]\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain Detail Information of a Rule',
+ 'summary' => 'Retrieves the detailed information of a rule.',
+ 'description' => '> This operation is used in conjunction with [Get basic rule information](~~142333~~). First, call the GetRule operation to obtain the rule ID. Then, use the rule ID as a parameter to call the **GetRuleDetail** operation.',
+ 'requestParamsDescription' => '**Request parameters in JSON string format**'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------------------- | :------------- | :------- | :---------------------------------------------------------------------------- |'."\n"
+ .'| ruleIds | `List<String>` | No | The rule ID. If you specify this parameter, all other parameters are ignored. |'."\n"
+ .'| businessCategoryName | `List<String>` | No | The business category name. |',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-19T06:19:53.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:50.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetRuleDetail'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'RevertAssignedSessionGroup' => [
- 'summary' => '会话组批量回收',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetRuleV4' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'deprecated' => true,
- 'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '153844',
- 'abilityTreeNodes' => [
- 'FEATUREscaAJDYMI',
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'RuleId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '531', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'PlainResult<RulesInfo>',
+ 'description' => 'PlainResult\\<rulesinfo>',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'Rule information.',
+ 'enumValueTitles' => [],
+ '$ref' => '#/components/schemas/RulesInfo',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Set to true for success. Set to false or null for failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. A value of **200** indicates success. Other values indicate failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request failed. Returns **successful** if the request succeeded.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Messages' => [
+ 'description' => 'Error details if the request failed. Use this field when returning multiple messages.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Error details if the request failed. Use this field when returning multiple messages.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'HttpStatusCode' => ['description' => 'HTTP status code returned by the request. A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ ],
+ 'enumValueTitles' => [],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'title' => 'Obtain Rule Details (New Quality Inspection) ',
+ 'summary' => 'This API is located in the frontend at Quality Check Rule Configuration > Query. The Apsara Stack URL is ip:port/api/client/GetRuleById.json.',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-07T09:00:50.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetRuleV4'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Conditions\\": [\\n {\\n \\"Cid\\": \\"a\\",\\n \\"Id\\": 1,\\n \\"Rid\\": \\"1\\",\\n \\"Check_range\\": {\\n \\"RoleId\\": 1,\\n \\"Role\\": \\"客服\\",\\n \\"Anchor\\": {\\n \\"Cid\\": \\"a\\",\\n \\"Location\\": \\"BEFORE\\",\\n \\"Hit_time\\": 1\\n },\\n \\"Range\\": {\\n \\"From\\": 1,\\n \\"To\\": 2\\n },\\n \\"Absolute\\": true,\\n \\"AllSentencesSatisfy\\": true\\n },\\n \\"Operators\\": [\\n {\\n \\"Oid\\": \\"a\\",\\n \\"Id\\": 1,\\n \\"Type\\": \\"HIT_ANY_KEYWORDS\\",\\n \\"Param\\": {\\n \\"CustomerParam\\": {\\n \\"Field\\": \\"remark1\\",\\n \\"FieldType\\": 1,\\n \\"DataType\\": 1,\\n \\"Symbol\\": 1,\\n \\"Value\\": \\"xxx\\",\\n \\"ActualValue\\": \\"xx\\",\\n \\"ExpressionMetaDesc\\": {\\n \\"LeftFieldType\\": 0,\\n \\"LeftOperand\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"RightFieldType\\": 0,\\n \\"RightOperand\\": \\"\\",\\n \\"RoundingMode\\": \\"\\"\\n }\\n },\\n \\"Keywords\\": [\\n \\"你好\\"\\n ],\\n \\"Regex\\": \\"质疑.*\\",\\n \\"NotRegex\\": \\"优秀.*\\",\\n \\"Phrase\\": \\"你好,请问\\",\\n \\"References\\": [\\n \\"你好.{0,10}\\"\\n ],\\n \\"Interval\\": 1,\\n \\"IntervalEnd\\": 2,\\n \\"Threshold\\": 90,\\n \\"In_sentence\\": true,\\n \\"Target\\": 1,\\n \\"From_end\\": true,\\n \\"Different_role\\": true,\\n \\"Target_role\\": \\"客服\\",\\n \\"RoleId\\": 1,\\n \\"Velocity\\": 111,\\n \\"VelocityInMint\\": 1,\\n \\"KeywordExtension\\": 1,\\n \\"Synonyms\\": {\\n \\"key\\": [\\n \\"售卖\\"\\n ]\\n },\\n \\"Case_sensitive\\": true,\\n \\"Near_dialogue\\": true,\\n \\"MinWordSize\\": 1,\\n \\"Hit_time\\": 2,\\n \\"Excludes\\": [\\n \\"负向\\"\\n ],\\n \\"From\\": 0,\\n \\"CheckFirstSentence\\": true,\\n \\"Average\\": true,\\n \\"BeginType\\": \\"1\\",\\n \\"EndType\\": \\"2\\",\\n \\"CompareOperator\\": \\"gt\\",\\n \\"Pkey\\": \\"xx\\",\\n \\"Poutput_type\\": 1,\\n \\"SimilarlySentences\\": [\\n \\"我要购买\\"\\n ],\\n \\"LgfSentences\\": [\\n \\"你好{1}\\"\\n ],\\n \\"Score\\": 70,\\n \\"ContextChatMatch\\": true,\\n \\"KeywordMatchSize\\": 1,\\n \\"MaxEmotionChangeValue\\": 3,\\n \\"CheckType\\": 1,\\n \\"KnowledgeTargetId\\": \\"1\\",\\n \\"CategoryPathCode\\": \\"xx\\",\\n \\"KnowledgeTargetType\\": 1,\\n \\"KnowledgeTargetName\\": \\"订单\\",\\n \\"QuestionThreshold\\": \\"90\\",\\n \\"AnswerThreshold\\": \\"90\\",\\n \\"KnowledgeSentenceNum\\": 1,\\n \\"KnowledgeInfo\\": \\"下单\\",\\n \\"BotId\\": \\"chatbot-cn-xxx\\",\\n \\"UseEasAlgorithm\\": true,\\n \\"Pvalues\\": [\\n \\"\\"\\n ],\\n \\"Similarity_threshold\\": 90,\\n \\"AntModelInfo\\": {\\n \\"key\\": \\"xxx\\"\\n },\\n \\"DelayTime\\": 10,\\n \\"Knowledges\\": \\"\\",\\n \\"LlmModelCode\\": \\"\\",\\n \\"HitCondition\\": \\"\\",\\n \\"SceneName\\": \\"\\",\\n \\"Dimensions\\": [\\n {\\n \\"Dimension\\": \\"\\",\\n \\"Desc\\": \\"\\",\\n \\"ExcludeCondition\\": \\"\\",\\n \\"IncludeCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"Name\\": \\"a\\",\\n \\"UserGroup\\": \\"xxx\\",\\n \\"QualityCheckType\\": 0\\n }\\n ],\\n \\"Lambda\\": \\"a\\",\\n \\"Exclusion\\": 0,\\n \\"Name\\": \\"xx\\",\\n \\"UserGroup\\": \\"xxxx\\"\\n }\\n ],\\n \\"Rules\\": [\\n {\\n \\"Status\\": 1,\\n \\"IsDelete\\": 1,\\n \\"StartTime\\": \\"1641277321000\\",\\n \\"EndTime\\": \\"1641277321000\\",\\n \\"Weight\\": \\"1\\",\\n \\"IsOnline\\": 1,\\n \\"CreateEmpid\\": \\"1\\",\\n \\"CreateEmpName\\": \\"张三\\",\\n \\"CreateTime\\": \\"1641277321000\\",\\n \\"LastUpdateTime\\": \\"1641277321000\\",\\n \\"LastUpdateEmpid\\": \\"1\\",\\n \\"LastUpdateEmpName\\": \\"张三\\",\\n \\"Comments\\": \\"违规\\",\\n \\"Deny\\": 1,\\n \\"ScoreSubId\\": 1,\\n \\"ScoreName\\": \\"违规\\",\\n \\"ScoreSubName\\": \\"1\\",\\n \\"ScoreNum\\": 1,\\n \\"ScoreType\\": 1,\\n \\"ScoreDeleted\\": true,\\n \\"OperationMode\\": 1,\\n \\"Meet\\": 1,\\n \\"Effective\\": 1,\\n \\"FullCycle\\": 1,\\n \\"EffectiveStartTime\\": \\"OperationMode\\",\\n \\"EffectiveEndTime\\": \\"OperationMode\\",\\n \\"QualityCheckType\\": 1,\\n \\"Level\\": 1,\\n \\"GraphFlow\\": \\"{}\\",\\n \\"TaskFlowType\\": 1,\\n \\"CheckType\\": 3,\\n \\"SchemeCheckType\\": {\\n \\"CheckType\\": 1,\\n \\"CheckName\\": \\"流程规则\\",\\n \\"SourceScore\\": 1,\\n \\"Score\\": 50,\\n \\"Enable\\": 1,\\n \\"SchemeId\\": 1,\\n \\"SchemeScoreInfoList\\": [\\n {\\n \\"Rid\\": 1,\\n \\"Name\\": \\"xx\\",\\n \\"TaskFlowId\\": 1,\\n \\"TaskFlowName\\": \\"xx\\",\\n \\"ScoreType\\": 1,\\n \\"ScoreNumType\\": 0,\\n \\"ScoreNum\\": 1,\\n \\"ScoreRuleHitType\\": 0\\n }\\n ],\\n \\"TaskFlowScoreInfoList\\": [\\n {\\n \\"TaskFlowId\\": 1,\\n \\"TaskFlowName\\": \\"xx\\",\\n \\"TaskFlowType\\": 1,\\n \\"SchemeScoreInfoList\\": [\\n {\\n \\"Rid\\": 1,\\n \\"Name\\": \\"xx\\",\\n \\"TaskFlowId\\": 1,\\n \\"TaskFlowName\\": \\"xx\\",\\n \\"ScoreType\\": 1,\\n \\"ScoreNumType\\": 0,\\n \\"ScoreNum\\": 11,\\n \\"ScoreRuleHitType\\": 0\\n }\\n ]\\n }\\n ]\\n },\\n \\"TargetType\\": 10,\\n \\"ConfigType\\": 1,\\n \\"ScoreNumType\\": 1,\\n \\"ScoreRuleHitType\\": 0,\\n \\"SchemeId\\": 1,\\n \\"SchemeRuleMappingId\\": 1,\\n \\"SchemeName\\": \\"通用方案\\",\\n \\"ModifyType\\": 1,\\n \\"SortIndex\\": 1,\\n \\"RuleType\\": 1,\\n \\"Rid\\": \\"1\\",\\n \\"Name\\": \\"开头语规则\\",\\n \\"TaskFlowId\\": 111111111,\\n \\"Lambda\\": \\"a&&b\\",\\n \\"ExternalProperty\\": 1,\\n \\"Type\\": 2,\\n \\"RuleCategoryName\\": \\"正向规则\\",\\n \\"AutoReview\\": 1,\\n \\"RuleScoreType\\": 3,\\n \\"ScoreId\\": 1,\\n \\"PreqRule\\": {\\n \\"Rid\\": \\"\\"\\n },\\n \\"BusinessCategoryNameList\\": [\\n \\"全部\\"\\n ],\\n \\"Dialogues\\": [\\n {\\n \\"Id\\": 1,\\n \\"Content\\": [\\n {\\n \\"HourMinSec\\": \\"00:00:00\\",\\n \\"Role\\": \\"客户\\",\\n \\"Identity\\": \\"客户\\",\\n \\"EmotionValue\\": 1,\\n \\"SpeechRate\\": 100,\\n \\"Words\\": \\"方便\\",\\n \\"End\\": 1360,\\n \\"SilenceDuration\\": 100,\\n \\"BeginTime\\": 350,\\n \\"Begin\\": 360\\n }\\n ],\\n \\"Name\\": \\"xx\\",\\n \\"UserGroup\\": \\"xx\\"\\n }\\n ],\\n \\"Triggers\\": [\\n \\"a\\"\\n ]\\n }\\n ],\\n \\"Dialogues\\": [\\n {\\n \\"Id\\": 1,\\n \\"Content\\": [\\n {\\n \\"HourMinSec\\": \\"00:00:00\\",\\n \\"Role\\": \\"客户\\",\\n \\"Identity\\": \\"客户\\",\\n \\"EmotionValue\\": 1,\\n \\"SpeechRate\\": 100,\\n \\"Words\\": \\"方便\\",\\n \\"End\\": 1360,\\n \\"SilenceDuration\\": 100,\\n \\"BeginTime\\": 350,\\n \\"Begin\\": 360\\n }\\n ],\\n \\"Name\\": \\"xx\\",\\n \\"UserGroup\\": \\"xx\\"\\n }\\n ],\\n \\"Count\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n },\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": [\\n \\"无\\"\\n ],\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ ],
+ 'GetRulesCountList' => [
+ 'summary' => 'Corresponds to the frontend feature location: Quality Inspection Rule Configuration > List. Apsara Stack URL: ip:port/api/rule/GetRulesCountList.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
],
],
+ 'deprecated' => false,
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'jsonStr',
- 'in' => 'query',
+ 'name' => 'Rid',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Search by rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''],
+ ],
+ [
+ 'name' => 'RuleIdOrRuleName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Search by rule ID or rule name.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''],
+ ],
+ [
+ 'name' => 'BusinessName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Business name to which the rule belongs.', 'type' => 'string', 'required' => false, 'example' => '电话业务', 'title' => ''],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Type value of the rule category to which the rule belongs.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'TypeName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Name of the rule category to which the rule belongs.', 'type' => 'string', 'required' => false, 'example' => '全部类别', 'title' => ''],
+ ],
+ [
+ 'name' => 'BusinessRange',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Broad business category.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'CreateEmpid',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Rule creator ID. Same as CreateUserId. Use either one.', 'type' => 'string', 'required' => false, 'example' => '63', 'title' => ''],
+ ],
+ [
+ 'name' => 'CreateUserId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Rule creator ID. Same as CreateEmpid. Use either one.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '63', 'title' => ''],
+ ],
+ [
+ 'name' => 'UpdateUserId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Rule updater ID. Same as LastUpdateEmpid. Use either one.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '63', 'title' => ''],
+ ],
+ [
+ 'name' => 'LastUpdateEmpid',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Rule updater ID. Same as UpdateUserId. Use either one.', 'type' => 'string', 'required' => false, 'example' => '63', 'title' => ''],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'formData',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'Rule status:',
+ 'enumValueTitles' => ['Pending', 'Active', 'Expired', 'All'],
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'example' => '{"isSchemeData":1,"forceRevertSessionGroup":true,"sessionGroupIdList":["1"]}',
+ 'example' => '1',
+ 'title' => '',
],
],
[
- 'name' => 'BaseMeAgentId',
- 'in' => 'query',
+ 'name' => 'CategoryName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Category name.', 'type' => 'string', 'required' => false, 'example' => '分类名称A', 'title' => ''],
+ ],
+ [
+ 'name' => 'SourceType',
+ 'in' => 'formData',
'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
+ 'description' => 'Source type.',
+ 'enumValueTitles' => ['Default', 'ACC'],
'type' => 'integer',
- 'format' => 'int64',
+ 'format' => 'int32',
'required' => false,
+ 'example' => '0',
+ 'title' => '',
],
],
+ [
+ 'name' => 'RuleType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Rule category.',
+ 'enumValueTitles' => ['Predefined', 'Custom-created'],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'UpdateStartTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Filter by update time (start of range).', 'type' => 'string', 'required' => false, 'example' => '2022-10-07 00:00:00', 'title' => ''],
+ ],
+ [
+ 'name' => 'UpdateEndTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Filter by update time (end of range).', 'type' => 'string', 'required' => false, 'example' => '2022-10-08 23:59:59', 'title' => ''],
+ ],
+ [
+ 'name' => 'SchemeId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Quality inspection scheme ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''],
+ ],
+ [
+ 'name' => 'RequireInfos',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'Required fields.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Required fields.',
+ 'enumValueTitles' => ['ConditionInfo' => 'Condition information', 'ScoreInfo' => 'Score information: for V3', 'OperatorInfo' => 'Operator information', 'SchemeNames' => 'Whether to include referenced quality inspection scheme names', 'TransUserName' => 'Whether to convert creator/updater IDs to names', 'BusinessNameInfo' => 'Applicable business information', 'GraphFlowInfo' => 'Flow information', 'RuleCategory' => 'Category information'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ConditionInfo',
+ 'title' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 10,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'RuleScoreSingleType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Scoring type.',
+ 'enumValueTitles' => [1 => 'Deduction item', 'Bonus item', 4 => 'One-time score', 8 => 'No scoring set'],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Page number of the rule list.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'CountTotal',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Whether to count the total number.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Filter by creation time (end of range).', 'type' => 'string', 'required' => false, 'example' => '2022-10-07 00:00:00', 'title' => ''],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Filter by creation time (start of range).', 'type' => 'string', 'required' => false, 'example' => '2022-10-08 23:59:59', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BaseResult',
- 'description' => 'BaseResult',
+ 'title' => 'RulePageResult<RuleCountInfo>',
+ 'description' => 'RulePageResult\\<rulecountinfo>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
+ 'TotalCount' => ['description' => 'Total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''],
+ 'BusinessType' => ['description' => 'Business type. This field has no practical meaning and can be ignored.', 'type' => 'integer', 'format' => 'int32', 'example' => '忽略', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'Response results.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Response results. See additional notes.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
+ 'title' => '',
+ 'example' => '',
],
+ 'Count' => ['description' => 'Total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'CurrentPage' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'Number of rows per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'Current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '9987D326-83D9-4A42-B9A5-0B27F9B40539', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Use this field to determine request success: true means success; false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. **200** indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request failed. Returns "successful" on success.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'Messages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Message' => [
- 'description' => '',
+ 'description' => 'Error details if the request failed. Used when multiple messages are returned.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'items' => ['description' => 'Error details if the request failed. Used when multiple messages are returned.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'HttpStatusCode' => [
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 7,\\n \\"BusinessType\\": 0,\\n \\"Data\\": {\\n \\"Data\\": [\\n \\"\\"\\n ]\\n },\\n \\"Count\\": 20,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"9987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Batch retrieve the quality inspection rule list.',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetRulesCountList'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'SubmitReviewInfoV4' => [
- 'summary' => '提交复核结果v4',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetSchemeTaskConfig' => [
+ 'summary' => 'Obtain the configuration details of a quality inspection task.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREscaFRLL5D',
- 'FEATUREsca81P1AQ',
- ],
+ 'abilityTreeCode' => '274602',
+ 'abilityTreeNodes' => ['FEATUREscaFRLL5D', 'FEATUREsca81P1AQ'],
],
'parameters' => [
[
'name' => 'BaseMeAgentId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12345',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''],
],
[
'name' => 'JsonStr',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"comments":"tidComment","jsonReviewResult":"{\\"reviewInfoList\\":[{\\"changed\\":true,\\"comment\\":\\"ridComment\\",\\"matched\\":true,\\"reviewHitResult\\":0,\\"reviewResult\\":1,\\"rid\\":31459,\\"sentenceReviewResults\\":[{\\"changed\\":true,\\"cid\\":95302,\\"comment\\":\\"pidComment\\",\\"hitStatus\\":0,\\"pid\\":\\"0\\",\\"reviewDimensionType\\":\\"2\\",\\"rid\\":31459,\\"sid\\":54104}]}]}","taskId":"20251224-62931498-881B-1436-A93D-1FFBC5D7D4A0","vid":"8cbe2bccf3be4b42bada45136f77d4e9"}',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => 'A complete JSON string. See the detailed information below.', 'type' => 'string', 'required' => false, 'example' => '{"sourceDataType":3,"id":588}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Response schema',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** '],
+ 'Code' => ['description' => 'Result code. **200** means success.'."\n"
+ ."\n"
+ .'> Any other value means failure. The caller can use this field to identify the cause.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Use this field to check the result: true means success, false or null means failure.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request failed. Returns successful if the request succeeded.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Data' => [
+ 'description' => 'Response data. See the additional notes below.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'Quality inspection task ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
+ 'SchemeTaskConfigId' => ['description' => 'Quality inspection task ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''],
+ 'Name' => ['description' => 'Quality inspection task name', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'SourceDataType' => ['description' => 'Quality inspection result type:'."\n"
+ ."\n"
+ .'- 1: offline voice'."\n"
+ ."\n"
+ .'- 2: offline text'."\n"
+ ."\n"
+ .'- 3: real-time voice'."\n"
+ ."\n"
+ .'- 4: real-time text'."\n"
+ ."\n"
+ .'- 5: contact center secondary quality inspection'."\n"
+ ."\n"
+ .'- 51: call center voice secondary quality inspection'."\n"
+ ."\n"
+ .'- 52: call center text secondary quality inspection'."\n"
+ ."\n"
+ .'- 11: dataset voice'."\n"
+ ."\n"
+ .'- 12: dataset text', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'Status' => ['description' => 'Enable status. Valid values: 0 (disabled) or 1 (enabled)', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'SchemeIdList' => [
+ 'description' => 'Quality inspection scheme IDs',
+ 'type' => 'array',
+ 'items' => ['description' => 'Quality inspection scheme ID', 'type' => 'integer', 'format' => 'int64', 'example' => '13xxx', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'SchemeList' => [
+ 'description' => 'Quality inspection schemes',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Quality inspection scheme',
+ 'type' => 'object',
+ 'properties' => [
+ 'SchemeId' => ['description' => 'Quality inspection scheme ID', 'type' => 'integer', 'format' => 'int64', 'example' => '158', 'title' => ''],
+ 'Name' => ['description' => 'Quality inspection scheme name', 'type' => 'string', 'example' => '质检方案B', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'DataConfig' => [
+ 'description' => 'Data configuration',
+ 'type' => 'object',
+ 'properties' => [
+ 'Index' => ['description' => 'Index number', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'AssignConfigs' => [
+ 'description' => 'Data screening items for on-the-fly recording',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Data screening items for on-the-fly recording',
+ 'type' => 'object',
+ 'properties' => [
+ 'AssignConfigContests' => [
+ 'description' => 'Parameter matching configurations for on-the-fly recording',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Parameter matching configuration for on-the-fly recording',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'Check item name', 'type' => 'string', 'example' => 'callStartTime', 'title' => ''],
+ 'DataType' => ['description' => 'Type of the value'."\n"
+ ."\n"
+ .'- 0: String'."\n"
+ ."\n"
+ .'- 1: Number'."\n"
+ ."\n"
+ .'- 2: List (use list type for all parameter values when using =)'."\n"
+ ."\n"
+ .'- 3: Date'."\n"
+ ."\n"
+ .'- 4: List\\_Json', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'Symbol' => ['description' => 'Operator'."\n"
+ ."\n"
+ .'- 1: =='."\n"
+ ."\n"
+ .'- 2: >'."\n"
+ ."\n"
+ .'- 3: <'."\n"
+ ."\n"
+ .'- 4: range'."\n"
+ ."\n"
+ .'- 5: >='."\n"
+ ."\n"
+ .'- 6: <='."\n"
+ ."\n"
+ .'- 7: !='."\n"
+ ."\n"
+ .'- 8: null'."\n"
+ ."\n"
+ .'- 9: not null'."\n"
+ ."\n"
+ .'- 10: contains'."\n"
+ ."\n"
+ .'- 11: does not contain', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
+ 'Value' => ['description' => 'Matching value for on-the-fly recording data', 'type' => 'string', 'example' => '{\\"start\\":\\"2022-09-01 00:00:00\\",\\"end\\":\\"2022-09-30 00:00:00\\"}', 'title' => ''],
+ 'ListObject' => [
+ 'description' => 'List of on-the-fly recording data',
+ 'type' => 'array',
+ 'items' => ['description' => 'List of on-the-fly recording data', 'type' => 'any', 'example' => 'xx', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ResultParam' => ['description' => 'JSON text for filtering conditions used in secondary quality inspection. For details, see the request parameters of the GetResult API.', 'type' => 'string', 'example' => '{}', 'title' => ''],
+ 'DataSets' => ['description' => 'Dataset task. Manage datasets.', 'type' => 'string', 'example' => '[]', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AssignType' => ['description' => 'Assignment type', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'ManualReview' => ['description' => 'Manual review', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'AsrTaskPriority' => ['description' => 'Task priority:'."\n"
+ ."\n"
+ .'- 0 (low)'."\n"
+ ."\n"
+ .'- 1 (medium)'."\n"
+ ."\n"
+ .'- 2 (high)', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'ModeCustomizationId' => ['description' => 'Language model ID', 'type' => 'string', 'example' => 'cdae396590b*****ec40f3476e274fc', 'title' => ''],
+ 'ModelName' => ['description' => 'Language model name', 'type' => 'string', 'example' => '自定义模型', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"Id\\": 3,\\n \\"SchemeTaskConfigId\\": 123,\\n \\"Name\\": \\"test\\",\\n \\"SourceDataType\\": \\"1\\",\\n \\"Status\\": \\"1\\",\\n \\"SchemeIdList\\": [\\n 0\\n ],\\n \\"SchemeList\\": [\\n {\\n \\"SchemeId\\": 158,\\n \\"Name\\": \\"质检方案B\\"\\n }\\n ],\\n \\"DataConfig\\": {\\n \\"Index\\": 0,\\n \\"AssignConfigs\\": [\\n {\\n \\"AssignConfigContests\\": [\\n {\\n \\"Name\\": \\"callStartTime\\",\\n \\"DataType\\": 3,\\n \\"Symbol\\": 4,\\n \\"Value\\": \\"{\\\\\\\\\\\\\\"start\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2022-09-01 00:00:00\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"end\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2022-09-30 00:00:00\\\\\\\\\\\\\\"}\\",\\n \\"ListObject\\": [\\n \\"xx\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"ResultParam\\": \\"{}\\",\\n \\"DataSets\\": \\"[]\\"\\n },\\n \\"AssignType\\": 0,\\n \\"ManualReview\\": 0,\\n \\"AsrTaskPriority\\": 2,\\n \\"ModeCustomizationId\\": \\"cdae396590b*****ec40f3476e274fc\\",\\n \\"ModelName\\": \\"自定义模型\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain Quality Inspection Job',
+ 'requestParamsDescription' => '### About JsonStr'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| -------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |'."\n"
+ .'| id | integer | Yes | Task ID |'."\n"
+ .'| sourceDataType | integer | Yes | Task type: 1 (offline voice), 2 (offline text), 3 (real-time voice), 4 (real-time text), 51 (offline voice secondary quality inspection), 52 (offline text secondary quality inspection), 53 (real-time voice secondary quality inspection), or 54 (real-time text secondary quality inspection) |',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-05T08:24:44.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'AssignReviewer' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetScoreInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'systemTags' => [],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"assignmentList":[{"taskId":"1C21CF1E-2917-4236-A046-20E37B293B69","fileId":"7981b466fd6a4c70a7065da159739a5b"},{"taskId":"0111DDBC-5F10-47E0-B7D4-7175F47D626F","fileId":"1814eeae3cff41e989e31ab547f07561"}],"assignments":[{"reviewer":"255746168704895558"},{"reviewer":"268370362815185444"}]}',
- ],
+ 'schema' => ['description' => 'Paged queries are not supported. Pass an empty string.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '""', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -10060,73 +9553,141 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4D55C6',
- ],
- 'Success' => [
+ 'Code' => ['description' => 'The result code. A value of **200** means the call succeeded. Any other value means the call failed. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Details about the error if the call fails. If the call succeeds, this value is successful.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. A value of true means success. A value of false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'ScorePo' => [
+ 'description' => 'Detailed response data.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ScoreId' => ['description' => 'The ID of the main scoring item.', 'type' => 'integer', 'format' => 'int32', 'example' => '34', 'title' => ''],
+ 'ScoreName' => ['description' => 'The name of the main scoring item.', 'type' => 'string', 'example' => '服务规范', 'title' => ''],
+ 'ScoreInfos' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'ScoreParam' => [
+ 'description' => 'Information about sub-scoring items.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ScoreSubName' => ['description' => 'The name of the sub-scoring item.', 'type' => 'string', 'example' => '回复生硬', 'title' => ''],
+ 'ScoreNum' => ['description' => 'The score value.', 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''],
+ 'ScoreSubId' => ['description' => 'The ID of the sub-scoring item.', 'type' => 'integer', 'format' => 'int32', 'example' => '3422', 'title' => ''],
+ 'ScoreType' => ['description' => 'The score type. Valid values: 1 for bonus points and 3 for penalty points.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AssignReviewerResponse>\\n <Code>200</Code>\\n <RequestId>D1436A84-8A33-4416-ACC9-94D0247C6DA8</RequestId>\\n <Success>true</Success>\\n <Message>successful</Message>\\n</AssignReviewerResponse>","errorExample":""}]',
+ 'staticInfo' => ['noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ScorePo\\": [\\n {\\n \\"ScoreId\\": 34,\\n \\"ScoreName\\": \\"服务规范\\",\\n \\"ScoreInfos\\": {\\n \\"ScoreParam\\": [\\n {\\n \\"ScoreSubName\\": \\"回复生硬\\",\\n \\"ScoreNum\\": 32,\\n \\"ScoreSubId\\": 3422,\\n \\"ScoreType\\": 1\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Retrieve all scoring item information',
+ 'summary' => 'Retrieves information about all scoring items.',
+ 'requestParamsDescription' => "\n",
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-19T06:19:53.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetScoreInfo'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'SubmitComplaint' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetSkillGroupConfig' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'systemTags' => [],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '56199',
+ 'abilityTreeNodes' => ['FEATUREscaKR8LQC', 'FEATUREsca6QWO0D'],
+ ],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the details below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"id":"配置ID"}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -10134,78 +9695,181 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Code' => ['description' => 'The response code. A value of **200** indicates a successful response.'."\n"
+ ."\n"
+ .'> Other values indicate a failed response. You can use this field to identify the cause of the failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The response message. If the request is successful, a value of **successful** is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** ', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.'."\n"
+ ."\n"
+ .'The caller can use this field to determine whether the request was successful:'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- false or **null**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '90',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4D55C6',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => 'The details of the skill group rule configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The configuration type. Valid values: 1 (custom configuration) and 0 (built-in configuration).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Status' => ['description' => 'The status of the configuration. Valid values: 0 (disabled) and 1 (enabled).', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'UpdateTime' => ['description' => 'The time when the configuration was last updated.', 'type' => 'string', 'example' => '2020-12-01T19:28Z', 'title' => ''],
+ 'AllContentQualityCheck' => ['description' => 'Indicates whether to perform a full-text quality check after the real-time quality check is complete. Valid values:'."\n"
+ ."\n"
+ .'- 1: yes'."\n"
+ ."\n"
+ .'- 0: no', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the configuration was created.', 'type' => 'string', 'example' => '2020-12-01T15:12Z', 'title' => ''],
+ 'SkillGroupId' => ['description' => 'The skill group ID.', 'type' => 'string', 'example' => '111', 'title' => ''],
+ 'InstanceId' => ['description' => 'This is an internal parameter. You can ignore it.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'VocabId' => ['description' => 'The hotword ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''],
+ 'SkillGroupFrom' => ['description' => 'The source of the skill group. The value is fixed at 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Rid' => ['description' => 'The quality check rule ID.', 'type' => 'string', 'example' => '2332', 'title' => ''],
+ 'SkillGroupName' => ['description' => 'The skill group name.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'ModelName' => ['description' => 'The language model name.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'AllRids' => ['description' => 'The ID of the rule used for the full-text quality check.', 'type' => 'string', 'example' => '223', 'title' => ''],
+ 'Name' => ['description' => 'The configuration name.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'ModelId' => ['description' => 'The language model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1321', 'title' => ''],
+ 'Id' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1212', 'title' => ''],
+ 'QualityCheckType' => ['description' => 'The quality check type. Valid values:'."\n"
+ ."\n"
+ .'- 0: offline'."\n"
+ ."\n"
+ .'- 1: real-time', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'VocabName' => ['description' => 'The hotword name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'RuleList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'RuleNameInfo' => [
+ 'description' => 'A list of rules.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleName' => ['description' => 'The name of the rule.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'Rid' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '222', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AllRuleList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'RuleNameInfo' => [
+ 'description' => 'The details of the rules used for the full-text quality check.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleName' => ['description' => 'The name of the rule.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'Rid' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"90\\",\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Code>200</Code>\\n<Data>95</Data>\\n<RequestId>5CB46375-E2F8-4072-9E5F-1506EDC2D211</RequestId>\\n<Success>true</Success>\\n<Message>successful</Message>","errorExample":""}]',
+ 'staticInfo' => ['noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Type\\": 1,\\n \\"Status\\": 0,\\n \\"UpdateTime\\": \\"2020-12-01T19:28Z\\",\\n \\"AllContentQualityCheck\\": 1,\\n \\"CreateTime\\": \\"2020-12-01T15:12Z\\",\\n \\"SkillGroupId\\": \\"111\\",\\n \\"InstanceId\\": \\"xxx\\",\\n \\"VocabId\\": 123,\\n \\"SkillGroupFrom\\": 0,\\n \\"Rid\\": \\"2332\\",\\n \\"SkillGroupName\\": \\"xxx\\",\\n \\"ModelName\\": \\"xxx\\",\\n \\"AllRids\\": \\"223\\",\\n \\"Name\\": \\"xxx\\",\\n \\"ModelId\\": 1321,\\n \\"Id\\": 1212,\\n \\"QualityCheckType\\": 0,\\n \\"VocabName\\": \\"test\\",\\n \\"RuleList\\": {\\n \\"RuleNameInfo\\": [\\n {\\n \\"RuleName\\": \\"test\\",\\n \\"Rid\\": 222\\n }\\n ]\\n },\\n \\"AllRuleList\\": {\\n \\"RuleNameInfo\\": [\\n {\\n \\"RuleName\\": \\"test\\",\\n \\"Rid\\": 12\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain Skill Group Rule Configuration Details by ID',
+ 'summary' => 'Retrieves the configuration that is specified by its ID.',
+ 'requestParamsDescription' => '### Details of the JsonStr parameter'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------- | :--- | :------- | :-------------------- |'."\n"
+ .'| id | Long | Yes | The configuration ID. |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-29T06:47:50.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetSkillGroupConfig'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'HandleComplaint' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetSyncResult' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'systemTags' => [],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Complete JSON string. For details, see the following information. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"pageNumber":1,"pageSize":10,"requiredFields":"asrResult,agent,status,errorMessage,reviewStatus,reviewResult,score,taskId,reviewer,resolver,recording.name,recording.duration,recording.url,hitResult,business","startTime":"2020-12-25 00:00:00","endTime":"2020-12-31 23:59:59"}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'baseMeAgentId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
@@ -10213,178 +9877,338 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '76DB5D8C-5BD9-42A7-B527-5AF3A5F****', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. The caller can use this field to determine the request status: true indicates success; false or null indicates failure. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ResultCountId' => ['description' => 'Internal field. Ignore it. ', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'Code' => ['description' => 'Result code. A value of 200 indicates success. Any other value indicates failure. The caller can use this field to determine the cause of failure. ', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details when an error occurs; "successful" when the operation succeeded.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'PageNumber' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'Number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Count' => ['description' => 'Total number of entries. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'Query result.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Query result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'Current job status. Possible values: 0 (not completed); 1 (completed). The caller can use this field to determine whether the job is complete. Values other than 0 or 1 indicate an error; see the errorMessage field for Error Details.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'When status is neither 0 nor 1, this field indicates the Error Details. ', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'Reviewer' => ['description' => 'Username of the assigned quality inspector. ', 'type' => 'string', 'example' => '张三', 'title' => ''],
+ 'CreateTime' => ['description' => 'Job Creation Time. '."\n", 'type' => 'string', 'example' => '2019-07-24T19:31Z ', 'title' => ''],
+ 'ReviewStatus' => ['description' => 'Review status; possible values: 0 (not reviewed); 1 (reviewed). ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TaskName' => ['description' => 'Internal field. Ignore it. ', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'Comments' => ['description' => 'Review comments. ', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'ReviewResult' => ['description' => 'Review accuracy. Possible values: 0 (fault); 1 (correct); 2 (partially correct); 3 (pending review). ', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'Score' => ['description' => 'Quality inspection score, with a maximum of 100. ', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'TaskId' => ['description' => 'Job ID.', 'type' => 'string', 'example' => '20201231de3d34ec-40fa-4a55-8d27-76ea*****', 'title' => ''],
+ 'Resolver' => ['description' => 'The quality inspector who actually reviewed the task.'."\n", 'type' => 'string', 'example' => '张三', 'title' => ''],
+ 'AsrResult' => [
+ 'description' => 'Transcription result (dialogue text) ',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'File transcription result. ',
+ 'type' => 'object',
+ 'properties' => [
+ 'Words' => ['description' => 'Dialogue content. ', 'type' => 'string', 'example' => '您好,很高兴为您服务', 'title' => ''],
+ 'Begin' => ['description' => 'The start time of this sentence, which is the offset from the starting point in milliseconds. ', 'type' => 'integer', 'format' => 'int64', 'example' => '340', 'title' => ''],
+ 'EmotionValue' => ['description' => 'Emotion intensity value ranging from 1 to 10. A higher value indicates stronger emotion. ', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''],
+ 'End' => ['description' => 'The end time of this sentence, which is the offset from the starting point in milliseconds. ', 'type' => 'integer', 'format' => 'int64', 'example' => '3000', 'title' => ''],
+ 'SpeechRate' => ['description' => 'The average speech rate of this sentence, in characters per minute. ', 'type' => 'integer', 'format' => 'int32', 'example' => '221', 'title' => ''],
+ 'Role' => ['description' => 'Role in the dialogue content. Possible values: agent, Customer. ', 'type' => 'string', 'example' => '客服', 'title' => ''],
+ 'SilenceDuration' => ['description' => 'Internal field. Ignore it. ', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'HitResult' => [
+ 'description' => 'Rule hit result. ',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Rule hit result. ',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'Rule type associated with the hit rule. ', 'type' => 'string', 'example' => '2', 'title' => ''],
+ 'ReviewResult' => ['description' => 'Review accuracy; possible values: 0 (fault); 1 (correct). ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Name' => ['description' => 'Hit rule name. ', 'type' => 'string', 'example' => '测试规则', 'title' => ''],
+ 'Rid' => ['description' => 'Hit rule ID. ', 'type' => 'string', 'example' => '1211', 'title' => ''],
+ 'Hits' => [
+ 'description' => 'Specific hit location information. At the sentence dimension, returns which condition in the rule was hit and which specific characters triggered the hit within the sentence. ',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Rule hit result. ',
+ 'type' => 'object',
+ 'properties' => [
+ 'KeyWords' => [
+ 'description' => 'Returns the specific characters in the current sentence that hit the rule, which are the keywords to be highlighted.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A list of positions where hits occurred.',
+ 'type' => 'object',
+ 'properties' => [
+ 'From' => ['description' => 'The starting character position (inclusive) of the keyword to be highlighted. The value starts from 0 and can be at most the total number of characters in the sentence minus 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'To' => ['description' => 'The ending character position (exclusive) of the keyword to be highlighted. The maximum value is the total number of characters in the sentence minus 1. For example, in the sentence “不可能给你退货的”, if from=0 and to=3, the highlighted keyword is “不可能”, which consists of three characters.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'Val' => ['description' => 'The exact keyword content.'."\n", 'type' => 'string', 'example' => '投诉', 'title' => ''],
+ 'Cid' => ['description' => 'The ID of the condition that was hit.', 'type' => 'string', 'example' => '66666', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Cid' => [
+ 'description' => 'List of hit condition IDs. ',
+ 'type' => 'array',
+ 'items' => ['description' => 'List of hit condition IDs. ', 'type' => 'string', 'example' => '["1","3"]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Phrase' => [
+ 'description' => 'Details of the sentence that hit the current rule. ',
+ 'type' => 'object',
+ 'properties' => [
+ 'Words' => ['description' => 'A sentence spoken by this role.', 'type' => 'string', 'example' => '我要投诉', 'title' => ''],
+ 'Begin' => ['description' => 'The Start Time of this sentence, represented as an offset in milliseconds from the starting point.', 'type' => 'integer', 'format' => 'int64', 'example' => '440', 'title' => ''],
+ 'EmotionValue' => ['description' => 'Emotion intensity value ranging from 1 to 10. A higher value indicates stronger emotion.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''],
+ 'End' => ['description' => 'The End Time of this sentence, represented as an offset in milliseconds from the starting point.', 'type' => 'integer', 'format' => 'int32', 'example' => '4000', 'title' => ''],
+ 'SpeechRate' => ['description' => 'The speech rate of this sentence.', 'type' => 'integer', 'format' => 'int32', 'example' => '234', 'title' => ''],
+ 'Role' => ['description' => 'The role in the conversation content. Possible values: agent, Customer, System.', 'type' => 'string', 'example' => '客服', 'title' => ''],
+ 'SilenceDuration' => ['description' => 'Internal field. Ignore.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Recording' => [
+ 'description' => 'Recording file information ',
+ 'type' => 'object',
+ 'properties' => [
+ 'Callee' => ['description' => 'Callee number. ', 'type' => 'string', 'example' => '1888888***', 'title' => ''],
+ 'Remark3' => ['description' => 'Custom data 3. ', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'Business' => ['description' => 'Line-of-business name. '."\n", 'type' => 'string', 'example' => '客服部', 'title' => ''],
+ 'Url' => ['description' => 'Recording file URL, used for playback. '."\n", 'type' => 'string', 'example' => 'http://aliyun.com/xxx.wav ', 'title' => ''],
+ 'PrimaryId' => ['description' => 'Internal field. Ignore it. ', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'Remark1' => ['description' => 'Custom data 1. ', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'Remark2' => ['description' => 'Custom data 2. ', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'CallType' => ['description' => 'Call type: '."\n"
+ .'- 1: Outgoing call '."\n"
+ .'- 3: Incoming call ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Caller' => ['description' => 'Caller number. ', 'type' => 'string', 'example' => '0108888**** ', 'title' => ''],
+ 'CallId' => ['description' => 'Call ID. ', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'DataSetName' => ['description' => 'Internal field. Ignore this. ', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'Duration' => ['description' => 'Total number of words in the conversation. '."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '232', 'title' => ''],
+ 'DurationAudio' => ['description' => 'Call duration. ', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''],
+ 'Name' => ['description' => 'Recording file name. '."\n", 'type' => 'string', 'example' => '123123.wav', 'title' => ''],
+ 'Id' => ['description' => 'File ID, which is the callId in the request parameters. If not specified, a random ID will be generated. '."\n", 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
+ 'CallTime' => ['description' => 'Recording generation UNIX timestamp, accurate to milliseconds. '."\n", 'type' => 'string', 'example' => '1563967699000', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Agent' => [
+ 'description' => 'Agent information',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'Agent name', 'type' => 'string', 'example' => '李四', 'title' => ''],
+ 'SkillGroup' => ['description' => 'Skill group name', 'type' => 'string', 'example' => '客服组', 'title' => ''],
+ 'Id' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => '12221', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
'example' => '',
],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9987D326-83D9-4A42-B9A5-0B27F9B40539',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"9987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<HandleComplaintResponse>\\r\\n <message>successful</message>\\r\\n <requestId>9987D326-83D9-4A42-B9A5-0B27F9B40539</requestId>\\r\\n <code>200</code>\\r\\n <success>true</success>\\r\\n</HandleComplaintResponse>","errorExample":""}]',
+ 'staticInfo' => [
+ 'substitutions' => ['Qualitycheck::2019-01-15::GetResult'],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"76DB5D8C-5BD9-42A7-B527-5AF3A5F****\\",\\n \\"Success\\": true,\\n \\"ResultCountId\\": \\"xxx\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Count\\": 1,\\n \\"Data\\": [\\n {\\n \\"Status\\": 1,\\n \\"ErrorMessage\\": \\"xxxx\\",\\n \\"Reviewer\\": \\"张三\\",\\n \\"CreateTime\\": \\"2019-07-24T19:31Z\\\\t\\",\\n \\"ReviewStatus\\": 1,\\n \\"TaskName\\": \\"xxx\\",\\n \\"Comments\\": \\"xxx\\",\\n \\"ReviewResult\\": 3,\\n \\"Score\\": 100,\\n \\"TaskId\\": \\"20201231de3d34ec-40fa-4a55-8d27-76ea*****\\",\\n \\"Resolver\\": \\"张三\\",\\n \\"AsrResult\\": [\\n {\\n \\"Words\\": \\"您好,很高兴为您服务\\",\\n \\"Begin\\": 340,\\n \\"EmotionValue\\": 6,\\n \\"End\\": 3000,\\n \\"SpeechRate\\": 221,\\n \\"Role\\": \\"客服\\",\\n \\"SilenceDuration\\": 11\\n }\\n ],\\n \\"HitResult\\": [\\n {\\n \\"Type\\": \\"2\\",\\n \\"ReviewResult\\": 1,\\n \\"Name\\": \\"测试规则\\",\\n \\"Rid\\": \\"1211\\",\\n \\"Hits\\": [\\n {\\n \\"KeyWords\\": [\\n {\\n \\"From\\": 2,\\n \\"To\\": 5,\\n \\"Val\\": \\"投诉\\",\\n \\"Cid\\": \\"66666\\"\\n }\\n ],\\n \\"Cid\\": [\\n \\"[\\\\\\"1\\\\\\",\\\\\\"3\\\\\\"]\\"\\n ],\\n \\"Phrase\\": {\\n \\"Words\\": \\"我要投诉\\",\\n \\"Begin\\": 440,\\n \\"EmotionValue\\": 6,\\n \\"End\\": 4000,\\n \\"SpeechRate\\": 234,\\n \\"Role\\": \\"客服\\",\\n \\"SilenceDuration\\": 1\\n }\\n }\\n ]\\n }\\n ],\\n \\"Recording\\": {\\n \\"Callee\\": \\"1888888***\\",\\n \\"Remark3\\": \\"xxx\\",\\n \\"Business\\": \\"客服部\\",\\n \\"Url\\": \\"http://aliyun.com/xxx.wav\\\\t\\",\\n \\"PrimaryId\\": \\"xxxx\\",\\n \\"Remark1\\": \\"xxx\\",\\n \\"Remark2\\": \\"xxx\\",\\n \\"CallType\\": 1,\\n \\"Caller\\": \\"0108888****\\\\t\\",\\n \\"CallId\\": \\"xxx\\",\\n \\"DataSetName\\": \\"xxx\\",\\n \\"Duration\\": 232,\\n \\"DurationAudio\\": 120,\\n \\"Name\\": \\"123123.wav\\",\\n \\"Id\\": \\"xxxx\\",\\n \\"CallTime\\": \\"1563967699000\\"\\n },\\n \\"Agent\\": {\\n \\"Name\\": \\"李四\\",\\n \\"SkillGroup\\": \\"客服组\\",\\n \\"Id\\": \\"12221\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Obtain real-time quality inspection results ',
+ 'summary' => 'You can obtain the real-time quality inspection result of the hotline.',
+ 'requestParamsDescription' => '**Request Parameters JSON String Information**'."\n"
+ .'| Property | Value Type | Required | Description |'."\n"
+ .'| :------------------ | :--------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| taskId | String | No | Use the **task ID returned after uploading quality inspection data** to query. Generally, you must specify either taskId or tid, or use a time range for the query. Therefore, one of taskId, tid, or startTime/endTime is required. |'."\n"
+ .'| tid | String | No | Unique identifier of a conversation, such as the unique identifier of a recording. Generally, you must specify either tid or a time range for the query. Therefore, one of taskId, tid, or startTime/endTime is required. |'."\n"
+ .'| startTime | String | No | **Start Time** of the interval for querying by task upload time (API call time), in the format \'yyyy-MM-dd HH:mm:ss\'. |'."\n"
+ .'| endTime | String | No | **End Time** of the interval for querying by task upload time (API call time), in the format \'yyyy-MM-dd HH:mm:ss\'. |'."\n"
+ .'| pageSize | Integer | No | Number of data entries returned per page. Must be greater than 0 and less than 100. Default value: 10. |'."\n"
+ .'| pageNumber | Integer | No | Page number of the data to return. Default value: 1. |'."\n"
+ .'| countTotal | Boolean | No | Whether to return the total number of entries in the paginated data. Default value: true. When the data volume is large, disabling this option improves API response speed. |'."\n"
+ .'| requiredFields | String | No | Fields to include in the return result. Separate multiple fields with commas. Select fields as needed. Optional fields: taskId (Job ID), score (Score), status (Status), recording (File Information), recording.dataSet (Dataset Name), asrResult (Transcription Result), hitResult (Quality Inspection Result), comments (Review Comments), agent (Agent Information). Default value: score,status,taskId,hitResult,reviewHistory |'."\n"
+ .'| excludeFields | String | No | Fields to exclude from the return result, typically sub-fields. Separate multiple fields with commas. Example value: hitResult.hits. |'."\n"
+ .'| ruleIds | List | No | List of rule IDs that were hit. Filters data that matches the specified rules. |'."\n"
+ .'| customerServiceName | String | No | Customer service representative name. |'."\n"
+ .'| customerServiceId | String | No | Customer service representative ID. |'."\n"
+ .'| caller | String | No | Calling number. |'."\n"
+ .'| callee | String | No | Called number. |'."\n"
+ .'| callId | String | No | Call ID. |'."\n"
+ .'| skillGroupName | String | No | Skill group name. |'."\n"
+ .'| hitStatus | Integer | No | Hit status. Valid values: 0 (No rule hit); 1 (Rule hit). |'."\n"
+ .'| reviewStatus | Integer | No | Review status. Valid values: 0 (Not reviewed); 1 (Reviewed). |'."\n"
+ .'| assignStatus | Integer | No | File assignment status. Valid values: 0 (Not assigned); 1 (Assigned). |'."\n"
+ .'| scoreType | Integer | No | Filter type when filtering by quality inspection score. **Must be used together with totalScore.** Valid values: 1 (Return data where the quality inspection score equals totalScore); 2 (Return data where the quality inspection score is less than totalScore); 3 (Return data where the quality inspection score is greater than totalScore). |'."\n"
+ .'| reviewer | Long | No | Quality inspector ID. Returns only files assigned to this inspector. |'."\n"
+ .'| totalScore | Integer | No | Quality inspection score value for filtering. **Must be used together with scoreType.** |'."\n"
+ .'| durationType | Integer | No | Filter type when filtering by recording duration. **Must be used together with duration.** Valid values: 1 (Return data where the recording duration equals duration); 2 (Return data where the recording duration is less than duration); 3 (Return data where the recording duration is greater than duration). |'."\n"
+ .'| duration | Integer | No | Recording duration for filtering, in seconds. **Must be used together with durationType.** |'."\n"
+ .'| fileName | String | No | File name. You must provide the complete file name. Fuzzy search is not supported. |'."\n"
+ .'| remark1 | String | No | Custom data 1, provided when invoking the **SyncQualityCheck.json** API to upload quality inspection data. |'."\n"
+ .'| remark2 | String | No | Custom data 2, provided when invoking the **SyncQualityCheck.json** API to upload quality inspection data. |'."\n"
+ .'| remark3 | String | No | Custom data 3, provided when invoking the **SyncQualityCheck.json** API to upload quality inspection data. |'."\n"
+ .'| sortField | String | No | Parameter used for sorting. Currently, only quality inspection score and custom data fields (remark1/remark2/remark3) support sorting. Valid values: score/remark1/remark2/remark3. |'."\n"
+ .'| sortType | String | No | Sorting rule. Valid values: desc (Descending); asc (Ascending). |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'RevertAssignedSession' => [
- 'summary' => '批量回收',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:49.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-11-26T06:59:49.000Z', 'description' => 'Response parameters changed, Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetSyncResult'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sca:GetSyncResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetTag' => [
+ 'summary' => 'Queries the details of a label node.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREsca27EUYZ'],
+ ],
'parameters' => [
[
- 'name' => 'jsonStr',
+ 'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"isSchemeData":1,"searchParam":{"schemeTaskConfigId":1,"sourceDataType":1,"startTime":"2022-09-20 00:00:00","endTime":"2022-09-26 23:59:59"}}',
- ],
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the following detailed information.', 'type' => 'string', 'required' => false, 'example' => '“”', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The ID of the business space.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BaseResult',
- 'description' => 'BaseResult',
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4D55C6',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Messages' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** '],
+ 'Data' => [
+ 'description' => 'The returned result.',
'type' => 'object',
- 'itemNode' => true,
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- ],
- ],
+ 'TagId' => ['description' => 'The label ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '128', 'title' => ''],
+ 'Name' => ['description' => 'The label name.', 'type' => 'string', 'example' => '售后问题', 'title' => ''],
+ 'Description' => ['description' => 'The label description.', 'type' => 'string', 'example' => '用于归集售后服务相关的所有意图与 FAQ', 'title' => ''],
+ 'ParentTagId' => ['description' => 'The ID of the parent label node.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''],
+ 'ChildCount' => ['description' => 'The number of direct child nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'Level' => ['description' => 'The level of the current node.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the label was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1748428991000', 'title' => ''],
+ 'ModifyTime' => ['description' => 'The time when the label was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1748428991000', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['description' => 'The result code. A value of 200 indicates success. Other values indicate failure. You can use this field to determine the cause of a failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- true: The call was successful.'."\n"
+ .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Message' => ['description' => 'The error message, if any.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- ],
- 'CreateAsrVocab' => [
- 'summary' => '创建热词模型',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query label node details',
+ 'requestParamsDescription' => '| Field | Type | Required | Value | Description |'."\n"
+ .'|---|---|---|---|---|'."\n"
+ .'| `tagId` | `Long` | Yes | `100231` | The label node ID. |',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Data\\": {\\n \\"TagId\\": 128,\\n \\"Name\\": \\"售后问题\\",\\n \\"Description\\": \\"用于归集售后服务相关的所有意图与 FAQ\\",\\n \\"ParentTagId\\": -1,\\n \\"ChildCount\\": 5,\\n \\"Level\\": 2,\\n \\"CreateTime\\": 1748428991000,\\n \\"ModifyTime\\": 1748428991000\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]',
+ ],
+ 'HandleComplaint' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '56145',
- 'abilityTreeNodes' => [
- 'FEATUREscaKR8LQC',
- ],
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'A JSON string that contains the request parameters. For details, see the following section.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"taskId":"任务ID"}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The ID of the business space.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
@@ -10392,78 +10216,95 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '71b1795ac8634bd8bdf4d3878480c7c2',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '96138D8D-8D26-4E41-BFF4-77AED1088BBD',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates that the request was successful. Other values indicate that the request failed. You can use this code to identify the cause of the error.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The response message. If the request is successful, **successful** is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'The response data.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9987D326-83D9-4A42-B9A5-0B27F9B40539', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. A value of **true** indicates success, and **false or null** indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"71b1795ac8634bd8bdf4d3878480c7c2\\",\\n \\"RequestId\\": \\"96138D8D-8D26-4E41-BFF4-77AED1088BBD\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"9987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Handle an appeal',
+ 'summary' => 'Handles a complaint.',
+ 'description' => 'Only quality checkers or administrators can call this operation.',
+ 'requestParamsDescription' => '**JSON string parameters**'."\n"
+ ."\n"
+ .'| Parameter | Type | Required | Description |'."\n"
+ .'| :--------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| taskId | String | Yes | The task ID. |'."\n"
+ .'| fileId | String | Yes | The file ID. |'."\n"
+ .'| rid | Long | No | The rule ID. Leave this parameter empty if the complaint is for a manual scoring item. |'."\n"
+ .'| comments | String | Yes | The reason for the complaint. |'."\n"
+ .'| accept | Boolean | No | Indicates whether to accept the complaint. Valid values: true and false. The default is true. |'."\n"
+ .'| finalJudge | Boolean | No | Indicates whether this is a final review. A final review prevents any further complaints. Valid values: true and false. The default is false. |',
'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'HandleComplaint'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'UpdateAsrVocab' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'InvalidRule' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [],
+ 'deprecated' => true,
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Full JSON string information. See the following details for specific content.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"ruleIds":[3,4]}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -10471,48 +10312,75 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '71b1795ac8634bd8bdf4d3878480c7c2',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9987D326-83D9-4A42-B9A5-0B27F9B40539',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'Result code. **200** indicates success. Other values indicate failure. The caller can determine the cause of failure based on this field.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Indicates error details on failure. For success, the value is **successful**.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'Indicates whether the deletion was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '9987D326-83D9-4A42-B9A5-0B27F9B40539', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. The caller can determine if the request succeeded based on this field: **true** indicates success, and **false/null** indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"71b1795ac8634bd8bdf4d3878480c7c2\\",\\n \\"RequestId\\": \\"9987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateAsrVocabResponse>\\r\\n <code>200</code>\\r\\n <data>71b1795ac8634bd8bdf4d3878480c7c2</data>\\r\\n <message>successful</message>\\r\\n <requestId>76DB5D8C-5BD9-42A7-B527-5AF3A5F83F12</requestId>\\r\\n <success>true</success>\\r\\n</UpdateAsrVocabResponse>","errorExample":""}]',
+ 'staticInfo' => [
+ 'substitutions' => ['Qualitycheck::2019-01-15::DeleteRuleV4'],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"9987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Delete Rules',
+ 'summary' => 'Delete rules.',
+ 'requestParamsDescription' => '**Request parameter JSON string information**'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| :------- | :------------- | :------- | :---------- |'."\n"
+ .'| ruleIds | `List<String>` | Yes | Rule ID |',
'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-19T06:19:54.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'InvalidRule'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'GetAsrVocab' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListAsrVocab' => [
+ 'summary' => 'Retrieves a list of vocabulary groups without their specific content.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -10520,277 +10388,327 @@
],
'operationType' => 'read',
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '56172',
- 'abilityTreeNodes' => [
- 'FEATUREscaKR8LQC',
- ],
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '56212',
+ 'abilityTreeNodes' => ['FEATUREscaKR8LQC'],
],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the details below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"pageSize":1}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** ',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates that the request was successful. Other values indicate that the request failed. You can use this field to determine the cause of the failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error details if the request fails. If the request is successful, the value is **successful**.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '66E1ACB8-17B2-4BE8-8581-954A8EE1324B', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Use this field to determine if the request was successful. A value of true indicates success. A value of **false** or **null** indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
'type' => 'object',
+ 'itemNode' => true,
'properties' => [
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Words' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Word' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Weight' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Word' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
+ 'AsrVocab' => [
+ 'description' => 'The list of vocabularies.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'VocabularyId' => ['description' => 'The vocabulary group ID.', 'type' => 'string', 'example' => 'a01daaaxxxxxxxxx', 'title' => ''],
+ 'UpdateTime' => ['description' => 'The time when the vocabulary group was last updated.', 'type' => 'string', 'example' => '2019-04-15T14:57Z', 'title' => ''],
+ 'Name' => ['description' => 'The name of the vocabulary group.', 'type' => 'string', 'example' => '测试', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the vocabulary group was created.', 'type' => 'string', 'example' => '2019-04-15T14:57Z', 'title' => ''],
+ 'Id' => ['description' => 'The vocabulary group ID.', 'type' => 'string', 'example' => '18', 'title' => ''],
+ 'AsrVersion' => ['description' => 'The ASR version.'."\n"
+ ."\n"
+ .'- 2 or **null**: V2 (Intelligent Speech Interaction ASR)'."\n"
+ ."\n"
+ .'- **3**: V3 (Paraformer ASR)', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'ModelCustomizationId' => ['description' => 'The language model ID. This parameter is returned only for V3.', 'type' => 'string', 'example' => 'paraformer-8k-v2', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'AsrVersion' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ModelCustomizationId' => [
- 'type' => 'string',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Name\\": \\"test\\",\\n \\"Words\\": {\\n \\"Word\\": [\\n {\\n \\"Weight\\": 0,\\n \\"Word\\": \\"你好\\"\\n }\\n ]\\n },\\n \\"AsrVersion\\": 3,\\n \\"ModelCustomizationId\\": \\"paraformer-8k-v2\\"\\n }\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"66E1ACB8-17B2-4BE8-8581-954A8EE1324B\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"AsrVocab\\": [\\n {\\n \\"VocabularyId\\": \\"a01daaaxxxxxxxxx\\",\\n \\"UpdateTime\\": \\"2019-04-15T14:57Z\\",\\n \\"Name\\": \\"测试\\",\\n \\"CreateTime\\": \\"2019-04-15T14:57Z\\",\\n \\"Id\\": \\"18\\",\\n \\"AsrVersion\\": 3,\\n \\"ModelCustomizationId\\": \\"paraformer-8k-v2\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Retrieve hotword group list ',
+ 'requestParamsDescription' => '**Details of the JsonStr request parameter**'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :--------- | :------ | :------- | :------------------------------------------------------------------ |'."\n"
+ .'| pageSize | Integer | No | The number of entries per page. Default value: 10. |'."\n"
+ .'| pageNumber | Integer | No | The current page number. The value starts from 1. Default value: 1. |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-21T12:56:34.000Z', 'description' => 'Response parameters changed, Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:48.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListAsrVocab'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'ListAsrVocab' => [
- 'summary' => '获取热词模型列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListDataSet' => [
+ 'summary' => 'This feature is located in the Dataset management section of the frontend. The Apsara Stack URL is ip:port/api/dataset/ListDataSet.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'deprecated' => true,
'systemTags' => [
'operationType' => 'list',
- 'abilityTreeCode' => '56212',
- 'abilityTreeNodes' => [
- 'FEATUREscaKR8LQC',
- ],
+ 'abilityTreeCode' => '154557',
+ 'abilityTreeNodes' => ['FEATUREsca81P1AQ'],
],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"pageSize":1}',
- ],
+ 'schema' => ['description' => 'Input parameter JSON string', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{"pageNumber":1,"pageSize":10}'],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'PageResult<DataSet>',
+ 'description' => 'PageResult',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '66E1ACB8-17B2-4BE8-8581-954A8EE1324B',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'AsrVocab' => [
- 'description' => '',
+ 'Data' => [
+ 'description' => 'List of datasets.',
'type' => 'array',
'items' => [
+ 'description' => 'List of datasets.',
'type' => 'object',
'properties' => [
- 'VocabularyId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'a01daaaxxxxxxxxx',
- ],
- 'UpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-04-15T14:57Z',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-04-15T14:57Z',
- ],
- 'Id' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '18',
- ],
- 'AsrVersion' => [
+ 'SetId' => ['description' => 'Dataset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'SetName' => ['description' => 'Dataset name.', 'type' => 'string', 'example' => '数据集A', 'title' => ''],
+ 'SetDomain' => ['description' => 'Domain name where the dataset resides. Ignore for internal use.', 'type' => 'string', 'example' => '“”', 'title' => ''],
+ 'SetRoleArn' => ['description' => 'Dataset access role. Ignore for internal use.', 'type' => 'string', 'example' => '“”', 'title' => ''],
+ 'SetBucketName' => ['description' => 'Dataset OSS bucket name. Ignore for internal use.', 'type' => 'string', 'example' => '“”', 'title' => ''],
+ 'SetFolderName' => ['description' => 'Dataset file folder name. Ignore for internal use.', 'type' => 'string', 'example' => '“”', 'title' => ''],
+ 'SetNumber' => ['description' => 'Total number of dataset files.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RoleConfigStatus' => [
+ 'description' => 'Role configuration status.',
+ 'enumValueTitles' => ['Not configured', 'Configured', 'No configuration required'],
'type' => 'integer',
'format' => 'int32',
+ 'example' => '1',
+ 'title' => '',
+ ],
+ 'ChannelId0' => ['description' => 'Required for dual-track. The track number where the customer service role is located. Value is 0 or 1. For example, if customer service is on track 0, this value is 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'ChannelId1' => ['description' => 'Required for dual-track. The track number where the customer role is located. Value is 0 or 1. For example, if the customer is on track 1, this value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RoleConfigTask' => ['description' => 'Role configuration task', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'IsDelete' => ['description' => 'Is deleted:'."\n"
+ ."\n"
+ .'- 0: Not deleted'."\n"
+ ."\n"
+ .'- 1: Deleted', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'CreateTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2019-06-20T17:33Z', 'title' => ''],
+ 'UpdateTime' => ['description' => 'Last update time.', 'type' => 'string', 'example' => '2022-05-10T10:34Z', 'title' => ''],
+ 'ChannelType' => ['description' => 'Channel type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'SubDir' => ['description' => 'Dataset subdirectory', 'type' => 'string', 'example' => 'xx', 'title' => ''],
+ 'CreateType' => [
+ 'description' => 'Creation type.',
+ 'enumValueTitles' => ['Via user OSS', 'Direct upload'],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ 'title' => '',
],
- 'ModelCustomizationId' => [
- 'type' => 'string',
- ],
+ 'UserGroup' => ['description' => 'User group ID.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'RoleConfigProp' => ['description' => 'Role configuration file.', 'type' => 'string', 'example' => 'filesFromLocal/ef7ff45c147a4a5e882c925f9a75ac43', 'title' => ''],
+ 'AutoTranscoding' => ['description' => 'Automatic transcoding', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'SetType' => [
+ 'description' => 'Dataset creation type'."\n"
+ ."\n"
+ .'- 0: Preset'."\n"
+ ."\n"
+ .'- 1: User-created',
+ 'enumValueTitles' => ['Preset', 'User-created'],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ 'title' => '',
+ ],
+ 'DataSetType' => ['description' => 'Dataset type', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'SourceDataType' => ['description' => 'Quality inspection result type'."\n"
+ ."\n"
+ .'- 11: Dataset voice'."\n"
+ ."\n"
+ .'- 12: Dataset text', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Count' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '23', 'title' => ''],
+ 'CurrentPage' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageSize' => ['description' => 'Number of items displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'Current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '96138D8D-8D26-4E41-BFF4-77AED1088BBD', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Callers can use this field to determine if the request succeeded: true for success; false/null for failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. **200** indicates success. Other values indicate failure. Callers can use this field to determine the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if an error occurs; "successful" on success.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Messages' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Message' => [
+ 'description' => 'Error details if an error occurs, used when multiple messages are output.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Error details if an error occurs, used when multiple messages are output.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"66E1ACB8-17B2-4BE8-8581-954A8EE1324B\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"AsrVocab\\": [\\n {\\n \\"VocabularyId\\": \\"a01daaaxxxxxxxxx\\",\\n \\"UpdateTime\\": \\"2019-04-15T14:57Z\\",\\n \\"Name\\": \\"测试\\",\\n \\"CreateTime\\": \\"2019-04-15T14:57Z\\",\\n \\"Id\\": \\"18\\",\\n \\"AsrVersion\\": 3,\\n \\"ModelCustomizationId\\": \\"paraformer-8k-v2\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<Data>\\n <AsrVocab>\\n <Name>测试</Name>\\n <CreateTime>2019-07-09T15:31Z</CreateTime>\\n <VocabularyId>7c22c5078169451c84ef8834c491a1c0</VocabularyId>\\n <UpdateTime>2019-10-16T09:47Z</UpdateTime>\\n <Id>18</Id>\\n </AsrVocab>\\n</Data>\\n<Message>successful</Message>\\n<RequestId>8542C91F-E130-4FF0-A7C3-51B4FE5CDA27</RequestId>\\n<Success>true</Success>\\n<Code>200</Code>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'staticInfo' => ['noSubstitutionReason' => '暂无替代API,请关注后续API最新发布。'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Data\\": [\\n {\\n \\"SetId\\": 1,\\n \\"SetName\\": \\"数据集A\\",\\n \\"SetDomain\\": \\"“”\\",\\n \\"SetRoleArn\\": \\"“”\\",\\n \\"SetBucketName\\": \\"“”\\",\\n \\"SetFolderName\\": \\"“”\\",\\n \\"SetNumber\\": 1,\\n \\"RoleConfigStatus\\": 1,\\n \\"ChannelId0\\": 0,\\n \\"ChannelId1\\": 1,\\n \\"RoleConfigTask\\": \\"xx\\",\\n \\"IsDelete\\": 0,\\n \\"CreateTime\\": \\"2019-06-20T17:33Z\\",\\n \\"UpdateTime\\": \\"2022-05-10T10:34Z\\",\\n \\"ChannelType\\": 1,\\n \\"SubDir\\": \\"xx\\",\\n \\"CreateType\\": 0,\\n \\"UserGroup\\": \\"1\\",\\n \\"RoleConfigProp\\": \\"filesFromLocal/ef7ff45c147a4a5e882c925f9a75ac43\\",\\n \\"AutoTranscoding\\": 1,\\n \\"SetType\\": 1,\\n \\"DataSetType\\": 3,\\n \\"SourceDataType\\": 11\\n }\\n ]\\n },\\n \\"Count\\": 23,\\n \\"CurrentPage\\": 10,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"96138D8D-8D26-4E41-BFF4-77AED1088BBD\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Batch retrieve datasets ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDataSet'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'DeleteAsrVocab' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListPrecisionTask' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'A complete **JSON string**. For details, see the following information.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"{"pageSize":10,"pageNumber":1}"', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -10798,211 +10716,372 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. If true, the request succeeded. If false or null, the request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. A value of **200** means success. Any other value means failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request failed. Returns successful if the request succeeded.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'PageNumber' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'Number of items per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Count' => ['description' => 'Total number of items.', 'type' => 'integer', 'format' => 'int32', 'example' => '22', 'title' => ''],
'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'PrecisionTask' => [
+ 'description' => 'Task list data.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'Task status. Possible values: 0 (transcribing), 1 (transcription complete).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'UpdateTime' => ['description' => 'Last update time.', 'type' => 'string', 'example' => '2020-03-10 20:26:29', 'title' => ''],
+ 'IncorrectWords' => ['description' => 'Number of incorrectly transcribed characters.', 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''],
+ 'CreateTime' => ['description' => 'Task creation time.', 'type' => 'string', 'example' => '2020-03-10 20:26:29', 'title' => ''],
+ 'DataSetId' => ['description' => 'Data set ID if the task originates from a data set.', 'type' => 'integer', 'format' => 'int64', 'example' => '1212', 'title' => ''],
+ 'VerifiedCount' => ['description' => 'Total number of files verified.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'Source' => ['description' => 'File source. Possible values: 3 (data set), 0 (call center).', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'TotalCount' => ['description' => 'Total number of files in the task.', 'type' => 'integer', 'format' => 'int32', 'example' => '21', 'title' => ''],
+ 'DataSetName' => ['description' => 'Data set name if the task originates from a data set.', 'type' => 'string', 'example' => '数据集名称', 'title' => ''],
+ 'Duration' => ['description' => 'Total audio duration in **seconds**.', 'type' => 'integer', 'format' => 'int32', 'example' => '331311', 'title' => ''],
+ 'Name' => ['description' => 'Task name.', 'type' => 'string', 'example' => '任务名称', 'title' => ''],
+ 'TaskId' => ['description' => 'Task ID.', 'type' => 'string', 'example' => '7C1DEF5F-2C18-4D36-99C6-8C276F781796', 'title' => ''],
+ 'Precisions' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Precision' => [
+ 'description' => 'List of language models used for the task.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'Task status. Possible values: 0 (transcribing), 1 (transcription complete).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'CreateTime' => ['description' => 'Model comparison task creation time.', 'type' => 'string', 'example' => '2020-03-10 20:26:29', 'title' => ''],
+ 'ModelName' => ['description' => 'Model name.', 'type' => 'string', 'example' => '自定义模型', 'title' => ''],
+ 'TaskId' => ['description' => 'Task ID.', 'type' => 'string', 'example' => '7C1DEF5F-2C18-4D36-99C6-8C276F781796', 'title' => ''],
+ 'ModelId' => ['description' => 'Model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2321', 'title' => ''],
+ 'Precision' => ['description' => 'Precision score. For example, 0.98.', 'type' => 'number', 'format' => 'float', 'example' => '0.98', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '71b1795ac8634bd8bdf4d3878480c7c2',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4987D326-83D9-4A42-B9A5-0B27F9B40539',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"71b1795ac8634bd8bdf4d3878480c7c2\\",\\n \\"RequestId\\": \\"4987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteAsrVocabResponse>\\r\\n <code>200</code>\\r\\n <data>71b1795ac8634bd8bdf4d3878480c7c2</data>\\r\\n <message>successful</message>\\r\\n <requestId>76DB5D8C-5BD9-42A7-B527-5AF3A5F83F12</requestId>\\r\\n <success>true</success>\\r\\n</DeleteAsrVocabResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Count\\": 22,\\n \\"Data\\": {\\n \\"PrecisionTask\\": [\\n {\\n \\"Status\\": 1,\\n \\"UpdateTime\\": \\"2020-03-10 20:26:29\\",\\n \\"IncorrectWords\\": 32,\\n \\"CreateTime\\": \\"2020-03-10 20:26:29\\",\\n \\"DataSetId\\": 1212,\\n \\"VerifiedCount\\": 3,\\n \\"Source\\": 3,\\n \\"TotalCount\\": 21,\\n \\"DataSetName\\": \\"数据集名称\\",\\n \\"Duration\\": 331311,\\n \\"Name\\": \\"任务名称\\",\\n \\"TaskId\\": \\"7C1DEF5F-2C18-4D36-99C6-8C276F781796\\",\\n \\"Precisions\\": {\\n \\"Precision\\": [\\n {\\n \\"Status\\": 1,\\n \\"CreateTime\\": \\"2020-03-10 20:26:29\\",\\n \\"ModelName\\": \\"自定义模型\\",\\n \\"TaskId\\": \\"7C1DEF5F-2C18-4D36-99C6-8C276F781796\\",\\n \\"ModelId\\": 2321,\\n \\"Precision\\": 0.98\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain the speech recognition detection job list',
+ 'summary' => 'Retrieve the list of speech recognition precision tasks. Set the service endpoint to Hangzhou (cn-hangzhou).',
+ 'requestParamsDescription' => '## Input parameters'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :--------- | :------ | :------- | :--------------------------------------- |'."\n"
+ .'| pageSize | Integer | No | Number of items per page. Default is 10. |'."\n"
+ .'| pageNumber | Integer | No | Current page number. Default is 1. |',
+ 'responseParamsDescription' => '## Response parameters'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :--------- | :------ | :------- | :---------------------------------------------------------------------------- |'."\n"
+ .'| pageSize | Integer | Yes | Number of items per page. |'."\n"
+ .'| pageNumber | Integer | Yes | Current page number. |'."\n"
+ .'| count | Integer | Yes | Total number of items. |'."\n"
+ .'| data | List | Yes | Task information. For details, see the PrecisionTask field description below. |'."\n"
+ ."\n"
+ .'### PrecisionTask field description'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------------- | :------ | :------- | :--------------------------------------------------------------------------------------- |'."\n"
+ .'| taskId | String | Yes | Task ID. |'."\n"
+ .'| name | String | Yes | Task name. |'."\n"
+ .'| source | Integer | Yes | File source. Possible values: 3 (data set), 0 (call center). |'."\n"
+ .'| type | Integer | No | Task type. Possible values: 1 (precision task), 2 (model comparison task). Default is 1. |'."\n"
+ .'| dataSetId | Long | Yes | Data set ID if the task originates from a data set. |'."\n"
+ .'| dataSetName | String | Yes | Data set name if the task originates from a data set. |'."\n"
+ .'| duration | Long | Yes | Total audio duration. |'."\n"
+ .'| precisions | List | Yes | Precision scores. For details, see the Precision field description below. |'."\n"
+ .'| status | Integer | Yes | Task status. Possible values: 0 (transcribing), 1 (transcription complete). |'."\n"
+ .'| totalCount | Integer | Yes | Total number of files in the task. |'."\n"
+ .'| verifiedCount | Integer | Yes | Total number of files verified. |'."\n"
+ .'| incorrectWords | Integer | Yes | Number of incorrectly transcribed characters. |'."\n"
+ .'| updateTime | String | Yes | Last update time. |'."\n"
+ ."\n"
+ .'### Precision field description'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :--------- | :------ | :------- | :-------------------------------------------------------------------------- |'."\n"
+ .'| modelName | String | Yes | Model name. |'."\n"
+ .'| modelId | Long | Yes | Model ID. |'."\n"
+ .'| precision | Float | Yes | Precision score. For example, 0.98. |'."\n"
+ .'| status | Integer | Yes | Task status. Possible values: 0 (transcribing), 1 (transcription complete). |'."\n"
+ .'| taskId | String | Yes | Model comparison task ID. |'."\n"
+ .'| createTime | String | Yes | Model comparison task creation time in yyyy-MM-dd HH:mm:ss format. |',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListPrecisionTask'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'GetCustomizationConfigList' => [
- 'summary' => '获取语音模型列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListQualityCheckScheme' => [
+ 'summary' => 'Retrieves a list of quality check schemes.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '56177',
- 'abilityTreeNodes' => [
- 'FEATUREscaKR8LQC',
- ],
- ],
+ 'deprecated' => false,
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '""',
- ],
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the details that follow.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{'."\n"
+ .' "name": "质检方案A"'."\n"
+ .'}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The ID of the baseMe agent.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'Response data',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4*** ', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. A value of true indicates success. A value of **false** or **null** indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ResultCountId' => ['description' => 'An internal parameter. You can ignore this parameter.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
+ 'Code' => ['description' => 'The status code. A value of **200** indicates success. Other values indicate a failure. Use this code to identify the cause of the failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The returned message. If the request is successful, \\`successful\\` is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Count' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '22', 'title' => ''],
'Data' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'ModelCustomizationDataSetPo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'TaskType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-01-08',
- ],
- 'ModelStatus' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'ModelName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ModelId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'ModeCustomizationId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cdae396590bb479a9ec40f3476e274fc',
+ 'description' => 'The data of the quality check scheme list.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the quality check scheme.',
+ 'type' => 'object',
+ 'properties' => [
+ 'SchemeId' => ['description' => 'The ID of the quality check scheme.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '112**'],
+ 'Name' => ['description' => 'The name of the quality check scheme.', 'type' => 'string', 'title' => '', 'example' => 'test'],
+ 'Description' => ['description' => 'The description.', 'type' => 'string', 'title' => '', 'example' => '售前使用'],
+ 'DataType' => ['description' => 'The data type of the quality check scheme. Valid values: 0 (text) and 1 (audio).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Type' => ['description' => 'The type of the quality check scheme. Valid values: 0 (built-in) and 1 (user-defined).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TemplateType' => ['description' => 'The type of the quality check scheme template. Valid values: 1 (built-in) and 2 (user-defined).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Status' => ['description' => 'The status of the quality check scheme. Valid values: 0 (deleted), 1 (published), 2 (unpublished), and 3 (updated but not published).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'CreateUserName' => ['description' => 'The name of the creator.', 'type' => 'string', 'title' => '', 'example' => '张三'],
+ 'CreateTime' => ['description' => 'The time when the scheme was created.', 'type' => 'string', 'example' => '2022-05-10T09:34Z', 'title' => ''],
+ 'UpdateUserName' => ['description' => 'The name of the user who last updated the scheme.', 'type' => 'string', 'title' => '', 'example' => '李四'],
+ 'UpdateTime' => ['description' => 'The time when the scheme was last updated.', 'type' => 'string', 'example' => '2022-05-10T10:34Z', 'title' => ''],
+ 'SchemeCheckTypeList' => [
+ 'description' => 'The list of quality check dimensions.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The quality check dimension.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CheckType' => ['description' => 'The type of the quality check dimension.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Enable' => ['description' => 'The enabled status. Valid values: 0 (disabled) and 1 (enabled).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'CheckName' => ['description' => 'The name of the quality check dimension.', 'type' => 'string', 'example' => '服务规范性检测', 'title' => ''],
+ 'TargetType' => ['description' => 'An internal parameter. You can ignore this parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Score' => ['description' => 'The score of the quality check dimension.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
],
- 'AsrVersion' => [
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RuleList' => [
+ 'title' => '',
+ 'description' => 'The list of check items.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the rule hits.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Rules' => [
+ 'description' => 'The rule information. This parameter is reserved for future use. Currently, only one rule is returned.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The basic information of the rule.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Rid' => ['description' => 'The ID of the check item.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
+ 'Name' => ['description' => 'The name of the check item.', 'type' => 'string', 'example' => '测试规则', 'title' => ''],
+ 'RuleScoreType' => ['description' => 'Indicates whether to calculate a score. Valid values: 1 (no score) and 3 (score).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ScoreNum' => ['description' => 'The score.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'ScoreType' => ['description' => 'The scoring method. Valid values: 1 (add points) and 3 (deduct points).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'CheckType' => ['description' => 'The quality check dimension to which the item belongs.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TargetType' => ['description' => 'The application scenario of the check item. Valid values: 10 (common check item) and 11 (SOP flow check item).', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'ScoreNumType' => ['description' => 'The scoring type. Valid values: 0 (Points are added or deducted each time the rule is triggered) and 1 (A one-time score is given when the rule is triggered).', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
+ 'Version' => ['description' => 'The version of the quality check scheme.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ModelCustomizationDataSetPo\\": [\\n {\\n \\"TaskType\\": 1,\\n \\"CreateTime\\": \\"2019-01-08\\",\\n \\"ModelStatus\\": 5,\\n \\"ModelName\\": \\"自定义模型\\",\\n \\"ModelId\\": 1,\\n \\"ModeCustomizationId\\": \\"cdae396590bb479a9ec40f3476e274fc\\",\\n \\"AsrVersion\\": 3\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetCustomizationConfigListResponse>\\n <Message>successful</Message>\\n <RequestId>8D1C1B0E-D53F-427D-AB37-FF9A135F0F49</RequestId>\\n <Data>\\n <ModelCustomizationDataSetPo>\\n <ModelName>通用模型</ModelName>\\n <TaskType>1</TaskType>\\n <CreateTime>2019-01-08</CreateTime>\\n <ModelStatus>5</ModelStatus>\\n <ModeCustomizationId>cdae396590bb479a9ec40f3476e274fc</ModeCustomizationId>\\n <ModelId>746</ModelId>\\n </ModelCustomizationDataSetPo>\\n <ModelCustomizationDataSetPo>\\n <ModelName>aaa</ModelName>\\n <TaskType>2</TaskType>\\n <CreateTime>2020-02-18</CreateTime>\\n <ModelStatus>5</ModelStatus>\\n <ModeCustomizationId>0839ca64fbee401ca66c53b324c5907b</ModeCustomizationId>\\n <ModelId>9556</ModelId>\\n </ModelCustomizationDataSetPo>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetCustomizationConfigListResponse>","errorExample":""}]',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4***\\\\t\\",\\n \\"Success\\": true,\\n \\"ResultCountId\\": \\"XXX\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Count\\": 22,\\n \\"Data\\": [\\n {\\n \\"SchemeId\\": 0,\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"售前使用\\",\\n \\"DataType\\": 1,\\n \\"Type\\": 1,\\n \\"TemplateType\\": 1,\\n \\"Status\\": 1,\\n \\"CreateUserName\\": \\"张三\\",\\n \\"CreateTime\\": \\"2022-05-10T09:34Z\\",\\n \\"UpdateUserName\\": \\"李四\\",\\n \\"UpdateTime\\": \\"2022-05-10T10:34Z\\",\\n \\"SchemeCheckTypeList\\": [\\n {\\n \\"CheckType\\": 1,\\n \\"Enable\\": 1,\\n \\"CheckName\\": \\"服务规范性检测\\",\\n \\"TargetType\\": 10,\\n \\"Score\\": 20\\n }\\n ],\\n \\"RuleList\\": [\\n {\\n \\"Rules\\": [\\n {\\n \\"Rid\\": 12,\\n \\"Name\\": \\"测试规则\\",\\n \\"RuleScoreType\\": 1,\\n \\"ScoreNum\\": 2,\\n \\"ScoreType\\": 1,\\n \\"CheckType\\": 1,\\n \\"TargetType\\": 10,\\n \\"ScoreNumType\\": 0\\n }\\n ]\\n }\\n ],\\n \\"Version\\": 1\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Obtain the quality inspection plan list ',
+ 'requestParamsDescription' => '| Property | Value type | Required | Description | Default value | Example |'."\n"
+ .'| ------------ | ---------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------ |'."\n"
+ .'| schemeId | Long | No | The ID of the quality check scheme. | | 123 |'."\n"
+ .'| name | String | No | The name of the quality check scheme. | | Quality Check Scheme A |'."\n"
+ .'| type | Integer | No | The type of the quality check scheme. Valid values: 0 (built-in) and 1 (user-defined). | | 1 |'."\n"
+ .'| dataType | Integer | No | The data type of the quality check scheme. Valid values: 0 (text) and 1 (audio). | | 1 |'."\n"
+ .'| status | Integer | No | The status. Valid values: 0 (deleted), 1 (published), 2 (unpublished), and 3 (updated but not published). | | 1 |'."\n"
+ .'| requireInfos | List | No | Controls which fields of the quality check scheme are returned. `RuleDetailInfo` corresponds to the `ruleList` field. `CheckTypeListInfo` corresponds to the `schemeCheckTypeList` field. | \\["CheckTypeListInfo","RuleDetailInfo"] | {"jsonStr": "{\\\\"pageNumber\\\\": 1, \\\\"pageSize\\\\": 1, \\\\"requireInfos\\\\": [\\\\"CheckTypeListInfo\\\\"]}"} |'."\n"
+ .'| pageNumber | Integer | No | The page number. | 1 | 1 |'."\n"
+ .'| pageSize | Integer | No | The number of entries per page. | 10 | 10 |',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-05-30T12:54:38.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-05-16T12:19:26.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListQualityCheckScheme'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'DeleteCustomizationConfig' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListRules' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'systemTags' => [],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"modelId":"2412"}',
- ],
+ 'schema' => ['description' => 'A JSON string. For the full structure, see the details that follow.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"pageNumber":1,"pageSize":10}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -11010,664 +11089,1280 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F** ', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. A value of true means success. A value of false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The result code. A value of 200 means success. Any other value means failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Details about an error if the request failed. If the request succeeded, the value is successful.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the rule list.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Count' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '252',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9987D326-83D9-4A42-B9A5-0B27F9B40539',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => 'The rule list.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The rule list.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The type value of the rule\'s rule type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RuleType' => ['description' => 'The rule category. Valid values:'."\n"
+ ."\n"
+ .'- 1: Custom rule'."\n"
+ ."\n"
+ .'- 0: System-provided rule', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the rule was created.', 'type' => 'string', 'example' => '2020-04-20T20:10Z', 'title' => ''],
+ 'Comments' => ['description' => 'Comments for the rule.', 'type' => 'string', 'example' => '检测是否出现了禁用语', 'title' => ''],
+ 'TypeName' => ['description' => 'The name of the rule\'s rule type.', 'type' => 'string', 'example' => '服务规范', 'title' => ''],
+ 'Name' => ['description' => 'The rule name.', 'type' => 'string', 'example' => '禁用语检测', 'title' => ''],
+ 'Rid' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567', 'title' => ''],
+ 'BusinessCategoryNameList' => [
+ 'description' => 'The names of business categories associated with the rule.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The name of a business category associated with the rule.', 'type' => 'string', 'example' => '["所有业务"]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"252\\",\\n \\"RequestId\\": \\"9987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteCustomizationConfigResponse>\\r\\n <code>200</code>\\r\\n <data>252</data>\\r\\n <message>successful</message>\\r\\n <requestId>9987D326-83D9-4A42-B9A5-0B27F9B40539</requestId>\\r\\n <success>true</success>\\r\\n</DeleteCustomizationConfigResponse>","errorExample":""}]',
+ 'staticInfo' => [
+ 'substitutions' => ['Qualitycheck::2019-01-15::ListRulesV4'],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F**\\\\t\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Count\\": 20,\\n \\"Data\\": [\\n {\\n \\"Type\\": 1,\\n \\"RuleType\\": 1,\\n \\"CreateTime\\": \\"2020-04-20T20:10Z\\",\\n \\"Comments\\": \\"检测是否出现了禁用语\\",\\n \\"TypeName\\": \\"服务规范\\",\\n \\"Name\\": \\"禁用语检测\\",\\n \\"Rid\\": 1234567,\\n \\"BusinessCategoryNameList\\": [\\n \\"[\\\\\\"所有业务\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Retrieve Rule List',
+ 'summary' => 'Lists rules.',
+ 'requestParamsDescription' => '**JSON request parameters**'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example | Description |'."\n"
+ .'| :--------- | :------ | :------- | :-------------------------- | :--------------------------------- |'."\n"
+ .'| pageNumber | Integer | Yes | 1 | The page number. Minimum value: 1. |'."\n"
+ .'| pageSize | Integer | Yes | 10 | The number of entries per page. |'."\n"
+ .'| rid | Integer | No | 1234567 | The rule ID. |'."\n"
+ .'| ruleName | String | No | "Prohibited Word Detection" | The rule name. |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-19T06:19:54.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListRules'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'CreateTaskAssignRule' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListRulesV4' => [
+ 'summary' => 'Frontend location: Quality inspection rule configuration — List. Apsara Stack URL: ip:port/api/rule/GetRulesCountList.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'JsonStr',
- 'in' => 'query',
+ 'name' => 'Rid',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Search by rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '895EAD5312634F5AA708E3B3FA79662E', 'title' => ''],
+ ],
+ [
+ 'name' => 'RuleIdOrRuleName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Search by rule ID or rule name.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''],
+ ],
+ [
+ 'name' => 'BusinessName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Name of the business that owns the rule.', 'type' => 'string', 'required' => false, 'example' => '所有业务', 'title' => ''],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Type value of the rule category that the rule belongs to.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'TypeName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Name of the rule category that the rule belongs to.', 'type' => 'string', 'required' => false, 'example' => '所有类型', 'title' => ''],
+ ],
+ [
+ 'name' => 'BusinessRange',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Top-level business category.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '无', 'title' => ''],
+ ],
+ [
+ 'name' => 'CreateEmpid',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'ID of the rule creator. Same as CreateUserId. Specify one only.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'CreateUserId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'ID of the rule creator. Same as CreateEmpId. Specify one only.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'UpdateUserId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'ID of the rule updater. Same as LastUpdateEmpId. Specify one only.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'LastUpdateEmpid',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'ID of the rule updater. Same as UpdateUserId. Specify one only.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Rule status.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
+ ],
+ [
+ 'name' => 'CategoryName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Category name.', 'type' => 'string', 'required' => false, 'example' => '分类名称A', 'title' => ''],
+ ],
+ [
+ 'name' => 'SourceType',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Source type.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
+ ],
+ [
+ 'name' => 'RuleType',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Rule category.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'UpdateStartTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Filter by update time (left boundary).', 'type' => 'string', 'required' => false, 'example' => '2021-11-29 16:11:09', 'title' => ''],
+ ],
+ [
+ 'name' => 'UpdateEndTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Filter by update time (right boundary).', 'type' => 'string', 'required' => false, 'example' => '2021-11-29 18:11:09', 'title' => ''],
+ ],
+ [
+ 'name' => 'SchemeId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Quality inspection scheme ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000000090', 'title' => ''],
+ ],
+ [
+ 'name' => 'RequireInfos',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
+ 'description' => 'Required fields.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Required field.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''],
+ 'required' => false,
+ 'maxItems' => 10,
+ 'title' => '',
'example' => '',
],
],
[
+ 'name' => 'RuleScoreSingleType',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Scoring type.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Number of items per page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'CountTotal',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Whether to count the total number of items.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Filter by creation time (left boundary).', 'type' => 'string', 'required' => false, 'example' => '2021-11-29 18:11:09', 'title' => ''],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Filter by creation time (right boundary).', 'type' => 'string', 'required' => false, 'example' => '2021-11-29 19:11:09', 'title' => ''],
+ ],
+ [
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'RulePageResult<RuleCountInfo>',
+ 'description' => 'RulePageResult\\<rulecountinfo>\\</rulecountinfo>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'TotalCount' => ['description' => 'Total number of items.', 'type' => 'integer', 'format' => 'int32', 'example' => '219', 'title' => ''],
+ 'BusinessType' => ['description' => 'Business type. This field has no practical use. Ignore it.', 'type' => 'integer', 'format' => 'int32', 'example' => '无', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '54',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
+ 'description' => 'Response data.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Rule information.', '$ref' => '#/components/schemas/RuleCountInfo', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Count' => ['description' => 'Total number of items.', 'type' => 'integer', 'format' => 'int32', 'example' => '219', 'title' => ''],
+ 'CurrentPage' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageSize' => ['description' => 'Number of rows per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '96138D8D-8D26-4E41-BFF4-77AED1088BBD', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Callers can use this field to determine success: true means success. **false** or **null** means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. **200** means success. Any other value means failure. Callers can use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request failed. Returns **successful** if the request succeeded.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Messages' => [
+ 'description' => 'Error details if the request failed. Use this field when multiple messages are returned.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Error details if the request failed. Use this field when multiple messages are returned.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"54\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateTaskAssignRuleResponse>\\n <Message>successful</Message>\\n <RequestId>A28F15BD-1842-4747-8866-86183201AA48</RequestId>\\n <Data>37</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateTaskAssignRuleResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 219,\\n \\"BusinessType\\": 0,\\n \\"Data\\": [\\n {\\n \\"Rid\\": 123,\\n \\"Name\\": \\"0801转封装测试\\",\\n \\"Type\\": 1,\\n \\"Status\\": 1,\\n \\"CheckNumber\\": 1,\\n \\"HitNumber\\": 1,\\n \\"HitRate\\": 1,\\n \\"ReviewAccuracyRate\\": 1,\\n \\"ReviewRate\\": 1,\\n \\"PreReviewNumber\\": 1,\\n \\"ReviewNumber\\": 1,\\n \\"UnReviewNumber\\": 1,\\n \\"ProblemNumber\\": 1,\\n \\"StartTime\\": \\"1662685868850\\",\\n \\"EndTime\\": \\"1650092585176\\",\\n \\"CreateTime\\": \\"1615133575000\\",\\n \\"CreateEmpid\\": \\"1\\",\\n \\"CreateEmpName\\": \\"张三\\",\\n \\"LastUpdateEmpid\\": \\"1\\",\\n \\"LastUpdateEmpName\\": \\"张三\\",\\n \\"LastUpdateTime\\": \\"1648200901000\\",\\n \\"BusinessRange\\": [\\n 1\\n ],\\n \\"BusinessCategoryBasicInfoList\\": [\\n {\\n \\"Bid\\": 1,\\n \\"ServiceType\\": 1,\\n \\"Name\\": \\"全部\\",\\n \\"OriginalId\\": 1\\n }\\n ],\\n \\"BusinessCategoryNameList\\": [\\n \\"\\"\\n ],\\n \\"IsDelete\\": 1,\\n \\"TypeName\\": \\"全部类别\\",\\n \\"JobName\\": \\"job-1-20221012-105943\\",\\n \\"Comments\\": \\"测试\\",\\n \\"RealViolationNumber\\": 1,\\n \\"HitRealViolationRate\\": 1,\\n \\"ReviewStatusName\\": \\"通过\\",\\n \\"Deny\\": 1,\\n \\"ScoreSubId\\": 1,\\n \\"AutoReview\\": 1,\\n \\"RuleScoreType\\": 1,\\n \\"UserGroup\\": \\"xxxx\\",\\n \\"OperationMode\\": 1,\\n \\"IsSelect\\": true,\\n \\"RuleType\\": 1,\\n \\"Effective\\": 1,\\n \\"FullCycle\\": 1,\\n \\"EffectiveStartTime\\": \\"1662685868850\\",\\n \\"EffectiveEndTime\\": \\"1662685868850\\",\\n \\"QualityCheckType\\": 1,\\n \\"GraphFlow\\": \\"较复杂,忽略\\",\\n \\"RuleScoreSingleType\\": 1,\\n \\"TargetType\\": 10\\n }\\n ],\\n \\"Count\\": 219,\\n \\"CurrentPage\\": 10,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"96138D8D-8D26-4E41-BFF4-77AED1088BBD\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": [\\n \\"无\\"\\n ],\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Obtain Rule List (New Quality Inspection Version)',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:37.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListRulesV4'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'UpdateTaskAssignRule' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListSchemeTaskConfig' => [
+ 'summary' => 'This operation is used for the Task Management feature on the frontend. The Apsara Stack URL is ip:port/api/task/ListSchemeTaskInfo.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'systemTags' => [],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '153835',
+ 'abilityTreeNodes' => ['FEATUREscaFRLL5D', 'FEATUREsca81P1AQ'],
+ ],
'parameters' => [
[
- 'name' => 'JsonStr',
+ 'name' => 'jsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The request parameter JSON. For details, see the supplementary description of request parameters.', 'type' => 'string', 'required' => false, 'example' => '{"pageNumber":1,"pageSize":10,"sourceDataType":"1"}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'baseMeAgentId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'ListResult<SchemeTaskConfig>',
+ 'description' => 'ListResult\\<schemetaskconfig>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
+ 'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'Full response content.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'SchemeTaskConfig',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'Quality inspection task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''],
+ 'SchemeTaskConfigId' => ['description' => 'Quality inspection task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''],
+ 'Name' => ['description' => 'Quality inspection task name.', 'type' => 'string', 'example' => '检测任务A', 'title' => ''],
+ 'SourceDataType' => ['description' => 'Quality inspection result type:'."\n"
+ ."\n"
+ .'- 1: Offline speech quality inspection'."\n"
+ ."\n"
+ .'- 2: Offline text quality inspection'."\n"
+ ."\n"
+ .'- 3: Real-time speech quality inspection'."\n"
+ ."\n"
+ .'- 4: Real-time text quality inspection'."\n"
+ ."\n"
+ .'- 5: Call center secondary quality inspection'."\n"
+ ."\n"
+ .'- 51: Call speech center secondary quality inspection'."\n"
+ ."\n"
+ .'- 52: Call text center secondary quality inspection'."\n"
+ ."\n"
+ .'- 11: Dataset speech'."\n"
+ ."\n"
+ .'- 12: Dataset text', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'Status' => ['description' => 'Task status: 0 (disabled); 1 (enabled)', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ManualReview' => ['description' => 'Manual review', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'AssignType' => ['description' => 'Assignment type', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'DataConfig' => [
+ 'description' => 'Data configuration information',
+ 'type' => 'object',
+ 'properties' => [
+ 'Index' => ['description' => 'Index number', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'AssignConfigs' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'AssignConfig' => [
+ 'description' => 'Recorded data screening item',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Recorded data screening item',
+ 'type' => 'object',
+ 'properties' => [
+ 'AssignConfigContests' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'AssignConfigContest' => [
+ 'description' => 'Recorded parameter matching configuration',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Recorded parameter matching configuration',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'Check item name', 'type' => 'string', 'example' => 'callStartTime', 'title' => ''],
+ 'DataType' => ['description' => 'Type of value'."\n"
+ ."\n"
+ .'- 0: String'."\n"
+ ."\n"
+ .'- 1: Number'."\n"
+ ."\n"
+ .'- 2: List (use list type to pass parameter value when using =)'."\n"
+ ."\n"
+ .'- 3: Date'."\n"
+ ."\n"
+ .'- 4: List\\_Json', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'Symbol' => ['description' => 'Operator'."\n"
+ ."\n"
+ .'- 1: =='."\n"
+ ."\n"
+ .'- 2: >'."\n"
+ ."\n"
+ .'- 3: <'."\n"
+ ."\n"
+ .'- 4: Range'."\n"
+ ."\n"
+ .'- 5: >='."\n"
+ ."\n"
+ .'- 6: <='."\n"
+ ."\n"
+ .'- 7: !='."\n"
+ ."\n"
+ .'- 8: null'."\n"
+ ."\n"
+ .'- 9: not null'."\n"
+ ."\n"
+ .'- 10: Contains'."\n"
+ ."\n"
+ .'- 11: Does not contain', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
+ 'Value' => ['description' => 'Recorded data matching value.', 'type' => 'string', 'example' => '{\\"start\\":\\"2022-09-01 00:00:00\\",\\"end\\":\\"2022-09-30 00:00:00\\"}', 'title' => ''],
+ 'ListObject' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'ListObject' => [
+ 'description' => 'Recorded data list.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Recorded data list.', 'type' => 'any', 'example' => 'xx', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ResultParam' => ['description' => 'Used for secondary quality inspection. This is the JSON text of the screening conditions. For details, see the request parameters of the GetResult API for obtaining task results.', 'type' => 'string', 'example' => '{}', 'title' => ''],
+ 'DataSets' => ['description' => 'Used for dataset tasks. Manage datasets.', 'type' => 'string', 'example' => '[]', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'SchemeIdList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SchemeIdList' => [
+ 'description' => 'Quality inspection scheme ID list',
+ 'type' => 'array',
+ 'items' => ['description' => 'Quality inspection scheme ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '158', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'SchemeList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SchemeList' => [
+ 'description' => 'Quality inspection schemes list',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Quality inspection scheme',
+ 'type' => 'object',
+ 'properties' => [
+ 'SchemeId' => ['description' => 'Quality inspection scheme ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '158'],
+ 'Name' => ['description' => 'Quality inspection scheme name', 'type' => 'string', 'example' => '质检方案B', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AsrTaskPriority' => ['description' => 'Task priority:'."\n"
+ ."\n"
+ .'- 0 (Low)'."\n"
+ ."\n"
+ .'- 1 (Medium)'."\n"
+ ."\n"
+ .'- 2 (High)', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'ModeCustomizationId' => ['description' => 'Language model ID.', 'type' => 'string', 'example' => 'cdae396590b*****ec40f3476e274fc', 'title' => ''],
+ 'ModelName' => ['description' => 'Language model name', 'type' => 'string', 'example' => '语言模型A', 'title' => ''],
+ 'VocabId' => ['description' => 'Hotword model ID.', 'type' => 'string', 'example' => '9f90b3efa2****0a49acec226eafc17', 'title' => ''],
+ 'VocabName' => ['description' => 'Hotword model name', 'type' => 'string', 'example' => '热词模型A', 'title' => ''],
+ 'UserGroup' => ['description' => 'User group ID.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'CreateUser' => ['description' => 'Creator user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'CreateTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '1650418039000', 'title' => ''],
+ 'UpdateTime' => ['description' => 'Update time', 'type' => 'string', 'example' => '1650418039000', 'title' => ''],
+ 'UpdateUser' => ['description' => 'Updater user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'Type' => ['description' => 'Type', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'NumberSum' => ['description' => 'Total data volume.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''],
+ 'NumberSuccess' => ['description' => 'Successful data volume.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''],
+ 'NumberFail' => ['description' => 'Failed data volume.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'FinishRate' => ['description' => 'Task completion rate.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
+ 'NumberExecuting' => ['description' => 'Data volume in progress.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'AsrVersion' => ['description' => 'ASR version'."\n"
+ ."\n"
+ .'- **2/null**: V2 version (Intelligent Speech Interaction ASR)'."\n"
+ ."\n"
+ .'- **3**: V3 version (Paraformer ASR)', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
+ 'title' => '',
+ 'example' => '',
],
- 'Success' => [
+ 'Count' => ['description' => 'Total entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '22', 'title' => ''],
+ 'CurrentPage' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'Entries displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'Current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ResultCountId' => ['description' => 'Internal field. Ignore it.', 'type' => 'string', 'example' => '忽略', 'title' => ''],
+ 'LastDataId' => ['description' => 'This field marks the data. When querying more than 10,000 entries using GetResult, include the \\`lastDataId\\` of the last entry from the previous query in each request parameter.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '4B0A8DCD-0DDF-5E80-8B9C-0A2F68B3403B', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Callers can use this field to determine if the request succeeded: \\`true\\` for success, \\`false\\`/\\`null\\` for failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. **200** indicates success. Other values indicate failure. Callers can use this field to determine the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Provides error details on failure. For success, it is **successful**.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Messages' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Message' => [
+ 'description' => 'List of messages',
+ 'type' => 'array',
+ 'items' => ['description' => 'Message', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateTaskAssignRuleResponse>\\n <Message>successful</Message>\\n <RequestId>CB87B834-A048-43ED-8271-DDF85F6E9030</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UpdateTaskAssignRuleResponse>\\n","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Data\\": [\\n {\\n \\"Id\\": 123,\\n \\"SchemeTaskConfigId\\": 123,\\n \\"Name\\": \\"检测任务A\\",\\n \\"SourceDataType\\": 2,\\n \\"Status\\": 1,\\n \\"ManualReview\\": 0,\\n \\"AssignType\\": 0,\\n \\"DataConfig\\": {\\n \\"Index\\": 0,\\n \\"AssignConfigs\\": {\\n \\"AssignConfig\\": [\\n {\\n \\"AssignConfigContests\\": {\\n \\"AssignConfigContest\\": [\\n {\\n \\"Name\\": \\"callStartTime\\",\\n \\"DataType\\": 3,\\n \\"Symbol\\": 4,\\n \\"Value\\": \\"{\\\\\\\\\\\\\\"start\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2022-09-01 00:00:00\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"end\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2022-09-30 00:00:00\\\\\\\\\\\\\\"}\\",\\n \\"ListObject\\": {\\n \\"ListObject\\": [\\n \\"xx\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"ResultParam\\": \\"{}\\",\\n \\"DataSets\\": \\"[]\\"\\n },\\n \\"SchemeIdList\\": {\\n \\"SchemeIdList\\": [\\n 158\\n ]\\n },\\n \\"SchemeList\\": {\\n \\"SchemeList\\": [\\n {\\n \\"SchemeId\\": 158,\\n \\"Name\\": \\"质检方案B\\"\\n }\\n ]\\n },\\n \\"AsrTaskPriority\\": 2,\\n \\"ModeCustomizationId\\": \\"cdae396590b*****ec40f3476e274fc\\",\\n \\"ModelName\\": \\"语言模型A\\",\\n \\"VocabId\\": \\"9f90b3efa2****0a49acec226eafc17\\",\\n \\"VocabName\\": \\"热词模型A\\",\\n \\"UserGroup\\": \\"1\\",\\n \\"CreateUser\\": 1,\\n \\"CreateTime\\": \\"1650418039000\\",\\n \\"UpdateTime\\": \\"1650418039000\\",\\n \\"UpdateUser\\": 1,\\n \\"Type\\": 0,\\n \\"NumberSum\\": 1000,\\n \\"NumberSuccess\\": 1000,\\n \\"NumberFail\\": 0,\\n \\"FinishRate\\": 100,\\n \\"NumberExecuting\\": 0,\\n \\"AsrVersion\\": 3\\n }\\n ]\\n },\\n \\"Count\\": 22,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ResultCountId\\": \\"忽略\\",\\n \\"LastDataId\\": \\"xxx\\",\\n \\"RequestId\\": \\"4B0A8DCD-0DDF-5E80-8B9C-0A2F68B3403B\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Batch Retrieve Quality Inspection Jobs',
+ 'requestParamsDescription' => '### jsonStr Description'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| -------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| pageNumber | Integer | No | Current page |'."\n"
+ .'| pageSize | Integer | No | Page size |'."\n"
+ .'| sourceDataType | Integer | Yes | Task type: 1 (offline speech); 2 (offline text); 3 (real-time speech); 4 (real-time text); 51 (offline speech secondary quality inspection); 52 (offline text secondary quality inspection); 53 (real-time speech secondary quality inspection); 54 (real-time text secondary quality inspection) |',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-21T12:56:34.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListSchemeTaskConfig'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'ListTaskAssignRules' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListSessionGroup' => [
+ 'summary' => 'This API corresponds to the frontend location: Task Management > View Results > Task Result > Session Group Results tab. The Apsara Stack URL is: ip:port/api/session/group/ListSessionGroup.json. It aggregates multi-turn sessions by their session group ID for unified management. You must pass the `sessionGroupId` field. For more information, see the UploadData and UploadAudioData API documentation.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [],
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '153846',
+ 'abilityTreeNodes' => ['FEATUREscaAJDYMI'],
+ ],
'parameters' => [
[
- 'name' => 'JsonStr',
+ 'name' => 'jsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"pageNumber":1,"pageSize":10}',
- ],
+ 'schema' => ['description' => 'For more information, see the notes on request parameters.', 'type' => 'string', 'required' => false, 'example' => '{"isSchemeData":1,"pageNumber":1,"pageSize":10,"callStartTime":"2022-09-17 00:00:00","callEndTime":"2022-09-23 23:59:59","schemeTaskConfigId":368}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'ListResult<SessionGroupSummary>',
+ 'description' => 'ListResult\\<sessiongroupsummary>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Count' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '23',
- ],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'TaskAssignRuleInfo' => [
- 'description' => '',
+ 'Data' => [
+ 'description' => 'The detailed data.',
'type' => 'array',
'items' => [
+ 'description' => 'SessionGroupSummary',
'type' => 'object',
'properties' => [
- 'UpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-07-12T14:47Z',
- ],
- 'SkillGroupsStr' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XX',
- ],
- 'CallTimeEnd' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '39600',
- ],
- 'DurationMax' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-07-12T14:47Z',
- ],
- 'Priority' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'DurationMin' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'AgentsStr' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XX',
- ],
- 'RuleName' => [
+ 'SessionGroupId' => ['description' => 'The session group ID.', 'type' => 'string', 'example' => 'SessionGroupA', 'title' => ''],
+ 'SchemeTaskConfigId' => ['description' => 'The ID of the quality inspection task.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''],
+ 'SchemeTaskConfigName' => ['description' => 'The name of the quality inspection task.', 'type' => 'string', 'example' => '质检任务A', 'title' => ''],
+ 'CustomerServiceIdList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'CustomerServiceIdList' => [
+ 'description' => 'List of customer service IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Customer ID.', 'type' => 'string', 'example' => '15', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
- 'RuleId' => [
+ 'CustomerServiceNameList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'CustomerServiceNameList' => [
+ 'description' => 'The list of customer service representative names.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Customer name.', 'type' => 'string', 'example' => '客服人员A', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '23',
+ 'title' => '',
+ 'example' => '',
],
- 'AssignmentType' => [
+ 'CustomerIdList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'CustomerIdList' => [
+ 'description' => 'The list of customer IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A customer ID.', 'type' => 'string', 'example' => '13', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
+ 'title' => '',
+ 'example' => '',
],
- 'CallType' => [
+ 'CustomerNameList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'CustomerNameList' => [
+ 'description' => 'The list of customer names.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A customer name.', 'type' => 'string', 'example' => '客户人员A', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ 'title' => '',
+ 'example' => '',
],
- 'Enabled' => [
+ 'CallerList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'CallerList' => [
+ 'description' => 'The list of caller numbers.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A caller number.', 'type' => 'string', 'example' => '05712****989', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ 'title' => '',
+ 'example' => '',
],
- 'CallTimeStart' => [
+ 'SkillGroupNameList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SkillGroupNameList' => [
+ 'description' => 'The list of skill group names.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A skill group name.', 'type' => 'string', 'example' => '技能组A', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '39600',
+ 'title' => '',
+ 'example' => '',
],
- 'Agents' => [
+ 'Score' => ['description' => 'The quality inspection score. The maximum value is 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'SessionCount' => ['description' => 'The number of sessions.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'HitSessionCount' => ['description' => 'The number of sessions that match the review filter criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'CallStartTime' => ['description' => 'The earliest start time of a session.', 'type' => 'string', 'example' => '2022-09-26 10:09:14', 'title' => ''],
+ 'ReviewStatus' => ['description' => 'The review status. Valid values: 0 (not reviewed) and 1 (reviewed).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'AssignStatus' => ['description' => 'The assignment status. Valid values: 0 (not assigned) and 1 (assigned).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ReviewerList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'Agent' => [
- 'description' => '',
+ 'ReviewerList' => [
+ 'description' => 'The list of reviewers.',
'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'AgentName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'agent',
- ],
- 'AgentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '202526561358712105',
- ],
- ],
- ],
+ 'items' => ['description' => 'The name of the reviewer.', 'type' => 'string', 'example' => '复核人员A', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'SkillGroups' => [
+ 'SessionGroupReviewedOrComplained' => ['description' => 'Specifies whether the session group is under review or appeal.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LastDataId' => ['description' => 'The data marker. To retrieve more than 10,000 records, include the LastDataId from the previous response in the next request.', 'type' => 'string', 'example' => '4498420@a_z@93EAADF1-01D3-44BD-8AC9-F57F447EFCE8_1614*****', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Count' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2228', 'title' => ''],
+ 'CurrentPage' => ['description' => 'The number of the returned page. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The number of the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ResultCountId' => ['description' => 'A reserved parameter. You can ignore this parameter.', 'type' => 'string', 'example' => '忽略', 'title' => ''],
+ 'LastDataId' => ['description' => 'The data marker. To retrieve more than 10,000 records, include the LastDataId from the previous response in the next request.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates that the request was successful. A value of \\`false\\` or \\`null\\` indicates that the request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The result code. A value of \\`200\\` indicates that the request was successful. Other values indicate that the request failed.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error details if the request fails. \\`successful\\` is returned if the request is successful.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Messages' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Message' => [
+ 'description' => 'The error details when multiple messages are returned.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The error details when multiple messages are returned.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Data\\": [\\n {\\n \\"SessionGroupId\\": \\"SessionGroupA\\",\\n \\"SchemeTaskConfigId\\": 123,\\n \\"SchemeTaskConfigName\\": \\"质检任务A\\",\\n \\"CustomerServiceIdList\\": {\\n \\"CustomerServiceIdList\\": [\\n \\"15\\"\\n ]\\n },\\n \\"CustomerServiceNameList\\": {\\n \\"CustomerServiceNameList\\": [\\n \\"客服人员A\\"\\n ]\\n },\\n \\"CustomerIdList\\": {\\n \\"CustomerIdList\\": [\\n \\"13\\"\\n ]\\n },\\n \\"CustomerNameList\\": {\\n \\"CustomerNameList\\": [\\n \\"客户人员A\\"\\n ]\\n },\\n \\"CallerList\\": {\\n \\"CallerList\\": [\\n \\"05712****989\\"\\n ]\\n },\\n \\"SkillGroupNameList\\": {\\n \\"SkillGroupNameList\\": [\\n \\"技能组A\\"\\n ]\\n },\\n \\"Score\\": 100,\\n \\"SessionCount\\": 1,\\n \\"HitSessionCount\\": 1,\\n \\"CallStartTime\\": \\"2022-09-26 10:09:14\\",\\n \\"ReviewStatus\\": 1,\\n \\"AssignStatus\\": 1,\\n \\"ReviewerList\\": {\\n \\"ReviewerList\\": [\\n \\"复核人员A\\"\\n ]\\n },\\n \\"SessionGroupReviewedOrComplained\\": true,\\n \\"LastDataId\\": \\"4498420@a_z@93EAADF1-01D3-44BD-8AC9-F57F447EFCE8_1614*****\\"\\n }\\n ]\\n },\\n \\"Count\\": 2228,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ResultCountId\\": \\"忽略\\",\\n \\"LastDataId\\": \\"xxx\\",\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Retrieve session group list ',
+ 'requestParamsDescription' => '### JsonStr description'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| ------------------ | ---------- | -------- | ------------------------------------------ |'."\n"
+ .'| pageNumber | Integer | No | The current page number. |'."\n"
+ .'| pageSize | Integer | No | The number of entries per page. |'."\n"
+ .'| callStartTime | String | Yes | The start time of the time range to query. |'."\n"
+ .'| callEndTime | String | Yes | The end time of the time range to query. |'."\n"
+ .'| schemeTaskConfigId | Long | Yes | The ID of the quality inspection task. |',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListSessionGroup'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'ListSkillGroupConfig' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '56218',
+ 'abilityTreeNodes' => ['FEATUREscaKR8LQC', 'FEATUREsca6QWO0D'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The complete JSON string. For details, see the following section.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"pageNumber":1,"pageSize": 1}', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The result code. A value of 200 indicates success. Any other value indicates failure. Use this field to determine the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Details of the error if the request failed. If successful, the value is "successful".', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** ', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. A value of true means success. A value of false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SkillGroupConfig' => [
+ 'description' => 'The list of configurations.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The configuration type. Valid values: 1 (custom configuration), 0 (system built-in configuration).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Status' => ['description' => 'The enabled status. Valid values: 0 (disabled), 1 (enabled).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'UpdateTime' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2020-12-01T19:28Z ', 'title' => ''],
+ 'AllContentQualityCheck' => ['description' => 'Whether to perform full-text quality check after real-time quality check. Valid values: 1 (perform full-text quality check), 0 (do not perform full-text quality check).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2020-12-01T15:12Z', 'title' => ''],
+ 'SkillGroupId' => ['description' => 'The skill group ID.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'ScreenSwitch' => ['description' => 'Specifies whether to enable recorded data matching.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'InstanceId' => ['description' => 'Internal field. Ignore.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'VocabId' => ['description' => 'The hotword model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '323', 'title' => ''],
+ 'SkillGroupFrom' => ['description' => 'The source of the skill group. Fixed to 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Rid' => ['description' => 'The quality check rule ID.', 'type' => 'string', 'example' => '2221', 'title' => ''],
+ 'SkillGroupName' => ['description' => 'The skill group name.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'ModelName' => ['description' => 'The language model name.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'AllRids' => ['description' => 'The rule ID used for full-text quality check.', 'type' => 'string', 'example' => '223', 'title' => ''],
+ 'Name' => ['description' => 'The configuration name.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'ModelId' => ['description' => 'The language model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '211', 'title' => ''],
+ 'Id' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '221', 'title' => ''],
+ 'QualityCheckType' => ['description' => 'The quality check type. Valid values: 0 (offline quality check), 1 (real-time quality check).', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'VocabName' => ['description' => 'The hotword model name.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'RuleList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'SkillGroup' => [
- 'description' => '',
+ 'RuleNameInfo' => [
+ 'description' => 'The list of rules.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'SkillName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SkillId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
+ 'RuleName' => ['description' => 'The rule name.', 'type' => 'string', 'example' => 'x\'x\'x', 'title' => ''],
+ 'Rid' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2221', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'Reviewers' => [
+ 'AllRuleList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'Reviewer' => [
- 'description' => '',
+ 'RuleNameInfo' => [
+ 'description' => 'The detailed rules used for full-text quality check.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'ReviewerId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2337235457340978',
- ],
- 'ReviewerName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'RuleName' => ['description' => 'The rule name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'Rid' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '221', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'Rules' => [
+ 'SkillGroupScreens' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
- 'RuleBasicInfo' => [
- 'description' => '',
+ 'SkillGroupScreen' => [
+ 'description' => 'Information about call recordings.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2312',
- ],
+ 'Value' => ['description' => 'The value to match for the recorded data.', 'type' => 'string', 'example' => '张三', 'title' => ''],
+ 'DataType' => ['description' => 'The data type of the value. Valid values: 0 (String), 1 (Number), 2 (List). When using the = operator, always pass the value as a list.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Symbol' => ['description' => 'The operator.'."\n"
+ ."\n"
+ .'- 1: ='."\n"
+ ."\n"
+ .'- 2: >'."\n"
+ ."\n"
+ .'- 3: <', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Name' => ['description' => 'The screen recording data field name. Screen recording data refers to the parameters passed when uploading a quality check task. These correspond to the table headers on the quality check results list page. The actual values are in English. For example, agent name maps to customerName. For more available fields and their English names, see the request parameters in the corresponding quality check data upload API documentation.', 'type' => 'string', 'example' => 'customerName', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'SamplingMode' => [
'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'NumberOfDraws' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'AnyNumberOfDraws' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '60',
- ],
- 'Limit' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'Proportion' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.1',
- ],
- 'Dimension' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Designated' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RandomInspectionNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'SamplingModeAgents' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'SamplingModeAgent' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'AgentName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'zhangsan',
- ],
- 'AgentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Count\\": 23,\\n \\"Data\\": {\\n \\"TaskAssignRuleInfo\\": [\\n {\\n \\"UpdateTime\\": \\"2019-07-12T14:47Z\\",\\n \\"SkillGroupsStr\\": \\"XX\\",\\n \\"CallTimeEnd\\": 39600,\\n \\"DurationMax\\": 400,\\n \\"CreateTime\\": \\"2019-07-12T14:47Z\\",\\n \\"Priority\\": 1,\\n \\"DurationMin\\": 100,\\n \\"AgentsStr\\": \\"XX\\",\\n \\"RuleName\\": \\"分配规则\\",\\n \\"RuleId\\": 23,\\n \\"AssignmentType\\": 0,\\n \\"CallType\\": 1,\\n \\"Enabled\\": 1,\\n \\"CallTimeStart\\": 39600,\\n \\"Agents\\": {\\n \\"Agent\\": [\\n {\\n \\"AgentName\\": \\"agent\\",\\n \\"AgentId\\": \\"202526561358712105\\"\\n }\\n ]\\n },\\n \\"SkillGroups\\": {\\n \\"SkillGroup\\": [\\n {\\n \\"SkillName\\": \\"客服组\\",\\n \\"SkillId\\": \\"XXX\\"\\n }\\n ]\\n },\\n \\"Reviewers\\": {\\n \\"Reviewer\\": [\\n {\\n \\"ReviewerId\\": \\"2337235457340978\\",\\n \\"ReviewerName\\": \\"客服审核1\\"\\n }\\n ]\\n },\\n \\"Rules\\": {\\n \\"RuleBasicInfo\\": [\\n {\\n \\"Name\\": \\"用户可能要投诉\\",\\n \\"Rid\\": \\"2312\\"\\n }\\n ]\\n },\\n \\"SamplingMode\\": {\\n \\"NumberOfDraws\\": 20,\\n \\"AnyNumberOfDraws\\": 60,\\n \\"Limit\\": 30,\\n \\"Proportion\\": 0.1,\\n \\"Dimension\\": 0,\\n \\"Designated\\": true,\\n \\"RandomInspectionNumber\\": 5,\\n \\"SamplingModeAgents\\": {\\n \\"SamplingModeAgent\\": [\\n {\\n \\"AgentName\\": \\"zhangsan\\",\\n \\"AgentId\\": \\"123\\"\\n }\\n ]\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTaskAssignRulesResponse>\\n <Message>successful</Message>\\n <PageSize>10</PageSize>\\n <RequestId>22DD33F3-C215-4F0F-A38A-360FC8C6D53D</RequestId>\\n <PageNumber>1</PageNumber>\\n <Data>\\n <TaskAssignRuleInfo>\\n <DurationMin>0</DurationMin>\\n <Priority>5</Priority>\\n <RuleId>16</RuleId>\\n <CreateTime>2019-07-12T14:47Z</CreateTime>\\n <CallType>0</CallType>\\n <UpdateTime>2020-01-09T16:26Z</UpdateTime>\\n <Agents>\\n <Agent>\\n <AgentId>202526561358712105</AgentId>\\n <AgentName>agent</AgentName>\\n </Agent>\\n </Agents>\\n <Enabled>0</Enabled>\\n <DurationMax>0</DurationMax>\\n <Reviewers>\\n <Reviewer>\\n <ReviewerId>268370362815185444</ReviewerId>\\n <ReviewerName>0710质检员</ReviewerName>\\n </Reviewer>\\n </Reviewers>\\n <Rules>\\n <RuleBasicInfo>\\n <Rid>12970</Rid>\\n <Name>看了</Name>\\n </RuleBasicInfo>\\n </Rules>\\n </TaskAssignRuleInfo>\\n </Data>\\n <Count>19</Count>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListTaskAssignRulesResponse>","errorExample":""}]',
+ 'staticInfo' => ['noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SkillGroupConfig\\": [\\n {\\n \\"Type\\": 1,\\n \\"Status\\": 1,\\n \\"UpdateTime\\": \\"2020-12-01T19:28Z\\\\t\\",\\n \\"AllContentQualityCheck\\": 1,\\n \\"CreateTime\\": \\"2020-12-01T15:12Z\\",\\n \\"SkillGroupId\\": \\"123\\",\\n \\"ScreenSwitch\\": true,\\n \\"InstanceId\\": \\"xxx\\",\\n \\"VocabId\\": 323,\\n \\"SkillGroupFrom\\": 0,\\n \\"Rid\\": \\"2221\\",\\n \\"SkillGroupName\\": \\"xxx\\",\\n \\"ModelName\\": \\"xxx\\",\\n \\"AllRids\\": \\"223\\",\\n \\"Name\\": \\"xxx\\",\\n \\"ModelId\\": 211,\\n \\"Id\\": 221,\\n \\"QualityCheckType\\": 0,\\n \\"VocabName\\": \\"xxx\\",\\n \\"RuleList\\": {\\n \\"RuleNameInfo\\": [\\n {\\n \\"RuleName\\": \\"x\'x\'x\\",\\n \\"Rid\\": 2221\\n }\\n ]\\n },\\n \\"AllRuleList\\": {\\n \\"RuleNameInfo\\": [\\n {\\n \\"RuleName\\": \\"test\\",\\n \\"Rid\\": 221\\n }\\n ]\\n },\\n \\"SkillGroupScreens\\": {\\n \\"SkillGroupScreen\\": [\\n {\\n \\"Value\\": \\"张三\\",\\n \\"DataType\\": 0,\\n \\"Symbol\\": 1,\\n \\"Name\\": \\"customerName\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Retrieve configuration list',
+ 'summary' => 'You can call ListSkillGroupConfig to obtain the configuration list.',
+ 'requestParamsDescription' => '### Request parameter JSON string'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :--------- | :------ | :------- | :--------------------------------------------------------------------------------------- |'."\n"
+ .'| pageNumber | Integer | Yes | The page number of the data to return. Default is 1. |'."\n"
+ .'| pageSize | Integer | Yes | The number of entries per page. Must be greater than 0 and less than 100. Default is 10. |'."\n"
+ .'| name | String | No | Search by configuration name. |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-29T06:47:50.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListSkillGroupConfig'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'DeleteTaskAssignRule' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListTag' => [
+ 'summary' => 'Queries the list of label nodes.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'systemTags' => [],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREsca27EUYZ'],
+ ],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"ruleId": 24}',
- ],
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the following detailed information.', 'type' => 'string', 'required' => false, 'example' => '“”', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The ID of the business space.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***'],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Other values indicate failure. You can use this field to determine the cause of the failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. true: The call was successful. false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Message' => ['description' => 'The error message, if any.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The returned data.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagId' => ['description' => 'The label ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '128', 'title' => ''],
+ 'Name' => ['description' => 'The label name.', 'type' => 'string', 'example' => '售后问题', 'title' => ''],
+ 'Description' => ['description' => 'The label description.', 'type' => 'string', 'example' => '用于归集售后服务相关的所有意图与 FAQ', 'title' => ''],
+ 'ParentTagId' => ['description' => 'The ID of the parent label node.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''],
+ 'ChildCount' => ['description' => 'The number of direct child nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'Level' => ['description' => 'The level of the current node.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'Path' => [
+ 'description' => 'The node path.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The node path.', 'type' => 'string', 'example' => '["售后服务","退款"]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'CreateTime' => ['description' => 'The time when the label was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1748428991000', 'title' => ''],
+ 'ModifyTime' => ['description' => 'The time when the label was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1748428991000', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of records that meet the conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''],
+ 'DataSize' => ['description' => 'The actual number of records returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'CurrentPage' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteTaskAssignRuleResponse>\\n <Message>successful</Message>\\n <RequestId>CB87B834-A048-43ED-8271-DDF85F6E9030</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteTaskAssignRuleResponse>\\n","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'CreateWarningConfig' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query label node list',
+ 'requestParamsDescription' => '| Field | Type | Required | Value | Description |'."\n"
+ .'|------|------|------|------|------|'."\n"
+ .'| parentTagId | Long | No | -1 | The ID of the parent label node. A value of -1 indicates the root node. |'."\n"
+ .'| nameKeyword | String | No | - | The keyword of the label name for fuzzy search. |'."\n"
+ .'| currentPage | Integer | No | 1 | The page number. Default value: 1. |'."\n"
+ .'| pageSize | Integer | No | 20 | The number of entries per page. Default value: 20. |',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"TagId\\": 128,\\n \\"Name\\": \\"售后问题\\",\\n \\"Description\\": \\"用于归集售后服务相关的所有意图与 FAQ\\",\\n \\"ParentTagId\\": -1,\\n \\"ChildCount\\": 5,\\n \\"Level\\": 2,\\n \\"Path\\": [\\n \\"[\\\\\\"售后服务\\\\\\",\\\\\\"退款\\\\\\"]\\"\\n ],\\n \\"CreateTime\\": 1748428991000,\\n \\"ModifyTime\\": 1748428991000\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 12,\\n \\"DataSize\\": 2,\\n \\"CurrentPage\\": 1\\n}","type":"json"}]',
+ ],
+ 'ListTaskAssignRules' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
+ 'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Complete JSON string information. See the details below for specific content.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"pageNumber":1,"pageSize":10}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -11675,79 +12370,271 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Callers can use this field to determine if the request succeeded: true for success, false/null for failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. **200** indicates success. Other values indicate failure. Callers can use this field to determine the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if an error occurs. "successful" if the request succeeds.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'PageNumber' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'Number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Count' => ['description' => 'Total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '23', 'title' => ''],
'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'TaskAssignRuleInfo' => [
+ 'description' => 'Detailed response data.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UpdateTime' => ['description' => 'Last update time.', 'type' => 'string', 'example' => '2019-07-12T14:47Z', 'title' => ''],
+ 'SkillGroupsStr' => ['description' => 'Deprecated field. Ignore it.', 'type' => 'string', 'example' => 'XX', 'title' => ''],
+ 'CallTimeEnd' => ['description' => 'End time of the call, in seconds. For example, 39600 for 11:00 AM.', 'type' => 'integer', 'format' => 'int64', 'example' => '39600', 'title' => ''],
+ 'DurationMax' => ['description' => 'Maximum call duration range, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''],
+ 'CreateTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2019-07-12T14:47Z', 'title' => ''],
+ 'Priority' => ['description' => 'Deprecated field. Ignore it.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'DurationMin' => ['description' => 'The minimum call duration in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'AgentsStr' => ['description' => 'Deprecated field. Ignore it.', 'type' => 'string', 'example' => 'XX', 'title' => ''],
+ 'RuleName' => ['description' => 'Rule name.', 'type' => 'string', 'example' => '分配规则', 'title' => ''],
+ 'RuleId' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '23', 'title' => ''],
+ 'AssignmentType' => ['description' => 'Assignment type. Possible values: 0 for specified assignment, 1 for random assignment.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'CallType' => ['description' => 'Call type. Possible values: 1 for outbound, 3 for inbound, 0 for unlimited.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Enabled' => ['description' => 'Deprecated field. Ignore it.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'CallTimeStart' => ['description' => 'End time of the call, in seconds. For example, 39600 for 11:00 AM.', 'type' => 'integer', 'format' => 'int64', 'example' => '39600', 'title' => ''],
+ 'Agents' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Agent' => [
+ 'description' => 'Agent list.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AgentName' => ['description' => 'Agent name.', 'type' => 'string', 'example' => 'agent', 'title' => ''],
+ 'AgentId' => ['description' => 'Agent user ID.', 'type' => 'string', 'example' => '202526561358712105', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'SkillGroups' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SkillGroup' => [
+ 'description' => 'Skill group list information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SkillName' => ['description' => 'Skill group name.', 'type' => 'string', 'example' => '客服组', 'title' => ''],
+ 'SkillId' => ['description' => 'Deprecated field. Ignore it.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Reviewers' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Reviewer' => [
+ 'description' => 'Reviewer information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ReviewerId' => ['description' => 'Reviewer user ID.', 'type' => 'string', 'example' => '2337235457340978', 'title' => ''],
+ 'ReviewerName' => ['description' => 'Reviewer name.', 'type' => 'string', 'example' => '客服审核1', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Rules' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'RuleBasicInfo' => [
+ 'description' => 'List of selected quality inspection rules.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'Quality inspection rule name.', 'type' => 'string', 'example' => '用户可能要投诉', 'title' => ''],
+ 'Rid' => ['description' => 'Quality inspection rule ID.', 'type' => 'string', 'example' => '2312', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'SamplingMode' => [
+ 'description' => 'Random allocation parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'NumberOfDraws' => ['description' => 'Number of files sampled per agent when specifying agents by agent dimension.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'AnyNumberOfDraws' => ['description' => 'Duration of call recordings sampled in time dimension mode, in minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''],
+ 'Limit' => ['description' => 'Upper limit for the number of sampled files.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
+ 'Proportion' => ['description' => 'Sampling proportion. 0.1 represents 10%.', 'type' => 'number', 'format' => 'float', 'example' => '0.1', 'title' => ''],
+ 'Dimension' => ['description' => 'Sampling mode. Possible values: 0 for session dimension, 1 for agent dimension, 2 for time dimension.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Designated' => ['description' => 'Indicates whether agents are specified when the sampling mode is by agent dimension.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RandomInspectionNumber' => ['description' => 'Number of agents randomly sampled when agents are not specified by agent dimension.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'SamplingModeAgents' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'SamplingModeAgent' => [
+ 'description' => 'List of agents when specifying agents by agent dimension.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AgentName' => ['description' => 'Agent username.', 'type' => 'string', 'example' => 'zhangsan', 'title' => ''],
+ 'AgentId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '30',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4D55C6',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"30\\",\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateWarningConfigResponse>\\n <Message>successful</Message>\\n <RequestId>0BB91762-5DDF-4D0B-876D-1D4F4C21AC28</RequestId>\\n <Data>31</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateWarningConfigResponse>\\n","errorExample":""}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Count\\": 23,\\n \\"Data\\": {\\n \\"TaskAssignRuleInfo\\": [\\n {\\n \\"UpdateTime\\": \\"2019-07-12T14:47Z\\",\\n \\"SkillGroupsStr\\": \\"XX\\",\\n \\"CallTimeEnd\\": 39600,\\n \\"DurationMax\\": 400,\\n \\"CreateTime\\": \\"2019-07-12T14:47Z\\",\\n \\"Priority\\": 1,\\n \\"DurationMin\\": 100,\\n \\"AgentsStr\\": \\"XX\\",\\n \\"RuleName\\": \\"分配规则\\",\\n \\"RuleId\\": 23,\\n \\"AssignmentType\\": 0,\\n \\"CallType\\": 1,\\n \\"Enabled\\": 1,\\n \\"CallTimeStart\\": 39600,\\n \\"Agents\\": {\\n \\"Agent\\": [\\n {\\n \\"AgentName\\": \\"agent\\",\\n \\"AgentId\\": \\"202526561358712105\\"\\n }\\n ]\\n },\\n \\"SkillGroups\\": {\\n \\"SkillGroup\\": [\\n {\\n \\"SkillName\\": \\"客服组\\",\\n \\"SkillId\\": \\"XXX\\"\\n }\\n ]\\n },\\n \\"Reviewers\\": {\\n \\"Reviewer\\": [\\n {\\n \\"ReviewerId\\": \\"2337235457340978\\",\\n \\"ReviewerName\\": \\"客服审核1\\"\\n }\\n ]\\n },\\n \\"Rules\\": {\\n \\"RuleBasicInfo\\": [\\n {\\n \\"Name\\": \\"用户可能要投诉\\",\\n \\"Rid\\": \\"2312\\"\\n }\\n ]\\n },\\n \\"SamplingMode\\": {\\n \\"NumberOfDraws\\": 20,\\n \\"AnyNumberOfDraws\\": 60,\\n \\"Limit\\": 30,\\n \\"Proportion\\": 0.1,\\n \\"Dimension\\": 0,\\n \\"Designated\\": true,\\n \\"RandomInspectionNumber\\": 5,\\n \\"SamplingModeAgents\\": {\\n \\"SamplingModeAgent\\": [\\n {\\n \\"AgentName\\": \\"zhangsan\\",\\n \\"AgentId\\": \\"123\\"\\n }\\n ]\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain the list of automatic allocation rules for review tasks.',
+ 'summary' => 'Lists automatic allocation rules for review tasks.',
+ 'requestParamsDescription' => '## Input Parameters'."\n"
+ ."\n"
+ .'| Property | Value Type | Is Required | Description |'."\n"
+ .'| :----------- | :--------- | :---------- | :-------------------------- |'."\n"
+ .'| pageSize | Integer | Yes | Number of entries per page. |'."\n"
+ .'| pageNumber | Integer | Yes | Current page number. |'."\n"
+ .'| skillName | String | No | Skill group name. |'."\n"
+ .'| agentName | String | No | Agent name. |'."\n"
+ .'| reviewerName | String | No | Reviewer name. |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTaskAssignRules'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'UpdateWarningConfig' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListUsers' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
+ 'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"ridList":[18130],"configName":"0310","channels":[{"type":1,"url":"https://sca.console.aliyun.com/#/warningConfig"}],"configId":29}',
- ],
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the details below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"pageNumber":1,"pageSize":10}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -11755,44 +12642,110 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. A value of true indicates success. A value of false or null indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The result code. A value of `200` indicates success. Other values indicate failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned. The value is successful if the request is successful. Otherwise, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Count' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'User' => [
+ 'description' => 'The detailed data returned.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DisplayName' => ['description' => 'The display name.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'UpdateTime' => ['description' => 'The time when the user was last updated.', 'type' => 'string', 'example' => '2020-03-11T16:54Z', 'title' => ''],
+ 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'XXX', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the user was created.', 'type' => 'string', 'example' => '2020-03-11T16:54Z', 'title' => ''],
+ 'LoginUserType' => ['description' => 'The account type. Valid values: 1 (Alibaba Cloud account) and 2 (RAM user).', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'AliUid' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '2951869706989****', 'title' => ''],
+ 'RoleName' => ['description' => 'The role. Valid values: ADMIN (administrator), QUALITY\\_INSPECTOR (quality inspector), and AGENT (agent).', 'type' => 'string', 'example' => 'AGENT', 'title' => ''],
+ 'UserName' => ['description' => 'The logon name.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'Id' => ['description' => 'This field is deprecated. Ignore it.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateWarningConfigResponse>\\n <Message>successful</Message>\\n <RequestId>106C6CA0-282D-4AF7-85F0-D2D24F4CE647</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UpdateWarningConfigResponse>","errorExample":""}]',
+ 'staticInfo' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Count\\": 12,\\n \\"Data\\": {\\n \\"User\\": [\\n {\\n \\"DisplayName\\": \\"xxx\\",\\n \\"UpdateTime\\": \\"2020-03-11T16:54Z\\",\\n \\"Description\\": \\"XXX\\",\\n \\"CreateTime\\": \\"2020-03-11T16:54Z\\",\\n \\"LoginUserType\\": 2,\\n \\"AliUid\\": \\"2951869706989****\\",\\n \\"RoleName\\": \\"AGENT\\",\\n \\"UserName\\": \\"xxx\\",\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Retrieve User List ',
+ 'summary' => 'Retrieves a list of users. Set the service endpoint to China (Hangzhou) (cn-hangzhou).',
+ 'requestParamsDescription' => '## Request parameters'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :---------- | :------ | :------- | :------------------------------ |'."\n"
+ .'| userName | String | No | The logon name. |'."\n"
+ .'| displayName | String | No | The display name. |'."\n"
+ .'| roleId | Integer | No | The role ID. |'."\n"
+ .'| pageSize | Long | Yes | The number of entries per page. |'."\n"
+ .'| pageNumber | String | Yes | The page number. |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:47.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-12-05T07:01:47.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListUsers'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
'ListWarningConfig' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -11804,24 +12757,12 @@
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"pageNumber":1,"pageSize":10}',
- ],
+ 'schema' => ['description' => 'Full JSON string. For details, see the parameter descriptions below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"pageNumber":1,"pageSize":10}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -11829,440 +12770,601 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4D55C6',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'Result code. A value of **200** indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request fails. Returns successful if the request succeeds.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4D55C6', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. A value of true means success. A value of false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'WarningConfigInfo' => [
- 'description' => '',
+ 'description' => 'Detailed response data.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ConfigName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'UpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-10-29T17:24Z',
- ],
- 'ConfigId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '32',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-10-29T15:30Z',
- ],
+ 'Status' => ['description' => 'Enabled status. Valid values: 0 (disabled), 1 (enabled).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ConfigName' => ['description' => 'Warning configuration name.', 'type' => 'string', 'example' => '投诉预警', 'title' => ''],
+ 'UpdateTime' => ['description' => 'Last update time.', 'type' => 'string', 'example' => '2019-10-29T17:24Z', 'title' => ''],
+ 'ConfigId' => ['description' => 'Warning configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''],
+ 'CreateTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2019-10-29T15:30Z', 'title' => ''],
'RuleList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'WarningRule' => [
- 'description' => '',
+ 'description' => 'List of rules configured for this warning.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'Warning rule list',
'type' => 'object',
'properties' => [
- 'RuleName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '33452',
- ],
+ 'RuleName' => ['description' => 'Rule name.', 'type' => 'string', 'example' => '客户可能要投诉', 'title' => ''],
+ 'Rid' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '33452', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'Channels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Channel' => [
- 'description' => '',
+ 'description' => 'Notification channel.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'Notification channel.',
'type' => 'object',
'properties' => [
- 'Type' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Url' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'oapi.dingtalk.com/robot/send?access_token=c55628f700eb9ad2a3ca',
- ],
+ 'Type' => ['description' => 'Notification type. Valid values: 0 (DingTalk), 1 (callback).', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Url' => ['description' => 'Notification URL.', 'type' => 'string', 'example' => 'oapi.dingtalk.com/robot/send?access_token=c55628f700eb9ad2a3ca', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'RidList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RidList' => [
- 'description' => '',
+ 'description' => 'List of rule IDs configured for this warning.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '[5767,5647]',
- ],
+ 'items' => ['description' => 'List of rule IDs configured for this warning.', 'type' => 'string', 'example' => '[5767,5647]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"WarningConfigInfo\\": [\\n {\\n \\"Status\\": 1,\\n \\"ConfigName\\": \\"投诉预警\\",\\n \\"UpdateTime\\": \\"2019-10-29T17:24Z\\",\\n \\"ConfigId\\": 32,\\n \\"CreateTime\\": \\"2019-10-29T15:30Z\\",\\n \\"RuleList\\": {\\n \\"WarningRule\\": [\\n {\\n \\"RuleName\\": \\"客户可能要投诉\\",\\n \\"Rid\\": 33452\\n }\\n ]\\n },\\n \\"Channels\\": {\\n \\"Channel\\": [\\n {\\n \\"Type\\": 0,\\n \\"Url\\": \\"oapi.dingtalk.com/robot/send?access_token=c55628f700eb9ad2a3ca\\"\\n }\\n ]\\n },\\n \\"RidList\\": {\\n \\"RidList\\": [\\n \\"[5767,5647]\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListWarningConfigResponse>\\n <Message>successful</Message>\\n <RequestId>3137EFD8-7173-42E1-A85C-D4EC9EB98DF8</RequestId>\\n <Data>\\n <WarningConfigInfo>\\n <Status>0</Status>\\n <RuleList>\\n <WarningRule>\\n <Rid>5818</Rid>\\n <RuleName>1111111</RuleName>\\n </WarningRule>\\n <WarningRule>\\n <Rid>5819</Rid>\\n <RuleName>4444444</RuleName>\\n </WarningRule>\\n </RuleList>\\n <ConfigName>test01</ConfigName>\\n <CreateTime>2019-10-29T15:30Z</CreateTime>\\n <UpdateTime>2019-10-29T17:24Z</UpdateTime>\\n <RidList>\\n <RidList>5819</RidList>\\n <RidList>5818</RidList>\\n </RidList>\\n <ConfigId>16</ConfigId>\\n <Channels>\\n <Channel>\\n <Type>0</Type>\\n <Url>oapi.dingtalk.com/robot/send?access_token=c55628f700eb9ad2a3cafbd90cdb91532fd2b6b0c796ab08b5c4dca795ee7b60</Url>\\n </Channel>\\n </Channels>\\n </WarningConfigInfo>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListWarningConfigResponse>","errorExample":""}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"WarningConfigInfo\\": [\\n {\\n \\"Status\\": 1,\\n \\"ConfigName\\": \\"投诉预警\\",\\n \\"UpdateTime\\": \\"2019-10-29T17:24Z\\",\\n \\"ConfigId\\": 32,\\n \\"CreateTime\\": \\"2019-10-29T15:30Z\\",\\n \\"RuleList\\": {\\n \\"WarningRule\\": [\\n {\\n \\"RuleName\\": \\"客户可能要投诉\\",\\n \\"Rid\\": 33452\\n }\\n ]\\n },\\n \\"Channels\\": {\\n \\"Channel\\": [\\n {\\n \\"Type\\": 0,\\n \\"Url\\": \\"oapi.dingtalk.com/robot/send?access_token=c55628f700eb9ad2a3ca\\"\\n }\\n ]\\n },\\n \\"RidList\\": {\\n \\"RidList\\": [\\n \\"[5767,5647]\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain the warning configuration list ',
+ 'summary' => 'Lists warning configurations.',
+ 'requestParamsDescription' => '## Request parameters'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :--------- | :------ | :------- | :-------------------------- |'."\n"
+ .'| pageSize | Integer | Yes | Number of entries per page. |'."\n"
+ .'| pageNumber | Integer | Yes | Page number. |'."\n"
+ .'| configName | String | No | Configuration name. |'."\n"
+ .'| ruleName | String | No | Rule name. |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:46.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListWarningConfig'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'DeleteWarningConfig' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'RevertAssignedSession' => [
+ 'summary' => 'Frontend location: Task Management > Task Results > Batch Revoke. Apsara Stack URL: ip:port/api/job/RevertAssignedSession.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'JsonStr',
+ 'name' => 'jsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"configId": "31"}',
- ],
+ 'schema' => ['description' => 'Input JSON. For details, see the request parameter description.', 'type' => 'string', 'required' => false, 'example' => '{"isSchemeData":1,"searchParam":{"schemeTaskConfigId":1,"sourceDataType":1,"startTime":"2022-09-20 00:00:00","endTime":"2022-09-26 23:59:59"}}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'BaseResult',
+ 'description' => 'Base result object',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4D55C6',
- ],
- 'Success' => [
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4D55C6', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Set to true for success. Set to false or null for failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. A value of **200** indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request failed. Returns **successful** if the request succeeded.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Messages' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Message' => [
+ 'description' => 'List of messages. Ignore this field.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Message text. Ignore this field.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteWarningConfigResponse>\\n <Code>200</Code>\\n <RequestId>D1436A84-8A33-4416-ACC9-94D0247C6DA8</RequestId>\\n <Success>true</Success>\\n <Message>successful</Message>\\n</DeleteWarningConfigResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Batch Revoke (Single-channel Session Dimension) ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RevertAssignedSession'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'CreateSkillGroupConfig' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'RevertAssignedSessionGroup' => [
+ 'summary' => 'You can use this feature in the frontend console under Plan Management > Task Result > Session Group > Batch Revoke. The Apsara Stack URL for this operation is `ip:port/api/job/RevertAssignedSessionGroup.json`.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '56147',
- 'abilityTreeNodes' => [
- 'FEATUREsca6QWO0D',
- 'FEATUREscaKR8LQC',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '153844',
+ 'abilityTreeNodes' => ['FEATUREscaAJDYMI'],
],
'parameters' => [
[
- 'name' => 'JsonStr',
+ 'name' => 'jsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"skillGroupFrom":0,"qualityCheckType":0,"modelId":746,"name":"test","rid":"2493","vocabId":"267","skillGroupList":[{"skillGroupId":"0903","skillGroupName":"0903"}]}',
- ],
+ 'schema' => ['description' => 'For more information, see the description of the request parameters.', 'type' => 'string', 'required' => false, 'example' => '{"isSchemeData":1,"forceRevertSessionGroup":true,"sessionGroupIdList":["1"]}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The ID of the baseMeAgent.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'BaseResult',
+ 'description' => 'BaseResult',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '223',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** ',
- ],
- 'Success' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.'."\n"
+ ."\n"
+ .'The caller can use this field to determine whether the request succeeded.'."\n"
+ ."\n"
+ .'- **true**: The request was successful.'."\n"
+ ."\n"
+ .'- false or **null**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Other values indicate failure. Use this code to identify the cause of a failed request.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'If the request fails, this parameter provides error details. If the request succeeds, the value is \\`successful\\`.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Messages' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Message' => [
+ 'description' => 'Provides error details when the request fails. This parameter is used when multiple messages are returned.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Provides error details when the request fails. This parameter is used when multiple messages are returned.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": 223,\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>successful</Message>\\n<RequestId>0A2B7B10-0938-45C2-BAA4-***</RequestId>\\n<Data>553</Data>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'staticInfo' => ['noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Batch Revoke (Session Group Dimension) ',
+ 'requestParamsDescription' => '### JsonStr description'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| -------------- | ------- | ------------------------------------ | ------------------------------------------------------------------------------------------------ |'."\n"
+ .'| isSchemeData | Integer | Yes | The value must be 1. |'."\n"
+ .'| searchParam | Json | Required to export all results. | The parameters are the same as the request parameters of the GetResult API operation. |'."\n"
+ .'| \\-- taskIdList | List | Required to export selected results. | The ID of the selected quality inspection task. |'."\n"
+ .'| \\-- fileIdList | List | Required to export selected results. | The tId, vid, or fileId of the selected quality inspection task. These three IDs are equivalent. |',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RevertAssignedSessionGroup'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'UpdateSkillGroupConfig' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'RunCompletionMessage' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'deprecated' => true,
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '56245',
- 'abilityTreeNodes' => [
- 'FEATUREsca6QWO0D',
- 'FEATUREscaKR8LQC',
- ],
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREscaKP9JUP'],
],
'parameters' => [
[
- 'name' => 'JsonStr',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"skillGroupFrom":0,"name":"test","qualityCheckType":0,"rid":"2493,4098","vocabId":267,"skillGroupList":[{"skillGroupId":"090311","skillGroupName":"09031"}],"id":553}',
- ],
+ 'name' => 'ModelCode',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The model specification to use. Valid values: `TYXM_PLUS` and `TYXM_TURBO`.', 'type' => 'string', 'required' => false, 'example' => 'TYXM_PLUS', 'title' => ''],
],
[
- 'name' => 'BaseMeAgentId',
- 'in' => 'query',
+ 'name' => 'Messages',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Role' => ['description' => 'The role of the message sender. Valid values: `user`, `agent`, `system`, and `function`.', 'type' => 'string', 'required' => false, 'example' => 'user', 'title' => ''],
+ 'Content' => ['description' => 'The content of the message.', 'type' => 'string', 'required' => false, 'example' => '请用50字总结一下对话', 'title' => ''],
+ ],
+ 'description' => 'The structure of a message object.',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'A list of messages that form the conversation history and the current prompt.',
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'Stream',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Specifies whether to stream the response using Server-Sent Events (SSE). If `true`, the response is streamed. Defaults to `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '38E7E948-0876-4FEE-B0AA-6*****',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'title' => '', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***'],
+ 'Code' => ['description' => 'The status code. A value of `200` indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message if the request fails. This field returns **successful** if the request succeeds.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. A value of true or null indicates success, while false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'LlmRequestId' => ['description' => 'The request ID from the large model.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***', 'title' => ''],
+ 'FinishReason' => ['description' => 'The reason the model stopped generating output. For streaming responses, this value is `null` until the final message. It is set to `stop` if generation ended because a stop token was reached.', 'type' => 'string', 'example' => 'stop', 'title' => ''],
+ 'Text' => ['description' => 'The text output generated by the large model.', 'type' => 'string', 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。', 'title' => ''],
+ 'InputTokens' => ['description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'OutputTokens' => ['description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'TotalTokens' => ['description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '300', 'title' => ''],
+ ],
+ 'description' => 'The returned data.',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'description' => 'The response schema.',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"38E7E948-0876-4FEE-B0AA-6*****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>successful</Message>\\n<RequestId>38E7E948-0876-4FEE-B0AA-6DBAE9EB4***</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'GetSkillGroupConfig' => [
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid Param %s .', 'description' => 'Illegal parameter'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'RunCompletionMessage',
+ 'summary' => 'This operation calls a large model using the message protocol to generate a response. You can make calls using standard HTTP for a complete response or use Server-Sent Events (SSE) for a streaming response.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LlmRequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"FinishReason\\": \\"stop\\",\\n \\"Text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。\\",\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 200,\\n \\"TotalTokens\\": 300\\n }\\n}","type":"json"}]',
+ ],
+ 'SaveConfigDataSet' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '56199',
- 'abilityTreeNodes' => [
- 'FEATUREscaKR8LQC',
- 'FEATUREsca6QWO0D',
- ],
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '56228',
+ 'abilityTreeNodes' => ['FEATUREsca81P1AQ'],
],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
+ 'schema' => ['description' => 'A complete JSON string. For details, see the following information.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"{"judgeType":1,"setId":851,"jsonStrForRule":{"conditions":[{"cid":"1","check_range":{},"lambda":"1","operators":[{"oid":1,"type":"HIT_ANY_KEYWORDS","param":{"keywords":["有什么可以帮您","客服中心"],"in_sentence":false}}]}],"rules":[{"externalProperty":0,"lambda":"1","rid":"1"}],"roleJudgeMethod":"keyword"},"channelType":1}"', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'baseMeAgentId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message if the request fails. If the request succeeds, the value is successful.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F050E835-4E5B-4799-BAE3-D622DC529AB3', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. A value of true means success. A value of false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
+ 'title' => '',
'example' => '',
],
],
+ ],
+ 'staticInfo' => ['noSubstitutionReason' => '暂无替代API,请关注后续API最新发布。'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F050E835-4E5B-4799-BAE3-D622DC529AB3\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Save Speaker Role Configuration for Dataset',
+ 'summary' => 'Saves the speaker role configuration for a dataset.',
+ 'requestParamsDescription' => '### JSON String for Request Parameters'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| setId | Long | Yes | The ID of the dataset. |'."\n"
+ .'| channelType | Integer | Yes | The audio file type. Valid values: 1 (mono) or 2 (stereo). |'."\n"
+ .'| jsonStrForRule | String | No | A JSON-formatted rule. Required for mono files. For stereo files, this rule determines which channel is the agent channel. For more information, see the jsonStrForRule description below. |'."\n"
+ .'| channelId0 | Integer | No | Required for stereo files. The channel number for the agent. Valid values: 0 or 1. For example, if the agent is on channel 0, set this value to 0. |'."\n"
+ .'| channelId1 | Integer | No | Required for stereo files. The channel number for the customer. Valid values: 0 or 1. For example, if the customer is on channel 1, set this value to 1. |'."\n"
+ ."\n"
+ .'## jsonStrForRule Description'."\n"
+ ."\n"
+ .'The jsonStrForRule field defines a quality inspection rule. This rule contains only one keyword-matching condition. Use the fixed format shown below. You can only change the keywords array.'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{"conditions":[{"cid":"1","check_range":{},"lambda":"1","operators":[{"oid":1,"type":"HIT_ANY_KEYWORDS","param":{"keywords":["what can I help you with","customer service center"],"in_sentence":false}}]}],"rules":[{"externalProperty":0,"lambda":"1","rid":"1"}],"roleJudgeMethod":"keyword"}'."\n"
+ .'```',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-11-05T08:04:48.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SaveConfigDataSet'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'SubmitComplaint' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A JSON string that contains the complaint details. For more information, see the following table.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"taskId":"ADCA1DE6-8117-472A-B3A1-352A248F90D0","fileId":"653e563d-774f-4f01-a809-cb8bb920c3e6","rid":1346,"comments":"请重新判定"}', 'title' => ''],
+ ],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The business space ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
@@ -12270,239 +13372,92 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** ',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'UpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-12-01T19:28Z',
- ],
- 'AllContentQualityCheck' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-12-01T15:12Z',
- ],
- 'SkillGroupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '111',
- ],
- 'InstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'VocabId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123',
- ],
- 'SkillGroupFrom' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2332',
- ],
- 'SkillGroupName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'ModelName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'AllRids' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '223',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'ModelId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1321',
- ],
- 'Id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1212',
- ],
- 'QualityCheckType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'VocabName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'RuleList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'RuleNameInfo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'RuleName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '222',
- ],
- ],
- ],
- ],
- ],
- ],
- 'AllRuleList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'RuleNameInfo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'RuleName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Other values indicate failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The response message. If the request is successful, "successful" is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'The current quality check score.', 'type' => 'string', 'example' => '90', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4D55C6', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. A value of `true` indicates success, and a value of `false` or `null` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Type\\": 1,\\n \\"Status\\": 0,\\n \\"UpdateTime\\": \\"2020-12-01T19:28Z\\",\\n \\"AllContentQualityCheck\\": 1,\\n \\"CreateTime\\": \\"2020-12-01T15:12Z\\",\\n \\"SkillGroupId\\": \\"111\\",\\n \\"InstanceId\\": \\"xxx\\",\\n \\"VocabId\\": 123,\\n \\"SkillGroupFrom\\": 0,\\n \\"Rid\\": \\"2332\\",\\n \\"SkillGroupName\\": \\"xxx\\",\\n \\"ModelName\\": \\"xxx\\",\\n \\"AllRids\\": \\"223\\",\\n \\"Name\\": \\"xxx\\",\\n \\"ModelId\\": 1321,\\n \\"Id\\": 1212,\\n \\"QualityCheckType\\": 0,\\n \\"VocabName\\": \\"test\\",\\n \\"RuleList\\": {\\n \\"RuleNameInfo\\": [\\n {\\n \\"RuleName\\": \\"test\\",\\n \\"Rid\\": 222\\n }\\n ]\\n },\\n \\"AllRuleList\\": {\\n \\"RuleNameInfo\\": [\\n {\\n \\"RuleName\\": \\"test\\",\\n \\"Rid\\": 12\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>6FB2B950-FB76-4752-8E56-044A65***</RequestId>\\n<Message>successful</Message>\\n<Data>\\n <Status>1</Status>\\n <RuleList>\\n <RuleNameInfo>\\n <Rid>3316</Rid>\\n <RuleName>围巾2</RuleName>\\n </RuleNameInfo>\\n </RuleList>\\n <VocabId>0</VocabId>\\n <QualityCheckType>0</QualityCheckType>\\n <AllContentQualityCheck>0</AllContentQualityCheck>\\n <CreateTime>2020-12-01T15:12Z</CreateTime>\\n <SkillGroupId/>\\n <Rid>3316</Rid>\\n <Name>15个技能组测试</Name>\\n <Type>1</Type>\\n <SkillGroupName/>\\n <UpdateTime>2020-12-01T19:28Z</UpdateTime>\\n <Id>468</Id>\\n <ModelId>746</ModelId>\\n <SkillGroupFrom>0</SkillGroupFrom>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"90\\",\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Submit Appeal ',
+ 'summary' => 'Submits a complaint.',
+ 'requestParamsDescription' => '### JsonStr parameter'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| taskId | String | Yes | The task ID. |'."\n"
+ .'| fileId | String | Yes | The file ID. This ID is equivalent to the `Tid` or `CallId` in the data upload API. If you do not specify this parameter, the system automatically generates a file ID. You can call the `GetResult` or `GetResultToReview` operation to obtain the generated ID. |'."\n"
+ .'| rid | Long | No | The rule ID. Do not specify this parameter if the complaint is for a manually scored item. |'."\n"
+ .'| comments | String | Yes | The complaint reason. |'."\n"
+ .'| withdraw | Boolean | No | Specifies whether to withdraw the complaint. Default value: `false`. |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SubmitComplaint'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'ListSkillGroupConfig' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'SubmitPrecisionTask' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'deprecated' => true,
- 'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '56218',
- 'abilityTreeNodes' => [
- 'FEATUREscaKR8LQC',
- 'FEATUREsca6QWO0D',
- ],
- ],
+ 'operationType' => 'write',
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"pageNumber":1,"pageSize": 1}',
- ],
+ 'schema' => ['description' => 'A complete JSON string. See the detailed information below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"{"name":"test","dataSetId":1865}"', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -12510,290 +13465,112 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** ',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'SkillGroupConfig' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'UpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-12-01T19:28Z ',
- ],
- 'AllContentQualityCheck' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-12-01T15:12Z',
- ],
- 'SkillGroupId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'ScreenSwitch' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'InstanceId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'VocabId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '323',
- ],
- 'SkillGroupFrom' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2221',
- ],
- 'SkillGroupName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'ModelName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'AllRids' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '223',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'ModelId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '211',
- ],
- 'Id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '221',
- ],
- 'QualityCheckType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'VocabName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'RuleList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'RuleNameInfo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'RuleName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'x\'x\'x',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2221',
- ],
- ],
- ],
- ],
- ],
- ],
- 'AllRuleList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'RuleNameInfo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'RuleName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '221',
- ],
- ],
- ],
- ],
- ],
- ],
- 'SkillGroupScreens' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'SkillGroupScreen' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Value' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'DataType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Symbol' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'customerName',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => 'Result code. A value of **200** indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the call fails. Returns successful if the call succeeds.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'ID of the created task.', 'type' => 'string', 'example' => 'EA701F66-8CA2-4A79-8E3C-A6F2FA****', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. true means success. false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SkillGroupConfig\\": [\\n {\\n \\"Type\\": 1,\\n \\"Status\\": 1,\\n \\"UpdateTime\\": \\"2020-12-01T19:28Z\\\\t\\",\\n \\"AllContentQualityCheck\\": 1,\\n \\"CreateTime\\": \\"2020-12-01T15:12Z\\",\\n \\"SkillGroupId\\": \\"123\\",\\n \\"ScreenSwitch\\": true,\\n \\"InstanceId\\": \\"xxx\\",\\n \\"VocabId\\": 323,\\n \\"SkillGroupFrom\\": 0,\\n \\"Rid\\": \\"2221\\",\\n \\"SkillGroupName\\": \\"xxx\\",\\n \\"ModelName\\": \\"xxx\\",\\n \\"AllRids\\": \\"223\\",\\n \\"Name\\": \\"xxx\\",\\n \\"ModelId\\": 211,\\n \\"Id\\": 221,\\n \\"QualityCheckType\\": 0,\\n \\"VocabName\\": \\"xxx\\",\\n \\"RuleList\\": {\\n \\"RuleNameInfo\\": [\\n {\\n \\"RuleName\\": \\"x\'x\'x\\",\\n \\"Rid\\": 2221\\n }\\n ]\\n },\\n \\"AllRuleList\\": {\\n \\"RuleNameInfo\\": [\\n {\\n \\"RuleName\\": \\"test\\",\\n \\"Rid\\": 221\\n }\\n ]\\n },\\n \\"SkillGroupScreens\\": {\\n \\"SkillGroupScreen\\": [\\n {\\n \\"Value\\": \\"张三\\",\\n \\"DataType\\": 0,\\n \\"Symbol\\": 1,\\n \\"Name\\": \\"customerName\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>302B38F2-FEA9-4EE2-BCBC-9C953***</RequestId>\\n<Message>successful</Message>\\n<Data>\\n <SkillGroupConfig>\\n <Status>1</Status>\\n <RuleList>\\n <RuleNameInfo>\\n <Rid>3316</Rid>\\n <RuleName>客服组</RuleName>\\n </RuleNameInfo>\\n </RuleList>\\n <ModelName>通用模型</ModelName>\\n <VocabId>0</VocabId>\\n <QualityCheckType>0</QualityCheckType>\\n <AllContentQualityCheck>0</AllContentQualityCheck>\\n <CreateTime>2020-12-01T15:12Z</CreateTime>\\n <SkillGroupId/>\\n <Rid>3316</Rid>\\n <Name>客服部</Name>\\n <Type>1</Type>\\n <SkillGroupName/>\\n <UpdateTime>2020-12-01T19:28Z</UpdateTime>\\n <Id>468</Id>\\n <ModelId>746</ModelId>\\n <SkillGroupFrom>0</SkillGroupFrom>\\n </SkillGroupConfig>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"EA701F66-8CA2-4A79-8E3C-A6F2FA****\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Create a Speech Recognition Detection Job',
+ 'summary' => 'Creates a speech recognition evaluation task. The service endpoint is China East 1 (Hangzhou) (cn-hangzhou).',
+ 'requestParamsDescription' => '## JSON string for request parameters'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :-------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| type | Integer | No | Task type. Valid values: 1 (accuracy task) and 2 (model comparison task). Default value: 1. |'."\n"
+ .'| name | String | No | Task name. Required when you create an accuracy task. |'."\n"
+ .'| dataSetId | Long | No | Dataset ID. Each task supports only one dataset. Required when you create an accuracy task. |'."\n"
+ .'| precisionTaskId | String | No | Accuracy task ID. Required when you create a model comparison task. This is the ID of the accuracy task that you want to compare. |'."\n"
+ .'| modelId | Long | No | Model ID. Required when you create a model comparison task. |'."\n"
+ ."\n"
+ .'### Example request body for creating an accuracy task:'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "name":"test",'."\n"
+ .' "dataSetId":18**'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### Example request body for creating a model comparison task:'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "modelId":97**,'."\n"
+ .' "type":2,'."\n"
+ .' "precisionTaskId":"593A04C0-E6E9-4CDC-8C99-B12*****",'."\n"
+ .' "dataSetId":1**'."\n"
+ .'}'."\n"
+ .'```',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:45.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SubmitPrecisionTask'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'DeleteSkillGroupConfig' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'SubmitQualityCheckTask' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'deprecated' => true,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'abilityTreeCode' => '56157',
- 'abilityTreeNodes' => [
- 'FEATUREscaKR8LQC',
- 'FEATUREsca6QWO0D',
- ],
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"id":552}',
- ],
+ 'schema' => ['description' => 'The complete JSON string. For details, see the following sections.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"{"jobName":"任务 2020-03-19 14:16:55","jobType":0,"jsonStr":{"dataSetIds":[123**],"modeCustomizationId":"046db35352904c5dbb0564****","ruleIds":[185**,185**],"vocabId":"0f0cd63546c747bcb306bb05***"}}"', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -12801,182 +13578,366 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** ',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'Result code. **200** indicates success. Any other value indicates failure. Use this field to determine the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request failed. Returns "successful" on success.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'Task ID.', 'type' => 'string', 'example' => 'F6C2B68F-2311-4495-82AC-DAE86C9****', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '00A044A2-D59B-4104-96BA-84060AE8345F', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. true means success. false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>successful</Message>\\n<RequestId>38E7E948-0876-4FEE-B0AA-6DBAE9EB***</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"F6C2B68F-2311-4495-82AC-DAE86C9****\\",\\n \\"RequestId\\": \\"00A044A2-D59B-4104-96BA-84060AE8345F\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Create a dataset quality inspection job',
+ 'summary' => 'Create a new dataset quality check task.',
+ 'requestParamsDescription' => '## Request parameter details'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------ |'."\n"
+ .'| jsonStr | String | Yes | The complete JSON string. For details, see the following sections. |'."\n"
+ .'| jobName | String | No | Task name. |'."\n"
+ .'| jobType | Integer | No | Task type: 0 for a standard dataset task. Always use 0. |'."\n"
+ .'| scheduledFireTime | String | No | Scheduled task running time in yyyy-MM-dd HH:mm:ss format. Must not be earlier than the current time. Leave empty to run immediately. |'."\n"
+ ."\n"
+ .'### JSON string structure for request parameters'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------------------ | :----- | :------- | :--------------------- |'."\n"
+ .'| dataSetIds | List | Yes | Dataset ID collection. |'."\n"
+ .'| ruleIds | List | Yes | Rule ID collection. |'."\n"
+ .'| modeCustomizationId | String | Yes | Language model ID. |'."\n"
+ .'| vocabId | String | No | Hotword model ID. |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SubmitQualityCheckTask'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'ApplyWsToken' => [
- 'summary' => '申领实时语音所需token',
- 'methods' => [
- 'post',
+ 'SubmitReviewInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The complete JSON string information. See the following details for specific content.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{'."\n"
+ .' "taskId": "任务ID",'."\n"
+ .' "vid": "文件ID"'."\n"
+ .'}', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ ],
],
- 'schemes' => [
- 'https',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The result code. 200 indicates success.'."\n"
+ ."\n"
+ .'> If the value is different, it indicates failure. Callers can use this field to determine the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Indicates error details on failure, or **successful** on success.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'Returns the quality inspection score after review upon successful saving.', 'type' => 'string', 'example' => '95', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '9987D326-83D9-4A42-B9A5-0B27F9B40539', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.'."\n"
+ ."\n"
+ .'Callers can use this field to determine if the request was successful:'."\n"
+ ."\n"
+ .'- true indicates success'."\n"
+ ."\n"
+ .'- false/null indicates failure', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"95\\",\\n \\"RequestId\\": \\"9987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Save review result (Smart Conversation Analysis legacy version only) ',
+ 'summary' => 'Save review results. This is only supported by the legacy Smart Conversation Analysis.',
+ 'description' => 'You can manually review files after quality inspection. After completing the review, call this API to save the review results. This involves manually reviewing rules identified by the system as hits to determine if they are true hits or false positives. Refer to the file review feature on the console page. For more information, see [File Review](https://help.aliyun.com/document_detail/139653.html#h2-u6587u4EF6u590Du68385).',
+ 'requestParamsDescription' => '**Request Parameter JSON String Information**'."\n"
+ ."\n"
+ .'| Property | Value Type | Required | Description |'."\n"
+ .'| :--------------- | :--------- | :------- | :-------------------------------------------------------------------------------- |'."\n"
+ .'| taskId | String | Yes | Task ID |'."\n"
+ .'| vid | String | Yes | File ID: A string, which is the vid in GetResultToReview. |'."\n"
+ .'| comments | String | No | Review comments |'."\n"
+ .'| handScoreIdList | List | No | The ID of the sub-scoring item when adding manual scores. Example: [1345, 1422] |'."\n"
+ .'| jsonReviewResult | String | No | The review result for specific rules, a JSON string with the following structure. |'."\n"
+ ."\n"
+ .'**Request Parameter jsonReviewResult Structure Information**'."\n"
+ ."\n"
+ .'| Property | Value Type | Required | Description |'."\n"
+ .'| :--------------- | :--------- | :------- | :--------------------------------------- |'."\n"
+ .'| reviewInfoList | List | Yes | Review structure information |'."\n"
+ .'| complainInfoList | List | No | Complaint handling structure information |'."\n"
+ ."\n"
+ .'**Request Parameter ReviewInfo Structure Information**'."\n"
+ ."\n"
+ .'| Property | Value Type | Required | Description |'."\n"
+ .'| :----------- | :--------- | :------- | :--------------------------------------------------------------- |'."\n"
+ .'| rid | Long | Yes | Rule ID |'."\n"
+ .'| hitId | String | Yes | Hit ID, query in GetResultToReview |'."\n"
+ .'| reviewResult | Integer | Yes | Is it a true hit: 0: No; 1: Yes |'."\n"
+ .'| changed | Boolean | No | Whether this rule was modified in this operation. Default: false |'."\n"
+ ."\n"
+ .'**Request Parameter ComplainParam Structure Information**'."\n"
+ ."\n"
+ .'| Property | Value Type | Required | Description |'."\n"
+ .'| :--------- | :--------- | :------- | :------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| rid | Long | No | Rule ID: Leave blank if the complaint is for a manual scoring item. |'."\n"
+ .'| scoreId | Long | No | Scoring item ID: Leave blank if the complaint is for a scoring item associated with a rule. |'."\n"
+ .'| comments | String | Yes | Reason |'."\n"
+ .'| accept | Boolean | No | Whether to accept the complaint. true: Yes; false: No. Default: true |'."\n"
+ .'| finalJudge | Boolean | No | Whether it is a final review. No further complaints are allowed after a final review. true: Yes; false: No. Default: false |',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => '### Invocation Sample '."\n"
+ ."\n"
+ .'```'."\n"
+ .'public SubmitReviewInfoResponse submitReviewInfo(String taskId, String vid, String fileId, GetResultToReviewResponse.Data.HitRuleReviewInfo hitInfo) throws ClientException {'."\n"
+ .' SubmitReviewInfoRequest request = new SubmitReviewInfoRequest();'."\n"
+ .' request.setAcceptFormat(FormatType.JSON);'."\n"
+ .' Map<String, Object> submitReviewMap = Maps.newHashMap();'."\n"
+ .' submitReviewMap.put("taskId", taskId);'."\n"
+ .' submitReviewMap.put("comments","Review comments");'."\n"
+ .' submitReviewMap.put("fileId","1500");'."\n"
+ .' submitReviewMap.put("vid", vid);'."\n"
+ .' Map<String,Object> reviewInfoMap = Maps.newHashMap();'."\n"
+ .' reviewInfoMap.put("scoreId",-1);'."\n"
+ .' reviewInfoMap.put("hitId",hitInfo.getReviewInfo().getHitId());'."\n"
+ .' reviewInfoMap.put("rid",getReviewInfoRid());'."\n"
+ .' reviewInfoMap.put("reviewResult",1);'."\n"
+ .' List reviewInfoList = Lists.newArrayList();'."\n"
+ .' reviewInfoList.add(reviewInfoMap);'."\n"
+ .' Map<String,Object> jsonReviewResultMap = Maps.newHashMap();'."\n"
+ .' jsonReviewResultMap.put("reviewInfoList",reviewInfoList);'."\n"
+ .' submitReviewMap.put("jsonReviewResult",jsonReviewResultMap);'."\n"
+ .' request.setJsonStr(JSON.toJSONString(submitReviewMap));'."\n"
+ .' SubmitReviewInfoResponse response = client.getAcsResponse(request);'."\n"
+ .' System.out.println("step submitReviewInfo - 5" + JSON.toJSONString(response));'."\n"
+ .' return response;'."\n"
+ .' }'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SubmitReviewInfo'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'SubmitReviewInfoV4' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
- 'abilityTreeCode' => '257754',
- 'abilityTreeNodes' => [
- 'FEATUREscaKR8LQC',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREscaFRLL5D', 'FEATUREsca81P1AQ'],
],
'parameters' => [
[
'name' => 'BaseMeAgentId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'required' => false,
- 'example' => '123456',
- 'format' => 'int64',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''],
],
[
'name' => 'JsonStr',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{'."\n"
- .' "business": "test",'."\n"
- .' "callType": 1,'."\n"
- .' "callee": "13111111111",'."\n"
- .' "caller": "13800000000",'."\n"
- .' "skillGroupId": 1,'."\n"
- .' "skillGroupName": "test",'."\n"
- .' "taskConfigId": 399,'."\n"
- .' "tid": "2025012412cb129e-1579-46b5-9326-1b2ececf8f30"'."\n"
- .'}',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Complete JSON string. For details, see the following sections.', 'type' => 'string', 'required' => false, 'example' => '{"comments":"tidComment","jsonReviewResult":"{\\"reviewInfoList\\":[{\\"changed\\":true,\\"comment\\":\\"ridComment\\",\\"matched\\":true,\\"reviewHitResult\\":0,\\"reviewResult\\":1,\\"rid\\":31459,\\"sentenceReviewResults\\":[{\\"changed\\":true,\\"cid\\":95302,\\"comment\\":\\"pidComment\\",\\"hitStatus\\":0,\\"pid\\":\\"0\\",\\"reviewDimensionType\\":\\"2\\",\\"rid\\":31459,\\"sid\\":54104}]}]}","taskId":"20251224-62931498-881B-1436-A93D-1FFBC5D7D4A0","vid":"8cbe2bccf3be4b42bada45136f77d4e9"}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Response schema',
+ 'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '6987D326-83D9-4A42-B9A5-0B27F9B40539',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'SessionId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '42e59bcd-7206-44c5-ad34-525d364687c4',
- ],
- 'Token' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '5607b21d1728700640',
- ],
- 'WsEndpoint' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'wss://ws-gateway-real-voice.aliyuncs.com',
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***'],
+ 'Code' => ['description' => 'Result code. Use this field to identify failure causes.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request failed. Returns **successful** if the request succeeded.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. true = success, false or null = failure', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Code\\": \\"200\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"SessionId\\": \\"42e59bcd-7206-44c5-ad34-525d364687c4\\",\\n \\"Token\\": \\"5607b21d1728700640\\",\\n \\"WsEndpoint\\": \\"wss://ws-gateway-real-voice.aliyuncs.com\\"\\n }\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Save Review Result ',
+ 'summary' => 'Review quality inspection results',
+ 'requestParamsDescription' => '**JSON string request parameters**'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :--------------- | :----- | :------- | :------------------------------------------------------------------------- |'."\n"
+ .'| taskId | String | Yes | Task ID |'."\n"
+ .'| vid | String | Yes | File ID. A string returned by the GetResultToReview operation. |'."\n"
+ .'| comments | String | No | Review comments |'."\n"
+ .'| handScoreIdList | List | No | Sub-scoring item IDs to add for manual scoring. Example: [1345, 1422] |'."\n"
+ .'| jsonReviewResult | String | No | Review result for specific rules, as a JSON string. Structure shown below. |'."\n"
+ ."\n"
+ .'**Structure of jsonReviewResult**'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :--------------- | :--- | :------- | :------------------------------------ |'."\n"
+ .'| reviewInfoList | List | Yes | Review structure information |'."\n"
+ .'| complainInfoList | List | No | Appeal handling structure information |'."\n"
+ ."\n"
+ .'**Structure of ReviewInfo**'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :-------------------- | :------ | :------- | :--------------------------------------------------------------- |'."\n"
+ .'| rid | Long | Yes | Rule ID |'."\n"
+ .'| reviewResult | Integer | Yes | Whether the rule truly matched: 0 = no, 1 = yes |'."\n"
+ .'| changed | Boolean | No | Whether this rule was modified in this operation. Default: false |'."\n"
+ .'| comment | String | No | Review comments for the rule dimension |'."\n"
+ .'| sentenceReviewResults | List | Yes | Sentence-level review information |'."\n"
+ ."\n"
+ .'**Structure of SentenceReviewResults**'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :-------- | :------ | :------- | :---------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| rid | Long | Yes | Rule ID. Leave blank if the appeal is for a manual scoring item. |'."\n"
+ .'| cid | Long | Yes | Condition ID |'."\n"
+ .'| pid | Long | Yes | Sentence ID |'."\n"
+ .'| sid | Long | Yes | Sentence-dimension review ID. Leave blank for the first review. For subsequent reviews, use the sid from the GetResultToReview operation. |'."\n"
+ .'| comment | String | No | Review comments for the sentence dimension |'."\n"
+ .'| hitStatus | Integer | Yes | Whether the rule truly matched: 0 = no, 1 = yes |'."\n"
+ .'| changed | Boolean | No | Whether this rule was modified in this operation. Default: false |'."\n"
+ ."\n"
+ .'**Structure of ComplainParam**'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :--------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| rid | Long | No | Rule ID. Leave blank if the appeal is for a manual scoring item. |'."\n"
+ .'| comments | String | Yes | Reason for appeal |'."\n"
+ .'| accept | Boolean | No | Whether to accept the appeal: true = yes, false = no. Default: true |'."\n"
+ .'| finalJudge | Boolean | No | Whether this is the final review. After a final review, no further appeals are allowed: true = yes, false = no. Default: false |',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'GetSyncResult' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'SyncQualityCheck' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'deprecated' => true,
+ 'operationType' => 'write',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '56237',
+ 'abilityTreeNodes' => ['FEATUREsca27EUYZ'],
],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"pageNumber":1,"pageSize":10,"requiredFields":"asrResult,agent,status,errorMessage,reviewStatus,reviewResult,score,taskId,reviewer,resolver,recording.name,recording.duration,recording.url,hitResult,business","startTime":"2020-12-25 00:00:00","endTime":"2020-12-31 23:59:59"}',
- ],
+ 'schema' => ['description' => 'Complete JSON string information. See the details below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"tid":"20200823-234234","dialogue":"{}"}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1244721'],
],
],
'responses' => [
@@ -12984,693 +13945,802 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '76DB5D8C-5BD9-42A7-B527-5AF3A5F****',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ResultCountId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Count' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Code' => ['description' => 'Result status code. 200 indicates success. Other values indicate failure. The caller can determine the reason for failure using this field.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if an error occurs. "successful" if successful.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'Unique request identifier.', 'type' => 'string', 'example' => '66E1ACB8-17B2-4BE8-8581-954A8*****', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. The caller can use this field to determine if the request succeeded: true for success; false/null for failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'Reviewer' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-07-24T19:31Z ',
- ],
- 'ReviewStatus' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TaskName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Comments' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'ReviewResult' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'Score' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20201231de3d34ec-40fa-4a55-8d27-76ea*****',
- ],
- 'Resolver' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'AsrResult' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Words' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Begin' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '340',
- ],
- 'EmotionValue' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '6',
- ],
- 'End' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3000',
- ],
- 'SpeechRate' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '221',
- ],
- 'Role' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SilenceDuration' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '11',
+ 'description' => 'Returned result, including hit information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Score' => ['description' => 'Final score, with a maximum of 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'TaskId' => ['description' => 'Task ID.', 'type' => 'string', 'example' => '66E1ACB866E1ACB8', 'title' => ''],
+ 'Tid' => ['description' => 'Unique identifier for the current conversation.', 'type' => 'string', 'example' => '20200876-66E1ACB8', 'title' => ''],
+ 'BeginTime' => ['description' => 'Time of recording and dialogue occurrence, in milliseconds since January 1, 1970, 00:00:00 UTC (UNIX timestamp in milliseconds, such as 1584535485856).', 'type' => 'integer', 'format' => 'int64', 'example' => '1584535485856', 'title' => ''],
+ 'Rules' => [
+ 'description' => 'List of hit rules. Each item is a rule. Only hit rule information and hit rule location information are returned.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleName' => ['description' => 'Name of the hit rule.', 'type' => 'string', 'example' => '禁用语', 'title' => ''],
+ 'Rid' => ['description' => 'ID of the hit rule.', 'type' => 'string', 'example' => '232232', 'title' => ''],
+ 'RuleInfoBase' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Level' => ['description' => 'Rule importance level', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'],
+ 'Comments' => ['description' => 'Rule remarks', 'type' => 'string', 'title' => '', 'example' => '邀约客户,客户不同意参加试听'],
+ 'ScoreNum' => ['description' => 'Score value', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'ScoreType' => ['description' => '1 for bonus points, 3 for penalty points. Default is 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'ScoreNumType' => ['description' => 'Scoring type. 0: bonus/penalty points, 1: one-time score.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'Type' => ['description' => 'Rule type ID'."\n"
+ .'><notice>The requiredFields parameter must include "ruleInfoBase".></notice>', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'RuleCategoryName' => ['description' => 'Rule category name'."\n"
+ .'><notice>The requiredFields parameter must include "ruleInfoBase.ruleCategoryName".></notice>', 'type' => 'string', 'title' => '', 'example' => '服务规范'],
],
+ 'title' => '',
+ 'description' => 'Rule basic information',
+ 'example' => '',
],
- ],
- ],
- 'HitResult' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
- 'ReviewResult' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1211',
- ],
- 'Hits' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'KeyWords' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'From' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'To' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'Val' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Cid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '66666',
- ],
- ],
- ],
- ],
- 'Cid' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '["1","3"]',
- ],
- ],
- 'Phrase' => [
- 'description' => '',
+ 'Hit' => [
+ 'description' => 'List of hit sentences. For this API, if a hit occurs, it is a single data entry.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HitKeyWords' => [
+ 'description' => 'Keywords that met the condition.',
+ 'type' => 'array',
+ 'items' => [
'type' => 'object',
'properties' => [
- 'Words' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Begin' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '440',
- ],
- 'EmotionValue' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '6',
- ],
- 'End' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4000',
- ],
- 'SpeechRate' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '234',
- ],
- 'Role' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SilenceDuration' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'To' => ['description' => 'End position of the keyword.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
+ 'From' => ['description' => 'Start position of the keyword.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Val' => ['description' => 'Keyword.', 'type' => 'string', 'example' => '你好', 'title' => ''],
+ 'Cid' => ['description' => 'Condition ID of the rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '2312', 'title' => ''],
+ 'Pid' => ['description' => 'Index value of the hit sentence in the entire conversation.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Phrase' => [
+ 'description' => 'Dialogue content that met the condition.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Words' => ['description' => 'Dialogue content.', 'type' => 'string', 'example' => '你好请问有什么可以帮您的', 'title' => ''],
+ 'Identity' => ['description' => 'Deprecated field. Ignore it.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'Begin' => ['description' => 'Start time of this sentence relative to the entire conversation, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1230', 'title' => ''],
+ 'EmotionValue' => ['description' => 'Emotional value of this sentence, 0-10. Higher values indicate stronger emotions.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''],
+ 'End' => ['description' => 'End time of this sentence relative to the entire conversation, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3440', 'title' => ''],
+ 'SpeechRate' => ['description' => 'Speech rate of this sentence, in characters per minute.', 'type' => 'integer', 'format' => 'int32', 'example' => '233', 'title' => ''],
+ 'Role' => ['description' => 'Role of this sentence. Valid values: customer service representative, customer.', 'type' => 'string', 'example' => '客服', 'title' => ''],
+ 'SilenceDuration' => ['description' => 'Deprecated field. Ignore it.', 'type' => 'integer', 'format' => 'int32', 'example' => '123', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- ],
- ],
- ],
- 'Recording' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Callee' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1888888***',
- ],
- 'Remark3' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Business' => [
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
'example' => '',
],
- 'Url' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'http://aliyun.com/xxx.wav ',
- ],
- 'PrimaryId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'Remark1' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Remark2' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'CallType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Caller' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0108888**** ',
- ],
- 'CallId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'DataSetName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Duration' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '232',
- ],
- 'DurationAudio' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '120',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123123.wav',
- ],
- 'Id' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'CallTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1563967699000',
- ],
],
- ],
- 'Agent' => [
'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SkillGroup' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Id' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '12221',
- ],
- ],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'substitutions' => [
- 'Qualitycheck::2019-01-15::GetResult',
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"76DB5D8C-5BD9-42A7-B527-5AF3A5F****\\",\\n \\"Success\\": true,\\n \\"ResultCountId\\": \\"xxx\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Count\\": 1,\\n \\"Data\\": [\\n {\\n \\"Status\\": 1,\\n \\"ErrorMessage\\": \\"xxxx\\",\\n \\"Reviewer\\": \\"张三\\",\\n \\"CreateTime\\": \\"2019-07-24T19:31Z\\\\t\\",\\n \\"ReviewStatus\\": 1,\\n \\"TaskName\\": \\"xxx\\",\\n \\"Comments\\": \\"xxx\\",\\n \\"ReviewResult\\": 3,\\n \\"Score\\": 100,\\n \\"TaskId\\": \\"20201231de3d34ec-40fa-4a55-8d27-76ea*****\\",\\n \\"Resolver\\": \\"张三\\",\\n \\"AsrResult\\": [\\n {\\n \\"Words\\": \\"您好,很高兴为您服务\\",\\n \\"Begin\\": 340,\\n \\"EmotionValue\\": 6,\\n \\"End\\": 3000,\\n \\"SpeechRate\\": 221,\\n \\"Role\\": \\"客服\\",\\n \\"SilenceDuration\\": 11\\n }\\n ],\\n \\"HitResult\\": [\\n {\\n \\"Type\\": \\"2\\",\\n \\"ReviewResult\\": 1,\\n \\"Name\\": \\"测试规则\\",\\n \\"Rid\\": \\"1211\\",\\n \\"Hits\\": [\\n {\\n \\"KeyWords\\": [\\n {\\n \\"From\\": 2,\\n \\"To\\": 5,\\n \\"Val\\": \\"投诉\\",\\n \\"Cid\\": \\"66666\\"\\n }\\n ],\\n \\"Cid\\": [\\n \\"[\\\\\\"1\\\\\\",\\\\\\"3\\\\\\"]\\"\\n ],\\n \\"Phrase\\": {\\n \\"Words\\": \\"我要投诉\\",\\n \\"Begin\\": 440,\\n \\"EmotionValue\\": 6,\\n \\"End\\": 4000,\\n \\"SpeechRate\\": 234,\\n \\"Role\\": \\"客服\\",\\n \\"SilenceDuration\\": 1\\n }\\n }\\n ]\\n }\\n ],\\n \\"Recording\\": {\\n \\"Callee\\": \\"1888888***\\",\\n \\"Remark3\\": \\"xxx\\",\\n \\"Business\\": \\"客服部\\",\\n \\"Url\\": \\"http://aliyun.com/xxx.wav\\\\t\\",\\n \\"PrimaryId\\": \\"xxxx\\",\\n \\"Remark1\\": \\"xxx\\",\\n \\"Remark2\\": \\"xxx\\",\\n \\"CallType\\": 1,\\n \\"Caller\\": \\"0108888****\\\\t\\",\\n \\"CallId\\": \\"xxx\\",\\n \\"DataSetName\\": \\"xxx\\",\\n \\"Duration\\": 232,\\n \\"DurationAudio\\": 120,\\n \\"Name\\": \\"123123.wav\\",\\n \\"Id\\": \\"xxxx\\",\\n \\"CallTime\\": \\"1563967699000\\"\\n },\\n \\"Agent\\": {\\n \\"Name\\": \\"李四\\",\\n \\"SkillGroup\\": \\"客服组\\",\\n \\"Id\\": \\"12221\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0F103D9A-2473-4E9D-B951-4E***</RequestId>\\n<Message>successful</Message>\\n<PageSize>1</PageSize>\\n<PageNumber>1</PageNumber>\\n<Data>\\n <Status>1</Status>\\n <HitResult>\\n <Type>服务规范</Type>\\n <Hits>\\n <Phrase>\\n <Role>客服</Role>\\n <Words>您好,孙老师之彩云彩云,很高兴为您服务。请问有什么可以帮您。</Words>\\n <Begin>410</Begin>\\n <End>3930</End>\\n <EmotionValue>7</EmotionValue>\\n </Phrase>\\n <KeyWords>\\n <Val>孙老师</Val>\\n <From>3</From>\\n <To>6</To>\\n <Cid>11134</Cid>\\n </KeyWords>\\n <Cid>11134</Cid>\\n </Hits>\\n <Rid>2944</Rid>\\n <Name>实时质检2</Name>\\n </HitResult>\\n <Agent>\\n <SkillGroup>0819-1</SkillGroup>\\n <Id>291504891705943763</Id>\\n <Name>sca_agent</Name>\\n </Agent>\\n <Score>90</Score>\\n <TaskId>20201126d2e5ed3b-18ec-4dc4-874****</TaskId>\\n <ReviewStatus>0</ReviewStatus>\\n <CreateTime>2020-11-26T21:56Z</CreateTime>\\n <ReviewResult>3</ReviewResult>\\n <Recording>\\n <Callee>132434231</Callee>\\n <CallId>54512313231</CallId>\\n <CallType>1</CallType>\\n <Duration>23</Duration>\\n <Url>https://sca-bucket-inner.oss-cn-beijing.aliyuncs.com/aller/xxxx.wav</Url>\\n <Name>20201126-aller-08.wav</Name>\\n <Remark2>remark2-7</Remark2>\\n <Caller>412341234</Caller>\\n <Remark3>remark3-7</Remark3>\\n <Remark1>remark1-7</Remark1>\\n <Id>20201126-aller-08</Id>\\n <CallTime>1606398968000</CallTime>\\n <PrimaryId>20201126be772f4ec27945d9bb31d6f****</PrimaryId>\\n <Business>aller测试业务7</Business>\\n </Recording>\\n <AsrResult>\\n <Role>客服</Role>\\n <Words>您好,孙老师之彩云彩云,很高兴为您服务。请问有什么可以帮您。</Words>\\n <Begin>410</Begin>\\n <End>3930</End>\\n <SpeechRate>443</SpeechRate>\\n <EmotionValue>7</EmotionValue>\\n </AsrResult>\\n</Data>\\n<Count>1</Count>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"66E1ACB8-17B2-4BE8-8581-954A8*****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Score\\": 100,\\n \\"TaskId\\": \\"66E1ACB866E1ACB8\\",\\n \\"Tid\\": \\"20200876-66E1ACB8\\",\\n \\"BeginTime\\": 1584535485856,\\n \\"Rules\\": [\\n {\\n \\"RuleName\\": \\"禁用语\\",\\n \\"Rid\\": \\"232232\\",\\n \\"RuleInfoBase\\": {\\n \\"Level\\": 2,\\n \\"Comments\\": \\"邀约客户,客户不同意参加试听\\",\\n \\"ScoreNum\\": 1,\\n \\"ScoreType\\": 1,\\n \\"ScoreNumType\\": 1,\\n \\"Type\\": 1,\\n \\"RuleCategoryName\\": \\"服务规范\\"\\n },\\n \\"Hit\\": [\\n {\\n \\"HitKeyWords\\": [\\n {\\n \\"To\\": 4,\\n \\"From\\": 1,\\n \\"Val\\": \\"你好\\",\\n \\"Cid\\": 2312,\\n \\"Pid\\": 4\\n }\\n ],\\n \\"Phrase\\": {\\n \\"Words\\": \\"你好请问有什么可以帮您的\\",\\n \\"Identity\\": \\"xxx\\",\\n \\"Begin\\": 1230,\\n \\"EmotionValue\\": 6,\\n \\"End\\": 3440,\\n \\"SpeechRate\\": 233,\\n \\"Role\\": \\"客服\\",\\n \\"SilenceDuration\\": 123\\n }\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'SyncQualityCheck',
+ 'summary' => 'Perform real-time quality inspection for hotlines.',
+ 'description' => 'Real-time hotline quality inspection transcribes spoken dialogue into text during a call. It sends the text to the Smart Conversation Analysis system for real-time quality inspection to detect potential issues or risks. You can display the dialogue text and inspection results in real time on the customer service representative\'s workbench (a third-party system). This differs from offline quality inspection, which uses UploadAudioData for inspection or dataset inspection. For details, see the developer guide. Offline quality inspection occurs after the call ends and the recording file is generated.'."\n"
+ ."\n"
+ .'**Usage Flow**'."\n"
+ ."\n"
+ .'You can implement real-time transcription of audio streams to text during calls, or use Alibaba Cloud Call Center (CC) directly. CC integrates deeply with Smart Conversation Analysis, enabling real-time quality inspection during calls without API integration.'."\n"
+ ."\n"
+ .'If you implement audio-to-text conversion yourself, invoke the SyncQualityCheck API for real-time quality inspection after a speaker finishes a sentence and generates dialogue text. This returns the inspection result for that sentence synchronously.'."\n"
+ ."\n"
+ .'You should include skill group information when uploading data. Then, you can use the Call Center Quality Inspection - Configuration Management feature to configure different quality inspection rules for calls from different skill groups.'."\n"
+ ."\n"
+ .'After the call ends, you can store the recording file on a storage server accessible over the public network. You can invoke the recording information maintenance API: UpdateSyncQualityCheckData. You can submit the recording name, recording file URL, and other details to the Smart Conversation Analysis service. This lets quality inspectors play back the recording during review.'."\n"
+ ."\n"
+ .'After the call ends, you can view the quality inspection results in Call Center Quality Inspection - Result Display - Real-time Quality Inspection Results. You can also invoke the real-time quality inspection result query API: GetSyncResult to retrieve the results. You can use Score Dashboard - Real-time Dashboard to view data charts for customer service representatives, skill groups, and scoring items.'."\n"
+ ."\n"
+ .'**Full-Text Quality Inspection**'."\n"
+ ."\n"
+ .'Quality inspection rules include dozens of operators. Some operators require dialogue context (multi-turn conversations between customer service representatives and customers) for analysis. However, real-time quality inspection occurs during a call and typically uses text from only one sentence spoken by a single speaker. Some operators are not suitable for real-time quality inspection. Therefore, quality inspection rules are divided into real-time quality inspection rules and full-text quality inspection rules:'."\n"
+ ."\n"
+ .'**Real-time quality inspection rules**: Rules used for real-time quality inspection. They support a limited number of operator types. They do not support specifying the detection range for operators.'."\n"
+ ."\n"
+ .'**Full-text quality inspection rules**: Rules used for offline quality inspection. They support all operator types. They support custom detection ranges for operators.'."\n"
+ ."\n"
+ .'For calls that underwent real-time quality inspection, you can apply full-text quality inspection rules to the complete dialogue text after the call ends. To enable full-text quality inspection after real-time inspection, see the full-text quality inspection description in Call Center Quality Inspection - Configuration Management.',
+ 'requestParamsDescription' => '**jsonStr Properties:**'."\n"
+ ."\n"
+ .'| Property | Value Type | Required | Description |'."\n"
+ .'| :------------------ | :--------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| sourceType | Int | Yes | Data type. 1: real-time voice, 0: real-time text. |'."\n"
+ .'| uuid | String | No | Unique identifier for the current sentence, used for idempotence. Duplicate requests are deduplicated. The deduplication period is 24 hours. |'."\n"
+ .'| tid | String | Yes | Unique identifier for the current conversation (ensure uniqueness). This can be the call ID in your business system. The backend merges a complete conversation based on this ID. The length must be at least 8 characters, with the first 8 characters representing the call\'s date (YYYYMMDD). For example, if the recording date is July 5, 2020, the prefix is 20200705. Append your business system\'s call ID after the prefix, such as 20200705-234890134. The prefix date must be within one month before or one hour after the API call time. |'."\n"
+ .'| dialogue | Dialogue | Yes | The dialogue content to be inspected by the business. This is typically one sentence, but can be multiple sentences. See the jsonStr.dialogue Properties below for details. |'."\n"
+ .'| dialogueStatus | Integer | No | Session start/end identifier. 1: start, 2: in conversation. |'."\n"
+ .'| beginTime | Long | No | Start time of the recording and dialogue, in milliseconds since January 1, 1970, 00:00:00 UTC (UNIX timestamp in milliseconds, such as 1584535485856). If provided with each call, the first call\'s value takes precedence. If not specified, the current time is used. |'."\n"
+ .'| customerServiceId | Long | No | Customer service representative ID. Obtain this from the Console - Basic Settings - Personnel Management page. Enter the correct customer service representative ID so that the representative can view associated recording files when logging on to the console page. |'."\n"
+ .'| customerServiceName | String | No | Customer service representative name. |'."\n"
+ .'| skillGroupId | Long | No | Skill Group ID. |'."\n"
+ .'| skillGroupName | String | No | Skill Group Name. |'."\n"
+ .'| callType | Integer | No | Call type. Valid values: 1 (outbound) (default); 3 (inbound); 4 (other). |'."\n"
+ .'| callee | String | No | Callee number. For outbound calls, this is the customer\'s number. For inbound calls, this is the customer service representative\'s number. |'."\n"
+ .'| caller | String | No | Caller number. For outbound calls, this is the customer service representative\'s number. For inbound calls, this is the customer\'s number. |'."\n"
+ .'| callId | String | No | Call ID. This can be the call ID in the call center system or another ID that identifies the call. If a transfer occurs, callId remains the same for agents 1 to n, but tid differs. |'."\n"
+ .'| business | String | No | Line-of-business name. This is custom data used for categorization and statistics. |'."\n"
+ .'| remark1 | String | No | Custom data 1. Store custom fields related to your business. The maximum length is 32 characters. |'."\n"
+ .'| remark2 | String | No | Custom data 2. Store custom fields related to your business. The maximum length is 32 characters. |'."\n"
+ .'| remark3 | String | No | Custom data 3. Store custom fields related to your business. The maximum length is 32 characters. |'."\n"
+ .'| requiredFields | String | No | Additional fields in the response parameter. Valid values: ruleInfoBase (rule information); ruleInfoBase.ruleCategoryName (rule category name). |'."\n"
+ ."\n"
+ .'**jsonStr.dialogue Properties:**'."\n"
+ ."\n"
+ .'| Property | Value Type | Required | Description |'."\n"
+ .'| :-------------- | :--------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| role | String | Yes | Role in the dialogue content. Valid values: customer service representative, customer, system. |'."\n"
+ .'| identity | String | No | Specific identity for the dialogue role, such as customer service representative ID or customer ID. |'."\n"
+ .'| words | String | Yes | The sentence spoken by this role. Only UTF-8 encoding is supported. For example, Emoji characters are not UTF-8 encoded; do not include Emoji characters in the text content. |'."\n"
+ .'| begin | Integer | Yes | Start time offset relative to the starting point, in milliseconds. |'."\n"
+ .'| end | Integer | Yes | End time offset relative to the starting point, in milliseconds. |'."\n"
+ .'| emotionValue | Integer | No | Emotional energy value from 1 to 10. Higher values indicate stronger emotions. |'."\n"
+ .'| speechRate | Integer | No | Average speech rate for this sentence, in characters per minute. |'."\n"
+ .'| silenceDuration | Integer | No | Silence duration between this sentence and the previous one, in seconds. |'."\n"
+ ."\n"
+ .'## Request Parameter Example'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "sourceType": 0,'."\n"
+ .' "beginTime": 1724390164363,'."\n"
+ .' "callId": "job-548734733657395200",'."\n"
+ .' "customerName": "Zhang San Voice 11",'."\n"
+ .' "customerId": "zhangsan-vip-audio",'."\n"
+ .' "customerServiceId": "270071956987960408",'."\n"
+ .' "customerServiceName": "siqiyj",'."\n"
+ .' "dialogue": {'."\n"
+ .' "begin": 23596,'."\n"
+ .' "emotionValue": 0,'."\n"
+ .' "end": 24836,'."\n"
+ .' "role": "customer",'."\n"
+ .' "speechRate": 62,'."\n"
+ .' "words": "Ah, yes, yes, yes."'."\n"
+ .' },'."\n"
+ .' "skillGroupId": "e5bfc9fc-f860-4a33-a4e6-80321aa1ff64",'."\n"
+ .' "skillGroupName": "e5bfc9fc-f860-4a33-a4e6-80321aa1ff64",'."\n"
+ .' "tid": "20240823job-548734733657395200",'."\n"
+ .' "uuid": "258af5784bbaff9a503e056f39291a5d"'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Request Code Example'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'public class sca {'."\n"
+ ."\n"
+ .' private static String ak = "YOUR_ACCESS_KEY_ID";'."\n"
+ .' private static String sk = "YOUR_ACCESS_KEY_SECRET";'."\n"
+ ."\n"
+ .' private static void sync() throws Exception {'."\n"
+ .' String json = "{\\n" +'."\n"
+ .' " \\"sourceType\\": 0,\\n" +'."\n"
+ .' " \\"beginTime\\": 1724390164363,\\n" +'."\n"
+ .' " \\"callId\\": \\"job-548734733657395200\\",\\n" +'."\n"
+ .' " \\"customerName\\": \\"Zhang San Voice 11\\",\\n" +'."\n"
+ .' " \\"customerId\\": \\"zhangsan-vip-audio\\",\\n" +'."\n"
+ .' " \\"customerServiceId\\": \\"270071956987960408\\",\\n" +'."\n"
+ .' " \\"customerServiceName\\": \\"siqiyj\\",\\n" +'."\n"
+ .' " \\"dialogue\\": {\\n" +'."\n"
+ .' " \\"begin\\": 23596,\\n" +'."\n"
+ .' " \\"emotionValue\\": 0,\\n" +'."\n"
+ .' " \\"end\\": 24836,\\n" +'."\n"
+ .' " \\"role\\": \\"customer\\",\\n" +'."\n"
+ .' " \\"speechRate\\": 62,\\n" +'."\n"
+ .' " \\"words\\": \\"Ah, yes, yes, yes.\\"\\n" +'."\n"
+ .' " },\\n" +'."\n"
+ .' " \\"skillGroupId\\": \\"e5bfc9fc-f860-4a33-a4e6-80321aa1ff64\\",\\n" +'."\n"
+ .' " \\"skillGroupName\\": \\"e5bfc9fc-f860-4a33-a4e6-80321aa1ff64\\",\\n" +'."\n"
+ .' " \\"tid\\": \\"20240823job-548734733657395200\\",\\n" +'."\n"
+ .' " \\"uuid\\": \\"258af5784bbaff9a503e056f39291a5d\\"\\n" +'."\n"
+ .' "}";'."\n"
+ ."\n\n"
+ .' Config config = new Config();'."\n"
+ .' config.setAccessKeyId(ak).setAccessKeySecret(sk)'."\n"
+ .' .setEndpoint("qualitycheck.cn-hangzhou.aliyuncs.com")'."\n"
+ .' .setRegionId("cn-hangzhou").setProtocol("HTTPS");'."\n"
+ ."\n"
+ .' Client client = new Client(config);'."\n"
+ .' SyncQualityCheckRequest result = new SyncQualityCheckRequest();'."\n"
+ ."\n"
+ .' result.setJsonStr(json);'."\n"
+ ."\n"
+ .' SyncQualityCheckResponse response = client.syncQualityCheck(result);'."\n"
+ .' System.out.println(JSONObject.toJSONString(response));'."\n"
+ .' }'."\n"
+ ."\n"
+ .' public static void main(String[] args) throws Exception {'."\n"
+ .' sync();'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'responseParamsDescription' => '**Dialogue Context Sentence Description**: In complex scenarios, a single sentence from a speaker might not be enough to detect violations. Previous sentences are often needed as context for quality inspection analysis. The current maximum number of context sentences is 30 by default. For example, in a call where the 40th sentence has been spoken, after uploading the 40th sentence, we retrieve the preceding 29 sentences. This creates a total of 30 sentences, including the latest 40th sentence, for quality inspection analysis. Therefore, in extreme cases, some sentences undergo quality inspection analysis 30 times. When returning quality inspection results, we automatically deduplicate them. This means if a sentence hits the same condition within the same rule multiple times, only the first hit result for that sentence is returned.',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-17T14:21:44.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SyncQualityCheck'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'SyncQualityCheck' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'TestRuleV4' => [
+ 'summary' => 'Frontend location: Quality Check Rule Configuration > Test. Apsara Stack URL: http://<ip>:<port>/api/client/TestRule.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '56237',
- 'abilityTreeNodes' => [
- 'FEATUREsca27EUYZ',
- ],
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'JsonStr',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"tid":"20200823-234234","dialogue":"{}"}',
- ],
+ 'name' => 'IsSchemeData',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Whether this is the new quality check version. Valid values: 0 (legacy version) and 1 (new version). Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'BaseMeAgentId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'name' => 'TestJson',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'JSON request parameters for rule testing. For details, see the supplemental description of request parameters.', 'type' => 'string', 'required' => true, 'example' => '{"ruleList":[9771],"dialogues":[{"begin":0,"end":760,"hourMinSec":"00:00","role":"客户","identity":"客户","words":"123"},{"begin":21004,"end":21494,"hourMinSec":"00:21","role":"客服","identity":"客服","words":"123"}]}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'PlainResult<OverviewResult>',
+ 'description' => 'PlainResult\\<overviewresult>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '66E1ACB8-17B2-4BE8-8581-954A8*****',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
'Data' => [
- 'description' => '',
+ 'description' => 'Full response body.',
'type' => 'object',
'properties' => [
- 'Score' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '66E1ACB866E1ACB8',
- ],
- 'Tid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20200876-66E1ACB8',
- ],
- 'BeginTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1584535485856',
- ],
- 'Rules' => [
- 'description' => '',
+ 'HitRuleReviewInfoList' => [
+ 'description' => 'Information about hit check items.',
'type' => 'array',
'items' => [
+ 'description' => 'Information about hit check items.',
'type' => 'object',
'properties' => [
- 'RuleName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '232232',
- ],
- 'RuleInfoBase' => [
- 'title' => '规则基本信息',
- 'type' => 'object',
- 'properties' => [
- 'Level' => [
- 'title' => '规则重要程度',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'Comments' => [
- 'title' => '规则备注',
- 'type' => 'string',
- ],
- 'ScoreNum' => [
- 'title' => '计分值',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ScoreType' => [
- 'title' => '1加分 3减分 默认1',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ScoreNumType' => [
- 'title' => '计分类型'."\n"
- .'0:加减分,1:一次性得分',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'Type' => [
- 'title' => '规则类型Id',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'RuleCategoryName' => [
- 'title' => '规则类型名',
- 'type' => 'string',
- ],
- ],
- ],
- 'Hit' => [
- 'description' => '',
+ 'Rid' => ['description' => 'Check item ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '451', 'title' => ''],
+ 'Lambda' => ['description' => 'Lambda expression. Example: a&\\&b.', 'type' => 'string', 'example' => 'a&&b', 'title' => ''],
+ 'ConditionHitInfoList' => [
+ 'description' => 'Information about hit conditions.',
'type' => 'array',
'items' => [
+ 'description' => 'Information about hit conditions.',
'type' => 'object',
'properties' => [
- 'HitKeyWords' => [
- 'description' => '',
+ 'Cid' => [
+ 'description' => 'Condition ID.',
'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'To' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'From' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Val' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Cid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2312',
- ],
- 'Pid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- ],
- ],
+ 'items' => ['description' => 'Condition ID.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
'Phrase' => [
- 'description' => '',
+ 'description' => 'Sentence details for the current hit check item.',
'type' => 'object',
'properties' => [
- 'Words' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Identity' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Begin' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1230',
- ],
- 'EmotionValue' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '6',
- ],
- 'End' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3440',
- ],
- 'SpeechRate' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '233',
- ],
- 'Role' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SilenceDuration' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '123',
+ 'Role' => ['description' => 'Speaker role for this sentence. Valid values: agent and customer.', 'type' => 'string', 'example' => '客服', 'title' => ''],
+ 'Identity' => ['description' => 'Role identifier. In offline voice scenarios, roles are limited to agent or customer. In offline text quality check scenarios, this field shows the identity value passed in during upload.', 'type' => 'string', 'example' => '客服', 'title' => ''],
+ 'Words' => ['description' => 'Dialogue content.', 'type' => 'string', 'example' => '你好,请问有什么可以帮您', 'title' => ''],
+ 'Begin' => ['description' => 'Start time offset of this sentence relative to the start of the full dialogue, in milliseconds. For example, if the total audio duration is 2 minutes and 10 seconds, and a customer starts speaking at 1 minute and 12 seconds and finishes at 1 minute and 20 seconds, then begin equals 72000 and end equals 80000.', 'type' => 'integer', 'format' => 'int64', 'example' => '72000', 'title' => ''],
+ 'End' => ['description' => 'End time offset of this sentence relative to the start of the full dialogue, in milliseconds. For example, if the total audio duration is 2 minutes and 10 seconds, and a customer starts speaking at 1 minute and 12 seconds and finishes at 1 minute and 20 seconds, then begin equals 72000 and end equals 80000.', 'type' => 'integer', 'format' => 'int64', 'example' => '80000', 'title' => ''],
+ 'BeginTime' => ['description' => 'Start time of this sentence. Example: 2019-11-25 15:37:16.', 'type' => 'string', 'example' => '2019-11-25 15:37:16', 'title' => ''],
+ 'HourMinSec' => ['description' => 'Start time of this sentence in hh:mm:ss format.', 'type' => 'string', 'example' => '10:00:00', 'title' => ''],
+ 'EmotionValue' => ['description' => 'Emotion intensity score. Value equals volume in decibels divided by 10. Valid range: \\[1, 10]. Higher values indicate stronger emotion.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''],
+ 'EmotionFineGrainedValue' => ['description' => 'Internal use only. Ignore this field.', 'type' => 'integer', 'format' => 'int32', 'example' => '忽略', 'title' => ''],
+ 'SilenceDuration' => ['description' => 'Silence duration, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''],
+ 'SpeechRate' => ['description' => 'Average speech rate for this sentence, in words per minute.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'ChannelId' => ['description' => 'Channel ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Pid' => ['description' => 'Index of this sentence in the full list of sentences. This is the index of the sentence in the dialogues array of the request parameters, starting from 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'RenterId' => ['description' => 'Internal use only. Ignore this field.', 'type' => 'integer', 'format' => 'int64', 'example' => '无', 'title' => ''],
+ 'Uuid' => ['description' => 'Internal use only. Ignore this field.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'HitStatus' => ['description' => 'Hit status. Valid values:'."\n"
+ ."\n"
+ .'- **0**: Not hit'."\n"
+ ."\n"
+ .'- **1**: Hit', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Sid' => ['description' => 'Internal use only. Ignore this field.', 'type' => 'integer', 'format' => 'int64', 'example' => '无', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'KeyWords' => [
+ 'description' => 'Key information that was hit. This information appears highlighted on the review page. Examples include keywords matched by a keyword-check operator or category information matched by an agent-model-check operator.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Key information that was hit. This information appears highlighted on the review page. Examples include keywords matched by a keyword-check operator or category information matched by an agent-model-check operator.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OperatorKey' => ['description' => 'Key information matched by the operator.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'Val' => ['description' => 'Key information matched by the operator. For details, see **Detailed explanation of Val key information** in the response parameter description below.', 'type' => 'string', 'example' => '你好', 'title' => ''],
+ 'Pid' => ['description' => 'Index of this sentence in the full list of sentences. This is the index of the sentence in the dialogues array of the request parameters, starting from 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '13', 'title' => ''],
+ 'From' => ['description' => 'Starting character position for highlighting. Index starts at 0. Maximum value is the total number of characters in the sentence minus 1. The character at position from is included in the highlight.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'To' => ['description' => 'The position of the character that follows the highlighted keyword. The character at the \\`to\\` position is not included in the highlight. For example, if \\`from\\` is 0 and \\`to\\` is 3, the highlighted keyword consists of the characters at indices 0, 1, and 2. The maximum value is one less than the total number of characters in the sentence.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'Tid' => ['description' => 'Internal use only. Ignore this field.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'Oid' => ['description' => 'Operator ID.', 'type' => 'string', 'example' => '123', 'title' => ''],
+ 'Uuid' => ['description' => 'Internal use only. Ignore this field.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'SimilarPhrase' => ['description' => 'Similar phrase.', 'type' => 'string', 'example' => '您好', 'title' => ''],
+ 'Cid' => ['description' => 'Condition ID.', 'type' => 'string', 'example' => '4', 'title' => ''],
+ 'CustomizeCode' => ['description' => 'Internal field. Ignore this field.', 'type' => 'string', 'example' => '无', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ConditionInfoList' => [
+ 'description' => 'List of conditions.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Condition information.', '$ref' => '#/components/schemas/ConditionBasicInfo', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'BranchHitId' => ['description' => 'ID of the hit branch.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'BranchInfoList' => [
+ 'description' => 'List of branch information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Branch information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Index' => ['description' => 'Index number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Name' => ['description' => 'Node name.', 'type' => 'string', 'example' => '节点A', 'title' => ''],
+ 'NextNodeId' => ['description' => 'ID of the next flow node.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ 'Situation' => ['description' => 'Flow node condition.', '$ref' => '#/components/schemas/NextNodeSituations', 'title' => '', 'example' => ''],
+ 'Lambda' => ['description' => 'Lambda expression.', 'type' => 'string', 'example' => 'a&&b', 'title' => ''],
+ 'CheckType' => ['description' => 'Check item type.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Triggers' => [
+ 'description' => 'List of trigger IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Trigger ID.', 'type' => 'string', 'example' => 'a', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
+ 'RuleScoreType' => ['description' => 'Whether scoring applies. Valid values: 1 (no scoring) and 3 (scoring).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TaskFlowId' => ['description' => 'Flow ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'ScoreNumType' => ['description' => 'Scoring type. Valid values: 0 (add or subtract points on hit) and 1 (one-time score on hit).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Matched' => ['description' => 'Whether the rule was hit.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'NodeType' => ['description' => 'Node type.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'JudgeNodeName' => ['description' => 'Judgement node name.', 'type' => 'string', 'example' => '判断节点A', 'title' => ''],
+ 'RuleName' => ['description' => 'Rule name.', 'type' => 'string', 'example' => '规则A', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'HitTaskFlowList' => [
+ 'description' => 'List of hit advanced flow nodes.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Information about hit advanced flow nodes.',
+ 'type' => 'object',
+ 'properties' => [
+ 'GraphFlow' => ['description' => 'Flowchart canvas.', '$ref' => '#/components/schemas/TaskGraphFlow', 'title' => '', 'example' => ''],
+ 'TaskFlowType' => ['description' => 'Flowchart type. Deprecated. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '无', 'title' => ''],
+ 'Rid' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'UnhitRuleReviewInfoList' => [
+ 'description' => 'Information about rules that were not hit.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Information about rules that were not hit.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Rid' => ['description' => 'The ID of the rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ 'ConditionInfoList' => [
+ 'description' => 'List of conditions.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Condition information.', '$ref' => '#/components/schemas/ConditionBasicInfo', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Matched' => ['description' => 'Whether the rule was hit.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'TaskFlowType' => ['description' => 'Flowchart type. Deprecated. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '忽略', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '96138D8D-XXXX-4E41-XXXX-77AED1088BBD', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Callers can use this field to determine success: true means success; false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. 200 indicates success. Other values indicate failure. Callers can use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details when an error occurs. Returns successful when the request succeeds.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"66E1ACB8-17B2-4BE8-8581-954A8*****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Score\\": 100,\\n \\"TaskId\\": \\"66E1ACB866E1ACB8\\",\\n \\"Tid\\": \\"20200876-66E1ACB8\\",\\n \\"BeginTime\\": 1584535485856,\\n \\"Rules\\": [\\n {\\n \\"RuleName\\": \\"禁用语\\",\\n \\"Rid\\": \\"232232\\",\\n \\"RuleInfoBase\\": {\\n \\"Level\\": 2,\\n \\"Comments\\": \\"邀约客户,客户不同意参加试听\\",\\n \\"ScoreNum\\": 1,\\n \\"ScoreType\\": 1,\\n \\"ScoreNumType\\": 1,\\n \\"Type\\": 1,\\n \\"RuleCategoryName\\": \\"服务规范\\"\\n },\\n \\"Hit\\": [\\n {\\n \\"HitKeyWords\\": [\\n {\\n \\"To\\": 4,\\n \\"From\\": 1,\\n \\"Val\\": \\"你好\\",\\n \\"Cid\\": 2312,\\n \\"Pid\\": 4\\n }\\n ],\\n \\"Phrase\\": {\\n \\"Words\\": \\"你好请问有什么可以帮您的\\",\\n \\"Identity\\": \\"xxx\\",\\n \\"Begin\\": 1230,\\n \\"EmotionValue\\": 6,\\n \\"End\\": 3440,\\n \\"SpeechRate\\": 233,\\n \\"Role\\": \\"客服\\",\\n \\"SilenceDuration\\": 123\\n }\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SyncQualityCheckResponse>\\n <requestId>A0F9FF42-7905-4DC5-9B7E-00711C89AC90</requestId>\\n <message>successful</message>\\n <data>\\n <taskId>20200706A0F9FF42-7905-4DC5-9B7E-00711C89AC90</taskId>\\n <rules>\\n <hit>\\n <hitKeyWords>\\n <val>骚扰</val>\\n <pid>0</pid>\\n <from>11</from>\\n <to>13</to>\\n <cid>35630</cid>\\n </hitKeyWords>\\n <phrase>\\n <role>客户</role>\\n <words>嗯,你稍等一下。他总是骚扰我</words>\\n <begin>23910</begin>\\n <end>25780</end>\\n <identity>某客户</identity>\\n <emotionValue>6</emotionValue>\\n </phrase>\\n </hit>\\n <rid>21552</rid>\\n </rules>\\n <tid>20200706-1</tid>\\n </data>\\n <code>200</code>\\n <success>true</success>\\n</SyncQualityCheckResponse>\\n","errorExample":""}]',
- 'extraInfo' => ' ',
+ 'title' => 'Test Rules (New Quality Inspection)',
+ 'requestParamsDescription' => '## Sample request parameters'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "ruleList": ['."\n"
+ .' 50298'."\n"
+ .' ],'."\n"
+ .' "dialogues": ['."\n"
+ .' {'."\n"
+ .' "role": "agent",'."\n"
+ .' "identity": "agent",'."\n"
+ .' "words": "Hello. This is xx.",'."\n"
+ .' "hourMinSec": "00:00",'."\n"
+ .' "begin": 0'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "words": "I want to buy a towel.",'."\n"
+ .' "begin": 1000,'."\n"
+ .' "role": "customer",'."\n"
+ .' "identity": "customer",'."\n"
+ .' "hourMinSec": "00:01"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Sample Java code'."\n"
+ ."\n"
+ .'```java'."\n"
+ ."\n"
+ .'import com.alibaba.fastjson.JSONObject;'."\n"
+ .'import com.aliyun.qualitycheck20190115.Client;'."\n"
+ .'import com.aliyun.qualitycheck20190115.models.*;'."\n"
+ .'import com.aliyun.teaopenapi.models.Config;'."\n"
+ ."\n\n"
+ .'public class sca {'."\n"
+ ."\n"
+ .' private static String ak = "YOUR_ACCESS_KEY_ID";'."\n"
+ .' private static String sk = "YOUR_ACCESS_KEY_SECRET";'."\n"
+ ."\n"
+ .' private static void testRuleV4() throws Exception {'."\n"
+ .' String json="{\\"ruleList\\":[50298],\\"dialogues\\":[{\\"role\\":\\"agent\\",\\"identity\\":\\"agent\\",\\"words\\":\\"Hello. This is xx.\\",\\"hourMinSec\\":\\"00:00\\",\\"begin\\":0},{\\"words\\":\\"I want to buy a towel.\\",\\"begin\\":1000,\\"role\\":\\"customer\\",\\"identity\\":\\"customer\\",\\"hourMinSec\\":\\"00:01\\"}]}";'."\n"
+ ."\n"
+ .' Config config = new Config();'."\n"
+ .' config.setAccessKeyId(ak).setAccessKeySecret(sk)'."\n"
+ .' .setEndpoint("qualitycheck.cn-hangzhou.aliyuncs.com")'."\n"
+ .' .setRegionId("cn-hangzhou").setProtocol("HTTPS");'."\n"
+ ."\n"
+ .' Client client = new Client(config);'."\n"
+ .' TestRuleV4Request result = new TestRuleV4Request();'."\n"
+ ."\n"
+ .' result.setTestJson(json);'."\n"
+ ."\n"
+ .' TestRuleV4Response response = client.testRuleV4(result);'."\n"
+ .' System.out.println(JSONObject.toJSONString(response));'."\n"
+ .' }'."\n"
+ ."\n\n"
+ .' public static void main(String[] args) throws Exception {'."\n"
+ .' testRuleV4();'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2024-03-12T11:29:28.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '15', 'countWindow' => 5, 'regionId' => '*', 'api' => 'TestRuleV4'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"HitRuleReviewInfoList\\": [\\n {\\n \\"Rid\\": 451,\\n \\"Lambda\\": \\"a&&b\\",\\n \\"ConditionHitInfoList\\": [\\n {\\n \\"Cid\\": [\\n \\"1\\"\\n ],\\n \\"Phrase\\": {\\n \\"Role\\": \\"客服\\",\\n \\"Identity\\": \\"客服\\",\\n \\"Words\\": \\"你好,请问有什么可以帮您\\",\\n \\"Begin\\": 72000,\\n \\"End\\": 80000,\\n \\"BeginTime\\": \\"2019-11-25 15:37:16\\",\\n \\"HourMinSec\\": \\"10:00:00\\",\\n \\"EmotionValue\\": 7,\\n \\"EmotionFineGrainedValue\\": 0,\\n \\"SilenceDuration\\": 1000,\\n \\"SpeechRate\\": 100,\\n \\"ChannelId\\": 0,\\n \\"Pid\\": 3,\\n \\"RenterId\\": 0,\\n \\"Uuid\\": \\"无\\",\\n \\"HitStatus\\": 1,\\n \\"Sid\\": 0\\n },\\n \\"KeyWords\\": [\\n {\\n \\"OperatorKey\\": \\"无\\",\\n \\"Val\\": \\"你好\\",\\n \\"Pid\\": 13,\\n \\"From\\": 1,\\n \\"To\\": 3,\\n \\"Tid\\": \\"无\\",\\n \\"Oid\\": \\"123\\",\\n \\"Uuid\\": \\"无\\",\\n \\"SimilarPhrase\\": \\"您好\\",\\n \\"Cid\\": \\"4\\",\\n \\"CustomizeCode\\": \\"无\\"\\n }\\n ]\\n }\\n ],\\n \\"ConditionInfoList\\": [\\n {\\n \\"Cid\\": \\"a\\",\\n \\"Id\\": 1,\\n \\"Rid\\": \\"1\\",\\n \\"Check_range\\": {\\n \\"RoleId\\": 1,\\n \\"Role\\": \\"客服\\",\\n \\"Anchor\\": {\\n \\"Cid\\": \\"a\\",\\n \\"Location\\": \\"BEFORE\\",\\n \\"Hit_time\\": 1\\n },\\n \\"Range\\": {\\n \\"From\\": 1,\\n \\"To\\": 2\\n },\\n \\"Absolute\\": true,\\n \\"AllSentencesSatisfy\\": true\\n },\\n \\"Operators\\": [\\n {\\n \\"Oid\\": \\"a\\",\\n \\"Id\\": 1,\\n \\"Type\\": \\"HIT_ANY_KEYWORDS\\",\\n \\"Param\\": {\\n \\"CustomerParam\\": {\\n \\"Field\\": \\"remark1\\",\\n \\"FieldType\\": 1,\\n \\"DataType\\": 1,\\n \\"Symbol\\": 1,\\n \\"Value\\": \\"xxx\\",\\n \\"ActualValue\\": \\"xx\\",\\n \\"ExpressionMetaDesc\\": {\\n \\"LeftFieldType\\": 0,\\n \\"LeftOperand\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"RightFieldType\\": 0,\\n \\"RightOperand\\": \\"\\",\\n \\"RoundingMode\\": \\"\\"\\n }\\n },\\n \\"Keywords\\": [\\n \\"你好\\"\\n ],\\n \\"Regex\\": \\"质疑.*\\",\\n \\"NotRegex\\": \\"优秀.*\\",\\n \\"Phrase\\": \\"你好,请问\\",\\n \\"References\\": [\\n \\"你好.{0,10}\\"\\n ],\\n \\"Interval\\": 1,\\n \\"IntervalEnd\\": 2,\\n \\"Threshold\\": 90,\\n \\"In_sentence\\": true,\\n \\"Target\\": 1,\\n \\"From_end\\": true,\\n \\"Different_role\\": true,\\n \\"Target_role\\": \\"客服\\",\\n \\"RoleId\\": 1,\\n \\"Velocity\\": 111,\\n \\"VelocityInMint\\": 1,\\n \\"KeywordExtension\\": 1,\\n \\"Synonyms\\": {\\n \\"key\\": [\\n \\"售卖\\"\\n ]\\n },\\n \\"Case_sensitive\\": true,\\n \\"Near_dialogue\\": true,\\n \\"MinWordSize\\": 1,\\n \\"Hit_time\\": 2,\\n \\"Excludes\\": [\\n \\"负向\\"\\n ],\\n \\"From\\": 0,\\n \\"CheckFirstSentence\\": true,\\n \\"Average\\": true,\\n \\"BeginType\\": \\"1\\",\\n \\"EndType\\": \\"2\\",\\n \\"CompareOperator\\": \\"gt\\",\\n \\"Pkey\\": \\"xx\\",\\n \\"Poutput_type\\": 1,\\n \\"SimilarlySentences\\": [\\n \\"我要购买\\"\\n ],\\n \\"LgfSentences\\": [\\n \\"你好{1}\\"\\n ],\\n \\"Score\\": 70,\\n \\"ContextChatMatch\\": true,\\n \\"KeywordMatchSize\\": 1,\\n \\"MaxEmotionChangeValue\\": 3,\\n \\"CheckType\\": 1,\\n \\"KnowledgeTargetId\\": \\"1\\",\\n \\"CategoryPathCode\\": \\"xx\\",\\n \\"KnowledgeTargetType\\": 1,\\n \\"KnowledgeTargetName\\": \\"订单\\",\\n \\"QuestionThreshold\\": \\"90\\",\\n \\"AnswerThreshold\\": \\"90\\",\\n \\"KnowledgeSentenceNum\\": 1,\\n \\"KnowledgeInfo\\": \\"下单\\",\\n \\"BotId\\": \\"chatbot-cn-xxx\\",\\n \\"UseEasAlgorithm\\": true,\\n \\"Pvalues\\": [\\n \\"\\"\\n ],\\n \\"Similarity_threshold\\": 90,\\n \\"AntModelInfo\\": {\\n \\"key\\": \\"xxx\\"\\n },\\n \\"DelayTime\\": 10,\\n \\"Knowledges\\": \\"\\",\\n \\"LlmModelCode\\": \\"\\",\\n \\"HitCondition\\": \\"\\",\\n \\"SceneName\\": \\"\\",\\n \\"Dimensions\\": [\\n {\\n \\"Dimension\\": \\"\\",\\n \\"Desc\\": \\"\\",\\n \\"ExcludeCondition\\": \\"\\",\\n \\"IncludeCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"Name\\": \\"a\\",\\n \\"UserGroup\\": \\"xxx\\",\\n \\"QualityCheckType\\": 0\\n }\\n ],\\n \\"Lambda\\": \\"a\\",\\n \\"Exclusion\\": 0,\\n \\"Name\\": \\"xx\\",\\n \\"UserGroup\\": \\"xxxx\\"\\n }\\n ],\\n \\"BranchHitId\\": 1,\\n \\"BranchInfoList\\": [\\n {\\n \\"Index\\": 1,\\n \\"Name\\": \\"节点A\\",\\n \\"NextNodeId\\": 2,\\n \\"Situation\\": {\\n \\"ConditionGroup\\": [\\n {\\n \\"Conditions\\": [\\n {\\n \\"Field\\": \\"remark1\\",\\n \\"FieldType\\": 1,\\n \\"DataType\\": 1,\\n \\"Symbol\\": 1,\\n \\"Value\\": \\"xxx\\",\\n \\"ActualValue\\": \\"xx\\",\\n \\"ExpressionMetaDesc\\": {\\n \\"LeftFieldType\\": 0,\\n \\"LeftOperand\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"RightFieldType\\": 0,\\n \\"RightOperand\\": \\"\\",\\n \\"RoundingMode\\": \\"\\"\\n }\\n }\\n ],\\n \\"Type\\": \\"1\\"\\n }\\n ],\\n \\"Type\\": \\"1\\"\\n },\\n \\"Lambda\\": \\"a&&b\\",\\n \\"CheckType\\": 0,\\n \\"Triggers\\": [\\n \\"a\\"\\n ]\\n }\\n ],\\n \\"RuleScoreType\\": 1,\\n \\"TaskFlowId\\": 1,\\n \\"ScoreNumType\\": 1,\\n \\"Matched\\": true,\\n \\"NodeType\\": \\"0\\",\\n \\"JudgeNodeName\\": \\"判断节点A\\",\\n \\"RuleName\\": \\"规则A\\"\\n }\\n ],\\n \\"HitTaskFlowList\\": [\\n {\\n \\"GraphFlow\\": {\\n \\"Id\\": 1,\\n \\"Rid\\": 1,\\n \\"RuleName\\": \\"违规\\",\\n \\"SkipWhenFirstSessionNodeMiss\\": true,\\n \\"FlowRuleScoreType\\": 1,\\n \\"ShowProperties\\": \\"{}\\",\\n \\"Nodes\\": [\\n {\\n \\"Id\\": 1,\\n \\"Rid\\": 1,\\n \\"Name\\": \\"开始节点\\",\\n \\"NodeType\\": \\"startNode\\",\\n \\"Index\\": 1,\\n \\"Content\\": \\"{}\\",\\n \\"Properties\\": {\\n \\"Type\\": \\"xx\\",\\n \\"Role\\": \\"客户\\",\\n \\"SayType\\": \\"\\",\\n \\"RuleScoreType\\": 1,\\n \\"ScoreNum\\": 1,\\n \\"ScoreType\\": 1,\\n \\"ScoreRuleHitType\\": 0,\\n \\"AutoReview\\": 1,\\n \\"ScoreNumType\\": 1,\\n \\"Lambda\\": \\"a\\",\\n \\"CheckType\\": 1,\\n \\"Triggers\\": [\\n \\"a\\"\\n ],\\n \\"BranchJudge\\": true,\\n \\"CheckMoreSize\\": 1\\n },\\n \\"Conditions\\": [\\n {\\n \\"Cid\\": \\"a\\",\\n \\"Id\\": 1,\\n \\"Rid\\": \\"1\\",\\n \\"Check_range\\": {\\n \\"RoleId\\": 1,\\n \\"Role\\": \\"客服\\",\\n \\"Anchor\\": {\\n \\"Cid\\": \\"a\\",\\n \\"Location\\": \\"BEFORE\\",\\n \\"Hit_time\\": 1\\n },\\n \\"Range\\": {\\n \\"From\\": 1,\\n \\"To\\": 2\\n },\\n \\"Absolute\\": true,\\n \\"AllSentencesSatisfy\\": true\\n },\\n \\"Operators\\": [\\n {\\n \\"Oid\\": \\"a\\",\\n \\"Id\\": 1,\\n \\"Type\\": \\"HIT_ANY_KEYWORDS\\",\\n \\"Param\\": {\\n \\"CustomerParam\\": {\\n \\"Field\\": \\"remark1\\",\\n \\"FieldType\\": 1,\\n \\"DataType\\": 1,\\n \\"Symbol\\": 1,\\n \\"Value\\": \\"xxx\\",\\n \\"ActualValue\\": \\"xx\\",\\n \\"ExpressionMetaDesc\\": {\\n \\"LeftFieldType\\": 0,\\n \\"LeftOperand\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"RightFieldType\\": 0,\\n \\"RightOperand\\": \\"\\",\\n \\"RoundingMode\\": \\"\\"\\n }\\n },\\n \\"Keywords\\": [\\n \\"你好\\"\\n ],\\n \\"Regex\\": \\"质疑.*\\",\\n \\"NotRegex\\": \\"优秀.*\\",\\n \\"Phrase\\": \\"你好,请问\\",\\n \\"References\\": [\\n \\"你好.{0,10}\\"\\n ],\\n \\"Interval\\": 1,\\n \\"IntervalEnd\\": 2,\\n \\"Threshold\\": 90,\\n \\"In_sentence\\": true,\\n \\"Target\\": 1,\\n \\"From_end\\": true,\\n \\"Different_role\\": true,\\n \\"Target_role\\": \\"客服\\",\\n \\"RoleId\\": 1,\\n \\"Velocity\\": 111,\\n \\"VelocityInMint\\": 1,\\n \\"KeywordExtension\\": 1,\\n \\"Synonyms\\": {\\n \\"key\\": [\\n \\"售卖\\"\\n ]\\n },\\n \\"Case_sensitive\\": true,\\n \\"Near_dialogue\\": true,\\n \\"MinWordSize\\": 1,\\n \\"Hit_time\\": 2,\\n \\"Excludes\\": [\\n \\"负向\\"\\n ],\\n \\"From\\": 0,\\n \\"CheckFirstSentence\\": true,\\n \\"Average\\": true,\\n \\"BeginType\\": \\"1\\",\\n \\"EndType\\": \\"2\\",\\n \\"CompareOperator\\": \\"gt\\",\\n \\"Pkey\\": \\"xx\\",\\n \\"Poutput_type\\": 1,\\n \\"SimilarlySentences\\": [\\n \\"我要购买\\"\\n ],\\n \\"LgfSentences\\": [\\n \\"你好{1}\\"\\n ],\\n \\"Score\\": 70,\\n \\"ContextChatMatch\\": true,\\n \\"KeywordMatchSize\\": 1,\\n \\"MaxEmotionChangeValue\\": 3,\\n \\"CheckType\\": 1,\\n \\"KnowledgeTargetId\\": \\"1\\",\\n \\"CategoryPathCode\\": \\"xx\\",\\n \\"KnowledgeTargetType\\": 1,\\n \\"KnowledgeTargetName\\": \\"订单\\",\\n \\"QuestionThreshold\\": \\"90\\",\\n \\"AnswerThreshold\\": \\"90\\",\\n \\"KnowledgeSentenceNum\\": 1,\\n \\"KnowledgeInfo\\": \\"下单\\",\\n \\"BotId\\": \\"chatbot-cn-xxx\\",\\n \\"UseEasAlgorithm\\": true,\\n \\"Pvalues\\": [\\n \\"\\"\\n ],\\n \\"Similarity_threshold\\": 90,\\n \\"AntModelInfo\\": {\\n \\"key\\": \\"xxx\\"\\n },\\n \\"DelayTime\\": 10,\\n \\"Knowledges\\": \\"\\",\\n \\"LlmModelCode\\": \\"\\",\\n \\"HitCondition\\": \\"\\",\\n \\"SceneName\\": \\"\\",\\n \\"Dimensions\\": [\\n {\\n \\"Dimension\\": \\"\\",\\n \\"Desc\\": \\"\\",\\n \\"ExcludeCondition\\": \\"\\",\\n \\"IncludeCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"Name\\": \\"a\\",\\n \\"UserGroup\\": \\"xxx\\",\\n \\"QualityCheckType\\": 0\\n }\\n ],\\n \\"Lambda\\": \\"a\\",\\n \\"Exclusion\\": 0,\\n \\"Name\\": \\"xx\\",\\n \\"UserGroup\\": \\"xxxx\\"\\n }\\n ],\\n \\"NextNodes\\": [\\n {\\n \\"Index\\": 1,\\n \\"Name\\": \\"a\\",\\n \\"NextNodeId\\": 31533,\\n \\"Lambda\\": \\"a\\",\\n \\"CheckType\\": 1,\\n \\"Triggers\\": [\\n \\"a\\"\\n ]\\n }\\n ],\\n \\"UseConditions\\": true\\n }\\n ]\\n },\\n \\"TaskFlowType\\": 0,\\n \\"Rid\\": 1\\n }\\n ],\\n \\"UnhitRuleReviewInfoList\\": [\\n {\\n \\"Rid\\": 2,\\n \\"ConditionInfoList\\": [\\n {\\n \\"Cid\\": \\"a\\",\\n \\"Id\\": 1,\\n \\"Rid\\": \\"1\\",\\n \\"Check_range\\": {\\n \\"RoleId\\": 1,\\n \\"Role\\": \\"客服\\",\\n \\"Anchor\\": {\\n \\"Cid\\": \\"a\\",\\n \\"Location\\": \\"BEFORE\\",\\n \\"Hit_time\\": 1\\n },\\n \\"Range\\": {\\n \\"From\\": 1,\\n \\"To\\": 2\\n },\\n \\"Absolute\\": true,\\n \\"AllSentencesSatisfy\\": true\\n },\\n \\"Operators\\": [\\n {\\n \\"Oid\\": \\"a\\",\\n \\"Id\\": 1,\\n \\"Type\\": \\"HIT_ANY_KEYWORDS\\",\\n \\"Param\\": {\\n \\"Keywords\\": [\\n \\"你好\\"\\n ],\\n \\"Regex\\": \\"质疑.*\\",\\n \\"NotRegex\\": \\"优秀.*\\",\\n \\"Phrase\\": \\"你好,请问\\",\\n \\"References\\": [\\n \\"你好.{0,10}\\"\\n ],\\n \\"Interval\\": 1,\\n \\"IntervalEnd\\": 2,\\n \\"Threshold\\": 90,\\n \\"In_sentence\\": true,\\n \\"Target\\": 1,\\n \\"From_end\\": true,\\n \\"Different_role\\": true,\\n \\"Target_role\\": \\"客服\\",\\n \\"RoleId\\": 1,\\n \\"Velocity\\": 111,\\n \\"VelocityInMint\\": 1,\\n \\"KeywordExtension\\": 1,\\n \\"Synonyms\\": {\\n \\"key\\": [\\n \\"售卖\\"\\n ]\\n },\\n \\"Case_sensitive\\": true,\\n \\"Near_dialogue\\": true,\\n \\"MinWordSize\\": 1,\\n \\"Hit_time\\": 2,\\n \\"Excludes\\": [\\n \\"负向\\"\\n ],\\n \\"From\\": 0,\\n \\"CheckFirstSentence\\": true,\\n \\"Average\\": true,\\n \\"BeginType\\": \\"1\\",\\n \\"EndType\\": \\"2\\",\\n \\"CompareOperator\\": \\"gt\\",\\n \\"Pkey\\": \\"xx\\",\\n \\"Poutput_type\\": 1,\\n \\"SimilarlySentences\\": [\\n \\"我要购买\\"\\n ],\\n \\"LgfSentences\\": [\\n \\"你好{1}\\"\\n ],\\n \\"Score\\": 70,\\n \\"ContextChatMatch\\": true,\\n \\"KeywordMatchSize\\": 1,\\n \\"MaxEmotionChangeValue\\": 3,\\n \\"CheckType\\": 1,\\n \\"KnowledgeTargetId\\": \\"1\\",\\n \\"CategoryPathCode\\": \\"xx\\",\\n \\"KnowledgeTargetType\\": 1,\\n \\"KnowledgeTargetName\\": \\"订单\\",\\n \\"QuestionThreshold\\": \\"90\\",\\n \\"AnswerThreshold\\": \\"90\\",\\n \\"KnowledgeSentenceNum\\": 1,\\n \\"KnowledgeInfo\\": \\"下单\\",\\n \\"BotId\\": \\"chatbot-cn-xxx\\",\\n \\"UseEasAlgorithm\\": true,\\n \\"Pvalues\\": [\\n \\"\\"\\n ],\\n \\"Similarity_threshold\\": 90,\\n \\"AntModelInfo\\": {\\n \\"key\\": \\"xxx\\"\\n },\\n \\"DelayTime\\": 10,\\n \\"Knowledges\\": \\"\\",\\n \\"LlmModelCode\\": \\"\\",\\n \\"HitCondition\\": \\"\\",\\n \\"SceneName\\": \\"\\",\\n \\"Dimensions\\": [\\n {\\n \\"Dimension\\": \\"\\",\\n \\"Desc\\": \\"\\",\\n \\"ExcludeCondition\\": \\"\\",\\n \\"IncludeCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"Name\\": \\"a\\",\\n \\"UserGroup\\": \\"xxx\\",\\n \\"QualityCheckType\\": 0\\n }\\n ],\\n \\"Lambda\\": \\"a\\",\\n \\"Exclusion\\": 0,\\n \\"Name\\": \\"xx\\",\\n \\"UserGroup\\": \\"xxxx\\"\\n }\\n ],\\n \\"Matched\\": true,\\n \\"TaskFlowType\\": 0\\n }\\n ]\\n },\\n \\"RequestId\\": \\"96138D8D-XXXX-4E41-XXXX-77AED1088BBD\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
],
- 'UpdateSyncQualityCheckData' => [
- 'methods' => [
- 'post',
- 'get',
+ 'UpdateAgent' => [
+ 'summary' => 'Modifies an agent.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREscaFRLL5D'],
],
+ 'parameters' => [
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The business space ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''],
+ ],
+ [
+ 'name' => 'JsonStr',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the following details.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4987D326-83D9-4A42-B9A5-0B27F9B40539'],
+ 'Code' => ['description' => 'The status code. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message, if any.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. The caller can use this field to determine whether the request was successful. Valid values:'."\n"
+ .'- true: The request was successful.'."\n"
+ .'- false/null: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Data' => ['description' => 'The returned result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Modify an agent',
+ 'requestParamsDescription' => '---'."\n"
+ ."\n"
+ .'# Request parameter description.'."\n"
+ ."\n"
+ .'## 1. Overview'."\n"
+ ."\n"
+ .'The input object for agent management requests. It consists of two parts: basic agent attribute configuration and instruction type parameters.'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'## 2. Top-level fields'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'|`id` | Long | Yes | The agent ID.'."\n"
+ .'| `agentName` | `String` | Yes | The agent name. |'."\n"
+ .'| `agentDescription` | `String` | No | The agent description. |'."\n"
+ .'| `modelType` | `String` | Yes | The large language model type. For valid values, see the `LLMCodeEnum` enumeration. |'."\n"
+ .'| `inputType` | `String` | Yes | The analysis object type. Valid values: `text`, `voice`, and `image`. |'."\n"
+ .'| `instructionType` | `String` | Yes | The instruction type code. For valid values, see the `AgentInstructionTypeEnum` enumeration (see the following table). |'."\n"
+ .'| `instructionTypeParam` | `InstructionTypeParam` | Yes | The detailed configuration parameters for the instruction type. Pass the corresponding sub-object based on the value of `instructionType`. |'."\n"
+ ."\n"
+ .'### instructionType enumeration values'."\n"
+ ."\n"
+ .'| code | Description | Corresponding Param |'."\n"
+ .'|------|------|-----------|'."\n"
+ .'| `serviceInspection` | Service quality inspection | `serviceInspectionParam` |'."\n"
+ .'| `field` | Key attribute extraction | `fieldsParam` |'."\n"
+ .'| `tagCategory` | Tag classification | `tagCategoryParam` |'."\n"
+ .'| `multiLevelTag` | Multi-level tag recognition | `tagTreeLevelParam` |'."\n"
+ .'| `customPrompt` | Custom instruction | `customPromptParam` |'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'## 3. InstructionTypeParam (instruction type parameters)'."\n"
+ ."\n"
+ .'`instructionTypeParam` is the configuration container for various instruction types. Based on the value of `instructionType`, **pass only the corresponding sub-object**. Other sub-objects can be null.'."\n"
+ ."\n"
+ .'| Field | Type | Description |'."\n"
+ .'|--------|------|------|'."\n"
+ .'| `fieldsParam` | `FieldsParam` | The key attribute extraction configuration. Pass this when `instructionType=field`. |'."\n"
+ .'| `serviceInspectionParam` | `ServiceInspectionParam` | The service quality inspection configuration. Pass this when `instructionType=serviceInspection`. |'."\n"
+ .'| `tagCategoryParam` | `TagCategoryParam` | The tag classification configuration. Pass this when `instructionType=tagCategory`. |'."\n"
+ .'| `tagTreeLevelParam` | `TagTreeLevelParam` | The multi-level tag analysis configuration. Pass this when `instructionType=multiLevelTag`. |'."\n"
+ .'| `customPromptParam` | `CustomPromptParam` | The custom instruction configuration. Pass this when `instructionType=customPrompt`. |'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'### 3.1 FieldsParam (key attribute extraction)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `nameDescPairList` | `List<NameDescPair>` | Yes | The list of key attribute dimensions to extract. |'."\n"
+ ."\n"
+ .'**NameDescPair structure:**'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `name` | `String` | Yes | The attribute name. |'."\n"
+ .'| `desc` | `String` | Yes | The attribute description. |'."\n"
+ .'| `value` | `String` | Yes | The attribute value. |'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'### 3.2 ServiceInspectionParam (service quality inspection)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `sceneName` | `String` | Yes | The quality inspection scenario name. |'."\n"
+ .'| `sceneDescription` | `String` | Yes | The quality inspection scenario description. |'."\n"
+ .'| `dimensions` | `List<Dimension>` | Yes | The list of quality inspection dimensions that define the specific inspection dimensions and their conditions. |'."\n"
+ ."\n"
+ .'**Dimension structure:**'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `dimension` | `String` | Yes | The dimension name. (`title` is also accepted as an alias during JSON deserialization.) |'."\n"
+ .'| `desc` | `String` | Yes | The dimension description. (`content` is also accepted as an alias during JSON deserialization.) |'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'### 3.3 TagCategoryParam (tag classification)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `nameDescPairList` | `List<NameDescValueListPair>` | Yes | The list of tag classification dimensions. Each dimension can contain multiple candidate tag values. |'."\n"
+ ."\n"
+ .'**NameDescValueListPair structure:**'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `name` | `String` | Yes | The dimension or classification name. |'."\n"
+ .'| `desc` | `String` | Yes | The dimension description. |'."\n"
+ .'| `valueList` | `List<String>` | Yes | The list of candidate tag values under this dimension. |'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'### 3.4 TagTreeLevelParam (multi-level tag recognition)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `tagIds` | `List<Long>` | Yes | The list of tag IDs passed at runtime. The first ID is used as the matched starting parent tag, and matching continues from its child nodes. |'."\n"
+ .'| `tagTreeLevels` | `List<TagTreeLevelInfoParam>` | Yes | The list of prompt configurations for each level, arranged in hierarchical order. |'."\n"
+ ."\n"
+ .'**TagTreeLevelInfoParam structure:**'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `tagTreeIds` | `List<Long>` | Yes | The list of candidate tag IDs for the current level. A value of `-1` indicates all tags at this level are selected. |'."\n"
+ .'| `prompt` | `String` | Yes | The analysis prompt for this level. It is concatenated with tag data and sent to the large language model for analysis. |'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'### 3.5 CustomPromptParam (custom instruction)'."\n"
+ ."\n"
+ .'| Field | Type | Required | Description |'."\n"
+ .'|--------|------|------|------|'."\n"
+ .'| `customPrompt` | `String` | Yes | The user-defined prompt instruction content. |'."\n"
+ .'| `nameDescPairList` | `List<NameDescPair>` | No | The list of custom fields used as additional variables referenced in the prompt. |'."\n"
+ ."\n"
+ .'**The NameDescPair structure is the same as in Section 3.1.**'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'## 4. Request example'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "id": 123,'."\n"
+ .' "userGroup": "default",'."\n"
+ .' "aliUid": 1000000001,'."\n"
+ .' "agentName": "客服质检Agent",'."\n"
+ .' "agentDescription": "用于客服对话质量的自动检测",'."\n"
+ .' "modelType": "qwen-max",'."\n"
+ .' "inputType": "text",'."\n"
+ .' "instructionType": "serviceInspection",'."\n"
+ .' "instructionTypeParam": {'."\n"
+ .' "serviceInspectionParam": {'."\n"
+ .' "sceneName": "售后客服场景",'."\n"
+ .' "sceneDescription": "检查售后客服对话的服务质量",'."\n"
+ .' "dimensions": ['."\n"
+ .' {'."\n"
+ .' "dimension": "服务态度",'."\n"
+ .' "desc": "检查客服是否使用礼貌用语",'."\n"
+ .' "includeCondition": "包含问候语和感谢语",'."\n"
+ .' "excludeCondition": "无明显不当用语则不排除"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'UpdateAsrVocab' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -13683,24 +14753,12 @@
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"tid":"xxx"}',
- ],
+ 'schema' => ['description' => 'The request parameters that are configured as a JSON string. For more information, see the details below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"vocabId":"指定热词Id"}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -13708,214 +14766,356 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '76DB5D8C-5BD9-42A7-B527-5AF3A5F8*** ',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123123D8C-5BD9-42A7-B527-1235F8**',
- ],
- 'Tid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20210101-1212121***',
- ],
- ],
- ],
+ 'Code' => ['description' => 'The status code. A value of **200** indicates that the request was successful. Other values indicate that the request failed.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message that is returned. If the request is successful, **successful** is returned. If the request fails, an error message is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'The ID of the hotword vocabulary. This is the value of the **vocabId** that you specified in the request.', 'type' => 'string', 'example' => '71b1795ac8634bd8bdf4d3878480c7c2', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '9987D326-83D9-4A42-B9A5-0B27F9B40539', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. A value of true indicates success. A value of **false** or **null** indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"76DB5D8C-5BD9-42A7-B527-5AF3A5F8***\\\\t\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"123123D8C-5BD9-42A7-B527-1235F8**\\",\\n \\"Tid\\": \\"20210101-1212121***\\"\\n }\\n}","type":"json"}]',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"71b1795ac8634bd8bdf4d3878480c7c2\\",\\n \\"RequestId\\": \\"9987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Update Hotword Group ',
+ 'summary' => 'Updates the hotword vocabulary.',
+ 'requestParamsDescription' => '**JSON string details**'."\n"
+ ."\n"
+ .'| Parameter | Type | Required | Description |'."\n"
+ .'| :-------- | :----- | :------- | :------------------------------------------------------------------------------------------ |'."\n"
+ .'| vocabId | String | Yes | The ID of the hotword vocabulary. |'."\n"
+ .'| words | List | Yes | A list of hotwords. For more information, see the description of the words parameter below. |'."\n"
+ .'| name | String | No | The name of the hotword vocabulary. |'."\n"
+ ."\n"
+ .'**Details of the words parameter**'."\n"
+ ."\n"
+ .'| Parameter | Type | Required | Description |'."\n"
+ .'| :-------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| word | String | Yes | The hotword. |'."\n"
+ .'| weight | Integer | No | The weight of the hotword. The default value is 2. The value must be an integer from -6 to 5. A positive weight increases the recognition probability. A negative weight decreases the recognition probability. A weight of -6 prevents the word from being recognized. A weight of 2 is a common setting. If the recognition is not effective, increase the weight. However, a large weight may reduce the recognition accuracy of other words. |',
'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'extraInfo' => '### Sample invocation'."\n"
+ .'```'."\n"
+ .'UpdateAsrVocabRequest UpdateAsrVocabRequest = new UpdateAsrVocabRequest();'."\n"
+ .'UpdateAsrVocabRequest.setAcceptFormat(FormatType.JSON);'."\n"
+ .'String dataJsonStr = "{'."\n"
+ .'" +'."\n"
+ .'""vocabId":"yourVocabId","+'."\n"
+ .'""customWords":{" +'."\n"
+ .' ""New Custom 2":2,"+'."\n"
+ .' ""New Custom 1":1"+'."\n"
+ .'"},"+'."\n"
+ .'""strenWords":["+'."\n"
+ .' ""New Strengthened","+'."\n"
+ .' ""New Enhanced""+'."\n"
+ .'"],"+'."\n"
+ .'""weakWords":["+'."\n"
+ .' ""New Weakened","+'."\n"
+ .' ""New Reduced""+'."\n"
+ .'"]"+'."\n"
+ .'"}";'."\n"
+ .'UpdateAsrVocabRequest.setJsonStr(dataJsonStr);'."\n"
+ .'UpdateAsrVocabResponse response = client.getAcsResponse(UpdateAsrVocabRequest);'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateAsrVocab'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'DeleteSchemeTaskConfig' => [
- 'summary' => '删除质检任务',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateCheckTypeToScheme' => [
+ 'summary' => 'You can access this operation from the frontend by navigating to Plan Management > Create Quality Inspection Task or Edit > Edit icon next to the quality inspection dimension name. The Apsara Stack endpoint is ip:port/api/qcs/UpdateCheckTypeToScheme.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'jsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"schemeId":"329"}',
- ],
+ 'schema' => ['description' => 'Input parameter in JSON format. For more information, see the request parameters.', 'type' => 'string', 'required' => false, 'example' => '{"schemeId":"187","checkName":"服务规范性检测2","sourceScore":20,"checkType":0}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The baseMeAgentId.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BaseResult',
- 'description' => 'BaseResult',
+ 'title' => 'PlainResult<Long>',
+ 'description' => 'PlainResult',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4D55C6',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Data' => ['description' => 'The returned result.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. A value of true indicates success. A value of false or null indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Other values indicate failure. This code helps identify the cause of a failed request.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error details if the request fails. If the request is successful, the value is **successful**.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'Messages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Message' => [
- 'description' => '',
+ 'description' => 'A list of messages. This parameter can be ignored.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'items' => ['description' => 'A message. This parameter can be ignored.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'HttpStatusCode' => [
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 4,\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Update Quality Inspection Dimension ',
+ 'requestParamsDescription' => '### JsonStr description'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| ----------- | ---------- | -------- | --------------------------------------------- |'."\n"
+ .'| schemeId | Integer | Yes | The ID of the quality inspection plan. |'."\n"
+ .'| checkName | String | No | The name of the quality inspection dimension. |'."\n"
+ .'| sourceScore | Integer | No | The quality inspection score. |'."\n"
+ .'| enable | Integer | No | Specifies whether to enable the feature. |',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '360', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateCheckTypeToScheme'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'DeleteRule' => [
- 'summary' => '删除规则',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateQualityCheckData' => [
+ 'summary' => 'Update session recording data (third-party business fields) to facilitate statistics and queries across more business dimensions.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'deprecated' => true,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'RuleId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Complete JSON string containing detailed information. For specific content, see the details below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"taskId":"xxx"}', 'title' => ''],
],
[
- 'name' => 'ForceDelete',
- 'in' => 'formData',
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'baseMeAgentId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'Result code. A value of 200 indicates success. Any other value indicates failure, and the caller can determine the cause of failure based on this field.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'When an error occurs, this field provides error details; when the operation succeeds, it returns "successful".', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. The caller can use this field to determine whether the request was successful: true indicates success; false or null indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'IsSchemeData',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- '',
- '',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"xxx\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Update ad-hoc recording data',
+ 'requestParamsDescription' => '## jsonStr Property Description: '."\n"
+ .'Note: There are two ways to specify conversation data. The first is by using taskId and fileId together to precisely identify a single conversation record. The second is by using callId, which may return multiple records. You only need to choose one of these two methods.'."\n"
+ ."\n"
+ .'| Property | Value Type | Required | Description |'."\n"
+ .'| :--- | :--- | :--- | :--- |'."\n"
+ .'| taskId | String | No | The task ID returned after uploading quality inspection data. |'."\n"
+ .'| fileId | String | No | The file ID, which can be obtained by calling GetResult. It corresponds to recording.id in the Return Result. |'."\n"
+ .'| callId | String | No | The call ID. If multiple conversations exist for this call ID, at most the first 100 records will be updated. |'."\n"
+ .'| fileName | String | No | The audio file name. |'."\n"
+ .'| business | String | No | The line-of-business name. This is Custom data used for categorization and Statistics. |'."\n"
+ .'| jsonParamStr | String | No | Additional Custom Fields, formatted as a JSON string where the key is the Column Name and the value is the Content. Sample: {"客户登记": 3, "渠道": "官网"}. |'."\n"
+ .'| remark1 | String | No | Custom data 1, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark2 | String | No | Custom data 2, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark3 | String | No | Custom data 3, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark4 | String | No | Custom data 4, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark5 | Long | No | Custom data 5, which can store business-related Custom fields, formatted as a signed long. |'."\n"
+ .'| remark6 | String | No | Custom data 6, which can store business-related Custom fields, with a maximum length of 1024 characters. |'."\n"
+ .'| remark7 | String | No | Custom data 7, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark8 | String | No | Custom data 8, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark9 | String | No | Custom data 9, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark10 | String | No | Custom data 10, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark11 | String | No | Custom data 11, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark12 | String | No | Custom data 12, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark13 | String | No | Custom data 13, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark14 | Long | No | Custom data 14, which can store business-related Custom fields, formatted as a signed long. |'."\n"
+ .'| remark15 | Long | No | Custom data 15, which can store business-related Custom fields, formatted as a signed long. |'."\n"
+ .'| remark16 | String | No | Custom data 16, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark17 | String | No | Custom data 17, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark18 | Long | No | Custom data 18, which can store business-related Custom fields, formatted as a signed long. |'."\n"
+ .'| remark19 | String | No | Custom data 19, which can store business-related Custom fields, with a maximum length of 1024 characters. |'."\n"
+ .'| remark20 | String | No | Custom data 20, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark21 | String | No | Custom data 21, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark22 | String | No | Custom data 22, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark23 | String | No | Custom data 23, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark24 | String | No | Custom data 24, which can store business-related Custom fields, with a maximum length of 64 characters. |'."\n"
+ .'| remark25 | String | No | Custom data 25, which can store business-related Custom fields, with a maximum length of 64 characters. |',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:44.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-05-30T12:54:57.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '3000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateQualityCheckData'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateQualityCheckData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'example' => '1',
- 'default' => '1',
],
],
+ ],
+ ],
+ 'UpdateQualityCheckScheme' => [
+ 'summary' => 'Updates a quality check scheme.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'jsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The request parameters in JSON format. For more information, see the supplementary description of request parameters.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''],
+ ],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
@@ -13925,851 +15125,909 @@
'description' => 'BaseResult',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '96138D8D-8D26-4E41-BFF4-77AED1088BBD', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success. A value of \\`false\\` or \\`null\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Other values indicate failure. Use this field to determine the cause of a failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error details if the request fails. If the request is successful, the value is \\`successful\\`.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'Messages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Message' => [
- 'description' => '',
+ 'description' => 'A list of messages. Ignore this parameter.',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
+ 'items' => ['description' => 'A message. Ignore this parameter.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'HttpStatusCode' => [
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'substitutions' => [
- 'Qualitycheck::2019-01-15::DeleteRuleV4',
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"96138D8D-8D26-4E41-BFF4-77AED1088BBD\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Update Quality Inspection Plan',
+ 'requestParamsDescription' => 'For more information about requests, see the [`Quality check scheme object description`](https://help.aliyun.com/document_detail/453310.html) document.'."\n"
+ ."\n"
+ .'## Request parameter example'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "schemeId": "1726",'."\n"
+ .' "name": "test-001"'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Request code example'."\n"
+ ."\n"
+ .'```java'."\n"
+ ."\n"
+ .'import com.alibaba.fastjson.JSONObject;'."\n"
+ .'import com.aliyun.qualitycheck20190115.Client;'."\n"
+ .'import com.aliyun.qualitycheck20190115.models.*;'."\n"
+ .'import com.aliyun.teaopenapi.models.Config;'."\n"
+ ."\n\n"
+ .'public class sca {'."\n"
+ ."\n"
+ .' private static String ak = "YOUR_ACCESS_KEY_ID";'."\n"
+ .' private static String sk = "YOUR_ACCESS_KEY_SECRET";'."\n"
+ ."\n"
+ .' private static void updateQualityCheckScheme() throws Exception {'."\n"
+ .' String json="{\\"schemeId\\":\\"1726\\",\\"name\\":\\"test-001\\"}";'."\n"
+ ."\n"
+ .' Config config = new Config();'."\n"
+ .' config.setAccessKeyId(ak).setAccessKeySecret(sk)'."\n"
+ .' .setEndpoint("qualitycheck.cn-hangzhou.aliyuncs.com")'."\n"
+ .' .setRegionId("cn-hangzhou").setProtocol("HTTPS");'."\n"
+ ."\n"
+ .' Client client = new Client(config);'."\n"
+ .' UpdateQualityCheckSchemeRequest result = new UpdateQualityCheckSchemeRequest();'."\n"
+ ."\n"
+ .' result.setJsonStr(json);'."\n"
+ ."\n"
+ .' UpdateQualityCheckSchemeResponse response = client.updateQualityCheckScheme(result);'."\n"
+ .' System.out.println(JSONObject.toJSONString(response));'."\n"
+ .' }'."\n"
+ ."\n"
+ .' public static void main(String[] args) throws Exception {'."\n"
+ .' updateQualityCheckScheme();'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateQualityCheckScheme'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'GetRuleById' => [
- 'summary' => '获取规则',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateRule' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => true,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'RuleId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '53',
- ],
+ 'name' => 'JsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A complete JSON string. For details, see the following section.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"conditions":"所有条件的配置信息"}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<RulesInfo>',
- 'description' => 'PlainResult<RulesInfo>',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'example' => '',
- '$ref' => '#/components/schemas/RulesInfo',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** ',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Messages' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Details about the error if the call fails. Returns **successful** if the call succeeds.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'The response data.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4987D326-83D9-4A42-B9A5-0B27F9B40539', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Use this field to determine success:'."\n"
+ ."\n"
+ .'- **true** means success'."\n"
+ ."\n"
+ .'- false or **null** means failure', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'staticInfo' => [
- 'substitutions' => [
- 'Qualitycheck::2019-01-15::GetRuleV4',
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Conditions\\": [\\n {\\n \\"Cid\\": \\"\\",\\n \\"Id\\": 0,\\n \\"Rid\\": \\"\\",\\n \\"Check_range\\": {\\n \\"RoleId\\": 0,\\n \\"Role\\": \\"\\",\\n \\"Anchor\\": {\\n \\"Cid\\": \\"\\",\\n \\"Location\\": \\"\\",\\n \\"Hit_time\\": 0\\n },\\n \\"Range\\": {\\n \\"From\\": 0,\\n \\"To\\": 0\\n },\\n \\"Absolute\\": true,\\n \\"AllSentencesSatisfy\\": true\\n },\\n \\"Operators\\": [\\n {\\n \\"Oid\\": \\"\\",\\n \\"Id\\": 0,\\n \\"Type\\": \\"\\",\\n \\"Param\\": {\\n \\"CustomerParam\\": {\\n \\"Field\\": \\"\\",\\n \\"FieldType\\": 0,\\n \\"DataType\\": 0,\\n \\"Symbol\\": 0,\\n \\"Value\\": \\"\\",\\n \\"ActualValue\\": \\"\\",\\n \\"ExpressionMetaDesc\\": {\\n \\"LeftFieldType\\": 0,\\n \\"LeftOperand\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"RightFieldType\\": 0,\\n \\"RightOperand\\": \\"\\",\\n \\"RoundingMode\\": \\"\\"\\n }\\n },\\n \\"Keywords\\": [\\n \\"\\"\\n ],\\n \\"Regex\\": \\"\\",\\n \\"NotRegex\\": \\"\\",\\n \\"Phrase\\": \\"\\",\\n \\"References\\": [\\n \\"\\"\\n ],\\n \\"Interval\\": 0,\\n \\"IntervalEnd\\": 0,\\n \\"Threshold\\": 0,\\n \\"In_sentence\\": true,\\n \\"Target\\": 0,\\n \\"From_end\\": true,\\n \\"Different_role\\": true,\\n \\"Target_role\\": \\"\\",\\n \\"RoleId\\": 0,\\n \\"Velocity\\": 0,\\n \\"VelocityInMint\\": 0,\\n \\"KeywordExtension\\": 0,\\n \\"Synonyms\\": {\\n \\"key\\": [\\n \\"\\"\\n ]\\n },\\n \\"Case_sensitive\\": true,\\n \\"Near_dialogue\\": true,\\n \\"MinWordSize\\": 0,\\n \\"Hit_time\\": 0,\\n \\"Excludes\\": [\\n \\"\\"\\n ],\\n \\"From\\": 0,\\n \\"CheckFirstSentence\\": true,\\n \\"Average\\": true,\\n \\"BeginType\\": \\"\\",\\n \\"EndType\\": \\"\\",\\n \\"CompareOperator\\": \\"\\",\\n \\"Pkey\\": \\"\\",\\n \\"Poutput_type\\": 0,\\n \\"SimilarlySentences\\": [\\n \\"\\"\\n ],\\n \\"LgfSentences\\": [\\n \\"\\"\\n ],\\n \\"Score\\": 0,\\n \\"ContextChatMatch\\": true,\\n \\"KeywordMatchSize\\": 0,\\n \\"MaxEmotionChangeValue\\": 0,\\n \\"CheckType\\": 0,\\n \\"KnowledgeTargetId\\": \\"\\",\\n \\"CategoryPathCode\\": \\"\\",\\n \\"KnowledgeTargetType\\": 0,\\n \\"KnowledgeTargetName\\": \\"\\",\\n \\"QuestionThreshold\\": \\"\\",\\n \\"AnswerThreshold\\": \\"\\",\\n \\"KnowledgeSentenceNum\\": 0,\\n \\"KnowledgeInfo\\": \\"\\",\\n \\"BotId\\": \\"\\",\\n \\"UseEasAlgorithm\\": true,\\n \\"Pvalues\\": [\\n \\"\\"\\n ],\\n \\"Similarity_threshold\\": 0,\\n \\"AntModelInfo\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"DelayTime\\": 0,\\n \\"Knowledges\\": \\"\\",\\n \\"LlmModelCode\\": \\"\\",\\n \\"HitCondition\\": \\"\\",\\n \\"SceneName\\": \\"\\",\\n \\"Dimensions\\": [\\n {\\n \\"Dimension\\": \\"\\",\\n \\"Desc\\": \\"\\",\\n \\"ExcludeCondition\\": \\"\\",\\n \\"IncludeCondition\\": \\"\\"\\n }\\n ]\\n },\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\",\\n \\"QualityCheckType\\": 0\\n }\\n ],\\n \\"Lambda\\": \\"\\",\\n \\"Exclusion\\": 0,\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\"\\n }\\n ],\\n \\"Rules\\": [\\n {\\n \\"Status\\": 0,\\n \\"IsDelete\\": 0,\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"Weight\\": \\"\\",\\n \\"IsOnline\\": 0,\\n \\"CreateEmpid\\": \\"\\",\\n \\"CreateEmpName\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"LastUpdateTime\\": \\"\\",\\n \\"LastUpdateEmpid\\": \\"\\",\\n \\"LastUpdateEmpName\\": \\"\\",\\n \\"Comments\\": \\"\\",\\n \\"Deny\\": 0,\\n \\"ScoreSubId\\": 0,\\n \\"ScoreName\\": \\"\\",\\n \\"ScoreSubName\\": \\"\\",\\n \\"ScoreNum\\": 0,\\n \\"ScoreType\\": 0,\\n \\"ScoreDeleted\\": true,\\n \\"OperationMode\\": 0,\\n \\"Meet\\": 0,\\n \\"Effective\\": 0,\\n \\"FullCycle\\": 0,\\n \\"EffectiveStartTime\\": \\"\\",\\n \\"EffectiveEndTime\\": \\"\\",\\n \\"QualityCheckType\\": 0,\\n \\"Level\\": 0,\\n \\"GraphFlow\\": \\"\\",\\n \\"TaskFlowType\\": 0,\\n \\"CheckType\\": 0,\\n \\"SchemeCheckType\\": {\\n \\"CheckType\\": 0,\\n \\"CheckName\\": \\"\\",\\n \\"SourceScore\\": 0,\\n \\"Score\\": 0,\\n \\"Enable\\": 0,\\n \\"SchemeId\\": 0,\\n \\"SchemeScoreInfoList\\": [\\n {\\n \\"Rid\\": 0,\\n \\"Name\\": \\"\\",\\n \\"TaskFlowId\\": 0,\\n \\"TaskFlowName\\": \\"\\",\\n \\"ScoreType\\": 0,\\n \\"ScoreNumType\\": 0,\\n \\"ScoreNum\\": 0,\\n \\"ScoreRuleHitType\\": 0\\n }\\n ],\\n \\"TaskFlowScoreInfoList\\": [\\n {\\n \\"TaskFlowId\\": 0,\\n \\"TaskFlowName\\": \\"\\",\\n \\"TaskFlowType\\": 0,\\n \\"SchemeScoreInfoList\\": [\\n {\\n \\"Rid\\": 0,\\n \\"Name\\": \\"\\",\\n \\"TaskFlowId\\": 0,\\n \\"TaskFlowName\\": \\"\\",\\n \\"ScoreType\\": 0,\\n \\"ScoreNumType\\": 0,\\n \\"ScoreNum\\": 0,\\n \\"ScoreRuleHitType\\": 0\\n }\\n ]\\n }\\n ]\\n },\\n \\"TargetType\\": 0,\\n \\"ConfigType\\": 0,\\n \\"ScoreNumType\\": 0,\\n \\"ScoreRuleHitType\\": 0,\\n \\"SchemeId\\": 0,\\n \\"SchemeRuleMappingId\\": 0,\\n \\"SchemeName\\": \\"\\",\\n \\"ModifyType\\": 0,\\n \\"SortIndex\\": 0,\\n \\"RuleType\\": 0,\\n \\"Rid\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"TaskFlowId\\": 0,\\n \\"Lambda\\": \\"\\",\\n \\"ExternalProperty\\": 0,\\n \\"Type\\": 0,\\n \\"RuleCategoryName\\": \\"\\",\\n \\"AutoReview\\": 0,\\n \\"RuleScoreType\\": 0,\\n \\"ScoreId\\": 0,\\n \\"PreqRule\\": {\\n \\"Rid\\": \\"\\"\\n },\\n \\"BusinessCategoryNameList\\": [\\n \\"\\"\\n ],\\n \\"Dialogues\\": [\\n {\\n \\"Id\\": 0,\\n \\"Content\\": [\\n {\\n \\"HourMinSec\\": \\"\\",\\n \\"Role\\": \\"\\",\\n \\"Identity\\": \\"\\",\\n \\"EmotionValue\\": 0,\\n \\"SpeechRate\\": 0,\\n \\"Words\\": \\"\\",\\n \\"End\\": 0,\\n \\"SilenceDuration\\": 0,\\n \\"BeginTime\\": 0,\\n \\"Begin\\": 0\\n }\\n ],\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\"\\n }\\n ],\\n \\"Triggers\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"Dialogues\\": [\\n {\\n \\"Id\\": 0,\\n \\"Content\\": [\\n {\\n \\"HourMinSec\\": \\"\\",\\n \\"Role\\": \\"\\",\\n \\"Identity\\": \\"\\",\\n \\"EmotionValue\\": 0,\\n \\"SpeechRate\\": 0,\\n \\"Words\\": \\"\\",\\n \\"End\\": 0,\\n \\"SilenceDuration\\": 0,\\n \\"BeginTime\\": 0,\\n \\"Begin\\": 0\\n }\\n ],\\n \\"Name\\": \\"\\",\\n \\"UserGroup\\": \\"\\"\\n }\\n ],\\n \\"Count\\": 0,\\n \\"PageSize\\": 0,\\n \\"PageNumber\\": 0\\n },\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": [\\n \\"无\\"\\n ],\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'substitutions' => ['Qualitycheck::2019-01-15::UpdateRuleV4'],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"xxx\\",\\n \\"RequestId\\": \\"4987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Update Rule',
+ 'summary' => 'Update rule information.',
+ 'description' => '> Update an existing rule. You can modify its conditions and operators as needed. The rule ID (rid) remains unchanged, but condition IDs and operator IDs may change.',
+ 'requestParamsDescription' => '**JSON request parameter details**'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :--------- | :------------------------- | :------- | :------------------------------- |'."\n"
+ .'| conditions | `List<ConditionBasicInfo>` | Yes | Configuration for all conditions |'."\n"
+ .'| rules | `List<RuleInfo>` | Yes | Configuration for all rules |'."\n"
+ ."\n"
+ .'For details about condition and rule configuration, see [Create a rule](~~142307~~).',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-19T06:19:54.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateRule'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'GetRulesCountList' => [
- 'summary' => '获得规则列表',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateRuleById' => [
+ 'summary' => 'This API maps to the frontend function location: Quality Inspection Rule Configuration - Create & Update. The Apsara Stack URL is: ip:port/api/client/UpdateRuleById.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'deprecated' => false,
- 'systemTags' => [],
+ 'deprecated' => true,
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'Rid',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123',
- ],
- ],
- [
- 'name' => 'RuleIdOrRuleName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
- ],
- [
- 'name' => 'BusinessName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- ],
- [
- 'name' => 'Type',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'TypeName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- ],
- [
- 'name' => 'BusinessRange',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'CreateEmpid',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '63',
- ],
- ],
- [
- 'name' => 'CreateUserId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '63',
- ],
- ],
- [
- 'name' => 'UpdateUserId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '63',
- ],
- ],
- [
- 'name' => 'LastUpdateEmpid',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '63',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- '',
- '',
- '',
- '',
- ],
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'CategoryName',
+ 'name' => 'RuleId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Rule ID. Not required when creating, required when modifying.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'SourceType',
+ 'name' => 'JsonStrForRule',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- '',
- 'ACC',
- ],
- 'example' => '0',
- ],
+ 'schema' => ['description' => 'For more information about the format of JsonStrForlRule, see [`Rule object description`](https://help.aliyun.com/document_detail/453053.html).', 'type' => 'string', 'required' => true, 'example' => '{}', 'title' => ''],
],
[
- 'name' => 'RuleType',
+ 'name' => 'ReturnRelatedSchemes',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- '',
- '',
- ],
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'Returns the IDs and names of quality inspection schemes associated with this rule.', 'type' => 'boolean', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'UpdateStartTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2022-10-07 00:00:00',
- ],
- ],
- [
- 'name' => 'UpdateEndTime',
+ 'name' => 'IsCopy',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2022-10-08 23:59:59',
- ],
+ 'schema' => ['description' => 'Whether to copy. Setting to true is equivalent to copying the rule.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
- 'name' => 'SchemeId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123',
- ],
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
- [
- 'name' => 'RequireInfos',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'ConditionInfo' => '',
- 'ScoreInfo' => '',
- 'OperatorInfo' => '',
- 'SchemeNames' => '',
- 'TransUserName' => '',
- 'BusinessNameInfo' => '',
- 'GraphFlowInfo' => '',
- 'RuleCategory' => '',
+ 'title' => 'BaseResult',
+ 'description' => 'BaseResult',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4D55C6', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Callers can use this field to determine if the request succeeded: true for success, false/null for failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. **200** indicates success. Other values indicate failure. Callers can use this field to determine the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Provides error details on failure, and **successful** on success.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Messages' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'Message' => [
+ 'description' => 'Provides error details on failure, used when multiple messages are output.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Provides error details on failure, used when multiple messages are output.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'example' => 'ConditionInfo',
+ 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
- 'required' => false,
- 'maxItems' => 10,
- ],
- ],
- [
- 'name' => 'RuleScoreSingleType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- 1 => '',
- '',
- 4 => '',
- 8 => '',
- ],
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'CurrentPage',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
- ],
- [
- 'name' => 'CountTotal',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => [
+ 'substitutions' => ['Qualitycheck::2019-01-15::UpdateRuleV4'],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Create or Update a Quality Inspection Rule',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateRuleById'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'UpdateRuleToScheme' => [
+ 'summary' => 'Frontend location: Quality Check Plan Management > Create or edit a quality check task > Associate quality check rules. Apsara Stack URL: ip:port/api/qcs/UpdateRuleToScheme.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'StartTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2022-10-07 00:00:00',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
[
- 'name' => 'EndTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2022-10-08 23:59:59',
- ],
+ 'name' => 'jsonStr',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Request JSON. For details, see the request parameter description below.', 'type' => 'string', 'required' => false, 'example' => '{"schemeId":"10","schemeRules":[{"ruleId":229,"checkType":0}]}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232927'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'RulePageResult<RuleCountInfo>',
- 'description' => 'RulePageResult<RuleCountInfo>',
+ 'title' => 'PlainResult<Long>',
+ 'description' => 'PlainResult\\<long>',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '7',
- ],
- 'BusinessType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '',
- ],
- 'Data' => [
- 'type' => 'object',
+ 'Data' => ['description' => 'Quality check plan ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '9987D326-83D9-4A42-B9A5-0B27F9B40539', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Use this field to determine success: true means success. **false** or **null** means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. **200** means success. Any other value means failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request failed. Returns successful if the request succeeded.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Messages' => [
'itemNode' => true,
- 'properties' => [
- 'Data' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'Count' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'CurrentPage' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9987D326-83D9-4A42-B9A5-0B27F9B40539',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Messages' => [
'type' => 'object',
- 'itemNode' => true,
'properties' => [
'Message' => [
- 'description' => '',
+ 'description' => 'List of messages. Ignore this field.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'items' => ['description' => 'Message text. Ignore this field.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 7,\\n \\"BusinessType\\": 0,\\n \\"Data\\": {\\n \\"Data\\": [\\n \\"\\"\\n ]\\n },\\n \\"Count\\": 20,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"9987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 30,\\n \\"RequestId\\": \\"9987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Update rules in a quality inspection plan ',
+ 'requestParamsDescription' => '### About jsonStr'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| -------------------- | ----------------- | -------------------------------------------------------- | --------------------------- |'."\n"
+ .'| schemeId | String | Yes | Quality check plan ID. |'."\n"
+ .'| schemeRules | Array<schemerule> | At least one of schemeRules or ridDeleteSet is required. | List of rules to attach. |'."\n"
+ .'| schemeRule.ruleId | Integer | Yes | Rule ID. |'."\n"
+ .'| schemeRule.checkType | Integer | Yes | Quality check dimension ID. |'."\n"
+ .'| ridDeleteSet | Array<integer> | At least one of schemeRules or ridDeleteSet is required. | List of rule IDs to detach. |'."\n"
+ ."\n"
+ .'You can attach or detach rules in a quality check plan.'."\n"
+ .'Obtain the quality check plan ID and quality check dimension ID by calling GetQualityCheckScheme.'."\n"
+ ."\n"
+ .'## Sample request parameters'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "schemeId": "1727",'."\n"
+ .' "schemeRules": ['."\n"
+ .' {'."\n"
+ .' "ruleId": 50298,'."\n"
+ .' "checkType": 0'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "ruleId": 50299,'."\n"
+ .' "checkType": 0'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Sample Java code'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'public class sca {'."\n"
+ ."\n"
+ .' private static String ak = "YOUR_ACCESS_KEY_ID";'."\n"
+ .' private static String sk = "YOUR_ACCESS_KEY_SECRET";'."\n"
+ ."\n"
+ .' private static void addRuleToScheme() throws Exception {'."\n"
+ .' String json="{\\"schemeId\\":\\"1727\\",\\"schemeRules\\":[{\\"ruleId\\":50298,\\"checkType\\":0},{\\"ruleId\\":50299,\\"checkType\\":0}]}";'."\n"
+ ."\n"
+ .' Config config = new Config();'."\n"
+ .' config.setAccessKeyId(ak).setAccessKeySecret(sk)'."\n"
+ .' .setEndpoint("qualitycheck.cn-hangzhou.aliyuncs.com")'."\n"
+ .' .setRegionId("cn-hangzhou").setProtocol("HTTPS");'."\n"
+ ."\n"
+ .' Client client = new Client(config);'."\n"
+ .' UpdateRuleToSchemeRequest result = new UpdateRuleToSchemeRequest();'."\n"
+ ."\n"
+ .' result.setJsonStr(json);'."\n"
+ ."\n"
+ .' UpdateRuleToSchemeResponse response = client.updateRuleToScheme(result);'."\n"
+ .' System.out.println(JSONObject.toJSONString(response));'."\n"
+ .' }'."\n"
+ ."\n"
+ .' public static void main(String[] args) throws Exception {'."\n"
+ .' addRuleToScheme();'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateRuleToScheme'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'UpdateRuleById' => [
- 'summary' => '更新规则',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateRuleV4' => [
+ 'summary' => 'Corresponding frontend feature location: Rule Configuration - Update. Apsara Stack URL: ip:port/api/client/UpdateRuleById.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'deprecated' => true,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'deprecated' => false,
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'Rule ID. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'JsonStrForRule',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '{}',
- ],
- ],
- [
- 'name' => 'ReturnRelatedSchemes',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'IsCopy',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'For details about JsonStrForRule, see the document [`Rule Object Description`](~~453053~~). ', 'type' => 'string', 'required' => true, 'example' => '无', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'baseMeAgentId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResult',
- 'description' => 'BaseResult',
+ 'description' => 'BaseResult。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4D55C6',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['description' => 'Request ID. '."\n", 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. The caller can use this field to determine the request status: true indicates success; false or null indicates failure. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. A value of 200 indicates success. Any other value indicates failure. The caller can use this field to determine the reason for failure. ', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'When an error occurs, this field provides error details. When the request succeeds, the value is **successful**. ', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'Messages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Message' => [
- 'description' => '',
+ 'description' => 'When an error occurs, this field provides error details. It is used when multiple messages are returned.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'items' => ['description' => 'When an error occurs, this field provides error details. It is used when multiple messages are returned.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'HttpStatusCode' => [
'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'The HTTP response status code returned by the HTTP Request. A value of 200 indicates that the request succeeded. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Data' => ['description' => 'The updated rule ID. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'substitutions' => [
- 'Qualitycheck::2019-01-15::UpdateRuleV4',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 1\\n}","type":"json"}]',
+ 'title' => 'Update Rule (New Quality Inspection) ',
+ 'requestParamsDescription' => '## Request Input Parameter Sample'."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "rules": ['."\n"
+ .' {'."\n"
+ .' "autoReview": 1,'."\n"
+ .' "business": ['."\n"
+ .' {'."\n"
+ .' "name": "All Businesses",'."\n"
+ .' "bid": 0'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "comments": "Create Testing Rule",'."\n"
+ .' "fullCycle": 1,'."\n"
+ .' "level": 2,'."\n"
+ .' "name": "siqi-test",'."\n"
+ .' "targetType": 10,'."\n"
+ .' "type": 1,'."\n"
+ .' "rid": 50298,'."\n"
+ .' "scoreNumType": 0,'."\n"
+ .' "scoreType": 1,'."\n"
+ .' "scoreNum": 1,'."\n"
+ .' "lambda": "a",'."\n"
+ .' "triggers": ['."\n"
+ .' "a"'."\n"
+ .' ],'."\n"
+ .' "ruleScoreType": 3,'."\n"
+ .' "isHitNumScore": 0'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "conditions": ['."\n"
+ .' {'."\n"
+ .' "cid": "a",'."\n"
+ .' "lambda": "1",'."\n"
+ .' "check_range": {},'."\n"
+ .' "operators": ['."\n"
+ .' {'."\n"
+ .' "oid": "1",'."\n"
+ .' "type": "HIT_ANY_KEYWORDS",'."\n"
+ .' "param": {'."\n"
+ .' "contextChatMatch": false,'."\n"
+ .' "in_sentence": false,'."\n"
+ .' "keywordMatchSize": 1,'."\n"
+ .' "keywords": ['."\n"
+ .' "你好",'."\n"
+ .' "欢迎",'."\n"
+ .' "谢谢",'."\n"
+ .' "再见"'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ .'## Request Code Sample'."\n"
+ .'```java'."\n"
+ .'import com.alibaba.fastjson.JSONObject;'."\n"
+ .'import com.aliyun.qualitycheck20190115.Client;'."\n"
+ .'import com.aliyun.qualitycheck20190115.models.*;'."\n"
+ .'import com.aliyun.teaopenapi.models.Config;'."\n"
+ ."\n\n"
+ .'public class sca {'."\n"
+ ."\n"
+ .' private static String ak = "YOUR_ACCESS_KEY_ID";'."\n"
+ .' private static String sk = "YOUR_ACCESS_KEY_SECRET";'."\n"
+ ."\n"
+ .' private static void updateRuleV4() throws Exception {'."\n"
+ .' String json="{"rules":[{"autoReview":1,"business":[{"name":"所有业务","bid":0}],"comments":"新建测试规则","fullCycle":1,"level":2,"name":"siqi-test","targetType":10,"type":1,"rid":50298,"scoreNumType":0,"scoreType":1,"scoreNum":1,"lambda":"a","triggers":["a"],"ruleScoreType":3,"isHitNumScore":0}],"conditions":[{"cid":"a","lambda":"1","check_range":{},"operators":[{"oid":"1","type":"HIT_ANY_KEYWORDS","param":{"contextChatMatch":false,"in_sentence":false,"keywordMatchSize":1,"keywords":["你好","欢迎","谢谢","再见"]}}]}]}";'."\n"
+ ."\n"
+ .' Config config = new Config();'."\n"
+ .' config.setAccessKeyId(ak).setAccessKeySecret(sk)'."\n"
+ .' .setEndpoint("qualitycheck.cn-hangzhou.aliyuncs.com")'."\n"
+ .' .setRegionId("cn-hangzhou").setProtocol("HTTPS");'."\n"
+ ."\n"
+ .' Client client = new Client(config);'."\n"
+ .' UpdateRuleV4Request result = new UpdateRuleV4Request();'."\n"
+ ."\n"
+ .' result.setJsonStrForRule(json);'."\n"
+ .' result.setRuleId(50298L);'."\n"
+ ."\n"
+ .' UpdateRuleV4Response response = client.updateRuleV4(result);'."\n"
+ .' System.out.println(JSONObject.toJSONString(response));'."\n"
+ .' }'."\n"
+ ."\n\n"
+ .' public static void main(String[] args) throws Exception {'."\n"
+ .' updateRuleV4();'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateRuleV4'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateRuleV4',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4D55C6\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
],
- 'UpdateRule' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateSchemeTaskConfig' => [
+ 'summary' => 'Frontend path: Task Management > Edit any data on the right. Apsara Stack URL: ip:port/api/task/UpdateSchemeTaskConfig.json.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'deprecated' => true,
+ 'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
+ 'abilityTreeCode' => '153837',
+ 'abilityTreeNodes' => ['FEATUREsca81P1AQ', 'FEATUREscaFRLL5D'],
],
'parameters' => [
[
- 'name' => 'JsonStr',
+ 'name' => 'jsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Input parameter JSON. For details, see the request parameters section.', 'type' => 'string', 'required' => false, 'example' => '{"schemeTaskConfigId":368,"status":1,"name":"检测任务 2022-09-21 16:59:50"}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'BaseResult',
+ 'description' => 'BaseResult',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4987D326-83D9-4A42-B9A5-0B27F9B40539',
- ],
- 'Success' => [
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. true means success. false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Code' => ['description' => 'Result code. **200** means success. Other values mean failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if an error occurs. When successful, the value is **successful**.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Messages' => [
+ 'itemNode' => true,
'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => [
+ 'description' => 'List of messages. Ignore.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Message. Ignore.', 'type' => 'string', 'example' => '无', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'substitutions' => [
- 'Qualitycheck::2019-01-15::UpdateRuleV4',
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"xxx\\",\\n \\"RequestId\\": \\"4987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateRuleResponse>\\r\\n <code>200</code>\\r\\n <message>successful</message>\\r\\n <requestId>4E1D0CCB-172D-409E-86F3-2188C634E4D8</requestId>\\r\\n <success>true</success>\\r\\n <data>xxx</data>\\r\\n</UpdateRuleResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'Update Quality Inspection Job ',
+ 'description' => 'Updates quality inspection task information.',
+ 'requestParamsDescription' => 'For more information, see [the Quality Inspection Task Object Description document](https://help.aliyun.com/document_detail/453292.html).'."\n"
+ ."\n"
+ .'## Request input parameter example'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "id": 4761,'."\n"
+ .' "schemeTaskConfigId": 4761,'."\n"
+ .' "name": "Car Sales Scenario Task",'."\n"
+ .' "dataConfig": {'."\n"
+ .' "assignConfigs": ['."\n"
+ .' {'."\n"
+ .' "assignConfigContests": ['."\n"
+ .' {'."\n"
+ .' "symbol": 1,'."\n"
+ .' "dataType": 2,'."\n"
+ .' "name": "customerServiceName",'."\n"
+ .' "value": ['."\n"
+ .' "siqi"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "name": "customerServiceId",'."\n"
+ .' "symbol": 1,'."\n"
+ .' "value": ['."\n"
+ .' "1234"'."\n"
+ .' ],'."\n"
+ .' "dataType": 2'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "schemeIdList": ['."\n"
+ .' 198'."\n"
+ .' ],'."\n"
+ .' "assignConfig": null,'."\n"
+ .' "manualReview": 0,'."\n"
+ .' "modeCustomizationId": "cdae396590bb479a9ec40f3476e274fc",'."\n"
+ .' "vocabId": "3814930c648c48a79a43aaaf3ac937d7",'."\n"
+ .' "asrTaskPriority": 1'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Request code example'."\n"
+ ."\n"
+ .'```java'."\n"
+ ."\n"
+ .'import com.alibaba.fastjson.JSONObject;'."\n"
+ .'import com.aliyun.qualitycheck20190115.Client;'."\n"
+ .'import com.aliyun.qualitycheck20190115.models.*;'."\n"
+ .'import com.aliyun.teaopenapi.models.Config;'."\n"
+ ."\n\n"
+ .'public class sca {'."\n"
+ ."\n"
+ .' private static String ak = "YOUR_ACCESS_KEY_ID";'."\n"
+ .' private static String sk = "YOUR_ACCESS_KEY_SECRET";'."\n"
+ ."\n"
+ .' private static void updateSchemeTaskConfig() throws Exception {'."\n"
+ .' String json="{\\"id\\":4761,\\"schemeTaskConfigId\\":4761,\\"name\\":\\"Detection task siqi-test\\",\\"dataConfig\\":{\\"assignConfigs\\":[{\\"assignConfigContests\\":[{\\"symbol\\":1,\\"dataType\\":2,\\"name\\":\\"customerServiceName\\",\\"value\\":[\\"siqi\\"]},{\\"name\\":\\"customerServiceId\\",\\"symbol\\":1,\\"value\\":[\\"1234\\"],\\"dataType\\":2}]}]},\\"schemeIdList\\":[198],\\"assignConfig\\":null,\\"manualReview\\":0,\\"modeCustomizationId\\":\\"cdae396590bb479a9ec40f3476e274fc\\",\\"vocabId\\":\\"3814930c648c48a79a43aaaf3ac937d7\\",\\"asrTaskPriority\\":1}";'."\n"
+ ."\n"
+ .' Config config = new Config();'."\n"
+ .' config.setAccessKeyId(ak).setAccessKeySecret(sk)'."\n"
+ .' .setEndpoint("qualitycheck.cn-hangzhou.aliyuncs.com")'."\n"
+ .' .setRegionId("cn-hangzhou").setProtocol("HTTPS");'."\n"
+ ."\n"
+ .' Client client = new Client(config);'."\n"
+ .' UpdateSchemeTaskConfigRequest result = new UpdateSchemeTaskConfigRequest();'."\n"
+ ."\n"
+ .' result.setJsonStr(json);'."\n"
+ ."\n"
+ .' UpdateSchemeTaskConfigResponse response = client.updateSchemeTaskConfig(result);'."\n"
+ .' System.out.println(JSONObject.toJSONString(response));'."\n"
+ .' }'."\n"
+ ."\n"
+ .' public static void main(String[] args) throws Exception {'."\n"
+ .' updateSchemeTaskConfig();'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateSchemeTaskConfig'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'UploadRule' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateSkillGroupConfig' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
- 'systemTags' => [],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '56245',
+ 'abilityTreeNodes' => ['FEATUREsca6QWO0D', 'FEATUREscaKR8LQC'],
+ ],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{“conditions”:“xxxxx”,"rules":"xxxx"}',
- ],
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the details that follow.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"skillGroupFrom":0,"name":"test","qualityCheckType":0,"rid":"2493,4098","vocabId":267,"skillGroupList":[{"skillGroupId":"090311","skillGroupName":"09031"}],"id":553}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -14777,848 +16035,345 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4987D326-83D9-4A42-B9A5-0B27F9B40539',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'RidInfo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '318',
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => 'The result code. A value of 200 indicates success. Other values indicate failure. Use this field to identify the reason for a failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'If an error occurs, this field provides error details. If the request is successful, the value is \\`successful\\`.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '38E7E948-0876-4FEE-B0AA-6*****', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success. A value of \\`false\\` or \\`null\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"4987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RidInfo\\": [\\n \\"318\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<UploadRuleResponse>\\r\\n <code>200</code>\\r\\n <data>318</data>\\r\\n <message>successful</message>\\r\\n <requestId>*****</requestId>\\r\\n <success>true</success>\\r\\n</UploadRuleResponse>","errorExample":""}]',
+ 'staticInfo' => ['noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"38E7E948-0876-4FEE-B0AA-6*****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Update Configuration ',
+ 'summary' => 'You can call UpdateSkillGroupConfig to update a configuration.',
+ 'requestParamsDescription' => '## Details of the JsonStr request parameter'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| :--------------- | :--------- | :------- | :--------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| id | Integer | Yes | The configuration ID. |'."\n"
+ .'| status | Integer | No | The status of the configuration. Valid values: 0 (disabled) and 1 (enabled). |'."\n"
+ .'| skillGroupFrom | Integer | Yes | The source of the skill group. Set this to 0. |'."\n"
+ .'| qualityCheckType | Integer | Yes | The quality check type. Set this to 0. |'."\n"
+ .'| modelId | Integer | No | The ID of the language model. |'."\n"
+ .'| name | String | Yes | The name of the configuration. |'."\n"
+ .'| rid | String | Yes | The quality check rules. To specify multiple rules, separate their IDs with commas. A value of -2 indicates all rules. |'."\n"
+ .'| vocabId | String | No | The ID of the hotword model. |'."\n"
+ .'| skillGroupList | List | Yes | The skill group information. For more information, see the description of the skillGroupList field below. |'."\n"
+ ."\n"
+ .'## Description of the skillGroupList field'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| :------------- | :--------- | :------- | :--------------------------- |'."\n"
+ .'| skillGroupId | Integer | Yes | The ID of the skill group. |'."\n"
+ .'| skillGroupName | String | Yes | The name of the skill group. |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-29T06:47:50.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateSkillGroupConfig'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'GetRuleDetail' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateSyncQualityCheckData' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'deprecated' => true,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"ruleIds":"123"}',
- ],
+ 'schema' => ['description' => 'jsonStr is a JSON string that contains all Custom Parameters for this API. For details, see **jsonStr property description** below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"tid":"xxx"}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'baseMeAgentId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4987D326-83D9-4A42-B9A5-0B27F9B40539',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The Result code. A value of 200 indicates Succeeded. Any other value indicates failed. The API caller can determine the cause of failure based on this field.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Details of the error when an error occurs; "successful" when the operation succeeded. ', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID, which is the UUID of the request.', 'type' => 'string', 'example' => '76DB5D8C-5BD9-42A7-B527-5AF3A5F8*** ', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the Request succeeded. The API caller can use this field to determine whether the Request succeeded: true indicates success; false or null indicates failure.'."\n"
+ ."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The complete response Content.',
'type' => 'object',
'properties' => [
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Count' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Conditions' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'ConditionBasicInfo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ConditionInfoCid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '7',
- ],
- 'OperLambda' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '7',
- ],
- 'Operators' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'OperatorBasicInfo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'REGULAR_EXPRESSION',
- ],
- 'Oid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '8',
- ],
- 'OperName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'operator demo',
- ],
- 'Param' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'DifferentRole' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Regex' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'TargetRole' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'VelocityInMint' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '280',
- ],
- 'Average' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'KeywordExtension' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Score' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '80',
- ],
- 'NotRegex' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'CompareOperator' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'gt',
- ],
- 'DelayTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1000',
- ],
- 'KeywordMatchSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'HitTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'BeginType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DIALOGUE',
- ],
- 'Target' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'MaxEmotionChangeValue' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- 'Threshold' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '4',
- ],
- 'From' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'FromEnd' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'MinWordSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'InSentence' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Phrase' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Similarity_threshold' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '90',
- ],
- 'CheckType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Interval' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5000',
- ],
- 'ContextChatMatch' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Excludes' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Excludes' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- 'AntModelInfo' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'AntModelInfo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- ],
- ],
- 'Pvalues' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Pvalues' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- ],
- ],
- 'References' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Reference' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- 'SimilarlySentences' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'SimilarlySentence' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- 'OperKeyWords' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'OperKeyWord' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'CheckRange' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Absolute' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Role' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Anchor' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'HitTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Location' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AFTER',
- ],
- 'AnchorCid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '7',
- ],
- ],
- ],
- 'Range' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'To' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'From' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'Rules' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'RuleBasicInfo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'RuleLambda' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '7&&!8',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4',
- ],
- 'BusinessCategories' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'BusinessCategoryBasicInfo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'BusinessName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ServiceType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Bid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '264971810',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Triggers' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Trigger' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '["7","8"]',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'TaskId' => ['description' => 'The Job ID.', 'type' => 'string', 'example' => '123123D8C-5BD9-42A7-B527-1235F8**', 'title' => ''],
+ 'Tid' => ['description' => 'The UUID of the call.', 'type' => 'string', 'example' => '20210101-1212121***', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'substitutions' => [
- 'Qualitycheck::2019-01-15::GetRuleV4',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"76DB5D8C-5BD9-42A7-B527-5AF3A5F8***\\\\t\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"123123D8C-5BD9-42A7-B527-1235F8**\\",\\n \\"Tid\\": \\"20210101-1212121***\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Maintain recording information',
+ 'summary' => 'Maintain the recording information after real-time quality inspection is completed, which is used to play back the recording during review. After the recording information is maintained, the task status will change to Succeeded. ',
+ 'requestParamsDescription' => '**Description of jsonStr properties:** '."\n"
+ .'| Property | Value Type | Required | Description | '."\n"
+ .'| :--- | :--- | :--- | :--- | '."\n"
+ .'| sourceType | Int | Yes | Data Type: 1 indicates real-time voice, and 0 indicates real-time text. | '."\n"
+ .'| tid | String | Yes | UUID of the current conversation. This identifier is unique for each conversation, and the backend uses it to merge segments into a complete conversation. | '."\n"
+ .'| voiceFileUrl | String | Yes | URL of the recording file, used for playback during review. The URL must be HTTP-accessible. Submission of local files is not supported. The URL must use a domain name instead of an IP address, must not contain spaces, and should avoid Chinese characters as much as possible. The recording file must have public access permissions and remain accessible long-term; otherwise, playback will fail when viewing file details or performing file review. | '."\n"
+ .'| fileName | String | Yes | Name of the recording file. | '."\n"
+ ."\n"
+ .'## Sample input parameter (JSON) '."\n"
+ .'```json '."\n"
+ .'{ '."\n"
+ .' "tid" : "20240520-2300101", '."\n"
+ .' "fileName": "123.wav", '."\n"
+ .' "sourceType": 0, '."\n"
+ .' "beginTime": 1716199089301, '."\n"
+ .' "endTime": 1716199099301 '."\n"
+ .'} '."\n"
+ .'``` '."\n"
+ ."\n"
+ .'## Sample input parameter (Java) '."\n"
+ .'```java '."\n"
+ .'public class sca { '."\n"
+ ."\n"
+ .' private static String ak = "YOUR_ACCESS_KEY_ID"; '."\n"
+ .' private static String sk = "YOUR_ACCESS_KEY_SECRET"; '."\n"
+ ."\n"
+ .' private static void updateSync() throws Exception { '."\n"
+ .' String json="{'."\n"
+ .'" + '."\n"
+ .' " "tid" : "20240520-2300101",'."\n"
+ .'" + '."\n"
+ .' " "fileName": "123.wav",'."\n"
+ .'" + '."\n"
+ .' " "sourceType": 0,'."\n"
+ .'" + '."\n"
+ .' " "beginTime": 1716199089301,'."\n"
+ .'" + '."\n"
+ .' " "endTime": 1716199099301'."\n"
+ .'" + '."\n"
+ .' "}"; '."\n"
+ ."\n\n"
+ .' Config config = new Config(); '."\n"
+ .' config.setAccessKeyId(ak).setAccessKeySecret(sk) '."\n"
+ .' .setEndpoint("qualitycheck.cn-hangzhou.aliyuncs.com") '."\n"
+ .' .setRegionId("cn-hangzhou").setProtocol("HTTPS"); '."\n"
+ ."\n"
+ .' Client client = new Client(config); '."\n"
+ .' UpdateQualityCheckDataRequest result = new UpdateQualityCheckDataRequest(); '."\n"
+ ."\n"
+ .' result.setJsonStr(json); '."\n"
+ ."\n"
+ .' UpdateQualityCheckDataResponse response = client.updateQualityCheckData(result); '."\n"
+ .' System.out.println(JSONObject.toJSONString(response)); '."\n"
+ .' } '."\n"
+ ."\n"
+ .' public static void main(String[] args) throws Exception { '."\n"
+ .' updateSync(); '."\n"
+ .' } '."\n"
+ .'} '."\n"
+ .'``` ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '8000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateSyncQualityCheckData'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateSyncQualityCheckData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"4987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Count\\": 10,\\n \\"Conditions\\": {\\n \\"ConditionBasicInfo\\": [\\n {\\n \\"ConditionInfoCid\\": \\"7\\",\\n \\"OperLambda\\": \\"7\\",\\n \\"Operators\\": {\\n \\"OperatorBasicInfo\\": [\\n {\\n \\"Type\\": \\"REGULAR_EXPRESSION\\",\\n \\"Oid\\": \\"8\\",\\n \\"OperName\\": \\"operator demo\\",\\n \\"Param\\": {\\n \\"DifferentRole\\": true,\\n \\"Regex\\": \\".*修改密码.*\\",\\n \\"TargetRole\\": \\"客户\\",\\n \\"VelocityInMint\\": 280,\\n \\"Average\\": true,\\n \\"KeywordExtension\\": true,\\n \\"Score\\": 80,\\n \\"NotRegex\\": \\"发一下|告诉我\\",\\n \\"CompareOperator\\": \\"gt\\",\\n \\"DelayTime\\": 1000,\\n \\"KeywordMatchSize\\": 3,\\n \\"HitTime\\": 1,\\n \\"BeginType\\": \\"DIALOGUE\\",\\n \\"Target\\": 1,\\n \\"MaxEmotionChangeValue\\": 8,\\n \\"Threshold\\": 4,\\n \\"From\\": 3,\\n \\"FromEnd\\": true,\\n \\"MinWordSize\\": 4,\\n \\"InSentence\\": true,\\n \\"Phrase\\": \\"xxx\\",\\n \\"Similarity_threshold\\": 90,\\n \\"CheckType\\": 1,\\n \\"Interval\\": 5000,\\n \\"ContextChatMatch\\": true,\\n \\"Excludes\\": {\\n \\"Excludes\\": [\\n \\"[“好的”]\\"\\n ]\\n },\\n \\"AntModelInfo\\": {\\n \\"AntModelInfo\\": [\\n \\"xx\\"\\n ]\\n },\\n \\"Pvalues\\": {\\n \\"Pvalues\\": [\\n \\"xx\\"\\n ]\\n },\\n \\"References\\": {\\n \\"Reference\\": [\\n \\"[“优惠力度特别大”,”特别的优惠”]\\"\\n ]\\n },\\n \\"SimilarlySentences\\": {\\n \\"SimilarlySentence\\": [\\n \\"[“优惠力度特别大”,”特别的优惠”]\\"\\n ]\\n },\\n \\"OperKeyWords\\": {\\n \\"OperKeyWord\\": [\\n \\"[“你好”,”您好”,”上午好”]\\"\\n ]\\n }\\n }\\n }\\n ]\\n },\\n \\"CheckRange\\": {\\n \\"Absolute\\": true,\\n \\"Role\\": \\"客服\\",\\n \\"Anchor\\": {\\n \\"HitTime\\": 1,\\n \\"Location\\": \\"AFTER\\",\\n \\"AnchorCid\\": \\"7\\"\\n },\\n \\"Range\\": {\\n \\"To\\": 10,\\n \\"From\\": 1\\n }\\n }\\n }\\n ]\\n },\\n \\"Rules\\": {\\n \\"RuleBasicInfo\\": [\\n {\\n \\"RuleLambda\\": \\"7&&!8\\",\\n \\"Rid\\": \\"4\\",\\n \\"BusinessCategories\\": {\\n \\"BusinessCategoryBasicInfo\\": [\\n {\\n \\"BusinessName\\": \\"业务A\\",\\n \\"ServiceType\\": 1,\\n \\"Bid\\": 264971810\\n }\\n ]\\n },\\n \\"Triggers\\": {\\n \\"Trigger\\": [\\n \\"[\\\\\\"7\\\\\\",\\\\\\"8\\\\\\"]\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetRuleDetailResponse>\\r\\n <code>200</code>\\r\\n <data>\\r\\n <conditions>\\r\\n <checkRange>\\r\\n <anchor/>\\r\\n <range>\\r\\n <from>1</from>\\r\\n <to>-1</to>\\r\\n </range>\\r\\n <role>客服</role>\\r\\n </checkRange>\\r\\n <conditionInfoCid>7</conditionInfoCid>\\r\\n <operLambda>7</operLambda>\\r\\n <operators>\\r\\n <oid>7</oid>\\r\\n <operName>operator demo</operName>\\r\\n <param>\\r\\n <inSentence>false</inSentence>\\r\\n <regex>.*告诉.*密码.*</regex>\\r\\n </param>\\r\\n <type>REGULAR_EXPRESSION</type>\\r\\n </operators>\\r\\n </conditions>\\r\\n <conditions>\\r\\n <checkRange>\\r\\n <anchor>\\r\\n <anchorCid>7</anchorCid>\\r\\n <location>AFTER</location>\\r\\n </anchor>\\r\\n <range>\\r\\n <from>1</from>\\r\\n <to>-1</to>\\r\\n </range>\\r\\n <role>客服</role>\\r\\n </checkRange>\\r\\n <conditionInfoCid>8</conditionInfoCid>\\r\\n <operLambda>8</operLambda>\\r\\n <operators>\\r\\n <oid>8</oid>\\r\\n <operName>operator demo</operName>\\r\\n <param>\\r\\n <inSentence>false</inSentence>\\r\\n <regex>.*修改密码.*</regex>\\r\\n </param>\\r\\n <type>REGULAR_EXPRESSION</type>\\r\\n </operators>\\r\\n </conditions>\\r\\n <rules>\\r\\n <rid>4</rid>\\r\\n <ruleLambda>7 &amp;&amp; !8</ruleLambda>\\r\\n <business>\\r\\n <bid>264971810</bid>\\r\\n <name>业务A</name>\\r\\n </business>\\r\\n <business>\\r\\n <bid>386664996</bid>\\r\\n <name>业务B</name>\\r\\n </business>\\r\\n <triggers>7</triggers>\\r\\n <triggers>8</triggers>\\r\\n </rules>\\r\\n </data>\\r\\n <message>successful</message>\\r\\n <requestId>04CF046A-0F5E-442E-9D6C-1B4F1DCAC5C2</requestId>\\r\\n <success>true</success>\\r\\n</GetRuleDetailResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
],
- 'GetRule' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateTag' => [
+ 'summary' => 'Updates a label node.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'deprecated' => true,
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREsca27EUYZ'],
],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"ruleIds":"123"}',
- ],
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the following detailed information.', 'type' => 'string', 'required' => false, 'example' => '“”', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The business space ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3CEA0495-341B-4482-9AD9-8191EF4*** '],
'Data' => [
- 'description' => '',
+ 'description' => 'The returned result.',
'type' => 'object',
'properties' => [
- 'Rules' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'RuleInfo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Type' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ScoreSubId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '22',
- ],
- 'IsOnline' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2016-08-05 10:37:10',
- ],
- 'CreateEmpid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'LastUpdateEmpid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'IsDelete' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4',
- ],
- 'RuleScoreType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'EndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2016-08-05 10:37:10',
- ],
- 'Weight' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'StartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2016-08-05 10:37:10',
- ],
- 'RuleLambda' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'a && b',
- ],
- 'ScoreSubName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'AutoReview' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Comments' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'LastUpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2019-10-28 14:23:28',
- ],
- 'ScoreName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'demo',
- ],
- 'ScoreId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '123',
- ],
- 'BusinessCategoryNameList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'BusinessCategoryNameList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'TagId' => ['description' => 'The label ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '128', 'title' => ''],
+ 'Name' => ['description' => 'The label name.', 'type' => 'string', 'example' => '售后服务', 'title' => ''],
+ 'Description' => ['description' => 'The label description.', 'type' => 'string', 'example' => '涵盖退款、退货、维修、咨询等售后链路', 'title' => ''],
+ 'ParentTagId' => ['description' => 'The ID of the parent label node.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the label node was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1748428991000', 'title' => ''],
+ 'ModifyTime' => ['description' => 'The time when the label node was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1748431368000', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Other values indicate failure. You can use this field to determine the cause of the failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when an error occurs.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'substitutions' => [
- 'Qualitycheck::2019-01-15::GetRuleV4',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Update label node',
+ 'requestParamsDescription' => '| Field | Type | Required | Value | Description |'."\n"
+ .'|---|---|---|---|---|'."\n"
+ .'| `tagId` | `Long` | Yes | `100231` | The ID of the label node to update. |'."\n"
+ .'| `name` | `String` | No | `"售后服务"` | The label name, 1 to 64 characters. If not specified, the name is not modified. |'."\n"
+ .'| `description` | `String` | No | `"涵盖退款、退货、维修、咨询等售后链路"` | An empty string clears the value. If not specified, the description is not modified. |'."\n"
+ .'| `parentTagId` | `Long` | No | `100100` | The ID of the parent node, used to move the node. If not specified, the parent node is not modified. If a new value is specified, the current node is moved under the specified parent node. |',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Rules\\": {\\n \\"RuleInfo\\": [\\n {\\n \\"Status\\": 1,\\n \\"Type\\": 1,\\n \\"ScoreSubId\\": 22,\\n \\"IsOnline\\": 1,\\n \\"CreateTime\\": \\"2016-08-05 10:37:10\\",\\n \\"CreateEmpid\\": \\"123\\",\\n \\"LastUpdateEmpid\\": \\"123\\",\\n \\"IsDelete\\": 0,\\n \\"Rid\\": \\"4\\",\\n \\"RuleScoreType\\": 1,\\n \\"EndTime\\": \\"2016-08-05 10:37:10\\",\\n \\"Weight\\": \\"1\\",\\n \\"StartTime\\": \\"2016-08-05 10:37:10\\",\\n \\"RuleLambda\\": \\"a && b\\",\\n \\"ScoreSubName\\": \\"评分子项\\",\\n \\"AutoReview\\": 1,\\n \\"Comments\\": \\"测试规则\\",\\n \\"LastUpdateTime\\": \\"2019-10-28 14:23:28\\",\\n \\"ScoreName\\": \\"评分大项\\",\\n \\"Name\\": \\"demo\\",\\n \\"ScoreId\\": 123,\\n \\"BusinessCategoryNameList\\": {\\n \\"BusinessCategoryNameList\\": [\\n \\"[\\\\\\"业务A\\\\\\",\\\\\\"业务B\\\\\\"]\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetRuleResponse>\\r\\n <code>200</code>\\r\\n <data>\\r\\n <rules>\\r\\n <createTime>2016-08-05 10:37:10</createTime>\\r\\n <businessCategoryNameList>业务A</businessCategoryNameList>\\r\\n <businessCategoryNameList>业务B</businessCategoryNameList>\\r\\n <isDelete>0</isDelete>\\r\\n <name>demo</name>\\r\\n <rid>4</rid>\\r\\n <status>1</status>\\r\\n <autoReview>1</autoReview>\\r\\n <ruleScoreType>1</ruleScoreType>\\r\\n <scoreName>评分大项</scoreName>\\r\\n <scoreSubName>评分子项</scoreSubName>\\r\\n </rules>\\r\\n </data>\\r\\n <message>successful</message>\\r\\n <requestId>F190ADE9-619A-447D-84E3-7E241A5C428E</requestId>\\r\\n <success>true</success>\\r\\n</GetRuleResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3CEA0495-341B-4482-9AD9-8191EF4***\\\\t\\",\\n \\"Data\\": {\\n \\"TagId\\": 128,\\n \\"Name\\": \\"售后服务\\",\\n \\"Description\\": \\"涵盖退款、退货、维修、咨询等售后链路\\",\\n \\"ParentTagId\\": -1,\\n \\"CreateTime\\": 1748428991000,\\n \\"ModifyTime\\": 1748431368000\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]',
],
- 'ListRules' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateTaskAssignRule' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'deprecated' => true,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'operationType' => 'write',
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"pageNumber":1,"pageSize":10}',
- ],
+ 'schema' => ['description' => 'A complete JSON string. For details, see the parameter descriptions below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"callType":"0","agents":[{"agentId":"202526561358712105","agentName":"agent"}],"reviewers":[{"reviewerId":"255746168704895558","reviewerName":"0917质检员"},{"reviewerId":"268370362815185444","reviewerName":"0710质检员"}],"durationMin":1,"durationMax":300,"rules":[{"rid":15659},{"rid":17075}],"skillGroups":[{"skillName":"客服组"}],"enabled":1,"ruleId":37,"updateType":0}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -15626,155 +16381,122 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F** ',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Count' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RuleType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-04-20T20:10Z',
- ],
- 'Comments' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'TypeName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1234567',
- ],
- 'BusinessCategoryNameList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => 'The result code. A value of **200** indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error message if the request fails. If the request succeeds, the value is successful.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. A value of true means success. A value of false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'substitutions' => [
- 'Qualitycheck::2019-01-15::ListRulesV4',
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F**\\\\t\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Count\\": 20,\\n \\"Data\\": [\\n {\\n \\"Type\\": 1,\\n \\"RuleType\\": 1,\\n \\"CreateTime\\": \\"2020-04-20T20:10Z\\",\\n \\"Comments\\": \\"检测是否出现了禁用语\\",\\n \\"TypeName\\": \\"服务规范\\",\\n \\"Name\\": \\"禁用语检测\\",\\n \\"Rid\\": 1234567,\\n \\"BusinessCategoryNameList\\": [\\n \\"[\\\\\\"所有业务\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRulesResponse>\\n <RequestId>51330D59-DF7B-4768-8123-E8C3****</RequestId>\\n <Message>successful</Message>\\n <PageSize>2</PageSize>\\n <PageNumber>1</PageNumber>\\n <Data>\\n <Type>1</Type>\\n <TypeName>服务规范</TypeName>\\n <Comments>23423</Comments>\\n <CreateTime>2020-04-20T20:10Z</CreateTime>\\n <RuleType>1</RuleType>\\n <Rid>12345678</Rid>\\n <OperationMode>1</OperationMode>\\n <Name>禁用语检测</Name>\\n <BusinessCategoryNameList>所有业务</BusinessCategoryNameList>\\n </Data>\\n <Data>\\n <Type>1</Type>\\n <TypeName>服务规范</TypeName>\\n <Comments>111</Comments>\\n <CreateTime>2020-04-20T10:38Z</CreateTime>\\n <RuleType>1</RuleType>\\n <Rid>12345679</Rid>\\n <OperationMode>1</OperationMode>\\n <Name>开头语不完整</Name>\\n <BusinessCategoryNameList>所有业务</BusinessCategoryNameList>\\n </Data>\\n <Count>891</Count>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListRulesResponse>","errorExample":""}]',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Update the automatic allocation rule for review tasks ',
+ 'summary' => 'Update the automatic allocation rule for quality review tasks.',
+ 'requestParamsDescription' => '## Request parameters'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :---------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| ruleId | Long | Yes | The rule ID. |'."\n"
+ .'| agents | List | Yes | A list of agents. **For details, see the Agent field description below.** |'."\n"
+ .'| skillGroups | List | No | A list of skill groups. **For details, see the SkillGroup field description below.** |'."\n"
+ .'| durationMin | Long | No | The minimum duration, in seconds. |'."\n"
+ .'| durationMax | Long | No | The maximum duration, in seconds. A value of 0 means no limit. |'."\n"
+ .'| callType | Byte | No | The call type. Valid values: 1 (outbound), 3 (inbound), or 0 (no restriction). |'."\n"
+ .'| rules | List | No | The rules that trigger task assignment. **For details, see the Rule field description below.** |'."\n"
+ .'| reviewers | List | Yes | A list of reviewers. **For details, see the Reviewer field description below.** |'."\n"
+ .'| enabled | Byte | No | The status. Valid values: 0 (disabled) or 1 (enabled). To update only the status, include only ruleId, enabled, and updateType in the request. |'."\n"
+ .'| updateType | Integer | Yes | The update type. Valid values: 1 (update status only) or 0 (update full rule configuration). |'."\n"
+ ."\n"
+ .'### SkillGroup field description'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :-------- | :----- | :------- | :--------------------------- |'."\n"
+ .'| skillName | String | Yes | The name of the skill group. |'."\n"
+ ."\n"
+ .'### Rule field description'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :------- | :----- | :------- | :----------- |'."\n"
+ .'| rid | String | Yes | The rule ID. |'."\n"
+ ."\n"
+ .'### Agent field description'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :-------- | :----- | :------- | :-------------- |'."\n"
+ .'| agentId | Long | Yes | The agent ID. |'."\n"
+ .'| agentName | String | Yes | The agent name. |'."\n"
+ ."\n"
+ .'### Reviewer field description'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :----------- | :----- | :------- | :---------------------- |'."\n"
+ .'| reviewerId | Long | Yes | The reviewer\'s user ID. |'."\n"
+ .'| reviewerName | String | Yes | The reviewer name. |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateTaskAssignRule'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'InvalidRule' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateUser' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'deprecated' => true,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"ruleIds":[3,4]}',
- ],
+ 'schema' => ['description' => 'This API supports batch modification of user roles. The value of the \\`jsonStr\\` input parameter is a List type. Refer to the example value. See the detailed information below for the complete JSON string content.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"aliUid":"2951869706989****","roleName":"ADMIN"},{"aliUid":"2557461687048****","roleName":"ADMIN"}]', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -15782,85 +16504,90 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9987D326-83D9-4A42-B9A5-0B27F9B40539',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'Result code. **200** indicates success. Other values indicate failure. Use this field to determine the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details on failure. "successful" on success.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647', 'title' => ''],
+ 'Success' => ['description' => 'Indicates if the request succeeded. Use this field to determine if the request succeeded: \\`true\\` for success; \\`false\\`/\\`null\\` for failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'substitutions' => [
- 'Qualitycheck::2019-01-15::DeleteRuleV4',
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"9987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<InvalidRuleResponse>\\r\\n <message>successful</message>\\r\\n <requestId>9987D326-83D9-4A42-B9A5-0B27F9B40539</requestId>\\r\\n <data>true</data>\\r\\n <code>200</code>\\r\\n <success>true</success>\\r\\n</InvalidRuleResponse>","errorExample":""}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Edit User ',
+ 'summary' => 'Update users by modifying their roles in batches.',
+ 'description' => 'When you update users, you can modify only their roles. You cannot modify other account information because all Alibaba Cloud products use a unified account management system. Smart Conversation Analysis uses these accounts. To modify account information, go to [Resource Access Management (RAM)](https://ram.console.aliyun.com/).',
+ 'requestParamsDescription' => '## Request Parameters'."\n"
+ ."\n"
+ .'| Property | Value Type | Required | Description |'."\n"
+ .'| :------- | :--------- | :------- | :----------------------------------------------------------------------------------------------------- |'."\n"
+ .'| aliUid | Integer | Yes | User ID. |'."\n"
+ .'| roleName | String | Yes | Role. Options: ADMIN (Administrator); QUALITY_INSPECTOR (Quality Inspector); AGENT (Customer Service). |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-01-12T07:01:47.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:43.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateUser'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'GetScoreInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateWarningConfig' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'deprecated' => true,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '""',
- ],
+ 'schema' => ['description' => 'The complete JSON string. For details, see the detailed information below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"ridList":[18130],"configName":"0310","channels":[{"type":1,"url":"https://sca.console.aliyun.com/#/warningConfig"}],"configId":29}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -15868,285 +16595,724 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'ScorePo' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ScoreId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '34',
- ],
- 'ScoreName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ScoreInfos' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'ScoreParam' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ScoreSubName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ScoreNum' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '32',
- ],
- 'ScoreSubId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3422',
- ],
- 'ScoreType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => 'The result code. **200** indicates success. Other values indicate failure. The caller can determine the cause of failure based on this field.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Indicates error details on failure, or "successful" on success.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. The caller can determine if the request succeeded based on this field: true for success; false/null for failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ScorePo\\": [\\n {\\n \\"ScoreId\\": 34,\\n \\"ScoreName\\": \\"服务规范\\",\\n \\"ScoreInfos\\": {\\n \\"ScoreParam\\": [\\n {\\n \\"ScoreSubName\\": \\"回复生硬\\",\\n \\"ScoreNum\\": 32,\\n \\"ScoreSubId\\": 3422,\\n \\"ScoreType\\": 1\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetScoreInfoResponse>\\n <Message>successful</Message>\\n <RequestId>EB01750D-AAEB-4152-8B52-54113F***</RequestId>\\n <Data>\\n <ScorePo>\\n <ScoreInfos>\\n <ScoreParam>\\n <ScoreSubName>确认不必要信息</ScoreSubName>\\n <ScoreSubId>1181</ScoreSubId>\\n <ScoreType>3</ScoreType>\\n <ScoreNum>5</ScoreNum>\\n </ScoreParam>\\n </ScoreInfos>\\n <ScoreName>问题定位</ScoreName>\\n <ScoreId>-1</ScoreId>\\n </ScorePo>\\n <ScorePo>\\n <ScoreInfos>\\n <ScoreParam>\\n <ScoreSubName>没理解客户问题</ScoreSubName>\\n <ScoreSubId>1183</ScoreSubId>\\n <ScoreType>3</ScoreType>\\n <ScoreNum>5</ScoreNum>\\n </ScoreParam>\\n <ScoreParam>\\n <ScoreSubName>处理出错导致客户不满意</ScoreSubName>\\n <ScoreSubId>1184</ScoreSubId>\\n <ScoreType>3</ScoreType>\\n <ScoreNum>5</ScoreNum>\\n </ScoreParam>\\n <ScoreParam>\\n <ScoreSubName>处理出错未纠正</ScoreSubName>\\n <ScoreSubId>1185</ScoreSubId>\\n <ScoreType>3</ScoreType>\\n <ScoreNum>5</ScoreNum>\\n </ScoreParam>\\n <ScoreParam>\\n <ScoreSubName>漏答引起客户不满</ScoreSubName>\\n <ScoreSubId>1186</ScoreSubId>\\n <ScoreType>3</ScoreType>\\n <ScoreNum>5</ScoreNum>\\n </ScoreParam>\\n <ScoreParam>\\n <ScoreSubName>提醒不到位</ScoreSubName>\\n <ScoreSubId>1187</ScoreSubId>\\n <ScoreType>3</ScoreType>\\n <ScoreNum>5</ScoreNum>\\n </ScoreParam>\\n <ScoreParam>\\n <ScoreSubName>未结合上下文</ScoreSubName>\\n <ScoreSubId>1188</ScoreSubId>\\n <ScoreType>3</ScoreType>\\n <ScoreNum>5</ScoreNum>\\n </ScoreParam>\\n </ScoreInfos>\\n <ScoreName>问题解决</ScoreName>\\n <ScoreId>-6</ScoreId>\\n </ScorePo>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetScoreInfoResponse>","errorExample":""}]',
- 'requestParamsDescription' => "\n",
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Update Alert Configuration',
+ 'summary' => 'Updates the warning configuration.',
+ 'requestParamsDescription' => '## Request Parameters'."\n"
+ ."\n"
+ .'| Property | Value Type | Required | Description |'."\n"
+ .'| :--------- | :--------- | :------- | :----------------------------------------------------------------------------------------- |'."\n"
+ .'| configId | Long | Yes | Configuration ID |'."\n"
+ .'| configName | String | No | Configuration name |'."\n"
+ .'| status | Byte | No | Enable status. 0: disabled; 1: enabled. |'."\n"
+ .'| channels | List | No | Subscription push configuration. **For details, see the Channel field description below.** |'."\n"
+ .'| ridList | List | No | List of selected rule IDs |'."\n"
+ ."\n"
+ .'### Channel Field Description'."\n"
+ ."\n"
+ .'| Property | Value Type | Required | Description |'."\n"
+ .'| :------- | :--------- | :------- | :------------------------------------------------ |'."\n"
+ .'| type | Byte | Yes | Subscription push type. 0: DingTalk; 1: callback. |'."\n"
+ .'| url | String | Yes | URL address |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateWarningConfig'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'SubmitReviewInfo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UploadAudioData' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'systemTags' => [],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The complete JSON string. For more information, see the details below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{“callList”:“xxxxx”}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID. This ID is used to select a specific workspace in a multi-workspace scenario. The default workspace is used if you do not specify this parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'Response body',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '95',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9987D326-83D9-4A42-B9A5-0B27F9B40539',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The result code. A value of 200 indicates success. Other values indicate failure. You can use this field to determine the cause of a failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The error details if the request fails. If the request is successful, the value is \\`successful\\`.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'The task ID. Use this ID to get the task result.', 'type' => 'string', 'example' => '76DB5D8C-5BD9-42A7-B527-5AF3A5***', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. This is the unique identifier of the request.', 'type' => 'string', 'example' => '76DB5D8C-5BD9-42A7-B527-5AF3A5F8***', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. You can use this field to determine if the request succeeded. A value of \\`true\\` indicates success. A value of \\`false\\` or \\`null\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"95\\",\\n \\"RequestId\\": \\"9987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<code>200</code>\\n<data>95</data>\\n<requestId>F61E91AB-FAFD-472A-A3E8-0F4B48030685</requestId>\\n<success>true</success>\\n<message>successful</message>","errorExample":""}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"76DB5D8C-5BD9-42A7-B527-5AF3A5***\\",\\n \\"RequestId\\": \\"76DB5D8C-5BD9-42A7-B527-5AF3A5F8***\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'UploadAudioData',
+ 'summary' => 'Uploads offline audio data—such as recorded call session files—for quality inspection. This operation supports two call center agent scenarios.'."\n"
+ .'Scenario 1: Native integration with Alibaba Cloud Call Center (CC). No development is required. You can push call data to Smart Conversation Analysis (SCA) with a single click.'."\n"
+ .'Scenario 2: Integration with your own call center system. Each time a recording is generated, the call center pushes it to SCA for analysis.',
+ 'description' => '### Process description'."\n"
+ ."\n"
+ .'The process is as follows: An API call uploads the audio file for quality inspection → The audio file is converted to text → The transcribed text is separated by speaker role (agent and customer), based on the specified channel separation method → The role-separated text is analyzed using quality inspection rules → Quality inspection completes.'."\n"
+ ."\n"
+ .'### Task execution efficiency'."\n"
+ ."\n"
+ .'Task execution speed depends on how quickly the audio file is transcribed. A 5-minute audio file is typically transcribed in about 2 minutes. However, if the transcription service queue is long, a waiting period occurs. Transcription usually completes within 6 hours, except when large volumes of data are uploaded simultaneously—more than 500 hours of audio within 30 minutes. After transcription, quality inspection analysis completes in milliseconds.'."\n"
+ ."\n"
+ .'### Audio file URL requirements'."\n"
+ ."\n"
+ .'- Supports single-channel or dual-channel audio files in WAV or MP3 format. File size must be less than 512 MB.'."\n"
+ ."\n"
+ .'- The URL must be accessible over HTTP. Local files are not supported. The audio file must have public access permissions.'."\n"
+ ."\n"
+ .'- The URL must use a domain name, not an IP address. The URL cannot contain spaces or Chinese characters.'."\n"
+ ."\n"
+ .'- After transcription, the system deletes the downloaded audio file. No copy of the recording is retained.'."\n"
+ ."\n"
+ .'- If your audio URL has an expiration period—such as a presigned URL for an audio file stored in Alibaba Cloud Object Storage Service (OSS)—set the validity period to at least 12 hours. Ideally, set it to 24 hours. Because transcription may involve queuing, the audio file is downloaded only when transcription begins. A longer validity period prevents the URL from expiring before download starts.'."\n"
+ ."\n"
+ .'- After quality inspection completes, the provided URL is used for playback when you review the file in the console. Ensure the URL remains valid long-term. Otherwise, audio playback fails.'."\n"
+ ."\n"
+ .'### Role separation'."\n"
+ ."\n"
+ .'After transcription, the system automatically separates the text into two speaker roles but cannot determine which role corresponds to the agent and which to the customer. You must define rules for role separation. Role separation accuracy is critical because many quality inspection rules apply to a specific role—for example, checking only agent or only customer utterances. Incorrect role separation significantly reduces quality inspection accuracy.'."\n"
+ ."\n"
+ .'Audio files are typically either single-channel (mono) or dual-channel (stereo):'."\n"
+ ."\n"
+ .'- Single-channel recording: The voices of the agent and customer are mixed on one channel. After transcription, the system uses a built-in algorithm to separate dialogue into two roles. You can provide a list of keywords commonly spoken by agents. The system analyzes the transcribed text sentence by sentence. When a sentence contains a keyword, that speaker is identified as the agent, and the other speaker is identified as the customer. For more information, see the recognizeRoleDataSetId and serviceChannelKeywords request parameters. Because conversations can be unpredictable—for example, speakers may talk over each other—role separation for single-channel recordings cannot achieve 100% accuracy. We strongly recommend saving recordings as dual-channel audio.'."\n"
+ ."\n"
+ .'- Dual-channel recording: The voices of the agent and customer are stored on separate channels. Even if speakers talk over each other, transcription accurately distinguishes between them. Specify the agent and customer channels using the serviceChannel and clientChannel request parameters.'."\n"
+ ."\n"
+ .'### Retrieve quality inspection results'."\n"
+ ."\n"
+ .'Because audio analysis is asynchronous, you must retrieve results asynchronously. You can retrieve results in one of the following three ways:'."\n"
+ ."\n"
+ .'- Message notification: For more information, see [Message Queue](~~213237~~). After you receive a message, call the GetResult operation to retrieve detailed results. (Recommended)'."\n"
+ ."\n"
+ .'- Callback: Specify a callbackUrl in the request parameters. The system initiates a callback after the task completes. After you receive the callback, call the GetResult operation to retrieve detailed results.'."\n"
+ ."\n"
+ .'- Polling: The operation returns a task ID (taskId). Use the taskId to poll the getResult operation and retrieve the result asynchronously. Check the `status` parameter in the response to determine whether the task is complete. We recommend a polling interval of 30 seconds or longer because analysis typically completes within a few minutes. (Not recommended)',
+ 'requestParamsDescription' => '## Request parameters and JSON string information'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| :--------------------- | :--------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| callList | List | Yes | A collection of audio files. You can upload multiple audio files at a time. For more information, see the **jsonStr.callList properties** section below. |'."\n"
+ .'| autoSplit | Integer | No | This parameter is typically used for **single-channel** recordings. Valid values: 0 and 1. A value of 1 indicates that automatic channel separation is enabled. A value of 0 indicates that automatic channel separation is disabled. Default: 1. If you set this parameter to 1, the uploaded audio is treated as a **single-channel** recording. Automatic channel separation requires additional processing time. **If the recording is dual-channel, you must set this parameter to 0.** |'."\n"
+ .'| enableAutoSplitByLLM | Boolean | No | Specifies whether to use the Large Language Model (LLM) for intelligent role separation for this audio file. If you set this parameter to true, the LLM-based feature is used. Default: false |'."\n"
+ .'| recognizeRoleDataSetId | Long | No | The dataset ID. Use an existing dataset. When a dataset is created, role separation rules are configured (see the **Speaker Role Configuration** section in the create dataset feature). If you specify a dataset ID here, the role separation rules of that dataset are applied to the uploaded file. This parameter is applicable to **single-channel** recordings. |'."\n"
+ .'| serviceChannelKeywords | List | No | This parameter is typically used for **single-channel** recordings. Set a list of keywords that the agent is likely to say. Make sure to select highly distinctive keywords. The system analyzes the transcribed text sentence by sentence. When a sentence contains a keyword, the speaker is identified as the agent, and the other speaker is identified as the customer. If both `recognizeRoleDataSetId` and `serviceChannelKeywords` are specified, `recognizeRoleDataSetId` takes precedence. If neither is specified, the system uses built-in channel separation rules as a fallback. |'."\n"
+ .'| serviceChannel | Integer | No | This parameter is applicable to **dual-channel** recordings. Specifies the channel number for the agent role. Valid values: 0 and 1. Default: 0, which indicates that channel 0 is for the agent. Audio channels are typically numbered starting from 0. For example, two channels are numbered 0 and 1. You must confirm which channel belongs to the agent and which belongs to the customer. **If you use this parameter, you must also set the `autoSplit` parameter to 0.** This parameter is ignored for single-channel files. |'."\n"
+ .'| clientChannel | Integer | No | This parameter is applicable to **dual-channel** recordings. Specifies the channel number for the customer role. Valid values: 0 and 1. Default: 1, which indicates that channel 1 is for the customer. Audio channels are typically numbered starting from 0. For example, two channels are numbered 0 and 1. You must confirm which channel belongs to the agent and which belongs to the customer. **If you use this parameter, you must also set the `autoSplit` parameter to 0.** This parameter is ignored for single-channel files. |'."\n"
+ .'| sampleRate | Integer | No | The sample rate of the audio file. Valid values: 8 (for 8000 Hz) and 16 (for 16000 Hz). Default: 8. You must specify the correct sample rate. An incorrect sample rate leads to transcription errors. Audio recordings from call centers typically have a sample rate of 8000 Hz. |'."\n"
+ .'| callbackUrl | String | No | The webhook address. If you do not specify this parameter, no callback is initiated. Ensure the webhook address is accessible over the Internet. IP addresses are not supported. A callback is initiated after the audio analysis is complete. For more information, see the **Callback parameters** |'."\n"
+ ."\n"
+ .'## jsonStr.callList properties:'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| :--------------------- | :--------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| voiceFileUrl | String | Yes | The audio file. For specific requirements, see the **Audio file URL requirements** |'."\n"
+ .'| fileName | String | No | The name of the audio file, such as audio.wav. This parameter is optional, but we recommend that you provide it for statistical purposes. If you do not provide this parameter, the filename is parsed from `voiceFileUrl`. For example, if the URL is `http://www.aliyun.com/audio.wav`, the filename is parsed as `audio.wav`. |'."\n"
+ .'| autoSplit | Integer | No | See the description of the parameter in the parent object. If this parameter is left empty, the value of the corresponding parameter in the parent object is used. |'."\n"
+ .'| recognizeRoleDataSetId | Long | No | See the description of the parameter in the parent object. If this parameter is left empty, the value of the corresponding parameter in the parent object is used. |'."\n"
+ .'| serviceChannel | Integer | No | See the description of the parameter in the parent object. If this parameter is left empty, the value of the corresponding parameter in the parent object is used. |'."\n"
+ .'| clientChannel | Yes | See the description of the parameter in the parent object. If this parameter is left empty, the value of the corresponding parameter in the parent object is used. | See the parameter description of the parent object. If empty, the value is inherited from the parent object. |'."\n"
+ .'| sampleRate | Integer | No | See the description of the parameter in the parent object. If this parameter is left empty, the value of the corresponding parameter in the parent object is used. |'."\n"
+ .'| callStartTime | Long | No | The time when the recording was made. This is the number of milliseconds that have elapsed since 00:00:00 on January 1, 1970, UTC (a millisecond timestamp, for example, 1584535485856). If you do not specify this parameter, the current time is used. |'."\n"
+ .'| customerServiceId | Long | No | The agent ID. You can obtain this ID from the Staff Management page in the console under Basic Settings. If you enter the correct agent ID, the agent can view their associated audio files when they log on to the console. |'."\n"
+ .'| customerServiceName | String | No | The agent name. |'."\n"
+ .'| skillGroupId | Long | No | The skill group ID. |'."\n"
+ .'| skillGroupName | String | No | The skill group name. |'."\n"
+ .'| callType | Integer | No | The call type. Valid values: 1 (outbound) and 3 (inbound). |'."\n"
+ .'| callee | String | No | The callee number. For an outbound call, this is the customer\'s number. For an inbound call, this is the agent\'s number. |'."\n"
+ .'| caller | String | No | The caller number. For an outbound call, this is the agent\'s number. For an inbound call, this is the customer\'s number. |'."\n"
+ .'| callId | String | No | The call ID. This can be the call ID from the call center system or another ID that uniquely identifies the call. |'."\n"
+ .'| business | String | No | The line-of-business name. This is custom data used for categorized statistics. |'."\n"
+ .'| callUuid | String | No | A globally unique identifier used for idempotence (deduplication). If you provide this parameter, the system checks for an identical `callUuid` among data uploaded in the last two hours. If a match is found, the current upload request is rejected. |'."\n"
+ .'| sessionGroupId | String | No | The session group ID. A session group typically refers to all sessions between the same agent and the same customer. After you provide a session group ID, you can view the quality inspection results for that session group on the session group results page. **(Applicable only to the new version of Smart Conversation Analysis)** |'."\n"
+ .'| customerId | String | No | The customer ID. **(Applicable only to the new version of Smart Conversation Analysis)** |'."\n"
+ .'| customerName | String | No | The customer name. **(Applicable only to the new version of Smart Conversation Analysis)** |'."\n"
+ .'| schemeTaskConfigId | String | No | The ID of a manually specified quality inspection task. If specified, this task is used for quality inspection. **(Applicable only to the new version of Smart Conversation Analysis)** |'."\n"
+ .'| remark1 | String | No | Custom data 1. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark2 | String | No | Custom data 2. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark3 | String | No | Custom data 3. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark4 | String | No | Custom data 4. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark5 | Long | No | Custom data 5. You can store custom business-related fields. The format is a signed long integer. |'."\n"
+ .'| remark6 | String | No | Custom data 6. You can store custom business-related fields. The maximum length is 1024 characters. |'."\n"
+ .'| remark7 | String | No | Custom data 7. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark8 | String | No | Custom data 8. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark9 | String | No | Custom data 9. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark10 | String | No | Custom data 10. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark11 | String | No | Custom data 11. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark12 | String | No | Custom data 12. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark13 | String | No | Custom data 13. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark14 | Long | No | Custom data 14. You can store custom business-related fields. The format is a signed long integer. |'."\n"
+ .'| remark15 | Long | No | Custom data 15. You can store custom business-related fields. The format is a signed long integer. |'."\n"
+ .'| remark16 | String | No | Custom data 16. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark17 | String | No | Custom data 17. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark18 | String | No | Custom data 18. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark19 | String | No | Custom data 19. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark20 | String | No | Custom data 20. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark21 | String | No | Custom data 21. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark22 | String | No | Custom data 22. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark23 | String | No | Custom data 23. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark24 | String | No | Custom data 24. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| remark25 | String | No | Custom data 25. You can store custom business-related fields. The maximum length is 64 characters. |'."\n"
+ .'| jsonParamStr | String | No | More custom fields in JSON string format. The key is the field name and the value is the field content. Example: `{"Customer Level": 3, "Channel": "Official Website"}`. |'."\n"
+ ."\n"
+ .'## Callback parameters'."\n"
+ ."\n"
+ .'Assume the webhook address you provide is `http://aliyun.com/callback`. The full callback URL will be `http://aliyun.com/callback?taskId=xxx&timestamp=xxx&aliUid=xxx&signature=xxx&event=xxx`, where:'."\n"
+ ."\n"
+ .'- taskId: The task ID.'."\n"
+ ."\n"
+ .'- timestamp: The timestamp of the call, in milliseconds.'."\n"
+ ."\n"
+ .'- aliUid: The UID of your Alibaba Cloud account.'."\n"
+ ."\n"
+ .'- signature: The signature. You can use this to verify that the request originates from Alibaba Cloud. Calculation method: Encrypt the string taskId=xxx\\&timestamp=xxx\\&aliUid=xxx using MD5 and Base64. Parameter order matters. After receiving the callback, extract taskId and timestamp from the callback URL. Your aliUid is your Alibaba Cloud account ID. Compare your calculated signature with the `signature` in the URL to verify the request. For more information, see the Java code sample below.'."\n"
+ ."\n"
+ .'- event: The event name. Use this to identify which event triggered the callback. The value is TaskComplete, indicating a callback upon task completion.'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'public static void signature() {'."\n"
+ .' long timestamp = System.currentTimeMillis();'."\n"
+ .' String taskId = "xxx";'."\n"
+ .' String aliUid = "xxx";'."\n"
+ .' // Encrypt taskId=xxx&timestamp=xxx&aliUid=xxx using MD5 and Base64, and place the result in the signature field.'."\n"
+ .' String signature;'."\n"
+ .' try {'."\n"
+ .' signature = URLEncoder.encode(md5Base64("taskId=" + taskId + "&timestamp=" + timestamp + "&aliUid=" + aliUid), "utf-8");'."\n"
+ .' System.out.println(signature);'."\n"
+ .' } catch (Exception e) {'."\n"
+ .' e.printStackTrace();'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ ."\n"
+ .'public static String md5Base64(String str) throws NoSuchAlgorithmException {'."\n"
+ .' // The string must be UTF-8 encoded.'."\n"
+ .' byte[] utfBytes = str.getBytes(StandardCharsets.UTF_8);'."\n"
+ .' MessageDigest mdTemp = MessageDigest.getInstance("MD5");'."\n"
+ .' mdTemp.update(utfBytes);'."\n"
+ .' byte[] md5Bytes = mdTemp.digest();'."\n"
+ .' return Base64.encodeBase64String(md5Bytes);'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Sample request parameters'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "autoSplit":1,'."\n"
+ .' "serviceChannelKeywords":['."\n"
+ .' "study abroad",'."\n"
+ .' "customer service agent"'."\n"
+ .' ],'."\n"
+ .' "callbackUrl":"https://123.123.com/sca-callback",'."\n"
+ .' "callList":['."\n"
+ .' {'."\n"
+ .' "schemeTaskConfigId":"589",'."\n"
+ .' "voiceFileUrl":"https://sca-ccc-test.oss-cn-beijing.aliyuncs.com/****.wav",'."\n"
+ .' "fileName":"abc.wav",'."\n"
+ .' "callStartTime":"1584535485856",'."\n"
+ .' "customerServiceId":"30",'."\n"
+ .' "customerServiceName":"Aagent",'."\n"
+ .' "skillGroupId":"34sd24",'."\n"
+ .' "skillGroupName":"presales skill group",'."\n"
+ .' "callType":1,'."\n"
+ .' "callee":188888****,'."\n"
+ .' "caller":"0102323***",'."\n"
+ .' "callId":23456457**,'."\n"
+ .' "business":"presales group 1",'."\n"
+ .' "remark1":"March 8th sales promotion"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Sample request code'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'public class sca {'."\n"
+ .' '."\n"
+ .' private static String ak = "YOUR_ACCESS_KEY_ID";'."\n"
+ .' private static String sk = "YOUR_ACCESS_KEY_SECRET";'."\n"
+ ."\n"
+ .' private static void uploadAudio() throws Exception {'."\n"
+ .' String json = "{\\n" +'."\n"
+ .' " \\"autoSplit\\":1,\\n" +'."\n"
+ .' " \\"serviceChannelKeywords\\":[\\n" +'."\n"
+ .' " \\"study abroad\\",\\n" +'."\n"
+ .' " \\"customer service agent\\"\\n" +'."\n"
+ .' " ],\\n" +'."\n"
+ .' " \\"callbackUrl\\":\\"https://123.123.com/sca-callback\\",\\n" +'."\n"
+ .' " \\"callList\\":[\\n" +'."\n"
+ .' " {\\n" +'."\n"
+ .' " \\"schemeTaskConfigId\\":\\"589\\",\\n" +'."\n"
+ .' " \\"voiceFileUrl\\":\\"https://sc.oss-cn-beijing.aliyuncs.com/****.wav\\",\\n" +'."\n"
+ .' " \\"fileName\\":\\"abc.wav\\",\\n" +'."\n"
+ .' " \\"callStartTime\\":\\"1584535485856\\",\\n" +'."\n"
+ .' " \\"customerServiceId\\":\\"30\\",\\n" +'."\n"
+ .' " \\"customerServiceName\\":\\"Aagent\\",\\n" +'."\n"
+ .' " \\"skillGroupId\\":\\"34sd24\\",\\n" +'."\n"
+ .' " \\"skillGroupName\\":\\"presales skill group\\",\\n" +'."\n"
+ .' " \\"callType\\":1,\\n" +'."\n"
+ .' " \\"callee\\":188888****,\\n" +'."\n"
+ .' " \\"caller\\":\\"0102323***\\",\\n" +'."\n"
+ .' " \\"callId\\":23456457**,\\n" +'."\n"
+ .' " \\"business\\":\\"presales group 1\\",\\n" +'."\n"
+ .' " \\"remark1\\":\\"March 8th sales promotion\\"\\n" +'."\n"
+ .' " }\\n" +'."\n"
+ .' " ]\\n" +'."\n"
+ .' "}";'."\n"
+ ."\n\n"
+ .' Config config = new Config();'."\n"
+ .' config.setAccessKeyId(ak).setAccessKeySecret(sk).setEndpoint("qualitycheck.cn-hangzhou.aliyuncs.com")'."\n"
+ .' .setRegionId("cn-hangzhou").setProtocol("HTTPS");'."\n"
+ ."\n"
+ .' Client client = new Client(config);'."\n"
+ .' UploadAudioDataRequest result = new UploadAudioDataRequest();'."\n"
+ ."\n"
+ .' result.setJsonStr(json);'."\n"
+ ."\n"
+ .' UploadAudioDataResponse response = client.uploadAudioData(result);'."\n"
+ .' System.out.println(JSONObject.toJSONString(response));'."\n"
+ .' }'."\n"
+ ."\n\n"
+ .' public static void main(String[] args) throws Exception {'."\n"
+ .' uploadAudio();'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:42.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '3000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UploadAudioData'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'BatchSubmitReviewInfo' => [
- 'summary' => '批量复核',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UploadData' => [
+ 'summary' => 'Upload offline plain text quality inspection data (plain text sessions). This applies to online agent scenarios. Use the UploadDataV4 API. Differences between UploadDataV4 and UploadData include the following: UploadDataV4 supports only POST requests, and it supports longer JsonStr values.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [],
+ 'operationType' => 'write',
+ 'deprecated' => true,
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'jsonStr',
+ 'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"isSchemeData":1,"schemeTaskConfigId":334,"sourceDataType":2,"startTime":"2022-08-25 00:00:00","endTime":"2022-09-23 23:59:59","sessionList":[{"taskId":"20220831-F8D7F4DF-0A16-1A1C-BA63-28F203922692","fileId":"20220831-164343"},{"taskId":"20220831-F2A50A72-82C4-1E3F-A1FD-52A662283D25","fileId":"20220831-164343"}]}',
- ],
+ 'schema' => ['description' => 'JsonStr is a JSON string that contains all custom parameters for this API. See the JsonStr property description below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxx', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID. Use this to select a specific workspace in multi-workspace scenarios. Defaults to the default workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'BaseResult',
- 'description' => 'BaseResult',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'F190ADE9-619A-447D-84E3-7E241A5C428E',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Messages' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['description' => 'Result code. **200** means success. Any other value means failure. Use this field to diagnose failures.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request failed. Returns successful if the request succeeded.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'Task ID for this request.', 'type' => 'string', 'example' => '6F5934C7-C223-4F0F-BBF3-5B3594***', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID. A unique identifier for this request. Use it to trace the request.', 'type' => 'string', 'example' => '6F5934C7-C223-4F0F-BBF3-5B3594****', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. true means success. false or null means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F190ADE9-619A-447D-84E3-7E241A5C428E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Messages\\": {\\n \\"Message\\": [\\n \\"无\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'staticInfo' => [
+ 'substitutions' => ['Qualitycheck::2019-01-15::UploadDataV4'],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"6F5934C7-C223-4F0F-BBF3-5B3594***\\",\\n \\"RequestId\\": \\"6F5934C7-C223-4F0F-BBF3-5B3594****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'UploadData',
+ 'description' => 'You can call UploadData.json to upload text-based quality inspection data. Text typically originates from online customer service interactions or tickets. The API returns a task ID. You can retrieve results in one of three ways:'."\n"
+ ."\n"
+ .'- Message notification: For details, see [message queues](https://help.aliyun.com/document_detail/213237.html). After you receive a message, call the GetResult API to retrieve detailed results. (Recommended)'."\n"
+ ."\n"
+ .'- Callback: Specify a callback URL in your request parameters. After the task completes, the system sends a callback to that URL. Then call the GetResult API to retrieve detailed results.'."\n"
+ ."\n"
+ .'- Polling: Use the returned task ID to poll the GetResult API asynchronously. Check whether the status field in the response indicates completion. (Not recommended)',
+ 'requestParamsDescription' => '## JsonStr property description'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| ----------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| tickets | List | Yes | Text data to inspect. Each element is a full conversation. See the **JsonStr.tickets property description** |'."\n"
+ .'| business | String | No | Line-of-business name. Used for classification and reporting. All data in this request must belong to the same line of business. |'."\n"
+ .'| callbackUrl | String | No | Webhook address. If not specified, no callback occurs. Ensure the webhook address is reachable from your SCA application. IP addresses are not supported. The system sends a callback after quality inspection completes. For details, see the **Callback parameter description** |'."\n"
+ ."\n"
+ .'## JsonStr.tickets property description'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| ------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| dialogue | List | Yes | Text-based dialogue to inspect. See the **dialogue property description** |'."\n"
+ .'| tid | String | No | Conversation ID. Avoid duplicates. If omitted, the system generates a UUID. |'."\n"
+ .'| fileName | String | No | File name. |'."\n"
+ .'| customerServiceId | Long | No | Agent ID. Get it from the console: Basic Settings > Agent Management. Enter the correct agent ID so agents can view associated files when they log on to the Control Tower. |'."\n"
+ .'| customerServiceName | String | No | Agent name. |'."\n"
+ .'| skillGroupId | String | No | Skill group ID for the agent. |'."\n"
+ .'| skillGroupName | String | No | Skill group name for the agent. |'."\n"
+ .'| callType | Integer | No | Call type. Valid values: 1 (outbound), 3 (inbound). Use this when you run your own speech-to-text service and upload plain text directly to SCA. |'."\n"
+ .'| sessionGroupId | String | No | Session group ID. A session group includes all conversations between one agent and one customer. When you provide this ID, you can view quality inspection results at the session group level on the session group results page. |'."\n"
+ .'| customerId | String | No | Customer ID. |'."\n"
+ .'| customerName | String | No | Customer name. |'."\n"
+ .'| schemeTaskConfigId | String | No | Manual quality inspection task ID. If set, SCA uses this task for inspection. |'."\n"
+ .'| remark1 | String | No | Custom field 1. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark2 | String | No | Custom field 2. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark3 | String | No | Custom field 3. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark4 | String | No | Custom field 4. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark5 | Long | No | Custom field 5. Store business-specific data as a signed long integer. |'."\n"
+ .'| remark6 | String | No | Custom field 6. Store business-specific data. Maximum length: 1024 characters. |'."\n"
+ .'| remark7 | String | No | Custom field 7. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark8 | String | No | Custom field 8. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark9 | String | No | Custom field 9. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark10 | String | No | Custom field 10. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark11 | String | No | Custom field 11. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark12 | String | No | Custom field 12. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark13 | String | No | Custom field 13. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark14 | Long | No | Custom field 14. Store business-specific data as a signed long integer. |'."\n"
+ .'| remark15 | Long | No | Custom field 15. Store business-specific data as a signed long integer. |'."\n"
+ .'| remark16 | String | No | Custom field 16. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark17 | String | No | Custom field 17. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark18 | String | No | Custom field 18. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark19 | String | No | Custom field 19. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark20 | String | No | Custom field 20. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark21 | String | No | Custom field 21. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark22 | String | No | Custom field 22. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark23 | String | No | Custom field 23. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark24 | String | No | Custom field 24. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| remark25 | String | No | Custom field 25. Store business-specific data. Maximum length: 64 characters. |'."\n"
+ .'| jsonParamStr | String | No | Additional custom fields. Format as a JSON string. Keys are field names. Values are field contents. Example: {"Customer Level": 3,"Channel":"Official Website"}. |'."\n"
+ ."\n"
+ .'## dialogue property description'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| ------------------- | ------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| role | String | Yes | Speaker role. Valid values: agent, customer. |'."\n"
+ .'| customerServiceType | Integer | No | Distinguishes human agents from bots. Valid values: 0 (human), 1 (bot). Default: 0. If set to 1, the review page shows a bot profile picture. |'."\n"
+ .'| identity | String | No | Specific identity of the speaker. |'."\n"
+ .'| words | String | Yes | One utterance by this speaker. Supports UTF-8 encoding only. For emoji support, see the **Emoji display notes** |'."\n"
+ .'| type | String | No | Utterance type. Valid values: TEXT (text), AUDIO (audio), IMAGE (image). Images appear on the review details page. Audio plays on the review details page. Default: TEXT. For AUDIO or IMAGE, pass the resource URL in the words field. (Applies only to the new Smart Conversation Analysis) |'."\n"
+ .'| begin | Integer | Yes | Start time of this utterance, relative to the start point. Unit: milliseconds. |'."\n"
+ .'| end | Integer | Yes | End time of this utterance, relative to the start point. Unit: milliseconds. |'."\n"
+ .'| beginTime | Date | Yes | Start time of this utterance. Example: 2019-11-25 15:37:16. |'."\n"
+ ."\n"
+ .'## Emoji display notes'."\n"
+ ."\n"
+ .'On the review details page, only standard Emoji characters display. When uploading, replace emojis with UTF-8 character codes such as \\&#128512;. For example, the smiley face emoji is \\&#128512;. Codes start with \\&# and end with a semicolon. For more information, see the [Emoji character reference table](https://www.runoob.com/charsets/ref-emoji.html) and the [HTML character display guide](https://www.runoob.com/charsets/ref-html-symbols.html).'."\n"
+ ."\n"
+ .'## Callback parameter description'."\n"
+ ."\n"
+ .'If you specify the callback URL `http://aliyun.com/callback`, the full callback URL becomes `http://aliyun.com/callback?taskId=xxx&timestamp=xxx&signature=xxx&event=xxx`. Parameters:'."\n"
+ ."\n"
+ .'- taskId: Task ID.'."\n"
+ ."\n"
+ .'- timestamp: UNIX timestamp of the callback request. Unit: milliseconds.'."\n"
+ ."\n"
+ .'- aliUid: Alibaba Cloud account UID of the caller.'."\n"
+ ."\n"
+ .'- signature: Signature used to verify the request originated from Alibaba Cloud. Compute it by applying MD5 then Base64 encoding to the string `taskId=xxx&timestamp=xxx&aliUid=xxx`. Maintain the parameter order. After receiving the callback, extract taskId and timestamp from the URL. Use your Alibaba Cloud account UID as aliUid. Compare your computed signature with the one in the URL. See the Java code example below.'."\n"
+ ."\n"
+ .'- event: Event name. Use this to identify which event triggered the callback. Valid value: TaskComplete (sent when the task completes).'."\n"
+ ."\n"
+ .'```'."\n"
+ .'public static void signature() {'."\n"
+ .' long timestamp = System.currentTimeMillis();'."\n"
+ .' String taskId = "xxxx";'."\n"
+ .' String aliUid = "xxxxx";'."\n"
+ .' // Apply MD5 then Base64 encoding to "taskId=xxx&timestamp=xxx&aliUid=xxx", and place result in the signature field'."\n"
+ .' String signature;'."\n"
+ .' try {'."\n"
+ .' signature = URLEncoder.encode(md5Base64("taskId=" + taskId + "&timestamp=" + timestamp + "&aliUid=" + aliUid), "utf-8");'."\n"
+ .' System.out.println(signature);'."\n"
+ .' } catch (Exception e) {'."\n"
+ .' e.printStackTrace();'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ ."\n"
+ .'public static String md5Base64(String str) throws NoSuchAlgorithmException {'."\n"
+ .' // String encoding must be UTF-8'."\n"
+ .' byte[] utfBytes = str.getBytes(StandardCharsets.UTF_8);'."\n"
+ .' MessageDigest mdTemp = MessageDigest.getInstance("MD5");'."\n"
+ .' mdTemp.update(utfBytes);'."\n"
+ .' byte[] md5Bytes = mdTemp.digest();'."\n"
+ .' return Base64.encodeBase64String(md5Bytes);'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Request parameter example'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "callbackUrl": "https://123.123.com/sca-callback",'."\n"
+ .' "tickets": ['."\n"
+ .' {'."\n"
+ .' "schemeTaskConfigId": "389",'."\n"
+ .' "customerName": "Zhang San 1",'."\n"
+ .' "customerId": "zhangsan-vip-audio",'."\n"
+ .' "dialogue": ['."\n"
+ .' {'."\n"
+ .' "beginTime": "2019-11-25 15:36:01",'."\n"
+ .' "role": "customer",'."\n"
+ .' "identity": "A customer",'."\n"
+ .' "emotionValue": 6,'."\n"
+ .' "speechRate": 153,'."\n"
+ .' "words": "Hello.",'."\n"
+ .' "end": 2580,'."\n"
+ .' "begin": 1800,'."\n"
+ .' "channelId": 1'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "beginTime": "2019-11-25 15:37:01",'."\n"
+ .' "role": "agent",'."\n"
+ .' "identity": "An agent",'."\n"
+ .' "emotionValue": 6,'."\n"
+ .' "speechRate": 153,'."\n"
+ .' "words": "How can I help you? What would you like to buy? Please tell me.",'."\n"
+ .' "end": 2580,'."\n"
+ .' "begin": 1800,'."\n"
+ .' "channelId": 1'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "beginTime": "2019-11-25 15:37:06",'."\n"
+ .' "role": "agent",'."\n"
+ .' "identity": "An agent",'."\n"
+ .' "emotionValue": 6,'."\n"
+ .' "speechRate": 305,'."\n"
+ .' "words": "I want to buy a sweater.",'."\n"
+ .' "end": 12540,'."\n"
+ .' "begin": 6770,'."\n"
+ .' "channelId": 0'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Request code example'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'public class sca {'."\n"
+ ."\n"
+ .' private static String ak = "YOUR_ACCESS_KEY_ID";'."\n"
+ .' private static String sk = "YOUR_ACCESS_KEY_SECRET";'."\n"
+ ."\n"
+ .' private static void uploadText() throws Exception {'."\n"
+ .' String json="{\\n" +'."\n"
+ .' " \\"callbackUrl\\":\\"https://123.123.com/sca-callback\\",\\n" +'."\n"
+ .' " \\"tickets\\":[\\n" +'."\n"
+ .' " {\\n" +'."\n"
+ .' " \\"schemeTaskConfigId\\":\\"389\\",\\n" +'."\n"
+ .' " \\"customerName\\": \\"Zhang San 1\\",\\n" +'."\n"
+ .' " \\"customerId\\": \\"zhangsan-vip-audio\\",\\n" +'."\n"
+ .' " \\"dialogue\\":[\\n" +'."\n"
+ .' " {\\n" +'."\n"
+ .' " \\"beginTime\\":\\"2019-11-25 15:36:01\\",\\n" +'."\n"
+ .' " \\"role\\":\\"customer\\",\\n" +'."\n"
+ .' " \\"identity\\":\\"A customer\\",\\n" +'."\n"
+ .' " \\"emotionValue\\":6,\\n" +'."\n"
+ .' " \\"speechRate\\":153,\\n" +'."\n"
+ .' " \\"words\\":\\"Hello.\\",\\n" +'."\n"
+ .' " \\"end\\":2580,\\n" +'."\n"
+ .' " \\"begin\\":1800,\\n" +'."\n"
+ .' " \\"channelId\\":0\\n" +'."\n"
+ .' " },\\n" +'."\n"
+ .' " {\\n" +'."\n"
+ .' " \\"beginTime\\":\\"2019-11-25 15:37:01\\",\\n" +'."\n"
+ .' " \\"role\\":\\"agent\\",\\n" +'."\n"
+ .' " \\"identity\\":\\"An agent\\",\\n" +'."\n"
+ .' " \\"emotionValue\\":6,\\n" +'."\n"
+ .' " \\"speechRate\\":153,\\n" +'."\n"
+ .' " \\"words\\":\\"How can I help you? What would you like to buy? Please tell me.\\",\\n" +'."\n"
+ .' " \\"end\\":2580,\\n" +'."\n"
+ .' " \\"begin\\":1800,\\n" +'."\n"
+ .' " \\"channelId\\":1\\n" +'."\n"
+ .' " },\\n" +'."\n"
+ .' " {\\n" +'."\n"
+ .' " \\"beginTime\\":\\"2019-11-25 15:37:06\\",\\n" +'."\n"
+ .' " \\"role\\":\\"customer\\",\\n" +'."\n"
+ .' " \\"identity\\":\\"A customer\\",\\n" +'."\n"
+ .' " \\"emotionValue\\":6,\\n" +'."\n"
+ .' " \\"speechRate\\":305,\\n" +'."\n"
+ .' " \\"words\\":\\"I want to buy a sweater.\\",\\n" +'."\n"
+ .' " \\"end\\":12540,\\n" +'."\n"
+ .' " \\"begin\\":6770,\\n" +'."\n"
+ .' " \\"channelId\\":0\\n" +'."\n"
+ .' " }\\n" +'."\n"
+ .' " ]\\n" +'."\n"
+ .' " }\\n" +'."\n"
+ .' " ]\\n" +'."\n"
+ .' "}";'."\n"
+ ."\n"
+ .' Config config = new Config();'."\n"
+ .' config.setAccessKeyId(ak).setAccessKeySecret(sk).setEndpoint("qualitycheck.cn-hangzhou.aliyuncs.com")'."\n"
+ .' .setRegionId("cn-hangzhou").setProtocol("HTTPS");'."\n"
+ ."\n"
+ .' Client client = new Client(config);'."\n"
+ .' UploadDataRequest result = new UploadDataRequest();'."\n"
+ ."\n"
+ .' result.setJsonStr(json);'."\n"
+ ."\n"
+ .' UploadDataResponse response = client.uploadData(result);'."\n"
+ .' System.out.println(JSONObject.toJSONString(response));'."\n"
+ .' }'."\n"
+ ."\n\n"
+ .' public static void main(String[] args) throws Exception {'."\n"
+ .' uploadText();'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UploadData'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
'UploadDataSync' => [
- 'summary' => 'http_hsf',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Real-time text quality check',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -16159,32 +17325,18 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '56257',
- 'abilityTreeNodes' => [
- 'FEATUREscaFRLL5D',
- ],
+ 'abilityTreeNodes' => ['FEATUREscaFRLL5D'],
],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"tickets":xxx}',
- ],
+ 'schema' => ['description' => 'A JSON string that contains the custom parameters for the operation. See the **jsonStr attributes** section for details.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"tickets":xxx}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The business space ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -16192,69 +17344,40 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4987D326-83D9-4A42-B9A5-0B27F9B***',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'The result `code`. A value of **200** indicates that the request was successful. Other values indicate failure. Use this field to identify the cause of the failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The response message. If the request succeeds, the value is **successful**. Otherwise, this parameter provides error details.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'The `request ID`.', 'type' => 'string', 'example' => '4987D326-83D9-4A42-B9A5-0B27F9B***', 'title' => ''],
+ 'Success' => ['description' => 'Specifies whether the request succeeded. `true` indicates success; `false` or `null` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ResultInfo' => [
- 'description' => '',
+ 'description' => 'The results of the `real-time quality check`.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Score' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
+ 'Score' => ['description' => 'The quality check `score`. The score starts at 100, and points are added or subtracted based on the scoring items in matched `rule`s.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'Rules' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RuleHitInfo' => [
- 'description' => '',
+ 'description' => 'The `hit details`.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'A list of the rules that were matched.',
'type' => 'object',
'properties' => [
- 'Tid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '88888888',
- ],
- 'Rid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '801',
- ],
+ 'Tid' => ['description' => 'The text ID. This corresponds to the `tid` in the `tickets` `request parameter`.', 'type' => 'string', 'example' => '88888888', 'title' => ''],
+ 'Rid' => ['description' => 'The ID of the matched `rule`.', 'type' => 'string', 'example' => '801', 'title' => ''],
'Hit' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ConditionHitInfo' => [
- 'description' => '',
+ 'description' => 'Details about the hit location at the sentence level. This object specifies which condition of a `rule` was met and which words triggered the match.',
'type' => 'array',
'items' => [
'type' => 'object',
@@ -16264,201 +17387,566 @@
'itemNode' => true,
'properties' => [
'HitKeyWord' => [
- 'description' => '',
+ 'description' => 'The `keyword`s in the current sentence that triggered the `rule` match and should be highlighted.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The `keyword` that triggered the condition match.',
'type' => 'object',
'properties' => [
- 'To' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'From' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Val' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Tid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Pid' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'To' => ['description' => 'The exclusive end position of the highlighted `keyword`, based on a zero-indexed character count. For example, if a three-character `keyword` starts at index 0, `from` is 0 and `to` is 3.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'From' => ['description' => 'The inclusive starting position of the highlighted `keyword`, based on a zero-indexed character count. The value can range from 0 to the sentence length minus 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Val' => ['description' => 'The content of the `keyword`.', 'type' => 'string', 'example' => '嗯', 'title' => ''],
+ 'Tid' => ['description' => 'The text ID, which corresponds to the `tid` in the `tickets` `request parameter`.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'Pid' => ['description' => 'The zero-based index of the sentence within the `dialogue` array of the `request parameter`.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'CustomizeCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'IsMatch' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'HitCids' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CidItem' => [
- 'description' => '',
+ 'description' => 'The IDs of conditions that were met in the current sentence.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '["3265"]',
- ],
+ 'items' => ['description' => 'A condition ID that was met in the current sentence.', 'type' => 'string', 'example' => '["3265"]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'Phrase' => [
- 'description' => '',
+ 'description' => 'Details of the sentence that matched the `rule`.',
'type' => 'object',
'properties' => [
- 'Words' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Identity' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Begin' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'BeginTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1564574',
- ],
- 'End' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2090',
- ],
- 'Role' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'Words' => ['description' => 'The utterance from this `role`.', 'type' => 'string', 'example' => '你好', 'title' => ''],
+ 'Identity' => ['description' => 'The specific identifier for the `role`.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'Begin' => ['description' => 'The start time of the utterance, as an offset in milliseconds (ms) from the beginning of the conversation.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'BeginTime' => ['description' => 'The absolute start time of the utterance, formatted as a string. Example: 2019-11-25 15:37:16.', 'type' => 'string', 'example' => '1564574', 'title' => ''],
+ 'End' => ['description' => 'The end time of the utterance, as an offset in milliseconds (ms) from the beginning of the conversation.', 'type' => 'integer', 'format' => 'int64', 'example' => '2090', 'title' => ''],
+ 'Role' => ['description' => 'The `role` of the speaker. Possible values: `agent`, `customer`, or `system`.', 'type' => 'string', 'example' => '客服', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'ConditionInfo' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ConditionBasicInfo' => [
- 'description' => '',
+ 'description' => 'This is a `deprecated field`. Ignore it.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'This is a `deprecated field`. Ignore it.',
'type' => 'object',
'properties' => [
- 'ConditionInfoCid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
+ 'ConditionInfoCid' => ['description' => 'This is a `deprecated field`. Ignore it.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'LlmResponse' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'HandScoreIdList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'HandScoreIdList' => [
- 'description' => '',
+ 'description' => 'This is a `deprecated field`. Ignore it.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '[]',
- ],
+ 'items' => ['description' => 'This is a `deprecated field`. Ignore it.', 'type' => 'string', 'example' => '[]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'TyxmTurboCount' => [
- 'type' => 'string',
- ],
- 'TyxmPlusCount' => [
- 'type' => 'string',
- ],
+ 'TyxmTurboCount' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'TyxmPlusCount' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"4987D326-83D9-4A42-B9A5-0B27F9B***\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ResultInfo\\": [\\n {\\n \\"Score\\": 100,\\n \\"Rules\\": {\\n \\"RuleHitInfo\\": [\\n {\\n \\"Tid\\": \\"88888888\\",\\n \\"Rid\\": \\"801\\",\\n \\"Hit\\": {\\n \\"ConditionHitInfo\\": [\\n {\\n \\"HitKeyWords\\": {\\n \\"HitKeyWord\\": [\\n {\\n \\"To\\": 1,\\n \\"From\\": 1,\\n \\"Val\\": \\"嗯\\",\\n \\"Tid\\": \\"1\\",\\n \\"Pid\\": 1\\n }\\n ]\\n },\\n \\"HitCids\\": {\\n \\"CidItem\\": [\\n \\"[\\\\\\"3265\\\\\\"]\\"\\n ]\\n },\\n \\"Phrase\\": {\\n \\"Words\\": \\"你好\\",\\n \\"Identity\\": \\"1\\",\\n \\"Begin\\": 0,\\n \\"BeginTime\\": \\"1564574\\",\\n \\"End\\": 2090,\\n \\"Role\\": \\"客服\\"\\n }\\n }\\n ]\\n },\\n \\"ConditionInfo\\": {\\n \\"ConditionBasicInfo\\": [\\n {\\n \\"ConditionInfoCid\\": \\"xxx\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"HandScoreIdList\\": {\\n \\"HandScoreIdList\\": [\\n \\"[]\\"\\n ]\\n },\\n \\"TyxmTurboCount\\": \\"\\",\\n \\"TyxmPlusCount\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<UploadDataSyncResponse>\\n <Message>successful</Message>\\n <RequestId>4EFC3224-4E25-4019-AD06-63AC0***</RequestId>\\n <Data>\\n <ResultInfo>\\n <Rules>\\n <RuleHitInfo>\\n <Hit>\\n <ConditionHitInfo>\\n <HitKeyWords>\\n <HitKeyWord>\\n <Val>你好</Val>\\n <Pid>1</Pid>\\n <From>2</From>\\n <To>4</To>\\n <Tid>4ef4f8a9-4910-4d46-a348-eabfb***</Tid>\\n </HitKeyWord>\\n </HitKeyWords>\\n <HitCids>\\n <CidItem>24196</CidItem>\\n </HitCids>\\n <Phrase>\\n <Role>客服</Role>\\n <Words>哎,你好。</Words>\\n <Begin>3820</Begin>\\n <End>4830</End>\\n <Identity>某客服</Identity>\\n </Phrase>\\n </ConditionHitInfo>\\n </Hit>\\n <Rid>15589</Rid>\\n </RuleHitInfo>\\n <RuleHitInfo>\\n <Hit>\\n <ConditionHitInfo>\\n <HitKeyWords>\\n <HitKeyWord>\\n <Val>帮您</Val>\\n <Pid>2</Pid>\\n <From>5</From>\\n <To>7</To>\\n <Tid>4ef4f8a9-4910-4d46-a348-eabfb8e***</Tid>\\n </HitKeyWord>\\n </HitKeyWords>\\n <HitCids>\\n <CidItem>28208</CidItem>\\n </HitCids>\\n <Phrase>\\n <Role>客服</Role>\\n <Words>有什么可以帮您。</Words>\\n <Begin>6770</Begin>\\n <End>8540</End>\\n <Identity>某客服</Identity>\\n </Phrase>\\n </ConditionHitInfo>\\n </Hit>\\n <Rid>18128</Rid>\\n </RuleHitInfo>\\n </Rules>\\n <Tid>4ef4f8a9-4910-4d46-a348-eabfb8***</Tid>\\n </ResultInfo>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UploadDataSyncResponse>","errorExample":""}]',
+ 'title' => 'Real-time Text Quality Inspection ',
+ 'description' => 'This API pushes text data to SCA for real-time quality inspection based on specified rules and synchronously returns the analysis results. Unlike post-call quality inspection, which requires uploading the full transcript after a dialogue ends, real-time quality inspection offers lower latency by analyzing text immediately after a speaker completes one or more utterances.'."\n"
+ ."\n"
+ .'- If you push a single utterance from one speaker, some rule operators may fail because the required dialogue context is missing. Examples include the context repetition check, speech interruption check, and call mute check.'."\n"
+ ."\n"
+ .'- SCA returns analysis results synchronously and does not save call records, so you cannot query the results later via an API.',
+ 'requestParamsDescription' => '## jsonStr properties'."\n"
+ ."\n"
+ .'| Parameter | Type | Required | Description |'."\n"
+ .'| :------------ | :--- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| tickets | List | Yes | A list of objects, where each object contains the text for inspection. You can upload multiple text segments in a single API call. For details, see the **tickets properties** section below. |'."\n"
+ .'| commonRuleIds | List | No | The rule IDs to use for the analysis. If you do not specify this parameter, the service uses all available rules. If the total number of rules exceeds 100, the service applies only the first 100 rules in the list. We recommend specifying quality inspection rules to reduce API latency. Note: You can use only offline quality inspection rules. Real-time quality inspection rules are not supported. |'."\n"
+ ."\n"
+ .'## tickets properties'."\n"
+ ."\n"
+ .'| Parameter | Type | Required | Description |'."\n"
+ .'| :-------- | :----- | :------- | :--------------------------------------------------------------------------------------- |'."\n"
+ .'| tid | String | Yes | The unique ID for this text segment. You can use the corresponding call ID or ticket ID. |'."\n"
+ .'| dialogue | List | Yes | The dialogue content. For details, see the **dialogue properties** section below. |'."\n"
+ ."\n"
+ .'## dialogue properties'."\n"
+ ."\n"
+ .'| Parameter | Type | Required | Description |'."\n"
+ .'| :-------- | :------ | :------- | :----------------------------------------------------------------------------------------------- |'."\n"
+ .'| role | String | Yes | The role of the speaker. Valid values: agent, customer. |'."\n"
+ .'| identity | String | No | The specific identity of the speaker. |'."\n"
+ .'| words | String | Yes | The utterance from the speaker. |'."\n"
+ .'| begin | Integer | Yes | The start time of the utterance, as a millisecond offset from the beginning of the conversation. |'."\n"
+ .'| end | Integer | Yes | The end time of the utterance, as a millisecond offset from the beginning of the conversation. |'."\n"
+ .'| beginTime | Date | Yes | The absolute start time of the utterance. Example: 2019-11-25 15:37:16. |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '6000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UploadDataSync'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"4987D326-83D9-4A42-B9A5-0B27F9B***\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ResultInfo\\": [\\n {\\n \\"Score\\": 100,\\n \\"Rules\\": {\\n \\"RuleHitInfo\\": [\\n {\\n \\"Tid\\": \\"88888888\\",\\n \\"Rid\\": \\"801\\",\\n \\"Hit\\": {\\n \\"ConditionHitInfo\\": [\\n {\\n \\"HitKeyWords\\": {\\n \\"HitKeyWord\\": [\\n {\\n \\"To\\": 1,\\n \\"From\\": 1,\\n \\"Val\\": \\"嗯\\",\\n \\"Tid\\": \\"1\\",\\n \\"Pid\\": 1,\\n \\"CustomizeCode\\": \\"\\",\\n \\"IsMatch\\": \\"\\"\\n }\\n ]\\n },\\n \\"HitCids\\": {\\n \\"CidItem\\": [\\n \\"[\\\\\\"3265\\\\\\"]\\"\\n ]\\n },\\n \\"Phrase\\": {\\n \\"Words\\": \\"你好\\",\\n \\"Identity\\": \\"1\\",\\n \\"Begin\\": 0,\\n \\"BeginTime\\": \\"1564574\\",\\n \\"End\\": 2090,\\n \\"Role\\": \\"客服\\"\\n }\\n }\\n ]\\n },\\n \\"ConditionInfo\\": {\\n \\"ConditionBasicInfo\\": [\\n {\\n \\"ConditionInfoCid\\": \\"xxx\\"\\n }\\n ]\\n },\\n \\"LlmResponse\\": \\"\\"\\n }\\n ]\\n },\\n \\"HandScoreIdList\\": {\\n \\"HandScoreIdList\\": [\\n \\"[]\\"\\n ]\\n },\\n \\"TyxmTurboCount\\": \\"\\",\\n \\"TyxmPlusCount\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
- 'GetNextResultToVerify' => [
- 'methods' => [
- 'post',
- 'get',
+ 'UploadDataV4' => [
+ 'summary' => 'Uploads offline plain text conversation data for quality inspection in online agent scenarios. We recommend that you use the UploadDataV4 API. Compared to the UploadData API, UploadDataV4 supports only POST requests and allows a longer JsonStr.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'JsonStr',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The JSON string that contains all the custom parameters for this API. For more information, see the description of jsonStr properties below.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxx', 'title' => ''],
+ ],
+ [
+ 'name' => 'BaseMeAgentId',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'The workspace ID. Use this parameter to select a specific workspace when you have multiple workspaces. If you do not specify this parameter, the default workspace is used.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => 'The result code. A value of 200 indicates success. Other values indicate failure. Use this field to determine the cause of a failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The details of the error if the request fails. If the request is successful, the value is "successful".', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Data' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => '6F5934C7-C223-4F0F-BBF3-5B3594***', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID. This is a unique identifier for the request that can be used for tracking.', 'type' => 'string', 'example' => '6F5934C7-C223-4F0F-BBF3-5B3594***', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Use this field to determine if the request succeeded. A value of true indicates success. A value of false or null indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"6F5934C7-C223-4F0F-BBF3-5B3594***\\",\\n \\"RequestId\\": \\"6F5934C7-C223-4F0F-BBF3-5B3594***\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'UploadDataV4',
+ 'description' => 'You can call the UploadData.json operation to upload text data for quality inspection. The text usually comes from sources such as online customer service and tickets. The API returns a task ID. You can retrieve the results in one of the following three ways:'."\n"
+ ."\n"
+ .'- Message notifications: After you receive a notification, call the GetResult API to obtain the detailed results. For more information, see [Message Queue](https://help.aliyun.com/document_detail/213237.html). (Recommended)'."\n"
+ ."\n"
+ .'- Callbacks: Specify a callbackUrl in the request parameters. The system automatically initiates a callback after the task is complete. After you receive the callback, call the GetResult API to retrieve the detailed results.'."\n"
+ ."\n"
+ .'- Polling: Use the task ID returned by this API to poll the GetResult API and asynchronously retrieve the results. Check the status in the response to determine whether the task is complete. (Not recommended)',
+ 'requestParamsDescription' => '## jsonStr properties'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| ----------- | ---------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| tickets | List | Yes | The text data to be inspected. Each element is a complete conversation. For more information, see the description of **jsonStr.tickets properties** |'."\n"
+ .'| business | String | No | The name of the line-of-business. This is used for statistical classification. All data in the request must belong to the same line-of-business. |'."\n"
+ .'| callbackUrl | String | No | The webhook address. If you do not specify this parameter, no callback is performed. Ensure that the webhook address can be reached by the Smart Conversation Analysis (SCA) application. IP addresses are not supported. A callback is initiated after the quality inspection is complete. For more information, see the description of **Callback parameters** |'."\n"
+ ."\n"
+ .'## jsonStr.tickets properties'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| ------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |'."\n"
+ .'| dialogue | List | Yes | The text conversation to be inspected. For more information, see the description of **dialogue properties** |'."\n"
+ .'| tid | String | No | The ID of the conversation. Make sure the ID is unique. If you do not provide an ID, a random universally unique identifier (UUID) is generated. |'."\n"
+ .'| fileName | String | No | The name of the text file. |'."\n"
+ .'| customerServiceId | Long | No | The ID of the customer service agent. Obtain this ID from the User Management page under Basic Settings in the console. If you enter the correct agent ID, the agent can view their associated files when they log on to the console. |'."\n"
+ .'| customerServiceName | String | No | The name of the customer service agent. |'."\n"
+ .'| skillGroupId | String | No | The ID of the skill group to which the agent belongs. |'."\n"
+ .'| skillGroupName | String | No | The name of the skill group to which the agent belongs. |'."\n"
+ .'| callType | Integer | No | The call type. Valid values: 1 (outbound) and 3 (inbound). This parameter specifies the call type when you upload text directly to the SCA system from a local speech-to-text service. |'."\n"
+ .'| sessionGroupId | String | No | The session group ID. A session group typically includes all sessions between the same agent and the same customer. If you provide a session group ID, you can view quality inspection results for that session group on the results page. |'."\n"
+ .'| customerId | String | No | The customer ID. |'."\n"
+ .'| customerName | String | No | The customer name. |'."\n"
+ .'| schemeTaskConfigId | String | No | The ID of a manually specified quality inspection task. If you specify this ID, the corresponding task is used for the quality inspection. |'."\n"
+ .'| remark1 | String | No | Custom data 1. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark2 | String | No | Custom data 2. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark3 | String | No | Custom data 3. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark4 | String | No | Custom data 4. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark5 | Long | No | Custom data 5. Store custom business-related fields in this parameter. The format is a signed long. |'."\n"
+ .'| remark6 | String | No | Custom data 6. Store custom business-related fields in this parameter. The maximum length is 1024 characters. |'."\n"
+ .'| remark7 | String | No | Custom data 7. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark8 | String | No | Custom data 8. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark9 | String | No | Custom data 9. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark10 | String | No | Custom data 10. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark11 | String | No | Custom data 11. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark12 | String | No | Custom data 12. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark13 | String | No | Custom data 13. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark14 | Long | No | Custom data 14. Store custom business-related fields in this parameter. The format is a signed long. |'."\n"
+ .'| remark15 | Long | No | Custom data 15. Store custom business-related fields in this parameter. The format is a signed long. |'."\n"
+ .'| remark16 | String | No | Custom data 16. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark17 | String | No | Custom data 17. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark18 | String | No | Custom data 18. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark19 | String | No | Custom data 19. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark20 | String | No | Custom data 20. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark21 | String | No | Custom data 21. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark22 | String | No | Custom data 22. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark23 | String | No | Custom data 23. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark24 | String | No | Custom data 24. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| remark25 | String | No | Custom data 25. Store custom business-related fields in this parameter. The maximum length is 64 characters. |'."\n"
+ .'| jsonParamStr | String | No | More custom fields in the format of a JSON string. The key is the field name and the value is the field content. Example: {"Customer Level": 3, "Channel": "Official Website"}. |'."\n"
+ ."\n"
+ .'## dialogue properties'."\n"
+ ."\n"
+ .'| Property | Value type | Required | Description |'."\n"
+ .'| ------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| role | String | Yes | The role in the conversation. Valid values: Agent, Customer. |'."\n"
+ .'| customerServiceType | Integer | No | Indicates whether the role is a human or a bot. Valid values: 0 (human) and 1 (bot). Default value: 0. If the role is a bot, a bot profile picture is displayed on the review page. |'."\n"
+ .'| identity | String | No | The specific identity of the role in the conversation. |'."\n"
+ .'| words | String | Yes | A sentence spoken by the role. Only UTF-8 encoding is supported. If the sentence contains emojis, see the **Emoji display instructions** |'."\n"
+ .'| type | String | No | The type of the sentence. Valid values: TEXT, AUDIO, and IMAGE. Images can be displayed and audio can be played on the review details page. The default value is TEXT. If the type is AUDIO or IMAGE, enter the URL of the resource in the words field. (**Applicable only to the new version of Smart Conversation Analysis**) |'."\n"
+ .'| begin | Integer | Yes | The start time of the sentence. This is the offset from the beginning of the conversation, in milliseconds (ms). |'."\n"
+ .'| end | Integer | Yes | The end time of the sentence. This is the offset from the beginning of the conversation, in milliseconds (ms). |'."\n"
+ .'| beginTime | Date | Yes | The start time of the sentence. Example: 2019-11-25 15:37:16. |'."\n"
+ ."\n"
+ .'## Emoji display instructions'."\n"
+ ."\n"
+ .'When you view conversation details on the review details page, only standard emojis can be displayed. When you upload data, you must replace emojis with their UTF-8 character codes. For example, the code for a smiley face is `&#128512;`. The code must start with \\&# and end with a semicolon (;). For more information, see [Emoji Character Set Reference](https://www.runoob.com/charsets/ref-emoji.html) and [HTML Symbol Reference](https://www.runoob.com/charsets/ref-html-symbols.html).'."\n"
+ ."\n"
+ .'## Callback parameters'."\n"
+ ."\n"
+ .'If the webhook address that you provide is `http://aliyun.com/callback`, the full callback URL is `http://aliyun.com/callback?taskId=xxx&timestamp=xxx&signature=xxx&event=xxx`. The parameters are described as follows:'."\n"
+ ."\n"
+ .'- taskId: The task ID.'."\n"
+ ."\n"
+ .'- timestamp: The UNIX timestamp of the call, in milliseconds.'."\n"
+ ."\n"
+ .'- aliUid: The UID of your Alibaba Cloud account.'."\n"
+ ."\n"
+ .'- signature: The signature that is used to verify that the request is from Alibaba Cloud. To calculate the signature, encrypt the string `taskId=xxx&timestamp=xxx&aliUid=xxx` using MD5 and Base64. The order of the parameters is important. After you receive the callback, retrieve the taskId and timestamp from the callback URL. The aliUid is the UID of your Alibaba Cloud account. To verify the request, compare your calculated signature with the signature in the URL. For more information, see the Java code example below.'."\n"
+ ."\n"
+ .'- event: The event name. This parameter is used to determine which event triggered the callback. The value is TaskComplete, which indicates that the task is complete.'."\n"
+ ."\n"
+ .'```'."\n"
+ .'public static void signature() {'."\n"
+ .' long timestamp = System.currentTimeMillis();'."\n"
+ .' String taskId = "xxxx";'."\n"
+ .' String aliUid = "xxxxx";'."\n"
+ .' // Encrypt the string "taskId=xxx&timestamp=xxx&aliUid=xxx" using MD5 and Base64, and put the result in the signature field.'."\n"
+ .' String signature;'."\n"
+ .' try {'."\n"
+ .' signature = URLEncoder.encode(md5Base64("taskId=" + taskId + "&timestamp=" + timestamp + "&aliUid=" + aliUid), "utf-8");'."\n"
+ .' System.out.println(signature);'."\n"
+ .' } catch (Exception e) {'."\n"
+ .' e.printStackTrace();'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ ."\n"
+ .'public static String md5Base64(String str) throws NoSuchAlgorithmException {'."\n"
+ .' // The string must be UTF-8 encoded.'."\n"
+ .' byte[] utfBytes = str.getBytes(StandardCharsets.UTF_8);'."\n"
+ .' MessageDigest mdTemp = MessageDigest.getInstance("MD5");'."\n"
+ .' mdTemp.update(utfBytes);'."\n"
+ .' byte[] md5Bytes = mdTemp.digest();'."\n"
+ .' return Base64.encodeBase64String(md5Bytes);'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Sample request parameters'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "callbackUrl": "https://123.123.com/sca-callback",'."\n"
+ .' "tickets": ['."\n"
+ .' {'."\n"
+ .' "schemeTaskConfigId": "389",'."\n"
+ .' "customerName": "John Doe 1",'."\n"
+ .' "customerId": "johndoe-vip-audio",'."\n"
+ .' "dialogue": ['."\n"
+ .' {'."\n"
+ .' "beginTime": "2019-11-25 15:36:01",'."\n"
+ .' "role": "Customer",'."\n"
+ .' "identity": "A Customer",'."\n"
+ .' "emotionValue": 6,'."\n"
+ .' "speechRate": 153,'."\n"
+ .' "words": "Hello.",'."\n"
+ .' "end": 2580,'."\n"
+ .' "begin": 1800,'."\n"
+ .' "channelId": 0'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "beginTime": "2019-11-25 15:37:01",'."\n"
+ .' "role": "Agent",'."\n"
+ .' "identity": "An Agent",'."\n"
+ .' "emotionValue": 6,'."\n"
+ .' "speechRate": 153,'."\n"
+ .' "words": "How can I help you? Do you want to buy something? Please tell me.",'."\n"
+ .' "end": 2580,'."\n"
+ .' "begin": 1800,'."\n"
+ .' "channelId": 1'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "beginTime": "2019-11-25 15:37:06",'."\n"
+ .' "role": "Customer",'."\n"
+ .' "identity": "A Customer",'."\n"
+ .' "emotionValue": 6,'."\n"
+ .' "speechRate": 305,'."\n"
+ .' "words": "I want to buy a sweater.",'."\n"
+ .' "end": 12540,'."\n"
+ .' "begin": 6770,'."\n"
+ .' "channelId": 0'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'## Sample request code'."\n"
+ ."\n"
+ .'```java'."\n"
+ .'public class sca {'."\n"
+ ."\n"
+ .' private static String ak = "YOUR_ACCESS_KEY_ID";'."\n"
+ .' private static String sk = "YOUR_ACCESS_KEY_SECRET";'."\n"
+ ."\n"
+ .' private static void uploadText() throws Exception {'."\n"
+ .' String json="{\\n" +'."\n"
+ .' " \\"callbackUrl\\":\\"https://123.123.com/sca-callback\\",\\n" +'."\n"
+ .' " \\"tickets\\":[\\n" +'."\n"
+ .' " {\\n" +'."\n"
+ .' " \\"schemeTaskConfigId\\":\\"389\\",\\n" +'."\n"
+ .' " \\"customerName\\": \\"John Doe 1\\",\\n" +'."\n"
+ .' " \\"customerId\\": \\"johndoe-vip-audio\\",\\n" +'."\n"
+ .' " \\"dialogue\\":[\\n" +'."\n"
+ .' " {\\n" +'."\n"
+ .' " \\"beginTime\\":\\"2019-11-25 15:36:01\\",\\n" +'."\n"
+ .' " \\"role\\":\\"Customer\\",\\n" +'."\n"
+ .' " \\"identity\\":\\"A Customer\\",\\n" +'."\n"
+ .' " \\"emotionValue\\":6,\\n" +'."\n"
+ .' " \\"speechRate\\":153,\\n" +'."\n"
+ .' " \\"words\\":\\"Hello.\\",\\n" +'."\n"
+ .' " \\"end\\":2580,\\n" +'."\n"
+ .' " \\"begin\\":1800,\\n" +'."\n"
+ .' " \\"channelId\\":0,\\n" +'."\n"
+ .' " \\n" +'."\n"
+ .' " },\\n" +'."\n"
+ .' " {\\n" +'."\n"
+ .' " \\"beginTime\\":\\"2019-11-25 15:37:01\\",\\n" +'."\n"
+ .' " \\"role\\":\\"Agent\\",\\n" +'."\n"
+ .' " \\"identity\\":\\"An Agent\\",\\n" +'."\n"
+ .' " \\"emotionValue\\":6,\\n" +'."\n"
+ .' " \\"speechRate\\":153,\\n" +'."\n"
+ .' " \\"words\\":\\"How can I help you? Do you want to buy something? Please tell me.\\",\\n" +'."\n"
+ .' " \\"end\\":2580,\\n" +'."\n"
+ .' " \\"begin\\":1800,\\n" +'."\n"
+ .' " \\"channelId\\":1,\\n" +'."\n"
+ .' " \\n" +'."\n"
+ .' " },\\n" +'."\n"
+ .' " {\\n" +'."\n"
+ .' " \\"beginTime\\":\\"2019-11-25 15:37:06\\",\\n" +'."\n"
+ .' " \\"role\\":\\"Customer\\",\\n" +'."\n"
+ .' " \\"identity\\":\\"A Customer\\",\\n" +'."\n"
+ .' " \\"emotionValue\\":6,\\n" +'."\n"
+ .' " \\"speechRate\\":305,\\n" +'."\n"
+ .' " \\"words\\":\\"I want to buy a sweater.\\",\\n" +'."\n"
+ .' " \\"end\\":12540,\\n" +'."\n"
+ .' " \\"begin\\":6770,\\n" +'."\n"
+ .' " \\"channelId\\":0,\\n" +'."\n"
+ .' " \\n" +'."\n"
+ .' " }\\n" +'."\n"
+ .' " ],\\n" +'."\n"
+ .' " }\\n" +'."\n"
+ .' " \\n" +'."\n"
+ .' " ]\\n" +'."\n"
+ .' " \\n" +'."\n"
+ .' " }";'."\n"
+ ."\n\n"
+ .' Config config = new Config();'."\n"
+ .' config.setAccessKeyId(ak).setAccessKeySecret(sk).setEndpoint("qualitycheck.cn-hangzhou.aliyuncs.com")'."\n"
+ .' .setRegionId("cn-hangzhou").setProtocol("HTTPS");'."\n"
+ ."\n"
+ .' Client client = new Client(config);'."\n"
+ .' UploadDataV4Request result = new UploadDataV4Request();'."\n"
+ ."\n"
+ .' result.setJsonStr(json);'."\n"
+ ."\n"
+ .' UploadDataV4Response response = client.uploadDataV4(result);'."\n"
+ .' System.out.println(JSONObject.toJSONString(response));'."\n"
+ .' }'."\n"
+ ."\n\n"
+ .' public static void main(String[] args) throws Exception {'."\n"
+ .' uploadText();'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UploadDataV4'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'UploadRule' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '"{"pageNumber":1,"pageSize":1,"taskId":"593A04C0-E6E9-4CDC-8C9*****","original":1}"',
- ],
+ 'schema' => ['description' => 'Complete JSON string. For details, see the following sections.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{“conditions”:“xxxxx”,"rules":"xxxx"}', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -16466,283 +17954,522 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'Result code. **200** means success. Any other value indicates failure. Use this field to diagnose errors.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the call fails. **successful** if successful.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '4987D326-83D9-4A42-B9A5-0B27F9B40539', 'title' => ''],
+ 'Success' => ['description' => 'Whether the request succeeded. Use this field to verify success:'."\n"
+ ."\n"
+ .'- **true** means success.'."\n"
+ ."\n"
+ .'- false or **null** means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
- 'description' => '',
'type' => 'object',
+ 'itemNode' => true,
'properties' => [
- 'Index' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'AudioScheme' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'http',
- ],
- 'AudioURL' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sca-bucket.oss-cn-hangzhou.aliyuncs.com/upload_1173636551461420/dateset_1584674455133_SzC/%E4%BA%BA%E5%B7%A5%E6%A0%A1%E9%AA%8C%E6%B5%8B%E8%AF%95-%E6%9F%A5%E5%8C%97%E4%BA%AC%E5%A4%A9%E6%B0%94.wav?Expires=1584847372&amp;OSSAccessKeyId=*****&amp;Signature=HccAKnLOJwoYvzE*********',
- ],
- 'UpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-03-20T11:26Z',
- ],
- 'IncorrectWords' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '23',
- ],
- 'VerifiedCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Verified' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'FileName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx.wav',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'Precision' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.97079998',
- ],
- 'FileId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'e790e6c919d84b82b64ee*****',
- ],
- 'Duration' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '23421',
- ],
- 'Dialogues' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Dialogue' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Words' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Identity' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'IncorrectWords' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'BeginTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'SourceWords' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'End' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3422',
- ],
- 'SpeechRate' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '332',
- ],
- 'HourMinSec' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '00:00:07',
- ],
- 'SourceRole' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Begin' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '980',
- ],
- 'EmotionValue' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '6',
- ],
- 'Role' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'SilenceDuration' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Deltas' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Delta' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CHANGE',
- ],
- 'Source' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Position' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'Line' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Line' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Target' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Position' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'Line' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Line' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RidInfo' => [
+ 'description' => 'Rule IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Rule ID.', 'type' => 'string', 'example' => '318', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Index\\": 2,\\n \\"Status\\": 3,\\n \\"AudioScheme\\": \\"http\\",\\n \\"AudioURL\\": \\"sca-bucket.oss-cn-hangzhou.aliyuncs.com/upload_1173636551461420/dateset_1584674455133_SzC/%E4%BA%BA%E5%B7%A5%E6%A0%A1%E9%AA%8C%E6%B5%8B%E8%AF%95-%E6%9F%A5%E5%8C%97%E4%BA%AC%E5%A4%A9%E6%B0%94.wav?Expires=1584847372&amp;OSSAccessKeyId=*****&amp;Signature=HccAKnLOJwoYvzE*********\\",\\n \\"UpdateTime\\": \\"2020-03-20T11:26Z\\",\\n \\"IncorrectWords\\": 23,\\n \\"VerifiedCount\\": 2,\\n \\"Verified\\": true,\\n \\"FileName\\": \\"xxx.wav\\",\\n \\"TotalCount\\": 3,\\n \\"Precision\\": 0.97079998,\\n \\"FileId\\": \\"e790e6c919d84b82b64ee*****\\",\\n \\"Duration\\": 23421,\\n \\"Dialogues\\": {\\n \\"Dialogue\\": [\\n {\\n \\"Words\\": \\"你好有什么可以帮您\\",\\n \\"Identity\\": \\"某客服\\",\\n \\"IncorrectWords\\": 2,\\n \\"BeginTime\\": \\"XXX\\",\\n \\"SourceWords\\": \\"您好有什么可以帮您\\",\\n \\"End\\": 3422,\\n \\"SpeechRate\\": 332,\\n \\"HourMinSec\\": \\"00:00:07\\",\\n \\"SourceRole\\": \\"客服\\",\\n \\"Begin\\": 980,\\n \\"EmotionValue\\": 6,\\n \\"Role\\": \\"客户\\",\\n \\"SilenceDuration\\": 1,\\n \\"Deltas\\": {\\n \\"Delta\\": [\\n {\\n \\"Type\\": \\"CHANGE\\",\\n \\"Source\\": {\\n \\"Position\\": 5,\\n \\"Line\\": {\\n \\"Line\\": [\\n \\"这里是阿里云\\"\\n ]\\n }\\n },\\n \\"Target\\": {\\n \\"Position\\": 5,\\n \\"Line\\": {\\n \\"Line\\": [\\n \\"这里是服务台\\"\\n ]\\n }\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetNextResultToVerifyResponse>\\n <Message>successful</Message>\\n <RequestId>93F9E901-41C5-4563-95A4-4095A70FE4AB</RequestId>\\n <Data>\\n <Status>3</Status>\\n <IncorrectWords>4</IncorrectWords>\\n <Dialogues>\\n <Dialogue>\\n <HourMinSec>00:01</HourMinSec>\\n <Role>客服</Role>\\n <SourceRole>客服</SourceRole>\\n <Deltas>\\n <Delta>\\n <Type>CHANGE</Type>\\n <Target>\\n <Line>\\n <Line>服务控制台</Line>\\n </Line>\\n <Position>5</Position>\\n </Target>\\n <Source>\\n <Line>\\n <Line>阿里云</Line>\\n </Line>\\n <Position>5</Position>\\n </Source>\\n </Delta>\\n </Deltas>\\n <IncorrectWords>3</IncorrectWords>\\n <SourceWords>您好,这里是阿里云,您想查什么。</SourceWords>\\n <Words>您好,这里是服务控制台,您想查什么。</Words>\\n <Begin>1990</Begin>\\n <End>6000</End>\\n <Identity>某客服</Identity>\\n <SpeechRate>224</SpeechRate>\\n <EmotionValue>6</EmotionValue>\\n </Dialogue>\\n <Dialogue>\\n <HourMinSec>00:07</HourMinSec>\\n <Role>客户</Role>\\n <SourceRole>客户</SourceRole>\\n <Deltas>\\n </Deltas>\\n <IncorrectWords>0</IncorrectWords>\\n <SourceWords>帮我查看北京明天的天气情况。</SourceWords>\\n <Words>帮我查看北京明天的天气情况。</Words>\\n <Begin>7050</Begin>\\n <End>10910</End>\\n <Identity>某客户</Identity>\\n <SpeechRate>202</SpeechRate>\\n <EmotionValue>5</EmotionValue>\\n </Dialogue>\\n <Dialogue>\\n <HourMinSec>00:12</HourMinSec>\\n <Role>客服</Role>\\n <SourceRole>客服</SourceRole>\\n <Deltas>\\n </Deltas>\\n <IncorrectWords>0</IncorrectWords>\\n <SourceWords>北京明天天气晴朗,气温22到219度。</SourceWords>\\n <Words>北京明天天气晴朗,气温22到219度。</Words>\\n <Begin>12230</Begin>\\n <End>16590</End>\\n <Identity>某客服</Identity>\\n <SpeechRate>233</SpeechRate>\\n <EmotionValue>6</EmotionValue>\\n </Dialogue>\\n <Dialogue>\\n <HourMinSec>00:17</HourMinSec>\\n <Role>客户</Role>\\n <SourceRole>客户</SourceRole>\\n <Deltas>\\n </Deltas>\\n <IncorrectWords>0</IncorrectWords>\\n <SourceWords>好的谢谢。</SourceWords>\\n <Words>好的谢谢。</Words>\\n <Begin>17710</Begin>\\n <End>18800</End>\\n <Identity>某客户</Identity>\\n <SpeechRate>220</SpeechRate>\\n <EmotionValue>5</EmotionValue>\\n </Dialogue>\\n </Dialogues>\\n <FileName>人工校验测试-查北京天气.wav</FileName>\\n <VerifiedCount>3</VerifiedCount>\\n <AudioScheme>http</AudioScheme>\\n <Index>2</Index>\\n <Duration>62830</Duration>\\n <TotalCount>3</TotalCount>\\n <Verified>true</Verified>\\n <Precision>0.97079998254776</Precision>\\n <UpdateTime>2020-03-20T11:26Z</UpdateTime>\\n <FileId>e790e6c919d84b82b64ee34768a***</FileId>\\n <AudioURL>sca-bucket.oss-cn-hangzhou.aliyuncs.com/upload_1173636551461420/dateset_1584674455133_SzC/%E4%BA%BA%E5%B7%A5%E6%A0%A1%E9%AA%8C%E6%B5%8B%E8%AF%95-%E6%9F%A5%E5%8C%97%E4%BA%AC%E5%A4%A9%E6%B0%94.wav?Expires=1584847372&amp;OSSAccessKeyId=LTAI***UdO&amp;Signature=HccAKnLOJwoYvzE%2F3wlHyj%***</AudioURL>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetNextResultToVerifyResponse>","errorExample":""}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"4987D326-83D9-4A42-B9A5-0B27F9B40539\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RidInfo\\": [\\n \\"318\\"\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Creation of a rule',
+ 'summary' => 'Creates a rule. You can use this operation to provide your own rule editing interface.',
+ 'description' => '> For more information, see [Rule configuration](https://help.aliyun.com/document_detail/213225.html).',
+ 'requestParamsDescription' => '## JSON string for request parameters'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :--------- | :----- | :------- | :-------------------------------------------------------------------------------------- |'."\n"
+ .'| appKey | String | Yes | Tag for the business party or scenario. |'."\n"
+ .'| conditions | List | Yes | Detailed configuration for all conditions. For details, see `ConditionBasicInfo` below. |'."\n"
+ .'| rules | List | Yes | Rule configuration. For details, see `RuleInfo` below. |'."\n"
+ ."\n"
+ .'## Condition configuration: ConditionBasicInfo'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :---------- | :--------- | :------- | :----------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| cid | String | Yes | "1" | Condition ID. Must be a numeric string (we recommend starting from 1 and incrementing by 1). After upload, the system replaces this with an auto-generated ID. |'."\n"
+ .'| check_range | CheckRange | Yes | See `CheckRange` | Scope of condition evaluation. |'."\n"
+ .'| operators | List | Yes | See `OperatorBasicInfo` | Operators in this condition. |'."\n"
+ .'| lambda | String | Yes | One operator: "1". Multiple operators: `1&&2&&3` | Logical relationship among operators. Built from operator IDs (oid) and logical operators (AND, OR, NOT). In the example, 1, 2, and 3 are operator IDs. See `OperatorBasicInfo` for details on oid. |'."\n"
+ ."\n"
+ .'### CheckRange'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :------- | :----- | :------- | :---------------- | :----------------------------------------------------------------------------------- |'."\n"
+ .'| role | String | No | Agent | Target role. Valid values: "Agent", "Customer". If omitted, applies to all roles. |'."\n"
+ .'| anchor | Anchor | No | See `Anchor` | Prerequisite condition details. |'."\n"
+ .'| range | String | No | {"from":1,"to":3} | Evaluation range. For usage details, see `Range usage notes` later in this document. |'."\n"
+ ."\n"
+ .'### Anchor'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :------- | :------ | :------- | :------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| cid | String | Yes | "3" | Condition ID (cid) of the prerequisite condition. Identifies which condition serves as the anchor. |'."\n"
+ .'| location | String | Yes | AROUND | Specifies where to evaluate relative to the anchor condition\'s matched sentence. Valid values:BEFORE: before the anchor sentence.AROUND: around the anchor sentence (before and after).AFTER: after the anchor sentence.CURRENT: the anchor sentence itself.Use this field to define a scope. Then use the from and to values in range to specify exact sentences. |'."\n"
+ .'| hit_time | Integer | Yes | 3 | How many times the prerequisite condition must match. Options:Positive integer (1–N): matches the first (or Nth) occurrence.0: matches every occurrence.-1: matches any occurrence. |'."\n"
+ ."\n"
+ .'### OperatorBasicInfo'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :------- | :----- | :------- | :--------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ |'."\n"
+ .'| oid | String | Yes | "1" | Operator ID. Must be a numeric string (we recommend starting from 1 and incrementing by 1). After upload, the system replaces this with an auto-generated ID. |'."\n"
+ .'| name | String | Yes | My operator name | Operator name and description. |'."\n"
+ .'| type | String | Yes | INCLUDE_KEYWORDS | Operator type. For details, see `Param` below. |'."\n"
+ .'| param | Param | Yes | See `Param` | Operator expression details. |'."\n"
+ ."\n"
+ .'### Param: Operator types and parameters'."\n"
+ ."\n"
+ .'The param object contains many properties. Some are shared across all operator types, while others apply only to specific types. This section lists each operator type, its valid properties, and provides configuration examples.'."\n"
+ ."\n"
+ .'### 1. Keyword check'."\n"
+ ."\n"
+ .'Matches if any keyword is present (HIT\\_ANY\\_KEYWORDS), all keywords are present, a specific number of keywords are present, or no keywords are present (INCLUDE\\_KEYWORDS).'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :--------------- | :------ | :------- | :------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| keywords | List | Yes | \\["Hello", "Hi", "Good morning"] | List of keywords. |'."\n"
+ .'| contextChatMatch | Boolean | No | false | Whether to analyze multiple sentences together. Valid values: true (multi-sentence analysis), false (single-sentence analysis). Default: false. See **Detailed analysis modes** |'."\n"
+ .'| keywordMatchSize | Integer | No | 3 | Number of keywords to match. Rules:Any one keyword: set to 1.All keywords: set to -1.Any N keywords: set to an integer between 1 and the total number of keywords.None: set to 0.Default depends on type: HIT_ANY_KEYWORDS → 1, INCLUDE_KEYWORDS → -1. |'."\n"
+ .'| in_sentence | Boolean | No | true | Whether to restrict matching to a single sentence. A sentence ends at punctuation like commas or periods. Valid values: true (restrict), false (no restriction). Default: false. This setting has no effect if contextChatMatch is true. |'."\n"
+ .'| keywordExtension | Integer | No | 0 | Whether to enable synonym expansion. Valid values: 1 (enable), 0 (disable). Default: 0. |'."\n"
+ ."\n"
+ .'**Detailed analysis modes**'."\n"
+ ."\n"
+ .'- Single-sentence and multi-sentence analysis apply to the sentences that are defined by the role, anchor, and range of the current condition.'."\n"
+ ."\n"
+ .'- Limited sentences: Refers to one or more sentences that are defined by the role, anchor, and range of the condition.'."\n"
+ ."\n"
+ .'- Single-sentence analysis: Analyzes each limited sentence separately. For example, to match all keywords, at least one sentence must contain all of the specified keywords.'."\n"
+ ."\n"
+ .'- Multi-sentence analysis: Combines all limited sentences into a single paragraph and analyzes it. For example, to match all keywords, the combined paragraph must contain all of the specified keywords.'."\n"
+ ."\n"
+ .'**Request examples:** 1. Single-sentence analysis to match any one keyword.'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "keywords":['."\n"
+ .' "Hi",'."\n"
+ .' "Hello",'."\n"
+ .' "Good morning"'."\n"
+ .' ],'."\n"
+ .' "contextChatMatch":false'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB1CJ3KI4D1gK0jSZFsXXbldVXa-921-287.png)'."\n"
+ ."\n"
+ .'2\\. Multi-sentence analysis to match all keywords.'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "keywordMatchSize":-1,'."\n"
+ .' "keywords":['."\n"
+ .' "Hi",'."\n"
+ .' "Hello",'."\n"
+ .' "Good morning"'."\n"
+ .' ],'."\n"
+ .' "contextChatMatch":true'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB1MnoOI7L0gK0jSZFxXXXWHVXa-924-285.png)'."\n"
+ ."\n"
+ .'3\\. Single-sentence analysis to match any two keywords, restricted to one sentence, with synonym expansion enabled.'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "keywordMatchSize":2,'."\n"
+ .' "keywordExtension":1,'."\n"
+ .' "keywords":['."\n"
+ .' "Hi",'."\n"
+ .' "Hello",'."\n"
+ .' "Good morning"'."\n"
+ .' ],'."\n"
+ .' "in_sentence":true,'."\n"
+ .' "contextChatMatch":false'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB106RaaP39YK4jSZPcXXXrUFXa-985-288.png)'."\n"
+ ."\n"
+ .'4\\. Single-sentence analysis to match none of the keywords.'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "keywordMatchSize":0,'."\n"
+ .' "keywords":['."\n"
+ .' "Hi",'."\n"
+ .' "Hello",'."\n"
+ .' "Good morning"'."\n"
+ .' ],'."\n"
+ .' "contextChatMatch":false'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB16PAMI.T1gK0jSZFrXXcNCXXa-980-282.png)'."\n"
+ ."\n"
+ .'### 2. Regular expression check (REGULAR\\_EXPRESSION)'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :---------- | :------ | :------- | :----------------------- | :------------------------------------------------------------------------------------------------------------------------ |'."\n"
+ .'| regex | String | Yes | `See code example below` | Regular expression to match. |'."\n"
+ .'| notRegex | String | No | `See code example below` | Regular expression to exclude. |'."\n"
+ .'| in_sentence | Boolean | No | true | Whether to restrict matching to a single sentence. Default: false. Valid values: true (restrict), false (no restriction). |'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "regex":"Please.*(license plate number|engine number|driver\'s license number)",'."\n"
+ .' "notRegex":"Send me|Tell me",'."\n"
+ .' "in_sentence":true'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB1aOSeaggP7K4jSZFqXXamhVXa-1015-215.png)'."\n"
+ ."\n"
+ .'### 3. Text similarity check (SIMILAR\\_MATCH)'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :----------------- | :------ | :------- | :----------------------- | :--------------------------------------------------------------------------------------- |'."\n"
+ .'| similarlySentences | List | Yes | `See code example below` | Example sentences. Maximum 200 sentences. Each sentence can be up to 50 characters long. |'."\n"
+ .'| score | Integer | No | 80 | Similarity score. Default: 80. |'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "score":80,'."\n"
+ .' "similarlySentences":['."\n"
+ .' "I want to complain about your department",'."\n"
+ .' "I want to complain about you",'."\n"
+ .' "I want to report your department",'."\n"
+ .' "I will call 12315 to report you",'."\n"
+ .' "I will complain to the industrial and commercial administration"'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB1wuIYMoH1gK0jSZSyXXXtlpXa-1015-328.png)'."\n"
+ ."\n"
+ .'### 4. Advanced repeat detection (ADVANCED\\_REPEAT\\_DETECT)'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :-------- | :------ | :------- | :---------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| from | Integer | No | 3 | Maximum gap (in sentences) between repeated sentences. Default: 2. For example, if set to 2, repetition within the last two sentences triggers a violation. |'."\n"
+ .'| hit_time | Integer | No | 2 | Which repetition triggers a violation. Default: 1. |'."\n"
+ .'| threshold | Integer | No | 5 | Minimum sentence length (in characters) to check. Sentences shorter than this value are skipped. Default: 4. |'."\n"
+ .'| excludes | List | No | \\["OK, I understand", "OK, I understand"] | Sentences that are exempt from repeat checks. Default: empty. |'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "from":3,'."\n"
+ .' "hit_time":2,'."\n"
+ .' "threshold":5,'."\n"
+ .' "excludes":['."\n"
+ .' "OK, I understand",'."\n"
+ .' "OK, I understand"'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB1jaeteXT7gK0jSZFpXXaTkpXa-1015-254.jpg)'."\n"
+ ."\n"
+ .'### 5. Silence detection (INTERVAL\\_GREATER)'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :------------- | :------ | :------- | :------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| interval | Integer | Yes | 5000 | Silence duration (in milliseconds). |'."\n"
+ .'| different_role | Boolean | No | false | Whether to distinguish roles. true: distinguish roles. false: ignore roles. If true, sentences spoken by the same role as the target sentence are excluded from calculation. |'."\n"
+ .'| target | Integer | No | 1 | How many sentences before the current sentence to use as the target. If 0, the interval equals the current sentence’s end time minus its start time. |'."\n"
+ .'| from_end | Boolean | No | false | Whether to calculate the interval as the current sentence’s end time minus the target sentence’s end time. |'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "interval":5000,'."\n"
+ .' "different_role":false,'."\n"
+ .' "target":1,'."\n"
+ .' "from_end":false'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB1aBFTeaL7gK0jSZFBXXXZZpXa-2036-262.jpg)'."\n"
+ ."\n"
+ .'### 6. Speech speed check (SPEECH\\_SPEED\\_CHECK)'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :------------- | :------ | :------- | :------------ | :-------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| velocityInMint | Integer | Yes | 370 | Speech speed (characters per minute). Used to determine whether the current sentence exceeds this speed. |'."\n"
+ .'| minWordSize | Integer | No | 4 | Minimum sentence length (in characters) to check. Sentences shorter than this value are skipped. |'."\n"
+ .'| average | Boolean | No | false | Whether to check average speech speed across the entire conversation. true: check average. false: check per sentence. |'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "velocityInMint":370,'."\n"
+ .' "average":false,'."\n"
+ .' "minWordSize":4'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB1nelmeX67gK0jSZPfXXahhFXa-2030-312.jpg)'."\n"
+ ."\n"
+ .'### 7. Interruption detection (GRAB\\_WORDS)'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :-------- | :------ | :------- | :------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| interval | Integer | Yes | 5000 | Overlap time (in milliseconds). Calculated as the customer’s speech end time minus the agent’s speech start time. |'."\n"
+ .'| threshold | Integer | No | 4 | Minimum sentence length (in characters) to check for interruptions. |'."\n"
+ .'| delayTime | Integer | No | 1000 | Delay before detecting interruption (in milliseconds). For example, if set to 1000, overlap must persist for at least 1000 ms to trigger detection. |'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "interval":3000,'."\n"
+ .' "threshold":4'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB1K1F3eoY1gK0jSZFCXXcwqXXa-2030-312.jpg)'."\n"
+ ."\n"
+ .'### 8. Role check (ROLE\\_CHECK)'."\n"
+ ."\n"
+ .'This operator requires changes to check\\_range. See the full condition example below.'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :---------- | :----- | :------- | :------------ | :--------------------------------------------------------------- |'."\n"
+ .'| target_role | String | Yes | Customer | Target role for the sentence. Valid values: "Agent", "Customer". |'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "cid":"1",'."\n"
+ .' "lambda":"1",'."\n"
+ .' "check_range":{'."\n"
+ .' "absolute":true,'."\n"
+ .' "alSentencesSatisfy":true,'."\n"
+ .' "range":{'."\n"
+ .' "from":2,'."\n"
+ .' "to":2'."\n"
+ .' }'."\n"
+ .' },'."\n"
+ .' "operators":['."\n"
+ .' {'."\n"
+ .' "oid":1,'."\n"
+ .' "type":"ROLE_CHECK",'."\n"
+ .' "param":{'."\n"
+ .' "target_role":"Agent"'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB1w.00emf2gK0jSZFPXXXsopXa-2028-254.jpg)'."\n"
+ ."\n"
+ .'### 9. Abnormal hang-up (DURATION)'."\n"
+ ."\n"
+ .'Detects abnormal hang-ups based on the role of the last sentence and the time that elapses between the end of that sentence and the hang-up. To evaluate the last sentence, set both \\`from\\` and \\`to\\` in \\`check\\_range.range\\` to -1. See the full condition example below.'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :-------------- | :------ | :------- | :------------ | :---------------------------------------------------------------------------------------------- |'."\n"
+ .'| interval | Integer | Yes | 5000 | Time (in milliseconds) between the end of the last sentence and the hang-up. |'."\n"
+ .'| compareOperator | String | No | gt | Comparison operator for interval. Valid values: gt (greater than), lt (less than). Default: gt. |'."\n"
+ .'| beginType | String | Yes | DIALOGUE | Fixed value: DIALOGUE. |'."\n"
+ .'| target_role | String | No | Customer | Role of the last sentence. If omitted, applies to all roles. |'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "cid":"1",'."\n"
+ .' "lambda":"1",'."\n"
+ .' "check_range":{'."\n"
+ .' "range":{'."\n"
+ .' "from":-1,'."\n"
+ .' "to":-1'."\n"
+ .' }'."\n"
+ .' },'."\n"
+ .' "operators":['."\n"
+ .' {'."\n"
+ .' "oid":1,'."\n"
+ .' "type":"DURATION",'."\n"
+ .' "param":{'."\n"
+ .' "interval":3000,'."\n"
+ .' "beginType":"DIALOGUE",'."\n"
+ .' "target_role":"Customer"'."\n"
+ .' }'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB1SJF6ehD1gK0jSZFyXXciOVXa-2036-272.jpg)'."\n"
+ ."\n"
+ .'### 10. Recording duration check (DURATION)'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :-------------- | :------ | :------- | :------------ | :---------------------------------------------------------------------------------------------- |'."\n"
+ .'| interval | Integer | Yes | 5000 | Recording duration (in milliseconds). |'."\n"
+ .'| compareOperator | String | No | gt | Comparison operator for interval. Valid values: gt (greater than), lt (less than). Default: gt. |'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "interval":60000,'."\n"
+ .' "compareOperator":"lt"'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB151l2ehz1gK0jSZSgXXavwpXa-2032-204.jpg)'."\n"
+ ."\n"
+ .'### 11. Energy detection (ASR\\_EMOTION)'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :-------------------- | :------ | :------- | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| maxEmotionChangeValue | Integer | No | 3 | Energy value. Range: 1–10. |'."\n"
+ .'| checkType | Integer | No | 3 | Detection method. Valid values:1: energy fluctuation between adjacent sentences.2: maximum energy span.3: energy range detection.Default: 3. |'."\n"
+ .'| compareOperator | String | No | gt | Comparison direction. Valid values: gt (greater than), lt (less than). Default: gt. |'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB1r0ZYMbr1gK0jSZFDXXb9yVXa-1018-185.png)'."\n"
+ ."\n"
+ .'### 12. General detection model (EMOTION\\_MODEL)'."\n"
+ ."\n"
+ .'Uses built-in algorithms to detect issues such as abusive language or high-risk content.'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :------- | :--- | :------- | :------------ | :----------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| pvalues | List | No | \\["ruma01"] | Detection type. Valid values:ruma01: abusive language detection.goawei01: high-risk detection.Default: ["ruma01"]. |'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/imgextra/i3/O1CN01nKIjwc1OvKWFqhZFt_!!6000000001767-2-tps-1014-191.png)'."\n"
+ ."\n"
+ .'### 13. Customer detection model (CUSTOMER\\_CHECK\\_MODEL)'."\n"
+ ."\n"
+ .'Uses built-in algorithms to detect customer statements such as threats to complain, requests to speak with supervisors, complaints about agent attitude, internal complaints, or public sentiment issues.'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :------- | :--- | :------- | :--------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| pvalues | List | No | \\["tousu01","zhaozhuguan01"] | Detection type. Valid values:tousu01: threat to complain about agent.zhaozhuguan01: request to speak with supervisor.zhiyitaidu01: complaint about agent attitude.internal_complain01: internal complaint detection.public_opinion: public sentiment detection.Default: ["tousu01"]. |'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/imgextra/i2/O1CN01XyWkZx1rexDMlwaqs_!!6000000005657-2-tps-1017-166.png)'."\n"
+ ."\n"
+ .'### 14. Agent detection model (ABUSE\\_MODEL)'."\n"
+ ."\n"
+ .'This model uses built-in algorithms and does not require \\`param\\` configuration.'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :------- | :--- | :------- | :------------ | :-------------------------------------------------------------------------------- |'."\n"
+ .'| pvalues | List | No | \\["jifeng01"] | Detection type. Valid value: jifeng01 (mockery detection). Default: ["jifeng01"]. |'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/imgextra/i2/O1CN01ci8lMd1eLdVRoCm0V_!!6000000003855-2-tps-1013-135.png)'."\n"
+ ."\n"
+ .'## Rule configuration: RuleInfo'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :----------------- | :------ | :------- | :------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n"
+ .'| rid | String | Yes | 1 | Rule ID. Must be a numeric string. After upload, the system replaces this with an auto-generated ID. |'."\n"
+ .'| lambda | String | Yes | One condition: "". Multiple conditions: `a&&b&&c` | Logical relationship among conditions. Built from condition IDs (cid) and logical operators (AND, OR, NOT). In the example, a, b, and c are condition IDs. |'."\n"
+ .'| business | List | Yes | See `BusinessCategoryBasicInfo` | Businesses this rule applies to. Get this from the Create Rule page. If empty, defaults to "All businesses". |'."\n"
+ .'| type | Integer | Yes | 1 | Rule type. Get this from the Create Rule page. |'."\n"
+ .'| triggers | List | Yes | \\["a","b","c"] | Condition IDs (cid) whose results should be returned. When the rule matches, these condition details are included in the response. |'."\n"
+ .'| Name | String | Yes | "Customer may file a complaint" | Rule name. |'."\n"
+ .'| scoreSubId | Integer | No | 3678 | ID of the scoring sub-item this rule is attached to. Required if attaching to a scoring item. |'."\n"
+ .'| ruleScoreType | Integer | No | 3 | Whether this rule contributes to scoring. 1: no contribution. 3: contributes. |'."\n"
+ .'| level | Integer | No | 2 | Severity level. Used to group rules by severity in review pages. Values: 0 (severe), 1 (moderate), 2 (minor). Default: 2. |'."\n"
+ .'| fullCycle | Integer | No | 1 | When the rule is active. Valid values: 0 (active during a specific period), 1 (always active). |'."\n"
+ .'| effectiveStartTime | Date | No | 2021-03-04 04:05:05 | Start time for a specific active period. |'."\n"
+ .'| effectiveEndTime | Date | No | 2021-03-06 04:05:05 | End time for a specific active period. |'."\n"
+ ."\n"
+ .'### BusinessCategoryBasicInfo'."\n"
+ ."\n"
+ .'| Property | Type | Required | Example value | Description |'."\n"
+ .'| :------- | :------ | :------- | :------------ | :---------------------------------- |'."\n"
+ .'| bid | Integer | Yes | 267202890 | Business ID (BID). Must be numeric. |'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/imgextra/i4/O1CN01JAVwvr21FRYMRTLY4_!!6000000006955-2-tps-602-247.png)'."\n"
+ ."\n"
+ .'## Range usage notes'."\n"
+ ."\n"
+ .'The \\`range\\` parameter uses a numeric interval to select the sentences to which the condition applies.'."\n"
+ ."\n"
+ .'### Without a prerequisite condition'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB1l.utJ1L2gK0jSZFmXXc7iXXa-1534-486.png)'."\n"
+ ."\n"
+ .'1\\. {"from":1,"to":3}: Selects the first three sentences spoken by the specified role. 2. {"from":-1,"to":-3}: Selects the last three sentences spoken by the specified role. 3. {"from":3,"to":-3}: Selects from the third sentence to the third-to-last sentence spoken by the specified role.'."\n"
+ ."\n"
+ .'### With a prerequisite condition'."\n"
+ ."\n"
+ .'If a prerequisite condition exists, the system uses the matched prerequisite sentence as a divider to split all sentences into three segments: • All sentences before the matched prerequisite sentence. • All sentences after the matched prerequisite sentence. • Sentences around the matched prerequisite sentence. First, you must choose a segment. Then, you can use a numeric interval to select specific sentences within that segment.'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB1zZWuJ1L2gK0jSZFmXXc7iXXa-1462-544.png)'."\n"
+ ."\n"
+ .'**Before the prerequisite match (anchor.location = BEFORE)**'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB1MO8fXZ4z2K4jSZKPXXXAYpXa-1486-636.png)'."\n"
+ ."\n"
+ .'1\\. {"from":1,"to":3}: The first three sentences in the selected segment. The sentence immediately before the prerequisite match is considered sentence 1. 2. {"from":-1,"to":-3}: The last three sentences in the selected segment. The sentence farthest from the prerequisite match is considered the last sentence. 3. {"from":1,"to":-1}: All sentences before the prerequisite match. 4. {"from":0,"to":2}: The prerequisite match sentence plus the next two sentences spoken by the specified role. This is valid only if the current and prerequisite conditions apply to the same role.<br>5. These are only examples. You can use any positive or negative integers. Positive numbers count forward from the start of the segment, and negative numbers count backward from the end.<br>'."\n"
+ ."\n"
+ .'**Around the prerequisite match (anchor.location = AROUND)**'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB1OIkUlsKfxu4jSZPfXXb3dXXa-1482-660.png)'."\n"
+ ."\n"
+ .'1\\. {"from":0,"to":0}: Only the prerequisite match sentence. 2. {"from":1,"to":3}: The first to third sentences after the prerequisite match. 3. {"from":-2,"to":-4}: The second to fourth sentences before the prerequisite match. 4. {"from":-3,"to":3}: From the third sentence before the prerequisite match to the third sentence after it. 5. These are only examples. You can use any positive or negative integers. Positive numbers refer to sentences after the prerequisite match, and negative numbers refer to sentences before it.'."\n"
+ ."\n"
+ .'**After the prerequisite match (anchor.location = AFTER)**'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/tfs/TB1S0eZJYj1gK0jSZFuXXcrHpXa-1490-648.png)'."\n"
+ ."\n"
+ .'1\\. {"from":1,"to":3}: The first three sentences in the selected segment. The sentence immediately after the prerequisite match is considered sentence 1. 2. {"from":-1,"to":-3}: The last three sentences in the selected segment. The sentence farthest from the prerequisite match is considered the last sentence. 3. {"from":1,"to":-1}: All sentences after the prerequisite match. 4. {"from":0,"to":2}: The prerequisite match sentence plus the next two sentences spoken by the specified role. This is valid only if the current and prerequisite conditions apply to the same role.<br>5. These are only examples. You can use any positive or negative integers. Positive numbers count forward from the start of the segment, and negative numbers count backward from the end.<br>',
+ 'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UploadRule'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
'VerifyFile' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -16755,24 +18482,12 @@
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Complete JSON string information. For details, see the following information.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"{"taskId":"EA701F66-8CA2-4A79-8E3C-A6F2****","fileName":"人工校验测试-订购茶叶.wav"}"', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -16780,50 +18495,72 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 's',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.9485294',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => 'Result code. **200** indicates success. Other values indicate failure. Callers can determine the failure reason using this field.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details when an error occurs. Successful when successful.', 'type' => 'string', 'example' => 's', 'title' => ''],
+ 'Data' => ['description' => 'Current detection accuracy: Number of incorrect characters in verified files / Total number of characters in verified files.', 'type' => 'number', 'format' => 'float', 'example' => '0.9485294', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Callers can determine if the request was successful using this field: true indicates success; false/null indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"s\\",\\n \\"Data\\": 0.9485294,\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<VerifyFileResponse>\\n <Message>successful</Message>\\n <RequestId>3FC826D9-2017-411B-A73F-BDF80F6651F7</RequestId>\\n <Data>0.9485294222831726</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</VerifyFileResponse>","errorExample":""}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"s\\",\\n \\"Data\\": 0.9485294,\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Save the validation results of a single file',
+ 'summary' => 'Saves the verification result of a single file.',
+ 'requestParamsDescription' => '## Request Parameters'."\n"
+ ."\n"
+ .'| Property | Value Type | Required | Description |'."\n"
+ .'| :------- | :--------- | :------- | :---------- |'."\n"
+ .'| taskId | Integer | Yes | Task ID. |'."\n"
+ .'| fileName | String | Yes | File name. |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'VerifyFile'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
'VerifySentence' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -16836,24 +18573,12 @@
[
'name' => 'JsonStr',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Full JSON string. For details, see the following table.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"{"taskId":"EA701F66-8CA2-4A79-8E3C-A6F2F****","fileName":"人工校验测试-订购茶叶.wav","dialogueId":1,"roleCorrect":false,"sourceRole":0,"textCorrect":false,"sourceText":"我要订购大量的信阳毛尖。","oldIncorrectWords":3,"targetText":"我要订购大大的南阳毛巾。","targetRole":1}"', 'title' => ''],
],
[
'name' => 'BaseMeAgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['title' => 'baseMeAgentId', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
],
],
'responses' => [
@@ -16862,1262 +18587,1831 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'IncorrectWords' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'TargetRole' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'SourceRole' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded. Set to true for success. Set to false or null for failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'IncorrectWords' => ['description' => 'Number of incorrect characters in this sentence.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'TargetRole' => ['description' => 'Transcribed role. Valid values: 0 (agent), 1 (customer).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Code' => ['description' => 'Result code. **200** indicates success. Any other value indicates failure. Use this field to identify the cause of failure.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Error details if the request failed. Returns successful if the request succeeded.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'SourceRole' => ['description' => 'Correct role after manual verification. Valid values: 0 (agent), 1 (customer).', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Delta' => [
- 'description' => '',
+ 'description' => 'Differences between the transcribed and verified text if the transcription is incorrect. Empty otherwise.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'CHANGE',
- ],
+ 'Type' => ['description' => 'Type of error. Valid values: CHANGE (incorrect character), INSERT (extra character), DELETE (missing character).', 'type' => 'string', 'example' => 'CHANGE', 'title' => ''],
'Source' => [
- 'description' => '',
+ 'description' => 'Correct dialogue after manual verification.',
'type' => 'object',
'properties' => [
- 'Position' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Position' => ['description' => 'Character position.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Line' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Line' => [
- 'description' => '',
+ 'description' => 'Characters.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'items' => ['description' => 'Character.', 'type' => 'string', 'example' => '你', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
'Target' => [
- 'description' => '',
+ 'description' => 'Transcribed dialogue.',
'type' => 'object',
'properties' => [
- 'Position' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Position' => ['description' => 'Character position.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Line' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Line' => [
- 'description' => '',
+ 'description' => 'Characters.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'items' => ['description' => 'Character.', 'type' => 'string', 'example' => '您', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"IncorrectWords\\": 2,\\n \\"TargetRole\\": 1,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"SourceRole\\": 0,\\n \\"Data\\": {\\n \\"Delta\\": [\\n {\\n \\"Type\\": \\"CHANGE\\",\\n \\"Source\\": {\\n \\"Position\\": 1,\\n \\"Line\\": {\\n \\"Line\\": [\\n \\"你\\"\\n ]\\n }\\n },\\n \\"Target\\": {\\n \\"Position\\": 1,\\n \\"Line\\": {\\n \\"Line\\": [\\n \\"您\\"\\n ]\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<VerifySentenceResponse>\\n <SourceRole>0</SourceRole>\\n <IncorrectWords>3</IncorrectWords>\\n <Message>successful</Message>\\n <RequestId>4AD45ADD-4F5E-4BBB-8051-AE8B31F397F9</RequestId>\\n <TargetRole>1</TargetRole>\\n <Data>\\n <Delta>\\n <Type>CHANGE</Type>\\n <Target>\\n <Line>\\n <Line>大的南</Line>\\n </Line>\\n <Position>5</Position>\\n </Target>\\n <Source>\\n <Line>\\n <Line>量信</Line>\\n </Line>\\n <Position>5</Position>\\n </Source>\\n </Delta>\\n <Delta>\\n <Type>CHANGE</Type>\\n <Target>\\n <Line>\\n <Line>巾</Line>\\n </Line>\\n <Position>10</Position>\\n </Target>\\n <Source>\\n <Line>\\n <Line>尖</Line>\\n </Line>\\n <Position>9</Position>\\n </Source>\\n </Delta>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</VerifySentenceResponse>","errorExample":""}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"IncorrectWords\\": 2,\\n \\"TargetRole\\": 1,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"SourceRole\\": 0,\\n \\"Data\\": {\\n \\"Delta\\": [\\n {\\n \\"Type\\": \\"CHANGE\\",\\n \\"Source\\": {\\n \\"Position\\": 1,\\n \\"Line\\": {\\n \\"Line\\": [\\n \\"你\\"\\n ]\\n }\\n },\\n \\"Target\\": {\\n \\"Position\\": 1,\\n \\"Line\\": {\\n \\"Line\\": [\\n \\"您\\"\\n ]\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Save the validation results of a single sentence',
+ 'summary' => 'Save the verification result for a single sentence.',
+ 'requestParamsDescription' => '### Request parameter JSON string'."\n"
+ ."\n"
+ .'| Property | Type | Required | Description |'."\n"
+ .'| :---------------- | :------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |'."\n"
+ .'| taskId | String | Yes | Task ID. |'."\n"
+ .'| fileName | String | Yes | File name. |'."\n"
+ .'| dialogueId | Integer | Yes | Sentence ID. This is the position of the sentence in the dialogue array, starting from 0. |'."\n"
+ .'| roleCorrect | Boolean | Yes | Whether the role assignment is correct. If true, provide only sourceRole. Otherwise, provide both sourceRole and targetRole. |'."\n"
+ .'| sourceRole | Integer | Yes | Correct role after manual verification. Valid values: 0 (agent), 1 (customer). |'."\n"
+ .'| targetRole | Integer | No | Transcribed role. Valid values: 0 (agent), 1 (customer). |'."\n"
+ .'| textCorrect | Boolean | No | Whether the text transcription is correct. Default: false. If true, provide only sourceText. If false, provide both sourceText and targetText. |'."\n"
+ .'| sourceText | String | Yes | Correct dialogue after manual verification. |'."\n"
+ .'| targetText | String | Yes | Transcribed dialogue. |'."\n"
+ .'| oldIncorrectWords | Integer | No | Number of incorrect characters before this verification. Default: 0. For first-time verification, this value is always 0. For re-verification of previously checked sentences, provide the updated count. This value is returned by GetNextResultToVerify (as incorrectWords) and also in the response after each submission (as incorrectWords). |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-01T09:31:41.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'VerifySentence'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => '智能对话分析'],
+ ],
+ 'ramActions' => [],
],
- 'SubmitPrecisionTask' => [
- 'methods' => [
- 'post',
- 'get',
+ ],
+ 'endpoints' => [
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'qualitycheck.cn-hangzhou.aliyuncs.com', 'endpoint' => 'qualitycheck.cn-hangzhou.aliyuncs.com', 'vpc' => 'qualitycheck-vpc.cn-hangzhou.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'AccessDenied', 'message' => 'User has no access to the given task.', 'http_code' => 403, 'description' => 'Not authorized to perform the operation.'],
+ ['code' => 'addLambdaError', 'message' => 'Failed to add logic between conditions. Check expressions and the && operator.', 'http_code' => 400, 'description' => 'Failed to add logic among rule conditions. Check the expressions. Pay special attention to the logical AND (&&) operator.'],
+ ['code' => 'addTriggerError', 'message' => 'Invalid logic between conditions.', 'http_code' => 400, 'description' => 'Invalid logic among rule conditions.'],
+ ['code' => 'DataNotExist', 'message' => 'Record is duplicated.', 'http_code' => 404, 'description' => 'Duplicate data.'],
+ ['code' => 'DataNotExist', 'message' => 'Can not find data related to the given task.', 'http_code' => 404, 'description' => 'The business data is not found.'],
+ ['code' => 'Duplicate', 'message' => 'Record is duplicated.', 'http_code' => 400, 'description' => 'Duplicate data.'],
+ ['code' => 'MissingParam', 'message' => 'param must not be null or empty', 'http_code' => 400, 'description' => 'The parameters must be specified.'],
+ ['code' => 'NotExist', 'message' => 'Can not find data related to the given task.', 'http_code' => 404, 'description' => 'Data not found.'],
+ ['code' => 'InvalidParam', 'message' => 'Invalid Param %s .', 'http_code' => 400, 'description' => 'Illegal parameter'],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetSchemeTaskConfig'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'createdAt' => '2025-06-05T08:24:59.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateSkillGroupConfig'],
+ ['description' => 'Error codes changed', 'api' => 'DeleteSkillGroupConfig'],
+ ['description' => 'Error codes changed', 'api' => 'GetSkillGroupConfig'],
+ ['description' => 'Error codes changed', 'api' => 'ListSkillGroupConfig'],
+ ['description' => 'Error codes changed', 'api' => 'UpdateSkillGroupConfig'],
+ ],
+ 'createdAt' => '2025-05-29T06:48:10.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetResultToReview'],
],
- 'security' => [
- [
- 'AK' => [],
+ 'createdAt' => '2025-05-22T09:15:30.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ApplyWsToken'],
+ ],
+ 'createdAt' => '2025-02-06T03:00:04.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateAsrVocab'],
+ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'GetAsrVocab'],
+ ['description' => 'Response parameters changed', 'api' => 'GetCustomizationConfigList'],
+ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'ListAsrVocab'],
+ ['description' => 'Response parameters changed', 'api' => 'ListSchemeTaskConfig'],
+ ],
+ 'createdAt' => '2025-01-21T12:56:59.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'SyncQualityCheck'],
+ ],
+ 'createdAt' => '2024-12-17T14:22:00.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetResult'],
+ ['description' => 'Response parameters changed', 'api' => 'GetResultToReview'],
+ ],
+ 'createdAt' => '2024-12-04T03:25:51.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetQualityCheckScheme'],
+ ],
+ 'createdAt' => '2024-11-14T06:32:45.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'DeleteDataSet'],
+ ['description' => 'Error codes changed', 'api' => 'SaveConfigDataSet'],
+ ],
+ 'createdAt' => '2024-11-05T08:05:07.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetResult'],
+ ],
+ 'createdAt' => '2024-11-04T06:42:53.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetResult'],
+ ],
+ 'createdAt' => '2024-07-30T09:47:30.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetResult'],
+ ['description' => 'Response parameters changed', 'api' => 'GetResultToReview'],
+ ],
+ 'createdAt' => '2024-07-22T08:34:39.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetResult'],
+ ['description' => 'Response parameters changed', 'api' => 'GetResultToReview'],
+ ],
+ 'createdAt' => '2024-07-15T07:54:17.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetResult'],
+ ['description' => 'Response parameters changed', 'api' => 'GetResultToReview'],
+ ],
+ 'createdAt' => '2024-07-15T07:41:29.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetResult'],
+ ['description' => 'Response parameters changed', 'api' => 'GetResultToReview'],
+ ],
+ 'createdAt' => '2024-07-15T03:50:36.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'AddRuleCategory'],
+ ],
+ 'createdAt' => '2024-06-21T03:07:03.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'DeleteScoreForApi'],
+ ['description' => 'Error codes changed', 'api' => 'DeleteSubScoreForApi'],
+ ['description' => 'Error codes changed', 'api' => 'GetRule'],
+ ['description' => 'Error codes changed', 'api' => 'GetRuleDetail'],
+ ['description' => 'Error codes changed', 'api' => 'GetScoreInfo'],
+ ['description' => 'Error codes changed', 'api' => 'InsertScoreForApi'],
+ ['description' => 'Error codes changed', 'api' => 'InsertSubScoreForApi'],
+ ],
+ 'createdAt' => '2024-04-19T06:20:13.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'TestRuleV4'],
+ ],
+ 'createdAt' => '2024-03-12T11:29:45.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'GetBusinessCategoryList'],
+ ],
+ 'createdAt' => '2024-02-21T02:36:56.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'GetResultCallback'],
+ ],
+ 'createdAt' => '2024-01-12T08:58:15.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'UpdateUser'],
+ ],
+ 'createdAt' => '2024-01-12T07:02:03.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateUser'],
+ ['description' => 'Error codes changed', 'api' => 'DeleteUser'],
+ ],
+ 'createdAt' => '2024-01-02T09:21:48.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetResult'],
+ ],
+ 'createdAt' => '2023-12-07T03:18:22.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetRuleV4'],
+ ],
+ 'createdAt' => '2023-08-07T09:01:05.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'AddBusinessCategory'],
+ ['description' => 'Request parameters changed', 'api' => 'AddBusinessCategory'],
+ ['description' => 'Request parameters changed', 'api' => 'AddBusinessCategory'],
+ ['description' => 'Request parameters changed', 'api' => 'AddBusinessCategory'],
+ ['description' => 'Request parameters changed', 'api' => 'AddBusinessCategory'],
+ ['description' => 'Request parameters changed', 'api' => 'AddBusinessCategory'],
+ ['description' => 'Request parameters changed', 'api' => 'AddBusinessCategory'],
+ ['description' => 'Request parameters changed', 'api' => 'AddBusinessCategory'],
+ ['description' => 'Request parameters changed', 'api' => 'AddBusinessCategory'],
+ ['description' => 'Request parameters changed', 'api' => 'AddBusinessCategory'],
+ ],
+ 'createdAt' => '2023-08-01T09:34:09.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetResult'],
+ ],
+ 'createdAt' => '2023-04-12T12:04:02.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'ListUsers'],
+ ],
+ 'createdAt' => '2022-12-05T07:02:19.000Z',
+ 'description' => '开启ListUsers日志记录',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'DeleteRuleV4'],
+ ],
+ 'createdAt' => '2022-10-21T01:28:59.000Z',
+ 'description' => '隐藏客户不必要的字段',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetQualityCheckScheme'],
+ ['description' => 'Response parameters changed', 'api' => 'GetRuleById'],
+ ],
+ 'createdAt' => '2022-10-20T06:53:25.000Z',
+ 'description' => '1. 新增接口GetRuleById API2. 完善接口 GetQualityCheckScheme3. 复用数据结构',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'DeleteRule'],
+ ],
+ 'createdAt' => '2022-10-20T03:53:31.000Z',
+ 'description' => '兼容旧版质检删除规则',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'DeleteRule'],
+ ],
+ 'createdAt' => '2022-10-08T08:25:04.000Z',
+ 'description' => '新增接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'GetResult'],
+ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'GetResultToReview'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListBusinessSpaces'],
+ ['description' => 'Response parameters changed', 'api' => 'ListQualityCheckScheme'],
+ ['description' => 'OpenAPI offline', 'api' => 'UpdateQualityCheckData'],
+ ],
+ 'createdAt' => '2022-05-30T12:57:50.000Z',
+ 'description' => '- 新增接口:获取质检方案列表',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'ListQualityCheckScheme'],
+ ],
+ 'createdAt' => '2022-05-16T12:20:26.000Z',
+ 'description' => '新增接口:质检方案列表查询接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'GetSyncResult'],
+ ],
+ 'createdAt' => '2021-11-26T07:02:03.000Z',
+ 'description' => '- GetSyncResult:响应参数中增加durationAudio',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCheckTypeToScheme'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListUsers'],
+ ['threshold' => '360', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateCheckTypeToScheme'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCustomizationConfig'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetQualityCheckScheme'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RevertAssignedSession'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'VerifyFile'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetRuleCategory'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateAsrVocab'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteRuleV4'],
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteRule'],
+ ['threshold' => '800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListRules'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListQualityCheckScheme'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateSchemeTaskConfig'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetResult'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SaveConfigDataSet'],
+ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UploadData'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSkillGroupConfig'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateRule'],
+ ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApplyWsToken'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteAsrVocab'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddRuleV4'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AssignReviewerBySessionGroup'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteBusinessCategory'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListAsrVocab'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDataSet'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateTaskAssignRule'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteTaskAssignRule'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AssignReviewer'],
+ ['threshold' => '6000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UploadDataSync'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSkillGroupConfig'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteWarningConfig'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListSessionGroup'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateTaskAssignRule'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetNextResultToVerify'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateQualityCheckScheme'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetRuleDetail'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetRulesCountList'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListSchemeTaskConfig'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UploadDataV4'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListPrecisionTask'],
+ ['threshold' => '3000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateQualityCheckData'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetRuleV4'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RevertAssignedSessionGroup'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListWarningConfig'],
+ ['threshold' => '800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetResultToReview'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'VerifySentence'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SubmitPrecisionTask'],
+ ['threshold' => '1800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SyncQualityCheck'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSchemeTaskConfig'],
+ ['threshold' => '15', 'countWindow' => 5, 'regionId' => '*', 'api' => 'TestRuleV4'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateRuleToScheme'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetScoreInfo'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTaskAssignRules'],
+ ['threshold' => '3000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UploadAudioData'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateWarningConfig'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetAsrVocab'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListSkillGroupConfig'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetSyncResult'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateWarningConfig'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SubmitComplaint'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDataSet'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListRulesV4'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateSkillGroupConfig'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSchemeTaskConfig'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetSkillGroupConfig'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateRuleById'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UploadRule'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'InvalidRule'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetRule'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeletePrecisionTask'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DelRuleCategory'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateQualityCheckScheme'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'BatchSubmitReviewInfo'],
+ ['threshold' => '8000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateSyncQualityCheckData'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'HandleComplaint'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateRuleV4'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddRuleCategory'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetPrecisionTask'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SubmitReviewInfo'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteQualityCheckScheme'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetCustomizationConfigList'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetBusinessCategoryList'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetRuleById'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateUser'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddBusinessCategory'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAsrVocab'],
+ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SubmitQualityCheckTask'],
+ ],
+ 'product' => ['code' => 'sca', 'title' => 'Qualitycheck'],
+ ],
+ 'ram' => [
+ 'productCode' => 'SmartConversationAnalysis',
+ 'productName' => 'Smart Conversation Analysis',
+ 'ramCodes' => ['sca'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'ListRulesV4',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:ListRulesV4',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'write',
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'JsonStr',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '"{"name":"test","dataSetId":1865}"',
+ [
+ 'apiName' => 'CreateSchemeTaskConfig',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sca:CreateSchemeTaskConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'BaseMeAgentId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'ListQualityCheckScheme',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:ListQualityCheckScheme',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EA701F66-8CA2-4A79-8E3C-A6F2FA****',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'UpdateUser',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"EA701F66-8CA2-4A79-8E3C-A6F2FA****\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SubmitPrecisionTaskResponse>\\n <Message>successful</Message>\\n <RequestId>77F24A2E-6CE6-4230-AD81-BC9E0F3A4B45</RequestId>\\n <Data>76DC9DFA-E5CC-4E61-B77C-2742116***</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</SubmitPrecisionTaskResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'GetPrecisionTask' => [
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'UpdateRule',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'ListSessionGroup',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'sca:ListSessionGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'GetRulesCountList',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:GetRulesCountList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'read',
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'JsonStr',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '"{"taskId":"593A04C0-E6E9-4CDC-8C9****"}"',
+ [
+ 'apiName' => 'TestRuleV4',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:TestRuleV4',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'BaseMeAgentId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'UpdateRuleV4',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateRuleV4',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'UpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-03-10 20:26:29',
- ],
- 'IncorrectWords' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '23',
- ],
- 'DataSetId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1212',
- ],
- 'VerifiedCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Duration' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3423',
- ],
- 'DataSetName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'Source' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '7C1DEF5F-2C18-4D36-99C6-8C27*****',
- ],
- 'Precisions' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Precision' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ModelName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '593A04C0-E6E9-4CDC-8C99-B120C******',
- ],
- 'Precision' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.98',
- ],
- 'ModelId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2311',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'DeleteTaskAssignRule',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:DeleteTaskAssignRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": 1,\\n \\"UpdateTime\\": \\"2020-03-10 20:26:29\\",\\n \\"IncorrectWords\\": 23,\\n \\"DataSetId\\": 1212,\\n \\"VerifiedCount\\": 2,\\n \\"Duration\\": 3423,\\n \\"DataSetName\\": \\"数据集名称\\",\\n \\"TotalCount\\": 3,\\n \\"Source\\": 3,\\n \\"Name\\": \\"任务名称\\",\\n \\"TaskId\\": \\"7C1DEF5F-2C18-4D36-99C6-8C27*****\\",\\n \\"Precisions\\": {\\n \\"Precision\\": [\\n {\\n \\"Status\\": 1,\\n \\"ModelName\\": \\"模型名称\\",\\n \\"TaskId\\": \\"593A04C0-E6E9-4CDC-8C99-B120C******\\",\\n \\"Precision\\": 0.98,\\n \\"ModelId\\": 2311\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetPrecisionTaskResponse>\\n<Message>successful</Message>\\n<RequestId>AA84A5CC-8D21-4F11-BCE1-B91882673B15</RequestId>\\n<Data>\\n <Status>1</Status>\\n <IncorrectWords>4</IncorrectWords>\\n <TotalCount>3</TotalCount>\\n <TaskId>593A04C0-E6E9-4CDC-8C99-B120C***</TaskId>\\n <VerifiedCount>3</VerifiedCount>\\n <UpdateTime>2020-03-20T11:26Z</UpdateTime>\\n <DataSetId>18**</DataSetId>\\n <Duration>62830</Duration>\\n <Precisions>\\n <Precision>\\n <Status>1</Status>\\n <ModelName>测试01</ModelName>\\n <TaskId>18EB5390-21C0-4EF9-B599-FB**</TaskId>\\n <Precision>0.9708</Precision>\\n <ModelId>9706</ModelId>\\n </Precision>\\n <Precision>\\n <Status>1</Status>\\n <ModelName>通用模型</ModelName>\\n <TaskId>593A04C0-E6E9-4CDC-8C99-B***1FD</TaskId>\\n <Precision>0.9708</Precision>\\n <ModelId>746</ModelId>\\n </Precision>\\n </Precisions>\\n <Source>3</Source>\\n <DataSetName>语音识别检测四个</DataSetName>\\n <Name>111</Name>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</GetPrecisionTaskResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ListPrecisionTask' => [
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'GetScoreInfo',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sca:GetScoreInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'CreateQualityCheckScheme',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:CreateQualityCheckScheme',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'UploadDataV4',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sca:UploadDataV4',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'read',
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'JsonStr',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '"{"pageSize":10,"pageNumber":1}"',
+ [
+ 'apiName' => 'ListSkillGroupConfig',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'sca:ListSkillGroupConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'BaseMeAgentId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'ListSchemeTaskConfig',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'sca:ListSchemeTaskConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Count' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '22',
- ],
- 'Data' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'PrecisionTask' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'UpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-03-10 20:26:29',
- ],
- 'IncorrectWords' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '32',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-03-10 20:26:29',
- ],
- 'DataSetId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1212',
- ],
- 'VerifiedCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'Source' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '21',
- ],
- 'DataSetName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Duration' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '331311',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '7C1DEF5F-2C18-4D36-99C6-8C276F781796',
- ],
- 'Precisions' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'Precision' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-03-10 20:26:29',
- ],
- 'ModelName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '7C1DEF5F-2C18-4D36-99C6-8C276F781796',
- ],
- 'ModelId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2321',
- ],
- 'Precision' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.98',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'GetMiningTaskResult',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sca:GetMiningTaskResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Count\\": 22,\\n \\"Data\\": {\\n \\"PrecisionTask\\": [\\n {\\n \\"Status\\": 1,\\n \\"UpdateTime\\": \\"2020-03-10 20:26:29\\",\\n \\"IncorrectWords\\": 32,\\n \\"CreateTime\\": \\"2020-03-10 20:26:29\\",\\n \\"DataSetId\\": 1212,\\n \\"VerifiedCount\\": 3,\\n \\"Source\\": 3,\\n \\"TotalCount\\": 21,\\n \\"DataSetName\\": \\"数据集名称\\",\\n \\"Duration\\": 331311,\\n \\"Name\\": \\"任务名称\\",\\n \\"TaskId\\": \\"7C1DEF5F-2C18-4D36-99C6-8C276F781796\\",\\n \\"Precisions\\": {\\n \\"Precision\\": [\\n {\\n \\"Status\\": 1,\\n \\"CreateTime\\": \\"2020-03-10 20:26:29\\",\\n \\"ModelName\\": \\"自定义模型\\",\\n \\"TaskId\\": \\"7C1DEF5F-2C18-4D36-99C6-8C276F781796\\",\\n \\"ModelId\\": 2321,\\n \\"Precision\\": 0.98\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListPrecisionTaskResponse>\\n <Message>successful</Message>\\n <PageSize>2</PageSize>\\n <RequestId>D8E5E4CC-76A6-468B-B1EB-C37812818E07</RequestId>\\n <PageNumber>1</PageNumber>\\n <Data>\\n <PrecisionTask>\\n <Status>1</Status>\\n <IncorrectWords>3</IncorrectWords>\\n <TaskId>7C1DEF5F-2C18-4D36-99C6-8C276F781796</TaskId>\\n <CreateTime>2020-03-10T20:26Z</CreateTime>\\n <VerifiedCount>1</VerifiedCount>\\n <DataSetId>1852</DataSetId>\\n <Duration>816666</Duration>\\n <Precisions>\\n <Precision>\\n <Status>1</Status>\\n <ModelName>通用模型</ModelName>\\n <TaskId>7C1DEF5F-2C18-4D36-99C6-8C276F781796</TaskId>\\n <Precision>0.75</Precision>\\n <CreateTime>2020-03-10 20:26:29</CreateTime>\\n <ModelId>746</ModelId>\\n </Precision>\\n </Precisions>\\n <Source>3</Source>\\n <DataSetName>0310</DataSetName>\\n <Name>0310</Name>\\n <TotalCount>17</TotalCount>\\n <UpdateTime>2020-03-10T21:55Z</UpdateTime>\\n </PrecisionTask>\\n <PrecisionTask>\\n <Status>1</Status>\\n <IncorrectWords>0</IncorrectWords>\\n <TaskId>EAB4EEFA-37DD-44DF-92AA-3689B7CBFCF6</TaskId>\\n <CreateTime>2020-02-18T11:50Z</CreateTime>\\n <VerifiedCount>0</VerifiedCount>\\n <DataSetId>1809</DataSetId>\\n <Duration>382806</Duration>\\n <Precisions>\\n <Precision>\\n <Status>1</Status>\\n <ModelName>通用模型</ModelName>\\n <TaskId>EAB4EEFA-37DD-44DF-92AA-3689B7CBFCF6</TaskId>\\n <CreateTime>2020-02-18 11:50:14</CreateTime>\\n <ModelId>746</ModelId>\\n </Precision>\\n </Precisions>\\n <Source>3</Source>\\n <DataSetName>0218</DataSetName>\\n <Name>11</Name>\\n <TotalCount>11</TotalCount>\\n <UpdateTime>2020-02-18T11:50Z</UpdateTime>\\n </PrecisionTask>\\n </Data>\\n <Count>29</Count>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListPrecisionTaskResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
- ],
- 'DeletePrecisionTask' => [
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'SyncQualityCheck',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sca:SyncQualityCheck',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'DeleteRuleV4',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:DeleteRuleV4',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'SubmitQualityCheckTask',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:SubmitQualityCheckTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'write',
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'JsonStr',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '"{"taskId": "7C1DEF5F-2C18-4D36-99C6*******"}"',
+ [
+ 'apiName' => 'GetSchemeTaskConfig',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sca:GetSchemeTaskConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'BaseMeAgentId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'ListAsrVocab',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'sca:ListAsrVocab',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'GetQualityCheckScheme',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sca:GetQualityCheckScheme',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeletePrecisionTaskResponse>\\n <Message>successful</Message>\\n <RequestId>9A2467A2-8208-400B-A7B9-919495B5E0FE</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeletePrecisionTaskResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ListUsers' => [
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'GetResult',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'sca:GetResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'UpdateTaskAssignRule',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateTaskAssignRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'GetSyncResult',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sca:GetSyncResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'read',
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'JsonStr',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{"pageNumber":1,"pageSize":10}',
+ [
+ 'apiName' => 'GetResultToReview',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sca:GetResultToReview',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'BaseMeAgentId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'GetRule',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sca:GetRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Count' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '12',
- ],
- 'Data' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'User' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'DisplayName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'UpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-03-11T16:54Z',
- ],
- 'Description' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'XXX',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-03-11T16:54Z',
- ],
- 'LoginUserType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'AliUid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2951869706989****',
- ],
- 'RoleName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AGENT',
- ],
- 'UserName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'GetRuleById',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sca:GetRuleById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'staticInfo' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Count\\": 12,\\n \\"Data\\": {\\n \\"User\\": [\\n {\\n \\"DisplayName\\": \\"xxx\\",\\n \\"UpdateTime\\": \\"2020-03-11T16:54Z\\",\\n \\"Description\\": \\"XXX\\",\\n \\"CreateTime\\": \\"2020-03-11T16:54Z\\",\\n \\"LoginUserType\\": 2,\\n \\"AliUid\\": \\"2951869706989****\\",\\n \\"RoleName\\": \\"AGENT\\",\\n \\"UserName\\": \\"xxx\\",\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListUsersResponse>\\n <Message>successful</Message>\\n <PageSize>2</PageSize>\\n <RequestId>7372059E-C5D1-442D-AFB4-86F0A4D751C2</RequestId>\\n <PageNumber>1</PageNumber>\\n <Data>\\n <User>\\n <RoleName>QUALITY_INSPECTOR</RoleName>\\n <UserName>pursuing</UserName>\\n <Description/>\\n <CreateTime>2020-03-11T16:54Z</CreateTime>\\n <DisplayName>pursuing</DisplayName>\\n <UpdateTime>2020-03-11T16:54Z</UpdateTime>\\n <Id>2777</Id>\\n <LoginUserType>2</LoginUserType>\\n <AliUid>2951869706989***</AliUid>\\n </User>\\n <User>\\n <RoleName>QUALITY_INSPECTOR</RoleName>\\n <UserName>0917reviewer</UserName>\\n <Description/>\\n <CreateTime>2020-01-08T21:22Z</CreateTime>\\n <DisplayName>0917质检员</DisplayName>\\n <UpdateTime>2020-01-08T21:22Z</UpdateTime>\\n <Id>957</Id>\\n <LoginUserType>2</LoginUserType>\\n <AliUid>25574616870489****</AliUid>\\n </User>\\n </Data>\\n <Count>7</Count>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListUsersResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'UpdateUser' => [
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'UpdateCheckTypeToScheme',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateCheckTypeToScheme',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'UpdateSyncQualityCheckData',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateSyncQualityCheckData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'UpdateQualityCheckData',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateQualityCheckData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'write',
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'JsonStr',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '[{"aliUid":"2951869706989****","roleName":"ADMIN"},{"aliUid":"2557461687048****","roleName":"ADMIN"}]',
+ [
+ 'apiName' => 'UpdateSkillGroupConfig',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateSkillGroupConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'BaseMeAgentId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间Id',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'CreateAgentTask',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sca:CreateAgentTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'CreateAgent',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sca:CreateAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateUserResponse>\\n <Message>successful</Message>\\n <RequestId>65CF64B5-4D9D-4D9E-A91D-3CA1C63FBF1E</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UpdateUserResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'CreateMiningTask' => [
- 'summary' => '创建标签挖掘任务',
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'ApplyWsToken',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sca:ApplyWsToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ [
+ 'apiName' => 'SubmitReviewInfo',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:SubmitReviewInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'GetNextResultToVerify',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:GetNextResultToVerify',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'AssignReviewer',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:AssignReviewer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateSchemeTaskConfig',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateSchemeTaskConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetRuleV4',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:GetRuleV4',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitPrecisionTask',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:SubmitPrecisionTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetRuleCategory',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:GetRuleCategory',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RevertAssignedSessionGroup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sca:RevertAssignedSessionGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteSkillGroupConfig',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'sca:DeleteSkillGroupConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDataSet',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'sca:DeleteDataSet',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'VerifySentence',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:VerifySentence',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateRuleById',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateRuleById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateAsrVocab',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sca:CreateAsrVocab',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UploadData',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sca:UploadData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAgent',
+ 'description' => '',
'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '272674',
- 'abilityTreeNodes' => [
- 'FEATUREscaLN3HHV',
+ 'ramAction' => [
+ 'action' => 'sca:GetAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'BaseMeAgentId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123456',
+ [
+ 'apiName' => 'SubmitReviewInfoV4',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sca:SubmitReviewInfoV4',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'FilePath',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123.22.com/11.csv',
+ ],
+ [
+ 'apiName' => 'GetPrecisionTask',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:GetPrecisionTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'TaskType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demandMining',
- 'enum' => [
- 'demandMining',
- 'sopMining',
- 'satisfactionAnalysisReport',
- ],
+ ],
+ [
+ 'apiName' => 'SaveConfigDataSet',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sca:SaveConfigDataSet',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'Param',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"startDate":"20250505"}',
+ ],
+ [
+ 'apiName' => 'GetAgentTaskResult',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sca:GetAgentTaskResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'CallbackUrl',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
+ ],
+ [
+ 'apiName' => 'UpdateAgent',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24F4CE647',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '7C1DEF5F-2C18-4D36-99C6-8C27*****',
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'DeletePrecisionTask',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:DeletePrecisionTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'DeleteWarningConfig',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:DeleteWarningConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24F4CE647\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"7C1DEF5F-2C18-4D36-99C6-8C27*****\\"\\n }\\n}","type":"json"}]',
- ],
- 'GetMiningTaskResult' => [
- 'summary' => '获取标签挖掘任务结果',
- 'methods' => [
- 'get',
- 'post',
+ [
+ 'apiName' => 'DeleteCheckTypeToScheme',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sca:DeleteCheckTypeToScheme',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ [
+ 'apiName' => 'ListRules',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'sca:ListRules',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'AssignReviewerBySessionGroup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'sca:AssignReviewerBySessionGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'UpdateQualityCheckScheme',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateQualityCheckScheme',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateRuleToScheme',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateRuleToScheme',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListPrecisionTask',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:ListPrecisionTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddRuleCategory',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sca:AddRuleCategory',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateTaskAssignRule',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:CreateTaskAssignRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DelRuleCategory',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:DelRuleCategory',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunCompletionMessage',
+ 'description' => '',
'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '272684',
- 'abilityTreeNodes' => [
- 'FEATUREscaLN3HHV',
+ 'ramAction' => [
+ 'action' => 'sca:RunCompletionMessage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'BaseMeAgentId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123456',
+ [
+ 'apiName' => 'SubmitComplaint',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:SubmitComplaint',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'TaskId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***',
+ ],
+ [
+ 'apiName' => 'BatchSubmitReviewInfo',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:BatchSubmitReviewInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '106C6CA0-282D-4AF7-85F0-D2D24***',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20201231de3d34ec-40fa-4a55-8d27-76ea*****',
- ],
- 'FilePath' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123.22.com/manger/static/login-back.jpg',
- ],
- 'FilePathMd' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123.22.com/manger/static/login-back.md',
- ],
- 'TaskStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'finish',
- ],
- 'FilePathList' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'FileUrl' => [
- 'type' => 'string',
- ],
- 'FileType' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ [
+ 'apiName' => 'DeleteBusinessCategory',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:DeleteBusinessCategory',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'CreateCheckTypeToScheme',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:CreateCheckTypeToScheme',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"106C6CA0-282D-4AF7-85F0-D2D24***\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"20201231de3d34ec-40fa-4a55-8d27-76ea*****\\",\\n \\"FilePath\\": \\"123.22.com/manager/static/login-back.jpg\\",\\n \\"FilePathMd\\": \\"123.22.com/manager/static/login-back.md\\",\\n \\"TaskStatus\\": \\"finish\\",\\n \\"FilePathList\\": [\\n {\\n \\"FileUrl\\": \\"http://vxxxcustomer-pop.oss-cn-shanghai.aliyuncs.com/100.csv\\",\\n \\"FileType\\": \\"CSV\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- ],
- 'CreateUser' => [
- 'summary' => '创建用户',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'DeleteAsrVocab',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:DeleteAsrVocab',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ [
+ 'apiName' => 'AddRuleV4',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:AddRuleV4',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'ListUsers',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:ListUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'ListWarningConfig',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:ListWarningConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'VerifyFile',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:VerifyFile',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetBusinessCategoryList',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:GetBusinessCategoryList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetRuleDetail',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sca:GetRuleDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RevertAssignedSession',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:RevertAssignedSession',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAsrVocab',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sca:GetAsrVocab',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteSchemeTaskConfig',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:DeleteSchemeTaskConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UploadRule',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:UploadRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteAgent',
+ 'description' => '',
'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsca8WDKR3',
+ 'ramAction' => [
+ 'action' => 'sca:DeleteAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'BaseMeAgentId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'baseMeAgentId',
- 'description' => 'baseMeAgentId',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
+ [
+ 'apiName' => 'CreateSkillGroupConfig',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sca:CreateSkillGroupConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'JsonStr',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
+ ],
+ [
+ 'apiName' => 'UploadDataSync',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'sca:UploadDataSync',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '82C91484-B2D5-4D2A-A21F-A6D73F4*** ',
- 'title' => 'Id of the request',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- 'title' => 'Schema of Response',
+ [
+ 'apiName' => 'ListTaskAssignRules',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:ListTaskAssignRules',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'InvalidRule',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'sca:InvalidRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateWarningConfig',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateWarningConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteCustomizationConfig',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:DeleteCustomizationConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteQualityCheckScheme',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:DeleteQualityCheckScheme',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UploadAudioData',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'sca:UploadAudioData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetSkillGroupConfig',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'sca:GetSkillGroupConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteRule',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'sca:DeleteRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateAsrVocab',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:UpdateAsrVocab',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateWarningConfig',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:CreateWarningConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCustomizationConfigList',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'sca:GetCustomizationConfigList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataSet',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'sca:ListDataSet',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddBusinessCategory',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:AddBusinessCategory',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'HandleComplaint',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'sca:HandleComplaint',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'SmartConversationAnalysis', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"82C91484-B2D5-4D2A-A21F-A6D73F4***\\\\t\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateUserResponse>\\n <Message>successful</Message>\\n <RequestId>1AAF31DB-A600-4392-8938-CFA0BC****</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateUserResponse>","errorExample":""}]',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'qualitycheck.cn-hangzhou.aliyuncs.com',
],
+ 'resourceTypes' => [],
],
];