{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-dataanalysisgbi/batch-delete-synonyms":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_batch_delete_synonyms","summary":"Delete synonyms in bulk from the specified workspace","description":"POST /gbi/batchDelete/synonyms","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","synonymIdKeys"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"ID of the Alibaba Cloud Model Studio workspace used for this request"},"synonymIdKeys":{"type":"array","description":"List of synonym IDs to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/cancel-datasource-authorization":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_cancel_datasource_authorization","summary":"Cancels authorization for an associated data source","description":"POST /gbi/cancel/datasource","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"ID of the Alibaba Cloud Model Studio workspace used for this request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/create-business-logic":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_create_business_logic","summary":"Creates a business logic definition in the specified workspace","description":"POST /gbi/create/logic","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"The ID of the Model Studio workspace for the current request"},"description":{"type":"string","description":"The content of the business logic explanation"},"type":{"type":"integer","description":"The type of the business logic explanation to create"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/create-datasource-authorization":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_create_datasource_authorization","summary":"Creates an authorization to associate a data source with a specified workspace. After the association is…","description":"POST /gbi/create/datasource","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","type"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"The ID of the Alibaba Cloud Model Studio workspace for the current request"},"password":{"type":"string","description":"The password for the username to log on to the data source"},"type":{"type":"integer","description":"The type of the data source to associate"},"url":{"type":"string","description":"The JDBC connection string of the data source to create"},"userName":{"type":"string","description":"The username to log on to the data source"},"vdbId":{"type":"string","description":"The instance ID of the virtual data source. Specify this parameter only when you associate a virtual data source"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/create-synonyms":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_create_synonyms","summary":"Creates a synonym in the specified workspace","description":"POST /gbi/create/synonyms","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","word","wordSynonyms"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"The ID of the Alibaba Cloud Model Studio workspace for the request"},"columns":{"type":"array","description":"To associate the synonym with a specific column in a data table, specify the column name in the table_name.column_name format"},"word":{"type":"string","description":"The synonym"},"wordSynonyms":{"type":"array","description":"A list of words to map to the synonym"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/create-virtual-datasource-instance":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_create_virtual_datasource_instance","summary":"Creates a virtual data source instance in the specified workspace. This instance represents a virtual…","description":"POST /gbi/virtualDatasource/createVirtualDatasourceInstance","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"The ID of the Alibaba Cloud Model Studio workspace for the current request"},"description":{"type":"string","description":"The description of the virtual data source instance"},"name":{"type":"string","description":"The name of the virtual data source instance"},"type":{"type":"integer","description":"The type of the virtual data source"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/delete-business-logic":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_delete_business_logic","summary":"Delete a business logic definition from the specified workspace","description":"POST /gbi/delete/logic","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","businessLogicIdKeys"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"ID of the Alibaba Cloud Model Studio workspace used for this request"},"businessLogicIdKeys":{"type":"array","description":"List of unique identifiers for the business logic definitions to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/delete-column":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_delete_column","summary":"Delete a column from the specified workspace","description":"POST /gbi/delete/column","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","columnIdKey"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"The ID of the Alibaba Cloud Model Studio workspace used for this request"},"columnIdKey":{"type":"string","description":"The unique identifier of the column to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/delete-selected-table":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_delete_selected_table","summary":"Deletes the specified data table from the designated workspace","description":"POST /gbi/delete/table","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","tableIdKey"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"The ID of the Alibaba Cloud Model Studio workspace for the current request"},"tableIdKey":{"type":"string","description":"The unique identifier for the data table"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/delete-virtual-datasource-instance":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_delete_virtual_datasource_instance","summary":"Deletes a virtual data source instance in the specified workspace","description":"POST /gbi/virtualDatasource/deleteVirtualDatasourceInstance","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","vdbId"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"ID of the Alibaba Cloud Model Studio workspace used for this request"},"vdbId":{"type":"string","description":"ID of the virtual data source instance"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/list-business-logic":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_list_business_logic","summary":"Lists the definitions of enterprise knowledge terms in the specified workspace","description":"POST /gbi/list/logic","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"ID of the Alibaba Cloud Model Studio workspace used for this request"},"maxResults":{"type":"integer","description":"Maximum number of entries per page"},"nextToken":{"type":"string","description":"Pagination token. Omit this parameter for the first call. For subsequent calls, use the nextToken value returned in the previous response"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/list-column":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_list_column","summary":"Retrieve column information for a specified table in the current workspace","description":"POST /gbi/list/column","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","tableIdKey"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"ID of the Alibaba Cloud Model Studio workspace used for this request"},"maxResults":{"type":"integer","description":"Maximum number of entries per page"},"nextToken":{"type":"integer","description":"Paging token Omit this parameter for the first call For subsequent calls, use the nextToken value returned in the previous response"},"tableIdKey":{"type":"string","description":"Unique identifier of the data table"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/list-enum-mapping":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_list_enum_mapping","summary":"Retrieve enumeration values for the specified table and column within the current workspace","description":"POST /gbi/list/mapping","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","columnIdKey","tableIdKey"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"The ID of the Alibaba Cloud Model Studio workspace used for the current request"},"columnIdKey":{"type":"string","description":"The unique identifier ID of the data column"},"tableIdKey":{"type":"string","description":"The unique identifier ID of the data table"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/list-selected-tables":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_list_selected_tables","summary":"Retrieve the data tables associated with the current workspace","description":"POST /gbi/list/datasource/table","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"The ID of the Alibaba Cloud Model Studio workspace used for the current request"},"maxResults":{"type":"integer","description":"Maximum number of entries per page"},"nextToken":{"type":"string","description":"Paging cursor. If this is the first call, do not pass this parameter. For subsequent calls, pass the nextToken returned from the previous…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/list-synonyms":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_list_synonyms","summary":"Lists synonyms in a specified workspace","description":"POST /gbi/list/synonyms","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"The ID of the Alibaba Cloud Model Studio workspace for the current request"},"maxResults":{"type":"integer","description":"The maximum number of entries to return on each page"},"nextToken":{"type":"string","description":"The paging cursor. If this is your first call, do not include this parameter. For subsequent calls, set this parameter to the nextToken…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/list-virtual-datasource-instance":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_list_virtual_datasource_instance","summary":"Retrieve the list of data source instances in the current workspace","description":"POST /gbi/virtualDatasource/listVirtualDatasourceInstance","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"The Alibaba Cloud Model Studio workspace ID used for the current request"},"maxResults":{"type":"integer","description":"Maximum number of entries per page"},"nextToken":{"type":"string","description":"Paging cursor. If this is the first call, do not pass this parameter. If this is not the first call, pass the \\`nextToken\\` returned by…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/recover-column":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_recover_column","summary":"Restores a data column in a specified data table to its initial state","description":"POST /gbi/recover/column","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","columnIdKey","tableIdKey"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"ID of the Alibaba Cloud Model Studio workspace used for this request"},"columnIdKey":{"type":"string","description":"Unique ID of the data column"},"tableIdKey":{"type":"string","description":"Unique ID of the data table"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/resync-table":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_resync_table","summary":"Refreshes information about the associated data table from the remote database","description":"POST /gbi/refresh/table","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","tableIdKey"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"The Alibaba Cloud Model Studio workspace ID used in the current request"},"keep":{"type":"string","description":"Enable \"Keep and Add.\" Set to true to enable. Keep and Add: For tables with this option enabled, Xiyan retains information about already…"},"tableIdKey":{"type":"string","description":"The unique identifier of the data table"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/run-data-analysis":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_run_data_analysis","summary":"Xianyan provides you with OpenAPI operations that deliver the same conversational experience as the official…","description":"POST /{workspaceId}/gbi/runDataAnalysis","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","query"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"The Alibaba Cloud Model Studio workspace ID used for the current request"},"agentCtrlParams":{"type":"string","description":"Custom parameters passed through by the current conversation API. Currently supported options include: skip rewriting, skip visualization…"},"dataRole":{"type":"array","description":"A list of database permission role names. You must configure the relevant database permission settings on the product page before you can…"},"generateSqlOnly":{"type":"string","description":"The current request only generates and returns SQL without executing it"},"query":{"type":"string","description":"The query input by the user"},"sessionId":{"type":"string","description":"The message session ID returned in the service window callback message"},"specificationType":{"type":"string","description":"The version to use for the current request. If not specified, the default workspace version is used"},"userParams":{"type":"string","description":"Custom parameters on which the data role depends. If the role is configured with external parameters, these must be provided. You must…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/run-data-result-analysis":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_run_data_result_analysis","summary":"Analyze the execution results of structured data types and generate visualization information.","description":"POST /gbi/runDataResultAnalysis","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","requestId"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"The Alibaba Cloud Model Studio workspace ID used for the current request"},"analysisMode":{"type":"string","description":"The type of visualization to execute. You can generate only a chart or only a text analysis"},"requestId":{"type":"string","description":"Request ID. This request ID must be the one returned by the RunSqlGeneration API. If a request ID that has not been executed by…"},"sqlData":{"type":"object","description":"The structured data content retrieved after executing the SQL query. This parameter is required in the current scenario. Sample sqlData {…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/run-sql-generation":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_run_sql_generation","summary":"This operation generates SQL statements based on the current query information and associated data tables.…","description":"POST /gbi/runSqlGeneration","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","query"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"The ID of the Alibaba Cloud Model Studio workspace used for the current request"},"query":{"type":"string","description":"The query entered by the user"},"sessionId":{"type":"string","description":"The message session ID. Multiple request IDs can belong to the same session ID"},"specificationType":{"type":"string","description":"The version information specified for the current request. If empty, the default workspace version is used"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/save-virtual-datasource-ddl":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_save_virtual_datasource_ddl","summary":"Add DDL statements to a virtual data source instance in your current workspace. Alibaba Cloud GBI parses…","description":"POST /gbi/virtualDatasource/addDdl2VirtualInstance","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","ddl","vdbId"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"ID of the Alibaba Cloud Model Studio workspace used for this request"},"ddl":{"type":"string","description":"A CREATE DDL statement for a database. You can pass multiple statements. Separate them with line feeds ( )"},"vdbId":{"type":"string","description":"ID of the virtual data source instance"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/sync-remote-tables":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_sync_remote_tables","summary":"Update the data tables associated with your workspace by syncing the latest tables from a remote virtual…","description":"POST /gbi/update/datasource/tables","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","tableNames"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"ID of the Alibaba Cloud Model Studio workspace used for this request"},"keepTableNames":{"type":"array","description":"List of table names to keep and add columns for during association. Keep and add: For tables marked as Keep and Add, the system retains…"},"noModifiedTableNames":{"type":"array","description":"List of table names to keep and skip column updates for during association. Keep and skip: For tables marked as Keep and Skip, the system…"},"pullSamples":{"type":"string","description":"Whether to pull sample data when associating tables"},"tableNames":{"type":"array","description":"List of names of tables to associate"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/update-business-logic":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_update_business_logic","summary":"Update a business logic description in the specified Alibaba Cloud Model Studio workspace","description":"POST /gbi/update/logic","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","businessLogicIdKey","description","type"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"ID of the Alibaba Cloud Model Studio workspace used for this request"},"businessLogicIdKey":{"type":"string","description":"Unique ID of the business logic description"},"description":{"type":"string","description":"Content of the business logic description"},"type":{"type":"integer","description":"Type of the business logic description"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/update-column":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_update_column","summary":"Updates column information in the specified workspace","description":"POST /gbi/update/column","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","columnIdKey","enumType","tableIdKey"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"ID of the Alibaba Cloud Model Studio workspace used for this request"},"chineseName":{"type":"string","description":"Chinese name of the column"},"columnIdKey":{"type":"string","description":"Unique ID of the column"},"description":{"type":"string","description":"Description of the column"},"enumType":{"type":"integer","description":"Indicates whether the field is an enumeration type. If set to 1, you can provide values in the enumValues field"},"enumValues":{"type":"array","description":"List of enumeration values"},"rangeMax":{"type":"integer","description":"Maximum value for numeric data"},"rangeMin":{"type":"integer","description":"Minimum value for numeric data"},"samples":{"type":"array","description":"List of sample data values. This field populates automatically if you enable sample data pull when associating a table"},"tableIdKey":{"type":"string","description":"Unique ID of the table"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/update-enum-mapping":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_update_enum_mapping","summary":"Modifies the enumeration mapping for a specified column in a workspace","description":"POST /gbi/update/mapping","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","columnIdKey","tableIdKey"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"The ID of the Alibaba Cloud Model Studio workspace for the current request"},"columnIdKey":{"type":"string","description":"The unique ID of the data column"},"enumMapping":{"type":"object","description":"The value mapping for the enumeration"},"tableIdKey":{"type":"string","description":"The unique ID of the data table"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/update-synonyms":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_update_synonyms","summary":"Update synonym information in the current workspace","description":"POST /gbi/update/synonyms","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","synonymIdKey","word","wordSynonyms"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"ID of the Alibaba Cloud Model Studio workspace used for this request"},"columns":{"type":"array","description":"Column names to associate with this synonym, in table.column format"},"synonymIdKey":{"type":"string","description":"Unique ID of the synonym"},"word":{"type":"string","description":"The synonym term"},"wordSynonyms":{"type":"array","description":"List of terms to map to this synonym"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/update-table-info":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_update_table_info","summary":"Updates information for a specified data table","description":"POST /gbi/update/table","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","tableIdKey"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"ID of the Alibaba Cloud Model Studio workspace used in this request"},"description":{"type":"string","description":"Description of the data table"},"foreignKeys":{"type":"array","description":"List of foreign key relationships for this table, formatted as \"table_name.column_name=table_name.column_name\""},"primaryKey":{"type":"string","description":"Primary key field"},"tableIdKey":{"type":"string","description":"Unique ID of the data table"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/update-virtual-datasource-instance":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_update_virtual_datasource_instance","summary":"Updates the information of a virtual data source in a specified workspace","description":"POST /gbi/virtualDatasource/updateVirtualDatasourceInstance","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vdbId"],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"ID of the Alibaba Cloud Model Studio workspace used for this request"},"description":{"type":"string","description":"Description of the virtual data source"},"name":{"type":"string","description":"Name of the virtual data source"},"type":{"type":"integer","description":"Type of the virtual data source"},"vdbId":{"type":"string","description":"ID of the virtual data source instance"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataanalysisgbi/version":{"post":{"operationId":"cloud_aliyun_dataanalysisgbi_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dataanalysisgbi.cn-beijing.aliyuncs.com"],"default":"https://dataanalysisgbi.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dataanalysisgbi.cn-beijing.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}