Content for TS 23.482 Word version: 19.3.0
9 AIMLE APIs
9.1 General
9.2 AIMLE server APIs
9.2.1 AIMLE AI/ML Task Transfer API
9.2.2 ML model retrieval API
9.2.3 ML model training API
9.2.4 AIMLE TL model selection assistance API
9.2.5 FL member grouping support API
9.2.6 AIMLE client Discovery API
9.2.7 AIMLE client Selection API
9.2.8 AIMLE client Selection Subscribe API
9.2.9 AIMLE Data Management API
9.2.10 AIMLE Service Operations Management API
9.2.11 AIMLE Client Registration APIs
9.2.12 Split AI/ML Operation API
9.2.13 ML model update API
9.2.14 ML model performance monitoring API
9.2.15 AIMLE assisted ML model selection API
9.2.16 AIMLE context transfer API
9.2.17 AIMLE Assistance of Hierarchical Computing API
...
...
9 AIMLE APIs p. 124
9.1 General p. 124
The following AIMLE capabilities are offered as APIs:
- AIMLE server APIs;
- ML repository APIs;
- AIMLE client APIs;
9.2 AIMLE server APIs p. 124
9.2.1 AIMLE AI/ML Task Transfer API p. 124
9.2.1.1 General p. 124
Table 9.2.1.1-1 illustrates the APIs for AI/ML task transfer. This API enables the communication between VAL UE (via AIMLE Client) and the AIMLE server for AI/ML Task Transfer.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_AIMLTaskTransferAssist | Request | Request/Response | AIMLE Client |
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_AIMLESControlledAIMLTaskTransfer | Request | Request/Response | AIMLE Client |
9.2.1.2 Aimles_AIMLTaskTransferAssist_Request operation p. 125
9.2.1.2.1 General p. 125
API description:
This API enables source AI/ML member (AIMLE Client) to communicate with the AIMLE server for request assist AIML task transfer from the source AI/ML member (AIMLE Client) to target AI/ML member (AIMLE Client).
9.2.1.2.2 AIML task transfer assist request operation p. 125
API operation name:
Aimles_AIMLTaskTransferAssist_Request
Description:
The consumer requests for assist AI/ML task transfer.
Inputs:
See clause 8.6.3.2.
Outputs:
See clause 8.6.3.3.
See clause 8.6.2.1 for details of usage of this operation.
9.2.1.3 Aimles_AIMLESControlledAIMLTaskTransfer_Request operation p. 125
9.2.1.3.1 General p. 125
API description:
This API enables the source AI/ML member (AIMLE Client) to communicate with the AIMLE server for request AIMLE server-controlled AIML task transfer from the source AI/ML member (AIMLE Client) to the target AI/ML member (AIMLE Client).
9.2.1.3.2 AIMLE server-controlled AIML task transfer request operation p. 125
API operation name:
Aimles_AIMLESControlledAIMLTaskTransfer_Request
Description:
The consumer requests for AIMLE server-controlled AI/ML task transfer.
Inputs:
See clause 8.6.3.8.
Outputs:
See clause 8.6.3.9.
9.2.2 ML model retrieval API p. 125
9.2.2.1 General p. 125
Table 9.2.2.1-1 illustrates the API for ML model retrieval.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_MLModelRetrieval | Request | Request/Response | AIMLE Client, VAL Server |
| Subscribe | Subscribe/Notify | AIMLE Client, VAL Server | |
| Notify | |||
| UpdateSubscription | |||
| Unsubscribe |
9.2.2.2 Aimles_MLModelRetrieval_Request operation p. 126
API operation name:
Aimles_MLModelRetrieval_Request
Description:
The consumer requests for one time ML Model retrieval.
Inputs:
See clause 8.2.3.1.
Outputs:
See clause 8.2.3.2.
See clause 8.2.2.2 for details of usage of this operation.
9.2.2.3 Aimles_MLModelRetrieval_Subscribe operation p. 126
API operation name:
Aimles_MLModelRetrieval_Subscribe
Description:
The consumer subscribe for ML Model retrieval.
Inputs:
See clause 8.2.3.3.
Outputs:
See clause 8.2.3.4.
See clause 8.2.2.3.2 for details of usage of this operation.
9.2.2.4 Aimles_MLModelRetrieval_Notify operation p. 126
API operation name:
Aimles_MLModelRetrieval_Notify
Description:
The consumer is notified with ML Model.
Inputs:
See clause 8.2.3.5.
Outputs:
None.
See clause 8.2.2.3.3 for details of usage of this operation.
9.2.2.5 Aimles_MLModelRetrieval_UpdateSubscription operation p. 126
API operation name:
Aimles_MLModelRetrieval_UpdateSubscription
Description:
The consumer updates an existing subscription for ML Model retrieval.
Inputs:
See clause 8.2.3.6.
Outputs:
See clause 8.2.3.7.
See clause 8.2.2.3.4 for details of usage of this operation.
9.2.2.6 Aimles_MLModelRetrieval_Unsubscribe operation p. 126
API operation name:
Aimles_MLModelRetrieval_Unsubscribe
Description:
The consumer cancels an existing subscription for ML Model retrieval.
Inputs:
See clause 8.2.3.8.
Outputs:
See clause 8.2.3.9.
See clause 8.2.2.3.5 for details of usage of this operation.
9.2.3 ML model training API p. 127
9.2.3.1 General p. 127
Table 9.2.3.1-1 illustrates the API for ML model training. This API enables the VAL server to communicate with the AIMLE server for ML model training.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_MLModelTraining | Request | Request/Response | VAL Server |
9.2.3.2 Aimles_MLModelTraining_Request operation p. 127
API operation name:
Aimles_MLModelTraining_Request
Description:
The consumer requests for ML Model training.
Inputs:
See clause 8.3.3.1.
Outputs:
See clause 8.3.3.2.
See clause 8.3.2 for details of usage of this operation.
9.2.4 AIMLE TL model selection assistance API p. 127
9.2.4.1 General p. 127
Table 9.2.4.1-1 illustrates the API for TL model selection assistance. This API enables the VAL server to communicate with the AIMLE server for requesting assistance on TL model selection.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_TLModelSelectionAssistance | Request | Request/Response | VAL Server |
9.2.4.2 Aimles_TLModelSelectionAssistance_Request operation p. 127
API operation name:
Aimles_TLModelSelectionAssistance_Request
Description:
The consumer requests AIMLE server to assist in the TL model selection.
Inputs:
See clause 8.16.4.1.
Outputs:
See clause 8.16.4.2.
See clause 8.16.2 for details of usage of this operation.
9.2.5 FL member grouping support API p. 128
9.2.5.1 General p. 128
Table 9.2.5.1-1 illustrates the API for FL member grouping support. This API enables the VAL server to communicate with the AIMLE server for requesting support on FL member group management.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_FLMemberGroupSupport | Request | Request/Response | VAL Server |
9.2.5.2 Aimles_FLMemberGroupSupport_Request operation p. 128
API operation name:
Aimles_FLMemberGroupSupport_Request
Description:
The consumer requests AIMLE server to assist in the FL member grouping.
Inputs:
See clause 8.17.3.1.
Outputs:
See clause 8.17.3.2.
See clause 8.17.2 for details of usage of this operation.
9.2.6 AIMLE client Discovery API p. 128
9.2.6.1 General p. 128
Table 9.2.6.1-1 illustrates the APIs for AIMLE client discovery. This API enables the communication between the VAL server and the AIMLE server for AIMLE client discovery operation.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_AIMLEClientDiscovery | Request | Request/Response | VAL Server |
9.2.6.2 AIMLE client discovery request operation p. 128
API operation name:
Aimles_AIMLEClientDiscovery_Request
Description:
The consumer requests AIMLE server for AIMLE client discovery.
Inputs:
See clause 8.8.3.1.
Outputs:
See clause 8.8.3.2.
See clause 8.8.2.1 for details of usage of this operation.
9.2.7 AIMLE client Selection API p. 129
9.2.7.1 General p. 129
Table 9.2.7.1-1 illustrates the APIs for AIMLE client selection. This API enables the communication between the VAL server and the AIMLE server for AIMLE client selection operation.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_AIMLEClientSelection | Request | Request/Response | VAL Server |
9.2.7.2 AIMLE client selection request operation p. 129
API operation name:
Aimles_AIMLEClientSelection_Request
Description:
The consumer requests AIMLE server for AIMLE client selection.
Inputs:
See clause 8.9.3.1.
Outputs:
See clause 8.9.3.2.
See clause 8.9.2.1 for details of usage of this operation.
9.2.8 AIMLE client Selection Subscribe API p. 129
9.2.8.1 General p. 129
Table 9.2.8.1-1 illustrates the API for AIMLE client selection subscription for enabling a VAL server to monitor and select AIMLE clients for participation in AI/ML operations.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_ClientSelection | Subscribe | Subscribe/Notify | VAL Server |
| Notify | |||
| Update | |||
| Unsubscribe |
9.2.8.2 Aimles_ClientSelection_subscribe operation p. 129
API operation name:
Aimles_ClientSelection_subscribe
Description:
The consumer subscribes for monitoring and selection of AIMLE clients for AI/ML operations.
Inputs:
See clause 8.13.3.2.
Outputs:
See clause 8.13.3.3.
See clause 8.13.2.2 for details of usage of this operation.
9.2.8.3 Aimles_ClientSelection_notify operation p. 130
API operation name:
Aimles_ClientSelection_notify
Description:
The consumer is notified of selected AIMLE client status update events.
Inputs:
See clause 8.13.3.4.
Outputs:
None.
See clause 8.13.2.3 for details of usage of this operation.
9.2.8.4 Aimles_ClientSelection_update operation p. 130
API operation name:
Aimles_ClientSelection_update
Description:
The consumer updates selection of AIMLE clients for AI/ML operations.
Inputs:
See clause 8.13.3.5.
Outputs:
See clause 8.13.3.6.
See clause 8.13.2.2 for details of usage of this operation.
9.2.8.5 Aimles_ClientSelection_unsubscribe operation p. 130
API operation name:
Aimles_ClientSelection_ unsubscribe
Description:
The consumer unsubscribes of selected AIMLE clients for AI/ML operations.
Inputs:
See clause 8.13.3.7.
Outputs:
See clause 8.13.3.8.
See clause 8.13.2.3 for details of usage of this operation.
9.2.9 AIMLE Data Management API p. 130
9.2.9.1 General p. 130
Table 9.2.9.1-1 illustrates the API for AIMLE data management for enabling a VAL server to request assistance with data management operations.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_DataManagement | Subscribe | Subscribe/Notify | VAL server |
| Notify |
9.2.9.2 Aimles_DataManagement_Subscribe operation p. 130
API operation name:
Aimles_DataManagementAssistance_Subscribe
Description:
The consumer subscribes for assistance with data management operations.
Inputs:
See clause 8.15.3.1.
Outputs:
See clause 8.15.3.2.
See clause 8.15.2 for details of usage of this operation.
9.2.9.3 Aimles_DataManagement_Notify operation p. 131
API operation name:
Aimles_DataManagementAssistance_Notify
Description:
The consumer received notifications for data management operations.
Inputs:
See clause 8.15.3.3.
Outputs:
None.
See clause 8.15.2 for details of usage of this operation.
9.2.10 AIMLE Service Operations Management API p. 131
9.2.10.1 General p. 131
Table 9.2.10.1-1 illustrates the API for AIMLE Service Operations Management.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_AIMLEServiceOperationsManagement | Request | Request/Response | VAL Server |
9.2.10.2 Aimles_AIMLEServiceOperationsManagement_Request operation p. 131
API operation name:
Aimles_AIMLEServiceOperationsManagement_Request
Description:
The consumer requests for AIMLE Service operations management
Inputs:
See clause 8.20.3.1
Outputs:
See clause 8.20.3.2
See clause 8.20.2 for details of usage of this operation.
9.2.11 AIMLE Client Registration APIs p. 131
9.2.11.1 General p. 131
Table 9.2.11.1-1 illustrates the APIs for AIMLE client registration, update and de-registration. This API enables the communication between the AIMLE client and the AIMLE server for AIMLE client registration operations.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_AIMLEClientRegistration | Request | Request/Response | AIMLE Client |
| Update | AIMLE Client | ||
| Delete | AIMLE Client |
9.2.11.2 AIMLE client registration request operation p. 131
API operation name:
Aimles_AIMLEClientRegistration_Request
Description:
The consumer requests AIMLE server for AIMLE client registration.
Inputs:
See clause 8.7.3.2.
Outputs:
See clause 8.7.3.3.
See clause 8.7.2.2 for details of usage of this operation.
9.2.11.3 AIMLE client registration update request operation p. 132
API operation name:
Aimles_AIMLEClientRegistration_Update Request
Description:
The consumer requests AIMLE server for update AIMLE client registration.
Inputs:
See clause 8.7.3.4.
Outputs:
See clause 8.7.3.5.
See clause 8.7.2.3 for details of usage of this operation.
9.2.11.4 AIMLE client registration delete request operation p. 132
API operation name:
Aimles_AIMLEClientRegistration_Delete Request
Description:
The consumer requests AIMLE server for delete AIMLE client registration.
Inputs:
See clause 8.7.3.6.
Outputs:
See clause 8.7.3.7.
See clause 8.7.2.4 for details of usage of this operation.
9.2.12 Split AI/ML Operation API p. 132
9.2.12.1 General p. 132
Table 9.2.12.1-1 illustrates the API for Split AI/ML Operation. This API enables the AIMLE Client or VAL server to communicate with the AIMLE server for split AI/ML operation pipeline discovery or creation, for node registration and for split operation event subscription.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_SplitOpPipeline | Discover | Request/Response | AIMLE Client |
| Create | |||
| Update | |||
| Delete | |||
| Aimles_SplitOpNodeRegistration | Request | Request/Response | VAL Server |
| Update | |||
| Deregister | |||
| Aimles_SplitOpEvent | Subscribe | Subscribe/Notify | AIMLE Client, VAL Server |
| Notify | Subscribe/Notify | AIMLE Client, VAL Server | |
| UpdateSubscription | |||
| Unsubscribe |
9.2.12.2 Aimles_SplitOpPipeline_Discover operation p. 132
API operation name:
Aimles_SplitOpPipeline_Discover_Request
Description:
The consumer requests for one time split AI/ML operation pipeline discovery.
Inputs:
See clause 8.14.3.2.
Outputs:
See clause 8.14.3.3.
See clause 8.14.2.2 for details of usage of this operation.
9.2.12.3 Aimles_SplitOpPipeline_Create operation p. 133
API operation name:
Aimles_SplitOpPipeline_Create_Request
Description:
The consumer creates a split AI/ML operation pipeline.
Inputs:
See clause 8.14.3.4.
Outputs:
See clause 8.14.3.5.
See clause 8.14.2.3 for details of usage of this operation.
9.2.12.4 Aimles_SplitOpPipeline_Update operation p. 133
API operation name:
Aimles_SplitOpPipeline_Update_Request
Description:
The consumer updates a split AI/ML operation pipeline.
Inputs:
See clause 8.14.3.19.
Outputs:
See clause 8.14.3.20.
See clause 8.14.2.6 for details of usage of this operation.
9.2.12.5 Aimles_SplitOpPipeline_Delete operation p. 133
API operation name:
Aimles_SplitOpPipeline_Delete_Request
Description:
The consumer deletes a split AI/ML operation pipeline.
Inputs:
See clause 8.14.3.21.
Outputs:
See clause 8.14.3.22.
See clause 8.14.2.7 for details of usage of this operation.
9.2.12.6 Aimles_SplitOpNodeRegistration_Request operation p. 133
API operation name:
Aimles_SplitOpNodeRegistration_Request
Description:
The consumer requests for one time split AI/ML operation node registration.
Inputs:
See clause 8.14.3.6.
Outputs:
See clause 8.14.3.7.
See clause 8.14.2.4.2 for details of usage of this operation.
9.2.12.7 Aimles_SplitOpNodeRegistration_Update operation p. 133
API operation name:
Aimles_SplitOpNodeRegistration_Update
Description:
The consumer updates a split AI/ML operation node registration.
Inputs:
See clause 8.14.3.8.
Outputs:
See clause 8.14.3.9.
See clause 8.14.2.4.3 for details of usage of this operation.
9.2.12.8 Aimles_SplitOpNodeRegistration_Deregister operation p. 134
API operation name:
Aimles_SplitOpNodeRegistration_Deregister
Description:
The consumer deregisters a split AI/ML operation node registration.
Inputs:
See clause 8.14.3.10.
Outputs:
See clause 8.14.3.11.
See clause 8.14.2.4.4 for details of usage of this operation.
9.2.12.9 Aimles_SplitOpEvent_Subscribe operation p. 134
API operation name:
Aimles_SplitOpEvent_Subscribe
Description:
The consumer subscribes for split AI/ML operation events.
Inputs:
See clause 8.14.3.12.
Outputs:
See clause 8.14.3.13.
See clause 8.14.2.5.2 for details of usage of this operation.
9.2.12.10 Aimles_SplitOpEvent_Notify operation p. 134
API operation name:
Aimles_SplitOpEvent_Notify
Description:
The consumer is notified of split AI/ML operation events.
Inputs:
See clause 8.14.3.14.
Outputs:
None.
See clause 8.14.2.5.3 for details of usage of this operation.
9.2.12.11 Aimles_SplitOpEvent_UpdateSubscription operation p. 134
API operation name:
Aimles_SplitOpEvent_UpdateSubscription
Description:
The consumer updates an existing subscription for split AI/ML operation events.
Inputs:
See clause 8.14.3.15.
Outputs:
See clause 8.14.3.16.
See clause 8.14.2.5.4 for details of usage of this operation.
9.2.12.12 Aimles_SplitOpEvent_Unsubscribe operation p. 134
API operation name:
Aimles_SplitOpEvent_Unsubscribe
Description:
The consumer cancels an existing subscription for split AI/ML operation events.
Inputs:
See clause 8.14.3.17.
Outputs:
See clause 8.14.3.18.
See clause 8.14.2.5.5 for details of usage of this operation.
9.2.13 ML model update API p. 135
9.2.13.1 General p. 135
Table 9.2.13.1-1 illustrates the API for ML model update.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_MLModelUpdate | Request | Request/Response | VAL server, ADAE server, AIMLE client |
9.2.13.2 Aimles_MLModelUpdate_Request operation p. 135
API operation name:
Aimles_MLModelUpdate_Request
Description:
The AIMLE consumer requests ML Model update.
Inputs:
See clause 8.21.3.1.
Outputs:
See clause 8.21.3.2.
See clause 8.21.2 for details of usage of this operation.
9.2.14 ML model performance monitoring API p. 135
9.2.14.1 General p. 135
Table 9.2.14.1-1 illustrates the API for ML model performance monitoring subscription and notification. This API enables the VAL server to communicate with the AIMLE server for subscribing for model performance monitoring.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_MLModelPerfMonitor | Subscribe | Subscribe/Notify | VAL Server |
| Notify |
9.2.14.2 Subscribe p. 135
API operation name:
MLModelPerfMonitor_Subscribe
Description:
The consumer subscribes for ML model performance monitoring.
Inputs:
See clause 8.22.3.1.
Outputs:
See clause 8.22.3.2.
See clause 8.22.2 for details of usage of this operation.
9.2.14.3 Notify p. 135
API operation name:
MLModelPerfMonitor_Notify
Description:
The consumer is notified by ML repository on the ML model performance monitoring.
Inputs:
-
Outputs:
See clause 8.22.3.3.
See clause 8.22.2 for details of usage of this operation.
9.2.15 AIMLE assisted ML model selection API p. 136
9.2.15.1 General p. 136
Table 9.2.15.1-1 illustrates the API for AIMLE assisted ML model selection. This API enables an AIMLE service consumer to request assistance with ML model selection.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_AssistedMLModelSelection | Subscribe | Subscribe/Notify | VAL Server |
| Notify |
9.2.15.2 Aimles_AssistedMLModelSelection_Subscribe operation p. 136
API operation name:
Aimles_AssistedMLModelSelection_Subscribe
Description:
The consumer subscribes to AIMLE assisted ML model selection from an AIMLE server.
Inputs:
See clause 8.23.3.1.
Outputs:
See clause 8.23.3.2.
See clause 8.23.2 for details of usage of this operation.
9.2.15.3 Aimles_AssistedMLModelSelection_Notify operation p. 136
API operation name:
Aimles_AssistedMLModelSelection_Notify
Description:
The consumer receives notifications for AIMLE assisted ML model selection.
Inputs:
See clause 8.23.3.3.
Outputs:
None.
See clause 8.23.2 for details of usage of this operation.
9.2.16 AIMLE context transfer API p. 136
9.2.16.1 General p. 136
Table 9.2.16.1-1 illustrates the API for AIMLE context transfer. This API enables an AIMLE server to communicate AIMLE context to another AIMLE server in edge scenarios.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_ContextTransfer | Request | Request/Response | AIMLE Server |
9.2.16.2 Aimles_ContextTransfer_Request operation p. 136
API operation name:
Aimles_ContextTransfer_Request
Description:
The consumer requests AIMLE context transfer to an AIMLE server.
Inputs:
See clause 8.24.3.1.
Outputs:
See clause 8.24.3.2.
See clause 8.24.2 for details of usage of this operation.
9.2.17 AIMLE Assistance of Hierarchical Computing API p. 137
9.2.17.1 General p. 137
Table 9.2.17.1-1 illustrates the API for assist hierarchical computing. This API enables the communication between VAL server (e.g. CAS, EAS) and the AIMLE server for assistance of a hierarchical computing process.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimles_HierarchicalComputingAssist | Request | Request/Response | VAL Server (e.g. CAS, EAS) |
9.2.17.2 Aimles_HierarchicalComputingAssist_Request operation p. 137
API operation name:
Aimles_HierarchicalComputingAssist_Request
Description:
The consumer requests for assistance of a hierarchical computing process.
Inputs:
See clause 8.25.3.1.
Outputs:
See clause 8.25.3.2.
See clause 8.25.2 for details of usage of this operation.
