4.5 Nnwdaf_MLModelProvision Service
29.5203GPP5G SystemNetwork Data Analytics ServicesRelease 18Stage 3TS
4.5.1 Service Description
4.5.1.1 Overview
The Nnwdaf_MLModelProvision service as defined in 3GPP TS 23.501 [2] and 3GPP TS 23.288 [17], is provided by the Network Data Analytics Function (NWDAF) containing Model Training Logical Function (MTLF).
This service:
– allows the NF service consumers to subscribe to and unsubscribe from different ML model analytics events; and
– notifies the NF service consumers with a corresponding subscription about ML model information.
The types of analytics events include:
– Slice load level information;
– Network slice instance load level information;
– Service experience;
– NF load;
– Network performance;
– Abnormal behaviour;
– UE mobility;
– UE communication;
– Abnormal behaviour;
– User data congestion;
– QoS sustainability;
– Dispersion;
– SM congestion control experience;
– Redundant transmission experience; and
– WLAN performance.
NOTE: ML model provisioning is limited to a single vendor environment in this release of current specification.
4.5.1.2 Service Architecture
The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture is defined in 3GPP TS 23.288 [17]. The ML Model provisioning signalling flows are defined in 3GPP TS 29.552 [25].
The Nnwdaf_MLModelProvision service is part of the Nnwdaf service-based interface exhibited by the Network Data Analytics Function (NWDAF) containing Model Training Logical Function (MTLF).
Known consumers of the Nnwdaf_MLModelProvision service are:
– Network Data Analytics Function (NWDAF) containing Analytics logical function (AnLF)
Figure 4.5.1.2-1: Reference Architecture for the Nnwdaf_MLModelProvision Service; SBI representation
Figure 4.5.1.2-2: Reference Architecture for the Nnwdaf_MLModelProvision Service: reference point representation
4.5.1.3 Network Functions
4.5.1.3.1 Network Data Analytics Function (NWDAF)
The Network Data Analytics Function (NWDAF), containing Model Training Logical Function (MTLF), provides ML model information for different analytic events to NF service consumers.
The Network Data Analytics Function (NWDAF) allows NF service consumers to subscribe to and unsubscribe from one-time, periodic notification or notification when an event is detected.
4.5.1.3.2 NF Service Consumers
The Network Data Analytics Function (NWDAF) supports (un)subscription to the notification of different ML model information from the NWDAF which contains Model Training Logical Function (MTLF).
4.5.2 Service Operations
4.5.2.1 Introduction
Table 4.5.2.1-1: Operations of the Nnwdaf_MLModelProvision Service
|
Service operation name |
Description |
Initiated by |
|---|---|---|
|
Nnwdaf_MLModelProvision_Subscribe |
This service operation is used by an NF service consumer to subscribe to ML model provision from NWDAF. |
NF service consumer (NWDAF) |
|
Nnwdaf_MLModelProvision_Unsubscribe |
This service operation is used by an NF service consumer to unsubscribe to ML model provision. |
NF service consumer (NWDAF) |
|
Nnwdaf_MLModelProvision_Notify |
This service operation is used by the NWDAF to notify the ML model information to the NF service consumer instance which has subscribed to. |
NWDAF |
4.5.2.2 Nnwdaf_MLModelProvision_Subscribe service operation
4.5.2.2.1 General
The Nnwdaf_MLModelProvision_Subscribe service operation is used by an NF service consumer to subscribe or update subscription for event notifications from the NWDAF which contains Model Training Logical Function (MTLF).
4.5.2.2.2 Subscription for event notifications
Figure 4.5.2.2.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to subscribe for event notification(s) (as shown in 3GPP TS 23.288 [17]).
Figure 4.5.2.2.2-1: NF service consumer subscribes to notifications
The NF service consumer shall invoke the Nnwdaf_MLModelProvision_Subscribe service operation to subscribe to event notification(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/nnwdaf-mlmodelprovision/<apiVersion>/subscriptions" as Resource URI representing the "NWDAF ML Model Provision Subscriptions", as shown in figure 4.5.2.2.2-1, step 1, to create a subscription for an "Individual NWDAF ML Model Provision Subscription" according to the information in message body.
The NwdafMLModelProvSubsc data structure provided in the request body shall include:
– an URI where to receive the requested notifications as the "notifUri" attribute; and
– a description of the subscribed events as the "mLEventSubscs" attribute that, for each event, the MLEventSubscription data type shall include:
1) an event identifier as the "mLEvent" attribute;
2) event filter information as the "mLEventFilter" attirbute; and
and may include:
1) an identification of target UE information as the "tgtUe" attribute;
2) a time interval during which the ML model shall be reported as the "mLTargetPeriod" attirbute; and
3) the time when the subscription expired as the "expiryTime" attirbute.
The NwdafMLModelProvSubsc data structure provided in the request body may include:
– a notification correlation identifier assigned by the NF service consumer for the requested notifications as "notifCorreId" attribute; and
– the reporting requirement information of the subscription as the "eventReq" attribute.
For different event types, the "mLEventFilter" attribute within the MLEventSubscription data type:
– if the event is "SLICE_LOAD_LEVEL", shall provide:
1) the S-NSSAI as the "snssais" attribute; and/or
2) the identification(s) of Network Slice instance as the "nsiIdInfos" attribute;
and may provide:
1) an optional list of analytics subsets as the "listOfAnaSubsets" attribute;
– if the event is "SERVICE_EXPERIENCE", may provide:
1) the identification of the application as the "appIds" attribute;
2) the S-NSSAI as the "snssais" attribute;
3) the identification(s) of Network Slice instance as the "nsiIdInfos" attribute;
4) the Area of Interest (AOI) as the "networkArea" attribute;
5) the identification of DNN as the "dnns" attribute;
6) identification of user plane access to DN(s) which the subscription applies as the "dnais" attribute;
7) identification of RAT type where the UE camps on by "ratTypes" attribute if the feature "ServiceExperienceExt" is also supported; and
8) identification of frequency to UE’s serving cell by "freqs" attribute if the feature "ServiceExperienceExt" is also supported;
– if the event is "UE_MOBILITY", may provide:
1) Area of Interest (AOI) as the "networkArea" attribute; and
– if the feature "UeMobilityExt" is supported and the event is "UE_MOBILITY", may provide:
1) Visited Area(s) of Interest as the "visitedAreas" attirbute;
– if the event is "UE_COMM", may provide:
1) the S-NSSAI as the "snssais" attribute;
2) the identification of DNN as the "dnns" attribute;
3) the identification of the application as the "appIds" attribute;
4) the Area of Interest (AOI) as the "networkArea" attribute; and
5) an optional list of analytics subsets as the "listOfAnaSubsets" attribute.
– if he event is "QOS_SUSTAINABILITY", shall provide:
1) The QoS requirements via "qosRequ" attribute; and
2) Location information as "networkArea" attribute;
and may provide:
1) identification of network slice(s) by "snssais" attirbute;
– if the event is "ABNORMAL_BEHAVIOUR", may provide:
1) the S-NSSAI as the "snssais" attribute;
2) the identification of DNN as the "dnns" attribute;
3) the identification of the application as the "appIds" attribute;
4) the Area of Interest (AOI) as the "networkArea" attribute;
5) expected UE behaviour via "exptUeBehav" attribute; and
6) either the expected analytics type via "exptAnaType" attribute or a list of exception Ids with the associated thresholds via "excepRequs" attirbute;
– if the event is "USER_DATA_CONGESTION", shall provide:
1) the Area of Interest (AOI) as the "networkArea" attribute;
2) an optional list of analytics subsets as the "listOfAnaSubsets" attribute; and
3) the S-NSSAI as the "snssais" attirbute;
– if the event is "NF_LOAD", may provide:
1) the S-NSSAI as the "snssais" attribute;
2) either list of NF instance IDs in the "nfInstanceIds" attribute or list of NF set IDs in the "nfSetIds" attribute;
3) list of NF instance types in the "nfTypes" attribute;
4) the Area of Interest (AOI) as the "networkArea" attribute; and
5) an optional list of analytics subsets as the "listOfAnaSubsets" attirbute;
– if the event is "NETWORK_PERFORMANCE", may provide:
1) Area of Interest (AOI) as the "networkArea" attribute; and
2) an optional list of analytics subsets as the "listOfAnaSubsets" attirbute;
– if the event is "NSI_LOAD_LEVEL", shall provide:
1) the S-NSSAI as the "snssais" attribute; and/or
2) the identification(s) of Network Slice instance as the "nsiIdInfos" attribute;
and may provide:
1) an optional list of analytics subsets as the "listOfAnaSubsets" attirbute;
– if the event is "SM_CONGESTION", shall provide:
1) the S-NSSAI as the "snssais" attribute; and/or
2) the identification of DNN as the "dnns" attribute;
and may provide:
1) an optional list of analytics subsets as the "listOfAnaSubsets" attirbute;
– if the event is "REDUNDANT_TRANSMISSION", may provide:
1) the Area of Interest (AOI) as the "networkArea" attribute;
2) the S-NSSAI as the "snssais" attribute; and
3) the identification of DNN as the "dnns" attirbute;
– if the event is "WLAN_PERFORMANCE", may provide:
1) the Area of Interest (AOI) as the "networkArea" attribute;
2) the SSID(s) and BSSID(s) as "wlanReqs" attribute; and
3) an optional list of analytics subsets as the "listOfAnaSubsets" attirbute;
– if the event is "DN_PERFORMANCE", may provide:
1) the identification of the application as the "appIds" attribute;
2) the S-NSSAI as the "snssais" attribute;
3) the identification(s) of Network Slice instance as the "nsiIdInfos" attribute;
4) the Area of Interest (AOI) as the "networkArea" attribute;
5) the identification of the UPF as the "upfInfo" attribute;
6) the identification of DNN as the "dnns" attribute;
7) identification of user plane access to DN(s) which the subscription applies as the "dnais" attribute;
8) IP address(s)/FQDN(s) of the Application Server(s) as the "appServerAddrs" attribute;
9) an optional list of analytics subsets as the "listOfAnaSubsets" attirbute;
– if the event is "DISPERSION", may provide:
1) the Area of Interest (AOI) as the "networkArea" attribute;
2) the S-NSSAI as the "snssais" attribute;
3) the identification of the application as the "appIds" attribute;
4) dispersion analytics requirements in "disperReqs" attribute;
5) an optional list of analytics subsets as the "listOfAnaSubsets" attirbute;
Upon the reception of an HTTP POST request with: "{apiRoot}/nnwdaf-mlmodelprovision/<apiVersion>/subscriptions" as Resource URI and NwdafMLModelProvSubsc data structure as request body, the NWDAF shall create a new subscription and store the subscription.
If the NWDAF created an "Individual NWDAF ML Model Provision Subscription" resource, the NWDAF shall respond with "201 Created" with the message body containing a representation of the created subscription, as shown in figure 4.5.2.2.2-1, step 2. The NWDAF shall include a Location HTTP header field. The Location header field shall contain the URI of the created subscription i.e. "{apiRoot}/nnwdaf-mlmodelprovision/<apiVersion>/subscriptions/{subscriptionId}".
If the immediate reporting indication in the "immRep" attribute within the "eventReq" attribute sets to true during the event subscription, the NWDAF shall include the reports of the subscribed events, if available, as the "mLEventNotifs" attribute in the HTTP POST response.
If there is no associated ML model available for all the listed "mLEvent" attribute, the NWDAF which contains MTLF shall send a "500 Internal Server Error" status code to the NF service consumer. Also, the corresponding failure reason via a "problemDetails" attribute with the "cause" attribute set to "UNAVAILABLE_ML_MODEL_FOR_ALLEVENTS". If errors occur when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.4.7.
4.5.2.2.3 Update subscription for event notifications
Figure 4.5.2.2.3-1 shows a scenario that the NF service consumer sends an HTTP PUT request to the NWDAF to modify an existing subscription (as shown in 3GPP TS 23.288 [17]).
Figure 4.5.2.2.3-1: Modification of events subscription information using HTTP PUT
The NF service consumer shall invoke the Nnwdaf_MLModelProvision_Subscribe service operation to modify an existing ML Model subscription. The NF service consumer shall send an HTTP PUT request with: "{apiRoot}/nnwdaf-mlmodelprovision/<apiVersion>/subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription to be modified, to update an "Individual NWDAF ML Model Provision Subscription" according to the information in the message body. The NwdafMLModelProvSubsc data structure provided in the request body shall include the same contents as described in clause 4.5.2.2.2.
Upon receipt of an HTTP PUT request with: "{apiRoot}/nnwdaf-mlmodelprovision/<apiVersion>/subscriptions/{subscriptionId}" as Resource URI and NwdafMLModelProvSubsc data type as request body, if the request is successfully processed and accepted, the NWDAF shall:
– modify the concerned subscription; and
– store the subscription.
NOTE: The "notifUri" attribute within the NwdafMLModelProvSubsc data structure can be modified to request that subsequent notifications are sent to a new NF service consumer.
If the NWDAF successfully processed and accepted the received HTTP PUT request, the NWDAF shall update an "Individual NWDAF ML Model Provision Subscription" resource, and shall respond with:
– HTTP "204 No Content" response (as shown in figure 4.5.2.2.3-1, step 2a); or
– HTTP "200 OK" response (as shown in figure 4.5.2.2.3-1, step 2b) with a response body containing a representation of the updated subscription in the NwdafMLModelProvSubsc data type.
If errors occur when processing the HTTP PUT request, the NWDAF shall send an HTTP error response as specified in clause 5.4.7.
If the NWDAF determines that the received HTTP PUT request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6].
4.5.2.3 Nnwdaf_MLModelProvision_Unsubscribe service operation
4.5.2.3.1 General
The Nnwdaf_MLModelProvision_Unsubscribe service operation is used by an NF service consumer to unsubscribe from event notifications.
4.5.2.3.2 Unsubscribe from event notifications
Figure 4.5.2.3.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to unsubscribe from event notifications (see also 3GPP TS 23.288 [17]).
Figure 4.5.2.3.2-1: NF service consumer unsubscribes from notifications
The NF service consumer shall invoke the Nnwdaf_MLModelProvision_UnSubscribe service operation to unsubscribe to event notifications. The NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/nnwdaf-mlmodelprovision/<apiVersion>/subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription that is to be deleted.
Upon the reception of an HTTP DELETE request, if the NWDAF successfully processed and accepted the received HTTP DELETE request, the NWDAF shall:
– remove the corresponding subscription; and
– respond with HTTP "204 No Content" status code.
If the NWDAF determines the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6].
If errors occur when processing the HTTP DELETE request, the NWDAF shall send an HTTP error response as specified in clause 5.4.7.
4.5.2.4 Nnwdaf_MLModelProvision_Notify service operation
4.5.2.4.1 General
The Nnwdaf_MLModelProvision_Notify service operation is used by an NWDAF to notify NF consumers about subscribed events.
4.5.2.4.2 Notification about subscribed event
Figure 4.5.2.4.2-1 shows a scenario where the NWDAF sends a request to the NF Service Consumer to notify for event notifications (see also 3GPP TS 23.288 [17]).
Figure 4.5.2.4.2-1: NWDAF notifies the subscribed event
The NWDAF shall invoke the Nnwdaf_MLModelProvision_Notify service operation to notify the subscribed event. The NWDAF shall send an HTTP POST request with "{notifUri}" received in the Nnwdaf_MLModelProvision_Subscribe service operation as Resource URI, as shown in figure 4.2.2.4.2-1, step 1. The NwdafMLModelProvNotif data structure provided in the request body that shall include:
– an event subscriptionId as "subscriptionId" attribute;
– and description of the notified event as "eventNotifs" attribute, that for each event, the MLEventNotif data type shall include an event identifier as the "event" attribute, an address (e.g. a URL or an FQDN) of the ML model file as the "mLFileAddr" attribute, and may include a notification correlation identifier as "notifCorreId" attribute and a time period when the provided ML model applies as the "validityPeriod" attribute and an area where the provided ML model applies as the "spatialValidity" attribute.
Upon the reception of an HTTP POST request, if the NF service consumer successfully processed and accepted the received HTTP POST request, the NF Service Consumer shall store the notification and respond with HTTP "204 No Content" status code.
If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6].
If errors occur when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.4.7.