diff options
Diffstat (limited to 'data/farui/2024-06-28/api-docs.php')
| -rw-r--r-- | data/farui/2024-06-28/api-docs.php | 675 |
1 files changed, 203 insertions, 472 deletions
diff --git a/data/farui/2024-06-28/api-docs.php b/data/farui/2024-06-28/api-docs.php index 8c90d4c..7971952 100644 --- a/data/farui/2024-06-28/api-docs.php +++ b/data/farui/2024-06-28/api-docs.php @@ -1,283 +1,105 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'V3', - 'product' => 'FaRui', - 'version' => '2024-06-28', - ], + 'info' => ['style' => 'ROA', 'product' => 'FaRui', 'version' => '2024-06-28'], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'RunLegalAdviceConsultation' => [ - 'path' => '/{workspaceId}/farui/legalAdvice/consult', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'parameters' => [ - [ - 'name' => 'appId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'stream', - 'in' => 'formData', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], - ], - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'assistant', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'required' => false, - 'properties' => [ - 'id' => [ - 'type' => 'string', - 'required' => false, - ], - 'metaData' => [ - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - ], - ], - 'type' => [ - 'type' => 'string', - 'required' => false, - ], - 'version' => [ - 'type' => 'string', - 'required' => false, - ], - ], - ], - ], - [ - 'name' => 'thread', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'required' => false, - 'properties' => [ - 'messages' => [ - 'type' => 'array', - 'required' => false, - 'items' => [ - 'type' => 'object', - 'required' => false, - 'properties' => [ - 'content' => [ - 'type' => 'string', - 'required' => false, - ], - 'role' => [ - 'type' => 'string', - 'required' => false, - ], - ], - ], - ], - ], - ], - ], - [ - 'name' => 'extra', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'required' => false, - 'properties' => [ - 'deepThink' => [ - 'type' => 'boolean', - 'required' => false, - ], - 'onlineSearch' => [ - 'type' => 'boolean', - 'required' => false, - ], - ], - ], - ], - ], - ], 'CreateTextFile' => [ 'path' => '/{WorkspaceId}/data/textFile', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'CreateTime', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'TextFileName', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'TextFileUrl', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'ContractId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], ], - 'RunContractRuleGeneration' => [ - 'path' => '/{workspaceId}/farui/contract/rule/genarate', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'RunContractExtract' => [ + 'path' => '/{workspaceId}/pop/contract/extraction', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => false, 'parameters' => [ [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'required' => false], + ], + [ 'name' => 'appId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ - 'name' => 'stream', - 'in' => 'formData', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false], ], [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'fileOssUrl', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true], ], [ - 'name' => 'assistant', + 'name' => 'fieldsToExtract', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'type' => 'object', + 'type' => 'array', 'required' => false, - 'properties' => [ - 'metaData' => [ - 'type' => 'object', - 'required' => false, - 'properties' => [ - 'fileId' => [ - 'type' => 'string', - 'required' => false, - ], - 'position' => [ - 'type' => 'string', - 'required' => false, - ], + 'items' => [ + 'type' => 'object', + 'required' => false, + 'properties' => [ + 'extractItem' => ['type' => 'string', 'required' => false], + 'option' => [ + 'type' => 'array', + 'required' => false, + 'items' => ['type' => 'string', 'required' => false], ], - ], - 'type' => [ - 'type' => 'string', - 'required' => false, - ], - 'version' => [ - 'type' => 'string', - 'required' => false, + 'desc' => ['type' => 'string', 'required' => false], ], ], ], @@ -286,48 +108,30 @@ ], 'RunContractResultGeneration' => [ 'path' => '/{workspaceId}/farui/contract/result/genarate', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'parameters' => [ [ 'name' => 'appId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'stream', 'in' => 'formData', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['type' => 'boolean', 'required' => false], ], [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'assistant', @@ -352,35 +156,17 @@ 'type' => 'object', 'required' => false, 'properties' => [ - 'riskLevel' => [ - 'type' => 'string', - 'required' => false, - ], - 'ruleDesc' => [ - 'type' => 'string', - 'required' => false, - ], - 'ruleTitle' => [ - 'type' => 'string', - 'required' => false, - ], + 'riskLevel' => ['type' => 'string', 'required' => false], + 'ruleDesc' => ['type' => 'string', 'required' => false], + 'ruleTitle' => ['type' => 'string', 'required' => false], ], ], ], ], ], - 'fileId' => [ - 'type' => 'string', - 'required' => false, - ], - 'position' => [ - 'type' => 'string', - 'required' => false, - ], - 'ruleTaskId' => [ - 'type' => 'string', - 'required' => false, - ], + 'fileId' => ['type' => 'string', 'required' => false], + 'position' => ['type' => 'string', 'required' => false], + 'ruleTaskId' => ['type' => 'string', 'required' => false], 'rules' => [ 'type' => 'array', 'required' => false, @@ -388,160 +174,151 @@ 'type' => 'object', 'required' => false, 'properties' => [ - 'riskLevel' => [ - 'type' => 'string', - 'required' => false, - ], - 'ruleSequence' => [ - 'type' => 'string', - 'required' => false, - ], - 'ruleTag' => [ - 'type' => 'string', - 'required' => false, - ], - 'ruleTitle' => [ - 'type' => 'string', - 'required' => false, - ], + 'riskLevel' => ['type' => 'string', 'required' => false], + 'ruleSequence' => ['type' => 'string', 'required' => false], + 'ruleTag' => ['type' => 'string', 'required' => false], + 'ruleTitle' => ['type' => 'string', 'required' => false], ], ], ], ], ], - 'type' => [ - 'type' => 'string', - 'required' => false, - ], - 'version' => [ - 'type' => 'string', - 'required' => false, - ], + 'type' => ['type' => 'string', 'required' => false], + 'version' => ['type' => 'string', 'required' => false], ], ], ], ], ], - 'RunSearchLawQuery' => [ - 'path' => '/{workspaceId}/farui/search/law/query', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'RunContractRuleGeneration' => [ + 'path' => '/{workspaceId}/farui/contract/rule/genarate', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'deprecated' => false, + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'parameters' => [ [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'appId', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false], ], [ - 'name' => 'appId', + 'name' => 'stream', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'boolean', 'required' => false], ], [ - 'name' => 'thread', + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'required' => false], + ], + [ + 'name' => 'assistant', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'type' => 'object', 'required' => false, 'properties' => [ - 'messages' => [ - 'type' => 'array', + 'metaData' => [ + 'type' => 'object', 'required' => false, - 'items' => [ - 'type' => 'object', - 'required' => false, - 'properties' => [ - 'content' => [ - 'type' => 'string', - 'required' => false, - ], - 'role' => [ - 'type' => 'string', - 'required' => false, - ], - ], + 'properties' => [ + 'fileId' => ['type' => 'string', 'required' => false], + 'position' => ['type' => 'string', 'required' => false], ], ], + 'type' => ['type' => 'string', 'required' => false], + 'version' => ['type' => 'string', 'required' => false], ], ], ], + ], + ], + 'RunLegalAdviceConsultation' => [ + 'path' => '/{workspaceId}/farui/legalAdvice/consult', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], + 'security' => [ [ - 'name' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'parameters' => [ + [ + 'name' => 'appId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ - 'name' => 'queryKeywords', + 'name' => 'stream', + 'in' => 'formData', + 'schema' => ['type' => 'boolean', 'required' => false], + ], + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'required' => false], + ], + [ + 'name' => 'assistant', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'type' => 'array', + 'type' => 'object', 'required' => false, - 'items' => [ - 'type' => 'string', - 'required' => false, + 'properties' => [ + 'id' => ['type' => 'string', 'required' => false], + 'metaData' => [ + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string'], + ], + 'type' => ['type' => 'string', 'required' => false], + 'version' => ['type' => 'string', 'required' => false], ], ], ], [ - 'name' => 'pageParam', + 'name' => 'thread', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'type' => 'object', 'required' => false, 'properties' => [ - 'pageNumber' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'pageSize' => [ - 'type' => 'integer', - 'format' => 'int32', + 'messages' => [ + 'type' => 'array', 'required' => false, + 'items' => [ + 'type' => 'object', + 'required' => false, + 'properties' => [ + 'content' => ['type' => 'string', 'required' => false], + 'role' => ['type' => 'string', 'required' => false], + ], + ], ], ], ], ], [ - 'name' => 'filterCondition', + 'name' => 'extra', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'type' => 'object', 'required' => false, 'properties' => [ - 'lawName' => [ - 'type' => 'string', - 'required' => false, - ], + 'deepThink' => ['type' => 'boolean', 'required' => false], + 'onlineSearch' => ['type' => 'boolean', 'required' => false], ], ], ], @@ -549,40 +326,26 @@ ], 'RunSearchCaseFullText' => [ 'path' => '/{workspaceId}/farui/search/case/fulltext', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'appId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'thread', @@ -599,14 +362,8 @@ 'type' => 'object', 'required' => false, 'properties' => [ - 'content' => [ - 'type' => 'string', - 'required' => false, - ], - 'role' => [ - 'type' => 'string', - 'required' => false, - ], + 'content' => ['type' => 'string', 'required' => false], + 'role' => ['type' => 'string', 'required' => false], ], ], ], @@ -616,10 +373,7 @@ [ 'name' => 'query', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ 'name' => 'queryKeywords', @@ -628,10 +382,7 @@ 'schema' => [ 'type' => 'array', 'required' => false, - 'items' => [ - 'type' => 'string', - 'required' => false, - ], + 'items' => ['type' => 'string', 'required' => false], ], ], [ @@ -642,16 +393,8 @@ 'type' => 'object', 'required' => true, 'properties' => [ - 'pageNumber' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'pageSize' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'pageNumber' => ['type' => 'integer', 'format' => 'int32', 'required' => false], + 'pageSize' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], ], ], @@ -662,9 +405,7 @@ 'schema' => [ 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - ], + 'additionalProperties' => ['type' => 'string'], ], ], [ @@ -675,108 +416,101 @@ 'type' => 'object', 'required' => false, 'properties' => [ - 'caseTitle' => [ - 'type' => 'string', - 'required' => false, - ], - 'caseNo' => [ - 'type' => 'string', - 'required' => false, - ], + 'caseTitle' => ['type' => 'string', 'required' => false], + 'caseNo' => ['type' => 'string', 'required' => false], ], ], ], [ 'name' => 'referLevel', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], ], - 'RunContractExtract' => [ - 'path' => '/{workspaceId}/pop/contract/extraction', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'RunSearchLawQuery' => [ + 'path' => '/{workspaceId}/farui/search/law/query', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'appId', 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false], + ], + [ + 'name' => 'thread', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'type' => 'object', 'required' => false, + 'properties' => [ + 'messages' => [ + 'type' => 'array', + 'required' => false, + 'items' => [ + 'type' => 'object', + 'required' => false, + 'properties' => [ + 'content' => ['type' => 'string', 'required' => false], + 'role' => ['type' => 'string', 'required' => false], + ], + ], + ], + ], ], ], [ - 'name' => 'regionId', - 'in' => 'query', + 'name' => 'query', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true], + ], + [ + 'name' => 'queryKeywords', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'type' => 'array', 'required' => false, + 'items' => ['type' => 'string', 'required' => false], ], ], [ - 'name' => 'fileOssUrl', + 'name' => 'pageParam', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'type' => 'string', - 'required' => true, + 'type' => 'object', + 'required' => false, + 'properties' => [ + 'pageNumber' => ['type' => 'integer', 'format' => 'int32', 'required' => false], + 'pageSize' => ['type' => 'integer', 'format' => 'int32', 'required' => false], + ], ], ], [ - 'name' => 'fieldsToExtract', + 'name' => 'filterCondition', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'type' => 'array', + 'type' => 'object', 'required' => false, - 'items' => [ - 'type' => 'object', - 'required' => false, - 'properties' => [ - 'extractItem' => [ - 'type' => 'string', - 'required' => false, - ], - 'option' => [ - 'type' => 'array', - 'required' => false, - 'items' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'desc' => [ - 'type' => 'string', - 'required' => false, - ], - ], + 'properties' => [ + 'lawName' => ['type' => 'string', 'required' => false], ], ], ], @@ -784,9 +518,6 @@ ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'farui.cn-beijing.aliyuncs.com', - ], + ['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'farui.cn-beijing.aliyuncs.com', 'endpoint' => 'farui.cn-beijing.aliyuncs.com', 'vpc' => ''], ], ]; |
