summaryrefslogtreecommitdiff
path: root/data/zh_cn/paicopilot/2025-07-31
diff options
context:
space:
mode:
authorZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
committerZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
commit7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch)
tree0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/paicopilot/2025-07-31
downloadacs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz
acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip
Diffstat (limited to 'data/zh_cn/paicopilot/2025-07-31')
-rw-r--r--data/zh_cn/paicopilot/2025-07-31/api-docs.php398
1 files changed, 398 insertions, 0 deletions
diff --git a/data/zh_cn/paicopilot/2025-07-31/api-docs.php b/data/zh_cn/paicopilot/2025-07-31/api-docs.php
new file mode 100644
index 0000000..2bb358d
--- /dev/null
+++ b/data/zh_cn/paicopilot/2025-07-31/api-docs.php
@@ -0,0 +1,398 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'ROA',
+ 'product' => 'PAICopilot',
+ 'version' => '2025-07-31',
+ ],
+ 'directories' => [
+ 'SearchInfo',
+ ],
+ 'components' => [
+ 'schemas' => [
+ 'Chat' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ChatId' => [
+ 'type' => 'string',
+ ],
+ 'GmtCreateTime' => [
+ 'type' => 'string',
+ 'format' => 'iso8601_normal',
+ ],
+ 'GmtModified' => [
+ 'type' => 'string',
+ 'format' => 'iso8601_normal',
+ ],
+ 'Question' => [
+ '$ref' => '#/components/schemas/ChatDetail',
+ ],
+ 'Answer' => [
+ '$ref' => '#/components/schemas/ChatDetail',
+ ],
+ 'OwnerId' => [
+ 'type' => 'string',
+ ],
+ 'UserId' => [
+ 'type' => 'string',
+ ],
+ 'Title' => [
+ 'type' => 'string',
+ ],
+ 'SessionId' => [
+ 'type' => 'string',
+ ],
+ 'Status' => [
+ 'type' => 'string',
+ ],
+ 'ExtraData' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'ChatDetail' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UserInfo' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Role' => [
+ 'type' => 'string',
+ ],
+ 'Name' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'Content' => [
+ 'type' => 'string',
+ ],
+ 'GmtCreateTime' => [
+ 'type' => 'string',
+ 'format' => 'iso8601_normal',
+ ],
+ ],
+ ],
+ 'Feedback' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'FeedbackId' => [
+ 'type' => 'string',
+ ],
+ 'GmtCreateTime' => [
+ 'type' => 'string',
+ 'format' => 'iso8601_normal',
+ ],
+ 'GmtModified' => [
+ 'type' => 'string',
+ 'format' => 'iso8601_normal',
+ ],
+ 'FeedbackAction' => [
+ 'type' => 'string',
+ ],
+ 'FeedbackMessage' => [
+ 'type' => 'string',
+ ],
+ 'OwnerId' => [
+ 'type' => 'string',
+ ],
+ 'UserId' => [
+ 'type' => 'string',
+ ],
+ 'SessionId' => [
+ 'type' => 'string',
+ ],
+ 'ChatId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'Label' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => [
+ 'type' => 'string',
+ ],
+ 'Value' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'Session' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SessionId' => [
+ 'type' => 'string',
+ ],
+ 'GmtCreateTime' => [
+ 'type' => 'string',
+ 'format' => 'iso8601_normal',
+ ],
+ 'GmtModified' => [
+ 'type' => 'string',
+ 'format' => 'iso8601_normal',
+ ],
+ 'OwnerId' => [
+ 'type' => 'string',
+ ],
+ 'UserId' => [
+ 'type' => 'string',
+ ],
+ 'SessionTitle' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'apis' => [
+ 'SearchInfo' => [
+ 'summary' => '进行联网搜索以及知识库搜索。',
+ 'path' => '/api/v1/searches',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATURElearnOTS2AE',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '搜索请求体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'KnowledgeBaseFilters' => [
+ 'description' => '知识库搜索条件集合。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '知识库搜索条件。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CollectionName' => [
+ 'description' => '文档集名字。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'pai_qa',
+ ],
+ 'ResultLimit' => [
+ 'description' => '最多返回搜索结果个数,默认为3个。',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '5',
+ ],
+ 'ScoreThreshold' => [
+ 'description' => '搜索结果必须满足的最低分数(包含最低分数),分数表示搜索结果与搜索条件的匹配度,满分为1分。',
+ 'type' => 'number',
+ 'format' => 'double',
+ 'required' => false,
+ 'example' => '0.7827883223',
+ ],
+ 'Query' => [
+ 'description' => '搜索词。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'what is pai',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'WebFilters' => [
+ 'description' => '联网搜索条件集合。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '联网搜索条件。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResultLimit' => [
+ 'description' => '最多返回搜索结果个数,默认为3个。',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '5',
+ ],
+ 'IncludeSites' => [
+ 'description' => '搜索站点集合。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '搜索站点。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'help.aliyun.com',
+ ],
+ 'required' => false,
+ ],
+ 'ScoreThreshold' => [
+ 'description' => '搜索结果必须满足的最低分数(包含最低分数),分数表示搜索结果与搜索条件的匹配度,满分为1分。',
+ 'type' => 'number',
+ 'format' => 'double',
+ 'required' => false,
+ 'example' => '0.832883223',
+ ],
+ 'Query' => [
+ 'description' => '搜索词。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'what is dsw',
+ ],
+ 'Category' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '搜索结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => '请求ID。',
+ 'type' => 'string',
+ 'example' => '44553E9A-******-37ADC33FE2',
+ ],
+ 'KnowledgeBaseSearchResults' => [
+ 'description' => '知识库搜索结果集合。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '知识库搜索结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResultContent' => [
+ 'description' => '搜索结果内容。',
+ 'type' => 'string',
+ 'example' => 'DSW is ****** in pai.',
+ ],
+ 'Score' => [
+ 'description' => '分数,用于表示搜索内容与搜索条件的匹配度,满分为1分。',
+ 'type' => 'number',
+ 'format' => 'double',
+ 'example' => '0.6215165367',
+ ],
+ 'Index' => [
+ 'description' => '代表第几个KnowledgeBase问题的答复,下标从0开始。',
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ ],
+ ],
+ ],
+ 'WebSearchResults' => [
+ 'description' => '联网搜索结果集合。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '联网搜索结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'SourceLink' => [
+ 'description' => '来源网址。',
+ 'type' => 'string',
+ 'example' => 'https://help.aliyun.com/zh/pai/use-cases/dsw-use-qwen3-coder-to-assist-in-code-development',
+ ],
+ 'ResultContent' => [
+ 'description' => '搜索结果内容。',
+ 'type' => 'string',
+ 'example' => 'Qwen3-Coder*****is good',
+ ],
+ 'Score' => [
+ 'description' => '分数,用于表示搜索内容与搜索条件的匹配度,满分为1分。',
+ 'type' => 'number',
+ 'format' => 'double',
+ 'example' => '0.5215170567',
+ ],
+ 'Index' => [
+ 'description' => '代表第几个Web问题的答复,下标从0开始。',
+ 'type' => 'string',
+ 'example' => '2',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'IdempotentParameterMismatch',
+ 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"44553E9A-******-37ADC33FE2\\",\\n \\"KnowledgeBaseSearchResults\\": [\\n {\\n \\"ResultContent\\": \\"DSW is ****** in pai.\\",\\n \\"Score\\": 0.6215165367,\\n \\"Index\\": \\"0\\"\\n }\\n ],\\n \\"WebSearchResults\\": [\\n {\\n \\"SourceLink\\": \\"https://help.aliyun.com/zh/pai/use-cases/dsw-use-qwen3-coder-to-assist-in-code-development\\",\\n \\"ResultContent\\": \\"Qwen3-Coder*****is good\\",\\n \\"Score\\": 0.5215170567,\\n \\"Index\\": \\"2\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '联网搜索以及知识库搜索',
+ ],
+ ],
+ 'endpoints' => [
+ [
+ 'regionId' => 'cn-beijing',
+ 'endpoint' => 'paicopilot.cn-beijing.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-wulanchabu',
+ 'endpoint' => 'paicopilot.cn-wulanchabu.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai',
+ 'endpoint' => 'paicopilot.cn-shanghai.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen',
+ 'endpoint' => 'paicopilot.cn-shenzhen.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-1',
+ 'endpoint' => 'paicopilot.ap-southeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou',
+ 'endpoint' => 'paicopilot.cn-hangzhou.aliyuncs.com',
+ ],
+ ],
+];