{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-documentautoml/create-model-async-predict":{"post":{"operationId":"cloud_aliyun_documentautoml_create_model_async_predict","summary":"Creates an asynchronous prediction task for document self-learning","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://documentautoml.cn-beijing.aliyuncs.com"],"default":"https://documentautoml.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://documentautoml.cn-beijing.aliyuncs.com"},"ModelVersion":{"type":"string","description":"The version number of the model. If this parameter is not specified, the latest active version of the model is used by default"},"BinaryToText":{"type":"string","description":"Set to false when the content field contains an image URL. Set to true when the body contains Base64-encoded content"},"Content":{"type":"string","description":"The URL of the image or PDF file"},"ModelId":{"type":"integer","description":"The model ID. You can obtain the model ID from the model list page"},"ServiceName":{"type":"string","description":"The service name of the pre-training service"},"ServiceVersion":{"type":"string","description":"The version of the pre-trained service"},"Body":{"type":"string","description":"The Base64 encoding content of the image"}}}}}},"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-documentautoml/get-model-async-predict":{"post":{"operationId":"cloud_aliyun_documentautoml_get_model_async_predict","summary":"Performs model prediction in three types: long document information extraction, single receipt information…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AsyncPredictId"],"properties":{"endpoint":{"type":"string","enum":["https://documentautoml.cn-beijing.aliyuncs.com"],"default":"https://documentautoml.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://documentautoml.cn-beijing.aliyuncs.com"},"AsyncPredictId":{"type":"integer","description":"The unique ID of the asynchronous prediction. This ID is used to query the asynchronous prediction result"}}}}}},"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-documentautoml/predict-classifier-model":{"post":{"operationId":"cloud_aliyun_documentautoml_predict_classifier_model","summary":"Performs prediction using the document self-learning classifier","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://documentautoml.cn-beijing.aliyuncs.com"],"default":"https://documentautoml.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://documentautoml.cn-beijing.aliyuncs.com"},"ClassifierId":{"type":"integer","description":"The classifier ID"},"AutoPrediction":{"type":"string","description":"Specifies whether to enable automatic prediction. Valid values: false: Disabled. true: Enabled. Default value: true"},"Content":{"type":"string","description":"The accessible URL of an image or PDF file"},"Body":{"type":"string","description":"The Base64 encoding content of the image"},"BinaryToText":{"type":"string","description":"Specifies whether the input is Base64-encoded content. Set this parameter to false when the Content field is an image URL. Set this…"}}}}}},"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-documentautoml/predict-model":{"post":{"operationId":"cloud_aliyun_documentautoml_predict_model","summary":"Performs model prediction, which includes three types: long document information extraction, single receipt…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ModelId"],"properties":{"endpoint":{"type":"string","enum":["https://documentautoml.cn-beijing.aliyuncs.com"],"default":"https://documentautoml.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://documentautoml.cn-beijing.aliyuncs.com"},"Content":{"type":"string","description":"The URL for accessing the image or PDF file"},"ModelVersion":{"type":"string","description":"The version number of the model. If this parameter is not specified, the latest effective version of the model is used by default"},"ModelId":{"type":"integer","description":"The model ID. You can obtain the model ID from the model list page"},"BinaryToText":{"type":"string","description":"Set to false when the Content field contains an image URL. Set to true when the Body field contains Base64-encoded content"},"Body":{"type":"string","description":"The Base64 encoding content of the image"}}}}}},"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-documentautoml/predict-pre-train-model":{"post":{"operationId":"cloud_aliyun_documentautoml_predict_pre_train_model","summary":"Provides preset capability predictions. Currently available: UIE extraction, applicable to general-purpose…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://documentautoml.cn-beijing.aliyuncs.com"],"default":"https://documentautoml.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://documentautoml.cn-beijing.aliyuncs.com"},"Content":{"type":"string","description":"The prediction content in JSON string format. UIE extraction parameter format: {\"query\":\"xxx\",\"schema\":[\"field1\",\"field2\"]}. query…"},"ServiceVersion":{"type":"string","description":"The version of the preset capability service. Default value: V1"},"ServiceName":{"type":"string","description":"The service name of the preset capability service. This parameter is required. For UIE extraction, set this parameter to \"FormUIE\""},"BinaryToText":{"type":"string","description":"Set to false when the Content field contains an image URL. Set to true when the Body field contains a Base64-encoded image"},"Body":{"type":"string","description":"The prediction content when passing a Base64-encoded image, in JSON character string format. UIE extraction parameter format:…"}}}}}},"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-documentautoml/predict-template-model":{"post":{"operationId":"cloud_aliyun_documentautoml_predict_template_model","summary":"Performs template-based prediction, which currently includes two types: custom KV templates and custom table…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://documentautoml.cn-beijing.aliyuncs.com"],"default":"https://documentautoml.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://documentautoml.cn-beijing.aliyuncs.com"},"TaskId":{"type":"integer","description":"The task ID"},"Content":{"type":"string","description":"The URL of the image or PDF file"},"BinaryToText":{"type":"string","description":"Set to false when the Content field contains an image URL. Set to true when the Body field contains Base64-encoded content"},"Body":{"type":"string","description":"The Base64 encoding content of the image"}}}}}},"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-documentautoml/version":{"post":{"operationId":"cloud_aliyun_documentautoml_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://documentautoml.cn-beijing.aliyuncs.com"],"default":"https://documentautoml.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://documentautoml.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"}}}}}}}