{"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-nlp-automl/create-async-predict":{"post":{"operationId":"cloud_aliyun_nlp_automl_create_async_predict","summary":"Creates an asynchronous prediction by calling CreateAsyncPredict","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://nlp-automl.cn-hangzhou.aliyuncs.com"],"default":"https://nlp-automl.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://nlp-automl.cn-hangzhou.aliyuncs.com"},"ModelId":{"type":"integer","description":"The model ID. Not required when creating an asynchronous prediction by service name and service version. Required otherwise"},"Content":{"type":"string","description":"The prediction content. Maximum length: 1024 bytes"},"ModelVersion":{"type":"string","description":"The version number of the model. If this parameter is not specified, the latest published version is returned. Specify this parameter when…"},"DetailTag":{"type":"string","description":"Specifies whether to return detailed extraction results for text entity extraction models. Valid values: true and false"},"TopK":{"type":"integer","description":"The number of top results to return"},"FileType":{"type":"string","description":"The file type"},"FileUrl":{"type":"string","description":"The HTTP URL where the file is stored"},"FileContent":{"type":"string","description":"The Base64-encoded file content"},"FetchContent":{"type":"string","description":"The prediction text to return"},"ServiceName":{"type":"string","description":"The service name"},"ServiceVersion":{"type":"string","description":"The service version"}}}}}},"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-nlp-automl/get-async-predict":{"post":{"operationId":"cloud_aliyun_nlp_automl_get_async_predict","summary":"Calls GetAsyncPredict to retrieve asynchronous prediction results","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AsyncPredictId"],"properties":{"endpoint":{"type":"string","enum":["https://nlp-automl.cn-hangzhou.aliyuncs.com"],"default":"https://nlp-automl.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://nlp-automl.cn-hangzhou.aliyuncs.com"},"AsyncPredictId":{"type":"integer","description":"The asynchronous prediction ID. You can obtain this ID by calling the CreateAsyncPredict operation"}}}}}},"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-nlp-automl/get-predict-result":{"post":{"operationId":"cloud_aliyun_nlp_automl_get_predict_result","summary":"Retrieves the prediction results of a model","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ModelId","Content"],"properties":{"endpoint":{"type":"string","enum":["https://nlp-automl.cn-hangzhou.aliyuncs.com"],"default":"https://nlp-automl.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://nlp-automl.cn-hangzhou.aliyuncs.com"},"ModelId":{"type":"integer","description":"The model ID"},"Content":{"type":"string","description":"The prediction result, in JSON string format"},"ModelVersion":{"type":"string","enum":["V1","V2"],"description":"The model version"},"DetailTag":{"type":"string","enum":["false","true"],"description":"The label type"},"TopK":{"type":"integer","description":"0 indicates that the prediction has not started. 1 indicates that the prediction has started"}}}}}},"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-nlp-automl/run-pre-train-service":{"post":{"operationId":"cloud_aliyun_nlp_automl_run_pre_train_service","summary":"Calls a pre-trained model service","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ServiceName","PredictContent"],"properties":{"endpoint":{"type":"string","enum":["https://nlp-automl.cn-hangzhou.aliyuncs.com"],"default":"https://nlp-automl.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://nlp-automl.cn-hangzhou.aliyuncs.com"},"ServiceName":{"type":"string","description":"The service name"},"ServiceVersion":{"type":"string","description":"The service version"},"PredictContent":{"type":"string","description":"The prediction input"}}}}}},"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-nlp-automl/version":{"post":{"operationId":"cloud_aliyun_nlp_automl_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://nlp-automl.cn-hangzhou.aliyuncs.com"],"default":"https://nlp-automl.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://nlp-automl.cn-hangzhou.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"}}}}}}}