The following components are relevant for handling the AI Model Deployer:
Component |
Instance |
Method |
Description |
|---|---|---|---|
Model Converter with OpenVino |
/api/v{version}/deployment-service/model-converter/openvino/white-list |
GET |
Get the supported model types which can be converted. |
/deployment-service/model-converter/openvino/parameters |
GET |
Get the parameters for a model. |
|
/deployment-service/model-converter/openvino/conversions |
POST |
Convert the trained model. |
|
Pou Generators |
/deployment-service/pou-generators/datablock |
POST |
Create DataBlock file for TIA portal. |
/deployment-service/pou-generators/textlist |
POST |
Create TextList file for TIA portal. |
|
Template Configurator |
/deployment-service/template-configurators/configuration-files |
POST |
Create the template configuration file. |
/deployment-service/template-configurators/configuration-file-specifications |
GET |
Get the specification of the template configuration file. |
|
/deployment-service/template-configurators/templates |
GET |
Get all supported templates. |
|
/deployment-service/template-configurators/templates/{id} |
GET |
Get the certain template by id. |
|
/deployment-service/template-configurators/target-devices |
GET |
Get all supported target devices. |
|
/deployment-service/template-configurators/target-devices/{id} |
GET |
Get the certain target devices by id. |
|
/deployment-service/template-configurators/cameras |
GET |
Get all supported cameras. |
|
/deployment-service/template-configurators/cameras/{id} |
GET |
Get the certain camera by id. |
|
/deployment-service/template-configurators/tmnpu/network-cinfiguration-files |
POST |
Create the network configuration file. |
|
ApplicationBuilder |
/deployment-service/application-builder |
POST |
Generate SD card image for TM NPU include npu_app.conf, network.conf and converted model. |
Python Syntax Checker |
/deployment-service/python/syntax-checkers |
POST |
Check the syntax of a python file. |
Projects |
/project-manager/projects |
GET |
Get all created project list |
/project-manager/projects |
DELETE |
Delete all created projects |
|
/project-manager/projects/{projectName} |
POST |
Create a project with project name and template (SIMATIC.AIDeployer.Template.ImageClassification，SIMATIC.AIDeployer.Template.ObjectDetection) |
|
/project-manager/projects/{projectName} |
GET |
Get description of the specified project |
|
/project-manager/projects/{projectName} |
PUT |
Update description of the specified project |
|
/project-manager/projects/{projectName} |
DELETE |
Delete the specified project |
|
/project-manag-er/projects/{projectName}/package |
GET |
Export the specified project to local machine |
|
/project-manag-er/projects/{projectName}/package |
POST |
Upload the exported project to AI Model Deployer |
|
/project-manag-er/projects/{projectName}/duplicate |
POST |
Save the specified project as new project |
|
/project-manag-er/projects/{projectName}/configurations |
POST |
Upload a configuration file to the specified project |
|
/project-manag-er/projects/{projectName}/configurations/{fileName} |
GET |
Get the specified configuration file from the specified project |
|
/project-manag-er/projects/{projectName}/configurations/{fileName} |
DELETE |
Delete the specified configuration file from the specified project |
|
/project-manager/projects/{projectName}/files |
POST |
Upload a data file to the specified project |
|
/project-manager/projects/{projectName}/ files /{id} |
GET |
Get the specified data file from the specified project |
|
/project-manager/projects/{projectName}/ files /{id} |
DELETE |
Delete the specified data file from the specified project |
|
FTP |
/tmnpu/ftp-client/ftp-client-configurations |
POST |
Upload configurations of FTP client |
/tmnpu/ftp-client/directory-list-details |
GET |
Get file list of the specified directory at FTP server of the specified project |
|
/tmnpu/ftp-client/file-retriever |
GET |
Get the specified file from FTP server |
|
/tmnpu/ftp-client/file-uploader |
POST |
Upload the specified file to FTP server |
|
/tmnpu/ftp-client/file-remover |
DELETE |
Delete the specified file from FTP server |
|
NPU debug |
/tmnpu/npu-debug/debug-configuration |
GET |
Get debug configurations (the MAC address) of TM NPU |
/tmnpu/npu-debug/debug-logs |
GET |
Get debug logs from TM NPU |
|
Online deployment |
/tmnpu/online-deployment-client/image-deployment |
POST |
Deploy a built TM NPU package to the specified TM NPU |
/tmnpu/online-deployment-client/deploy-status |
GET |
Get real-time deployment status of the in-processing deployment pro-cess |