Fixed AFF review comments

SAP · Nov 4, 2024 · aacdc9f · aacdc9f
1 parent 47e546b
commit aacdc9f
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 36 deletions.
diff --git a/file-formats/intm/README.md b/file-formats/intm/README.md
@@ -2,4 +2,4 @@
 
 File | Cardinality | Definition | Schema | Example
 :--- | :--- | :--- | :--- | :---
-`<name>.intm.json` | 1 | [`zif_aff_intm_v1.intf.abap`](./type/zif_aff_intm_v1.intf.abap) | [`intm-v1.json`](./intm-v1.json) | [`saprgmlckx3qym6wrirw18fqvll0.intm.json`](./examples/saprgmlckx3qym6wrirw18fqvll0.intm.json)
+`<name>.intm.json` | 1 | [`zif_aff_intm_v1.intf.abap`](./type/zif_aff_intm_v1.intf.abap) | [`intm-v1.json`](./intm-v1.json) | [`saplvfkd32izflkp5or2uqi1jlc4.intm.json`](./examples/saplvfkd32izflkp5or2uqi1jlc4.intm.json)
diff --git a/...es/saprgmlckx3qym6wrirw18fqvll0.intm.json → ...es/saplvfkd32izflkp5or2uqi1jlc4.intm.json b/...es/saprgmlckx3qym6wrirw18fqvll0.intm.json → ...es/saplvfkd32izflkp5or2uqi1jlc4.intm.json
@@ -5,9 +5,9 @@
     "originalLanguage": "en"
   },
   "intelligentModel": {
-    "name": "RM_TEST_ADT_954_MOD",
-    "intelligentScenario": "RM_TEST_ADT_954",
-    "modellingContextId": "AB1B5492BF7DBFEF0E153E47BE3DCC16",
+    "name": "RM_TEST_ADT_959_MOD",
+    "intelligentScenario": "RM_TEST_ADT_959",
+    "modellingContextId": "0405E348470277F0EBDAEF4E3CEC2C31",
     "modelType": "SAPGENAI",
     "adapterId": "SAPGENAI.Default",
     "nativeModelType": "SAPGENAI.Default",
@@ -22,14 +22,14 @@
       "description": "System prompt",
       "prompt": "You are a sales executive who is responsible for reaching out to customers for confirming or declining their orders. Evaluate the size of the delivery vehicle based on the number of items. Calculate the distance between the billing and delivery location in kilometers. \n\nThe subject of email should be of format <Confirmation on order number: {order_number} placed on {booking_date}> \nThe body of email should be of format: \"\"\"\"SO contains <Category> to be delivered to <Location>. And will be delivered via a <size> vehicle. \nIF <distance between source address and delivery address> > 100 kms THEN include a message about potential delivery delays ELSE congratulate on being eligible for one day delivery",
       "promptParameters": "[]",
-      "visible": true
+      "isVisible": true
     },
     {
       "name": "USER_PROMPT",
       "description": "User prompt",
       "prompt": "Build a confirmation mail for a sales order containing {ISLM_Items} where the items are categorized for example pencil and paper will be stationary, printer and mouse will be electronics. The source address contains {ISLM_Source} and the delivery address is in {ISLM_Destination}.",
       "promptParameters": "[{\"Name\":\"ISLM_Items\",\"Value\":\"\"},{\"Name\":\"ISLM_Source\",\"Value\":\"\"},{\"Name\":\"ISLM_Destination\",\"Value\":\"\"}]",
-      "visible": true
+      "isVisible": true
     }
   ]
 }
diff --git a/file-formats/intm/intm-v1.json b/file-formats/intm/intm-v1.json
@@ -99,8 +99,8 @@
           "maxLength": 256
         },
         "modelSpecification": {
-          "title": "Model Content",
-          "description": "Model content",
+          "title": "Model Specification",
+          "description": "Model specification",
           "type": "string"
         },
         "modelDefinition": {
@@ -124,9 +124,9 @@
           "description": "Model bindings",
           "type": "string"
         },
-        "newModel": {
+        "isEnhancement": {
           "title": "Model flag",
-          "description": "Model flag that indicate new model or enhancement(X)",
+          "description": "If true, the model is an enhancement, if false the model is a new model.",
           "type": "boolean"
         },
         "executableId": {
@@ -154,8 +154,8 @@
       "description": "Model segment fields",
       "type": "array",
       "items": {
-        "title": "Segment Fields",
-        "description": "Model segment fields",
+        "title": "Segment Field",
+        "description": "Model segment field",
         "type": "object",
         "properties": {
           "fieldname": {
@@ -172,8 +172,8 @@
             "maximum": 2147483647
           },
           "isKey": {
-            "title": "Key Field",
-            "description": "Key field or not",
+            "title": "Is Key Field",
+            "description": "If true, the field is a key field",
             "type": "boolean"
           }
         },
@@ -185,8 +185,8 @@
       "description": "Model prompt templates",
       "type": "array",
       "items": {
-        "title": "Model Prompt Templates",
-        "description": "Model prompt templates",
+        "title": "Model Prompt Template",
+        "description": "Model prompt template",
         "type": "object",
         "properties": {
           "name": {
@@ -210,9 +210,9 @@
             "description": "Prompt parameters",
             "type": "string"
           },
-          "visible": {
+          "isVisible": {
             "title": "Prompt Visibility",
-            "description": "Prompt visibility",
+            "description": "If true, the prompt is visible",
             "type": "boolean"
           }
         },

diff --git a/file-formats/intm/type/zif_aff_intm_v1.intf.abap b/file-formats/intm/type/zif_aff_intm_v1.intf.abap
@@ -23,8 +23,8 @@ INTERFACE zif_aff_intm_v1
       "! <p class="shorttext">Native Model Type</p>
       "! Native model type
       native_model_type    TYPE c LENGTH 256,
-      "! <p class="shorttext">Model Content</p>
-      "! Model content
+      "! <p class="shorttext">Model Specification</p>
+      "! Model specification
       model_specification  TYPE string,
       "! <p class="shorttext">Model Definition</p>
       "! Model definition
@@ -39,8 +39,8 @@ INTERFACE zif_aff_intm_v1
       "! Model bindings
       bindings             TYPE string,
       "! <p class="shorttext">Model flag</p>
-      "! Model flag that indicate new model or enhancement(X)
-      new_model            TYPE abap_bool,
+      "! If true, the model is an enhancement, if false the model is a new model.
+      is_enhancement       TYPE abap_bool,
       "! <p class="shorttext">Executable ID</p>
       "! Executable ID
       executable_id        TYPE c LENGTH 64,
@@ -52,23 +52,23 @@ INTERFACE zif_aff_intm_v1
       llm_model_version    TYPE c LENGTH 30,
     END OF ty_intelligent_model,
 
-    "! <p class="shorttext">Segment Fields</p>
-    "! Model segment fields
-    BEGIN OF ty_segment_fields,
+    "! <p class="shorttext">Segment Field</p>
+    "! Model segment field
+    BEGIN OF ty_segment_field,
       "! <p class="shorttext">Field Name</p>
       "! Table or view field name
       fieldname      TYPE c LENGTH 30,
       "! <p class="shorttext">Position</p>
       "! Field position
       field_position TYPE i,
-      "! <p class="shorttext">Key Field</p>
-      "! Key field or not
+      "! <p class="shorttext">Is Key Field</p>
+      "! If true, the field is a key field
       is_key         TYPE abap_bool,
-    END OF ty_segment_fields,
+    END OF ty_segment_field,
 
-    "! <p class="shorttext">Model Prompt Templates</p>
-    "! Model prompt templates
-    BEGIN OF ty_prompt_templates,
+    "! <p class="shorttext">Model Prompt Template</p>
+    "! Model prompt template
+    BEGIN OF ty_prompt_template,
       "! <p class="shorttext">Prompt Template Name</p>
       "! Prompt template name
       "! $required
@@ -84,9 +84,9 @@ INTERFACE zif_aff_intm_v1
       "! Prompt parameters
       prompt_parameters TYPE string,
       "! <p class="shorttext">Prompt Visibility</p>
-      "! Prompt visibility
-      visible           TYPE abap_bool,
-    END OF ty_prompt_templates,
+      "! If true, the prompt is visible
+      is_visible        TYPE abap_bool,
+    END OF ty_prompt_template,
 
     "! <p class="shorttext">Intelligent scenario Models</p>
     "! Intelligent scenario model
@@ -103,9 +103,9 @@ INTERFACE zif_aff_intm_v1
       intelligent_model TYPE ty_intelligent_model,
       "! <p class="shorttext">Model Segment Fields</p>
       "! Model segment fields
-      segment_fields    TYPE STANDARD TABLE OF ty_segment_fields WITH DEFAULT KEY,
+      segment_fields    TYPE STANDARD TABLE OF ty_segment_field WITH DEFAULT KEY,
       "! <p class="shorttext">Model Prompt Templates</p>
       "! Model prompt templates
-      prompt_templates  TYPE STANDARD TABLE OF ty_prompt_templates WITH DEFAULT KEY,
+      prompt_templates  TYPE STANDARD TABLE OF ty_prompt_template WITH DEFAULT KEY,
     END OF ty_main.
 ENDINTERFACE.