diff options
Diffstat (limited to 'data/en_us/bailian/2023-06-01/api-docs.php')
| -rw-r--r-- | data/en_us/bailian/2023-06-01/api-docs.php | 1336 |
1 files changed, 1336 insertions, 0 deletions
diff --git a/data/en_us/bailian/2023-06-01/api-docs.php b/data/en_us/bailian/2023-06-01/api-docs.php new file mode 100644 index 0000000..f41be77 --- /dev/null +++ b/data/en_us/bailian/2023-06-01/api-docs.php @@ -0,0 +1,1336 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'bailian', + 'version' => '2023-06-01', + ], + 'directories' => [ + [ + 'id' => 189572, + 'title' => 'enterprise knowledge base', + 'type' => 'directory', + 'children' => [ + 'SubmitDocumentImportJob', + 'DescribeDocumentImportJob', + 'ListDocs', + 'DescribeDoc', + 'DeleteDoc', + 'UpdateDocAttribute', + 'DeleteDocumentTag', + 'UpdateDocumentTag', + 'CreateDocumentTag', + 'ListDocumentTags', + ], + ], + [ + 'id' => 187898, + 'title' => 'Prompt Engineering', + 'type' => 'directory', + 'children' => [ + 'GetPrompt', + ], + ], + 'CreateToken', + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'SubmitDocumentImportJob' => [ + 'summary' => '提交文档批量上传任务', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2818xxxx_p_efm', + ], + ], + [ + 'name' => 'Docs', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'URL' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'http://xxxx.com', + ], + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'RAW', + ], + 'StoreId' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '661dxxxx904f', + ], + 'TagIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '471dxxxx3427', + ], + 'required' => false, + ], + 'OwnerId' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + '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' => '778C0B3B-xxxx-5FC1-A947-36EDD13606AB', + ], + 'JobId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '20230718xxxx-146c93bf', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"778C0B3B-xxxx-5FC1-A947-36EDD13606AB\\",\\n \\"JobId\\": \\"20230718xxxx-146c93bf\\"\\n}","type":"json"}]', + ], + 'DescribeDocumentImportJob' => [ + 'summary' => '查询异步上传文档的任务结果', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '20230718xxxx-146c93bf', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2818xxxx_p_efm', + ], + ], + ], + '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' => '35A267BF-xxxx-54DB-8394-AA3B0742D833', + ], + 'JobId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '20230718xxxx-146c93bf', + ], + 'Status' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Docs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'DocId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8C8FxxxxC3EE', + ], + 'FailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35A267BF-xxxx-54DB-8394-AA3B0742D833\\",\\n \\"JobId\\": \\"20230718xxxx-146c93bf\\",\\n \\"Status\\": \\"成功\\",\\n \\"Docs\\": [\\n {\\n \\"Name\\": \\"文档1\\",\\n \\"Status\\": \\"导入完成\\",\\n \\"DocId\\": \\"8C8FxxxxC3EE\\",\\n \\"FailReason\\": \\"导入索引失败\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListDocs' => [ + 'summary' => '分页查询文档', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2818xxxx_p_efm', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20', + 'minimum' => '1', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'StoreId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '661dxxxx904f', + ], + ], + [ + 'name' => 'TagIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '471dxxxx3427', + ], + 'required' => false, + ], + ], + ], + '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' => '17204B98-xxxx-4F9A-8464-2446A84821CA', + ], + 'PageNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Docs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DocId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8C8FxxxxC3EE', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Size' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.08MB', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'RAW', + ], + 'OwnerId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '22968', + ], + 'FailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Tags' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TagId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '471dxxxx3427', + ], + 'TagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'UploadTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-01-12 10:43:02', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17204B98-xxxx-4F9A-8464-2446A84821CA\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 30,\\n \\"Docs\\": [\\n {\\n \\"DocId\\": \\"8C8FxxxxC3EE\\",\\n \\"Name\\": \\"文档1\\",\\n \\"Size\\": \\"1.08MB\\",\\n \\"Status\\": \\"导入完成\\",\\n \\"Type\\": \\"RAW\\",\\n \\"OwnerId\\": \\"22968\\",\\n \\"FailReason\\": \\"导入索引失败\\",\\n \\"Tags\\": [\\n {\\n \\"TagId\\": \\"471dxxxx3427\\",\\n \\"TagName\\": \\"标签1\\"\\n }\\n ],\\n \\"UploadTime\\": \\"2024-01-12 10:43:02\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeDoc' => [ + 'summary' => '根据文档ID获取单个文档信息', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DocId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '8C8FxxxxC3EE', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2818xxxx_p_efm', + ], + ], + ], + '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' => '778C0B3B-xxxx-5FC1-A947-36EDD13606AB', + ], + 'DocId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8C8FxxxxC3EE', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Size' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1.12MB', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'RAW', + ], + 'OwnerId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '19539', + ], + 'FailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'UploadTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-01-12 10:43:02', + ], + 'Tags' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TagId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '471dxxxx3427', + ], + 'TagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"778C0B3B-xxxx-5FC1-A947-36EDD13606AB\\",\\n \\"DocId\\": \\"8C8FxxxxC3EE\\",\\n \\"Name\\": \\"文档1\\",\\n \\"Size\\": \\"1.12MB\\",\\n \\"Status\\": \\"导入完成\\",\\n \\"Type\\": \\"RAW\\",\\n \\"OwnerId\\": \\"19539\\",\\n \\"FailReason\\": \\"导入索引失败\\",\\n \\"UploadTime\\": \\"2024-01-12 10:43:02\\",\\n \\"Tags\\": [\\n {\\n \\"TagId\\": \\"471dxxxx3427\\",\\n \\"TagName\\": \\"标签1\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DeleteDoc' => [ + 'summary' => '删除文档', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DocId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '8C8FxxxxC3EE', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2818xxxx_p_efm', + ], + ], + ], + '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' => '17204B98-xxxx-4F9A-8464-2446A84821CA', + ], + 'DocId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8C8FxxxxC3EE', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17204B98-xxxx-4F9A-8464-2446A84821CA\\",\\n \\"DocId\\": \\"8C8FxxxxC3EE\\"\\n}","type":"json"}]', + ], + 'UpdateDocAttribute' => [ + 'summary' => '根据文档ID更新文档信息', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2818xxxx_p_efm', + ], + ], + [ + 'name' => 'DocId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '8C8FxxxxC3EE', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'DelAllTags', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'TagIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '471dxxxx3427', + ], + 'required' => false, + ], + ], + ], + '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' => '17204B98-xxxx-4F9A-8464-2446A84821CA', + ], + 'DocId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8C8FxxxxC3EE', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17204B98-xxxx-4F9A-8464-2446A84821CA\\",\\n \\"DocId\\": \\"8C8FxxxxC3EE\\"\\n}","type":"json"}]', + ], + 'DeleteDocumentTag' => [ + 'summary' => '删除文档标签', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '471dxxxx3427', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2818xxxx_p_efm', + ], + ], + ], + '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' => '17204B98-xxxx-4F9A-8464-2446A84821CA', + ], + 'TagId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '471dxxxx3427', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17204B98-xxxx-4F9A-8464-2446A84821CA\\",\\n \\"TagId\\": \\"471dxxxx3427\\"\\n}","type":"json"}]', + ], + 'UpdateDocumentTag' => [ + 'summary' => '修改文档标签', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2818xxxx_p_efm', + ], + ], + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '471dxxxx3427', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + ], + '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' => '1C139002-xxxx-584C-A755-4B8B9FA080BE', + ], + 'TagId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '471dxxxx3427', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C139002-xxxx-584C-A755-4B8B9FA080BE\\",\\n \\"TagId\\": \\"471dxxxx3427\\"\\n}","type":"json"}]', + ], + 'CreateDocumentTag' => [ + 'summary' => '创建文档标签', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2818xxxx_p_efm', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + ], + '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' => '35A267BF-xxxx-54DB-8394-AA3B0742D833', + ], + 'TagId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '471dxxxx3427', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35A267BF-xxxx-54DB-8394-AA3B0742D833\\",\\n \\"TagId\\": \\"471dxxxx3427\\"\\n}","type":"json"}]', + ], + 'ListDocumentTags' => [ + 'summary' => '分页查询企业管理标签', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2818xxxx_p_efm', + ], + ], + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '471dxxxx3427', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + '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' => '778C0B3B-xxxx-5FC1-A947-36EDD13606AB', + ], + 'PageNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TagList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'TagId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '471dxxxx3427', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"778C0B3B-xxxx-5FC1-A947-36EDD13606AB\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 30,\\n \\"TagList\\": [\\n {\\n \\"Name\\": \\"标签1\\",\\n \\"TagId\\": \\"471dxxxx3427\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetPrompt' => [ + 'summary' => 'prompt模板调用接口', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'c160c841c8e54295bf2f441432785944_p_efm', + ], + ], + [ + 'name' => 'PromptId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'marketCopy', + ], + ], + [ + 'name' => 'Vars', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + ], + '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' => '1C139002-0EC5-584C-A755-4B8B9FA080BE', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100004', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PromptId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'marketCopy', + ], + 'PromptContent' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C139002-0EC5-584C-A755-4B8B9FA080BE\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"100004\\",\\n \\"Message\\": \\"参数缺失\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"PromptId\\": \\"cfec40c311f14f3e976403059d8f0116\\",\\n \\"PromptContent\\": \\"你是一名在小红书平台具有丰富经验的专业爆款营销文案策划人，现在请以“蓝牙智能耳机”为核心主题，撰写一段极具吸引力的小红书营销内容。要求内容包括：一个引人入胜且符合SEO优化原则的标题，以及一段详细且富有情感煽动力的正文。在正文中，请至少插入5个不同的emoji表情，以增加内容的互动性和视觉吸引力。此外，请根据该主题，设计并提供最多5个热门推荐标签，这些标签需具有高度概括主题和吸引目标用户群的特点。\\"\\n }\\n}","type":"json"}]', + ], + 'CreateToken' => [ + 'summary' => '创建临时token', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ac627989eb4f8a98ed05fd098beee5_p_efm', + ], + ], + ], + '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' => '778C0B3B-03C1-5FC1-A947-36EDD13606AB', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Forbidden', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Token' => [ + 'description' => '', + 'type' => 'string', + 'example' => '89158587dfb7d85a335f98de4966d840', + ], + 'ExpiredTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1664177985651', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"778C0B3B-03C1-5FC1-A947-36EDD13606AB\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Forbidden\\",\\n \\"Message\\": \\"错误信息\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"Token\\": \\"89158587dfb7d85a335f98de4966d840\\",\\n \\"ExpiredTime\\": 1664177985651\\n }\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'bailian.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'bailian.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'bailian.ap-southeast-1.aliyuncs.com', + ], + ], +]; |