Content for TS 23.482 Word version: 19.3.0
9.4 AIMLE client APIs
9.4.1 ML model training capability evaluation API
9.4.2 HFL training API
9.4.3 Client data processing API
9.4.4 AIMLE Client Service Operations API
9.4.5 AIMLE Client Participation API
9.4.6 AIMLE AI/ML Task Transfer APIs
9.4.7 FL grouping indication API
...
...
9.4 AIMLE client APIs p. 139
9.4.1 ML model training capability evaluation API p. 139
9.4.1.1 General p. 139
Table 9.4.1.1-1 illustrates the API for ML model training capability evaluation. This API enables the AIMLE Server to communicate with the AIMLE client(s) for ML model training capability evaluation.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimlec_MLModelTrainingCapabilityEva | Request | Request/Response | AIMLE Server |
| Response | AIMLE Client |
9.4.1.2 Aimlec_MLModelTrainingCapabilityEva_Request operation p. 140
API operation name:
Aimlec_MLModelTrainingCapabilityEva_Request
Description:
The consumer requests for ML Model training capability evaluation.
Inputs:
See clause 8.19.3.1.
Outputs:
None.
See clause 8.19.2 for details of usage of this operation.
9.4.1.3 Aimlec_MLModelTrainingCapabilityEva_Response operation p. 140
API operation name:
Aimlec_MLModelTrainingCapabilityEva_Response
Description:
The consumer responses for ML Model training capability evaluation.
Inputs:
See clause 8.19.3.2.
Outputs:
None.
See clause 8.19.2 for details of usage of this operation.
9.4.2 HFL training API p. 140
9.4.2.1 General p. 140
Table 9.4.2.1-1 illustrates the API for HFL training to enable an AIMLE server to subscribe to HFL training.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimlec_HFLTraining | Subscribe | Subscribe/Notify | AIMLE server |
| Notify |
9.4.2.2 Aimlec_HFLTraining_Subscribe operation p. 140
API operation name:
Aimlec_HFLTraining_Subscribe
Description:
The consumer subscribes to HFL training.
Inputs:
See clause 8.12.3.1.
Outputs:
See clause 8.12.3.2.
See clause 8.12.2 for details of usage of this operation.
9.4.2.3 Aimlec_HFLTraining_Notify operation p. 140
API operation name:
Aimlec_HFLTraining_Subscribe
Description:
The consumer receives notifications from HFL training.
Inputs:
See clause 8.12.3.3.
Outputs:
None.
See clause 8.12.2 for details of usage of this operation.
9.4.3 Client data processing API p. 141
9.4.3.1 General p. 141
Table 9.4.3.1-1 illustrates the API for Client data processing to enable an AIMLE server to request data processing to be performed on AIMLE clients.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimlec_ClientDataProcessing | Request | Request/Response | AIMLE server |
9.4.3.2 Aimlec_ClientDataProcessing_Request operation p. 141
API operation name:
Aimlec_ClientDataProcessing_Request
Description:
The consumer requests data processing to be performed on AIMLE clients.
Inputs:
See clause 8.15.3.4.
Outputs:
See clause 8.15.3.5.
See clause 8.15.2 for details of usage of this operation.
9.4.4 AIMLE Client Service Operations API p. 141
9.4.4.1 General p. 141
Table 9.4.4.1-1 illustrates the API for AIMLE Client Service Operations.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimlec_AIMLEClientServiceOperations | Request | Request/Response | AIMLE Server |
| Response | AIMLE Client |
9.4.4.2 Aimlec_ AIMLEClientServiceOperations_Request operation p. 141
API operation name:
Aimlec_AIMLEClientServiceOperations_Request
Description:
The consumer requests for AIMLE client service operations.
Inputs:
See clause 8.20.3.3.
Outputs:
None.
See clause 8.20.2 for details of usage of this operation.
9.4.4.3 Aimlec_ AIMLEClientServiceOperations_Response operation p. 141
API operation name:
Aimlec_AIMLEClientServiceOperations_Response
Description:
The consumer responses for AIMLE client service operations
Inputs:
See clause 8.20.3.4.
Outputs:
None.
See clause 8.20.2 for details of usage of this operation.
9.4.5 AIMLE Client Participation API p. 142
9.4.5.1 General p. 142
Table 9.4.5.1-1 illustrates the APIs for AIMLE client participation. This API enables the communication between the AIMLE client and the AIMLE server for AIMLE client participation.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimlec_AIMLEClientParticipation | Request | Request/Response | AIMLE Server |
9.4.5.2 Aimlec_AIMLEClientParticipation_Request operation p. 142
API operation name:
Aimlec_AIMLEClientParticipation_Request
Description:
The consumer requests AIMLE server for AIMLE client participation.
Inputs:
See clause 8.10.3.1.
Outputs:
See clause 8.10.3.2.
See clause 8.10.2.1 for details of usage of this operation.
9.4.6 AIMLE AI/ML Task Transfer APIs p. 142
9.4.6.1 General p. 142
Table 9.4.6.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) |
|---|---|---|---|
| Aimlec_AIMLTaskTransfer | Request | Request/Response | AIMLE Server |
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimlec_DirectAIMLTaskTransfer | Request | Request/Response | AIMLE Client |
9.4.6.2 Aimlec_AIMLTaskTransfer_Request operation p. 143
9.4.6.2.1 General p. 143
API description:
This API enables the AIMLE server to communicate with the target AI/ML member (AIMLE Client) for request AIML task transfer from source AI/ML member (AIMLE Client) to the target AI/ML member (AIMLE Client).
9.4.6.2.2 AIML task transfer request operation p. 143
API operation name:
Aimlec_AIMLTaskTransfer_Request
Description:
The consumer requests for AI/ML task transfer.
Inputs:
See clause 8.6.3.4.
Outputs:
See clause 8.6.3.5.
See clause 8.6.2.2 for details of usage of this operation.
9.4.6.3 Aimlec_DirectAIMLTaskTransfer_Request operation p. 143
9.4.6.3.1 General p. 143
API description:
This API enables the AIMLE client to communicate with the target AI/ML member (AIMLE Client) for request direct AIML task transfer from the source AI/ML member (AIMLE Client) to the target AI/ML member (AIMLE Client).
9.4.6.3.2 Direct AIML task transfer request operation p. 143
API operation name:
Aimlec_DirectAIMLTaskTransfer_Request
Description:
The consumer requests for direct AI/ML task transfer.
Inputs:
See clause 8.6.3.6.
Outputs:
See clause 8.6.3.7.
See clause 8.6.2.3 for details of usage of this operation.
9.4.7 FL grouping indication API p. 143
9.4.7.1 General p. 143
Table 9.4.7.1-1 illustrates the APIs for FL grouping indication. This API enables the communication between the AIMLE server and the FL member for indicating the FL grouping procedure.
| API Name | API Operations | Operation Semantics | Consumer(s) |
|---|---|---|---|
| Aimlec_FLGroupIndication | Request | Request/Response | AIMLE Server |
9.4.7.2 Aimlec_FLGroupIndication operation p. 143
API operation name:
Aimlec_FLGroupIndication
Description:
The consumer indicates to FL member (AIMLE clients which are deployed on UEs) for FL grouping procedure.
Inputs:
See clause 8.17.3.3.
Outputs:
See clause 8.17.3.4.
See clause 8.17.2 for details of usage of this operation.
