summaryrefslogtreecommitdiff
path: root/data/searchplat/2024-05-29/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <[email protected]>2026-02-14 10:08:30 +0800
committerZhineng Li <[email protected]>2026-02-14 10:08:30 +0800
commiteccd5cd5a067f5659982685afdeea209b1888efb (patch)
tree1626c903b854317be1708ce3ccd3b4f4e6e0fc97 /data/searchplat/2024-05-29/api-docs.php
downloadacs-metadata-786a07360cbe6e0241e4703da25d35c59185fb09.tar.gz
acs-metadata-786a07360cbe6e0241e4703da25d35c59185fb09.zip
Diffstat (limited to 'data/searchplat/2024-05-29/api-docs.php')
-rw-r--r--data/searchplat/2024-05-29/api-docs.php861
1 files changed, 861 insertions, 0 deletions
diff --git a/data/searchplat/2024-05-29/api-docs.php b/data/searchplat/2024-05-29/api-docs.php
new file mode 100644
index 0000000..84fdece
--- /dev/null
+++ b/data/searchplat/2024-05-29/api-docs.php
@@ -0,0 +1,861 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'product' => 'Searchplat',
+ 'version' => '2024-05-29',
+ ],
+ 'components' => [
+ 'schemas' => [],
+ ],
+ 'apis' => [
+ 'GetTextGeneration' => [
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/text-generation/{service_id}',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'messages' => [
+ 'type' => 'array',
+ 'required' => true,
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => [
+ 'type' => 'string',
+ ],
+ 'role' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 'stream' => [
+ 'type' => 'boolean',
+ ],
+ 'csi_level' => [
+ 'type' => 'string',
+ ],
+ 'parameters' => [
+ 'type' => 'object',
+ ],
+ 'enable_search' => [
+ 'type' => 'boolean',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetDocumentAnalyzeTaskStatus' => [
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/document-analyze/{service_id}/async/task-status',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'task_id',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ ],
+ ],
+ 'GetDocumentRank' => [
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/ranker/{service_id}',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'docs' => [
+ 'type' => 'array',
+ 'required' => true,
+ 'items' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ 'query' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetDocumentSplit' => [
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/document-split/{service_id}',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'document' => [
+ 'type' => 'object',
+ 'required' => true,
+ 'properties' => [
+ 'content' => [
+ 'type' => 'string',
+ ],
+ 'content_encoding' => [
+ 'type' => 'string',
+ ],
+ 'content_type' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'strategy' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'max_chunk_size' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ 'compute_type' => [
+ 'type' => 'string',
+ ],
+ 'need_sentence' => [
+ 'type' => 'boolean',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateDocumentAnalyzeTask' => [
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/document-analyze/{service_id}/async',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'document' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'url' => [
+ 'type' => 'string',
+ ],
+ 'content' => [
+ 'type' => 'string',
+ ],
+ 'file_name' => [
+ 'type' => 'string',
+ ],
+ 'file_type' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'output' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'image_storage' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetTextSparseEmbedding' => [
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/text-sparse-embedding/{service_id}',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'input' => [
+ 'type' => 'array',
+ 'required' => true,
+ 'items' => [
+ 'type' => 'string',
+ ],
+ ],
+ 'input_type' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'enum' => [
+ 'document',
+ 'query',
+ ],
+ ],
+ 'return_token' => [
+ 'type' => 'boolean',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetQueryAnalysis' => [
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/query-analyze/{service_id}',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'history' => [
+ 'type' => 'array',
+ 'required' => false,
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => [
+ 'type' => 'string',
+ ],
+ 'role' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 'query' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'functions' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => [
+ 'type' => 'string',
+ ],
+ 'parameters' => [
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateImageAnalyzeTask' => [
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/image-analyze/{service_id}/async',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'document' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'url' => [
+ 'type' => 'string',
+ ],
+ 'content' => [
+ 'type' => 'string',
+ ],
+ 'file_name' => [
+ 'type' => 'string',
+ ],
+ 'file_type' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetImageAnalyzeTaskStatus' => [
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/image-analyze/{service_id}/async/task-status',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'task_id',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ ],
+ ],
+ 'GetTextEmbedding' => [
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/text-embedding/{service_id}',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'input' => [
+ 'type' => 'array',
+ 'required' => true,
+ 'items' => [
+ 'type' => 'string',
+ ],
+ ],
+ 'input_type' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'enum' => [
+ 'document',
+ 'query',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetWebSearch' => [
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/web-search/{service_id}',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'query' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'way' => [
+ 'type' => 'string',
+ ],
+ 'top_k' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetEmbeddingTuning' => [
+ 'path' => '/v3/openapi/workspaces/{workspace_name}/embedding-tuning/{service_id}',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'workspace_name',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'service_id',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'input' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'number',
+ 'format' => 'float',
+ ],
+ ],
+ ],
+ 'parameters' => [
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetPrediction' => [
+ 'path' => '/v3/openapi/deployments/{deployment_id}/predict',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [],
+ 'deprecated' => false,
+ 'parameters' => [
+ [
+ 'name' => 'deployment_id',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'Token',
+ 'in' => 'header',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'endpoints' => [
+ [
+ 'regionId' => 'cn-shanghai',
+ 'endpoint' => 'searchplat.cn-shanghai.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'eu-central-1',
+ 'endpoint' => 'searchplat.eu-central-1.aliyuncs.com',
+ ],
+ ],
+];