✨ Add native property to NluData

common/src/Input.ts

@@ -11,7 +11,7 @@ export interface Entity {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   value?: any;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  native?: any;
+  native?: any; // raw API response from the NLU service
 }
 
 export interface EntityMap<ENTITY_TYPE extends Entity = Entity> {
@@ -25,6 +25,8 @@ export interface AsrData extends UnknownObject {
 export interface NluData extends UnknownObject {
   intent?: Intent | string;
   entities?: EntityMap;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  native?: any; // raw API response from the NLU service
 }
 
 export enum InputType {

docs/nlu.md

@@ -12,7 +12,7 @@ Learn more about natural language understanding (NLU) services that can be integ
 
 Natural language understanding (in short, NLU) is the process of turning raw text into structured meaning. It is part of the `interpretation` step of the [RIDR lifecycle](./ridr-lifecycle.md).
 
-Jovo offers integrations with a variety of NLU services that can either be self-hosted or accessed via an API. [You can find all the current integrations here](#integrations).
+Jovo offers integrations with a variety of NLU services that can either be self-hosted or accessed via an API. [You can find all the current integrations below](#integrations).
 
 NLU integrations are helpful for platforms that deal with raw text. The integration then writes the results into an `nlu` object that is part of the [`$input` property](./input.md):
 
@@ -27,6 +27,9 @@ NLU integrations are helpful for platforms that deal with raw text. The integrat
         value: 'Max',
       },
     },
+    native: {
+      // Raw API response from the NLU service
+    }
   },
 }
 ```

integrations/nlu-dialogflow/src/DialogflowNlu.ts

@@ -55,7 +55,9 @@ export class DialogflowNlu extends NluPlugin<DialogflowNluConfig> {
         jovo.$session.id,
       );
 
-      const nluData: NluData = {};
+      const nluData: NluData = {
+        native: dialogflowResponse.data,
+      };
       const displayName = dialogflowResponse.data.queryResult.intent.displayName;
       if (displayName) {
         nluData.intent = { name: displayName };

integrations/nlu-nlpjs/src/NlpjsNlu.ts

@@ -117,7 +117,8 @@ export class NlpjsNlu extends NluPlugin<NlpjsNluConfig> {
             name: nlpResult.intent,
           },
           entities,
-          raw: nlpResult, // TODO: temporary property
+          native: nlpResult,
+          raw: nlpResult, // @deprecated please use 'native' property
         }
       : undefined;
   }

integrations/nlu-rasa/src/RasaNlu.ts

@@ -52,6 +52,7 @@ export class RasaNlu extends NluPlugin<RasaNluConfig> {
         },
         alternativeIntents: this.mapAlternativeIntents(rasaResponse.data.intent_ranking),
         entities: this.getEntityMapFromResponse(rasaResponse.data),
+        native: rasaResponse.data,
       };
     } catch (e) {
       // eslint-disable-next-line no-console

integrations/nlu-snips/src/SnipsNlu.ts

@@ -74,7 +74,9 @@ export class SnipsNlu extends NluPlugin<SnipsNluConfig> {
     };
 
     const snipsNluResponse: SnipsNluResponse = await this.sendRequestToSnips(config);
-    const nluData: NluData = {};
+    const nluData: NluData = {
+      native: snipsNluResponse,
+    };
     if (snipsNluResponse.intent.intentName) {
       nluData.intent = { name: snipsNluResponse.intent.intentName };
     }