wordsmithing

SAP · Nov 23, 2023 · 63d79d1 · 63d79d1
1 parent 14848ce
commit 63d79d1
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 28 deletions.
diff --git a/vocabularies/AI.json b/vocabularies/AI.json
@@ -33,24 +33,25 @@
         "$ReturnType": {
           "$Type": "Edm.ComplexType",
           "@Core.Description": "Nested structure containing recommendations",
-          "@Core.LongDescription": "The nested structure contains complex types that correspond to the entity type of the binding parameter\n            or one of its related entity types. Each complex type has\n            <br>- the same properties as the key of the corresponding entity type\n            <br>- structural properties corresponding to non-key structural properties of the entity type for which recommendations are\n            available. The type of these properties is a collection of a specialization of [`PropertyRecommendationType`](#PropertyRecommendationType)\n            <br>- structural properties corresponding to navigation properties of the entity type.\n            The type of these properties is (a collection of) a nested complex type."
+          "@Core.LongDescription": "The nested structure contains complex types that correspond to the entity type of the binding parameter\n            or one of its related entity types. Each complex type contains\n            <br>- the same properties as the key of the corresponding entity type\n            <br>- structural properties corresponding to non-key structural properties of the entity type for which recommendations are\n            available. The type of such a property is a collection of a specialization of [`PropertyRecommendationType`](#PropertyRecommendationType)\n            <br>- structural properties corresponding to navigation properties of the entity type.\n            The type of such a property is (a collection of) a nested complex type corresponding to the target entity type of the navigation property."
         }
       }
     ],
     "PropertyRecommendationType": {
       "$Kind": "ComplexType",
       "$Abstract": true,
       "@Common.Experimental": true,
-      "@Core.Description": "AI-based recommendations for an entity type property",
-      "@Core.LongDescription": "In the specializations of this base type,\n          the `AIRecommendedFieldValue` is specialized to the primitive type of the entity type property and\n          the `AIRecommendedFieldDescription` is specialized to the string type of the corresponding text property.",
+      "@Core.Description": "Base type containing AI-based recommendations for an entity type property",
       "AIRecommendedFieldValue": {
         "$Type": "Edm.PrimitiveType",
         "@Core.Description": "Recommended value",
+        "@Core.LongDescription": "In the specializations of this base type, this property is specialized to the primitive type of the entity type property.",
         "@Common.Text": { "$Path": "AIRecommendedFieldDescription" }
       },
       "AIRecommendedFieldDescription": {
         "$Nullable": true,
-        "@Core.Description": "Description of the recommended value"
+        "@Core.Description": "Description of the recommended value",
+        "@Core.LongDescription": "In the specializations of this base type, this property is specialized to the string type of the text property corresponding to the entity type property."
       },
       "AIRecommendedFieldScoreValue": {
         "$Type": "Edm.Decimal",

diff --git a/vocabularies/AI.md b/vocabularies/AI.md
@@ -8,7 +8,7 @@ Terms for AI-related functionality at SAP
 
 Term|Type|Description
 :---|:---|:----------
-[RecommendationsRole](./AI.xml#L78:~:text=<Term%20Name="-,RecommendationsRole,-") *([Experimental](Common.md#Experimental))*|[RecommendationsRoleType](#RecommendationsRoleType)|<a name="RecommendationsRole"></a>Role of this property or parameter regarding AI-based recommendations
+[RecommendationsRole](./AI.xml#L79:~:text=<Term%20Name="-,RecommendationsRole,-") *([Experimental](Common.md#Experimental))*|[RecommendationsRoleType](#RecommendationsRoleType)|<a name="RecommendationsRole"></a>Role of this property or parameter regarding AI-based recommendations
 
 
 ## Functions
@@ -23,32 +23,28 @@ The function SHOULD compute the recommendations asynchronously, see [this diagra
 Parameter|Type|Description
 :--------|:---|:----------
 **[Entity](./AI.xml#L45:~:text=<Function%20Name="-,Recommendations,-")**|EntityType|**Binding parameter**
-[&rarr;](./AI.xml#L46:~:text=<Function%20Name="-,Recommendations,-")|ComplexType|Nested structure containing recommendations<br>The nested structure contains complex types that correspond to the entity type of the binding parameter or one of its related entity types. Each complex type has <br>- the same properties as the key of the corresponding entity type <br>- structural properties corresponding to non-key structural properties of the entity type for which recommendations are available. The type of these properties is a collection of a specialization of [`PropertyRecommendationType`](#PropertyRecommendationType) <br>- structural properties corresponding to navigation properties of the entity type. The type of these properties is (a collection of) a nested complex type.
+[&rarr;](./AI.xml#L46:~:text=<Function%20Name="-,Recommendations,-")|ComplexType|Nested structure containing recommendations<br>The nested structure contains complex types that correspond to the entity type of the binding parameter or one of its related entity types. Each complex type contains <br>- the same properties as the key of the corresponding entity type <br>- structural properties corresponding to non-key structural properties of the entity type for which recommendations are available. The type of such a property is a collection of a specialization of [`PropertyRecommendationType`](#PropertyRecommendationType) <br>- structural properties corresponding to navigation properties of the entity type. The type of such a property is (a collection of) a nested complex type corresponding to the target entity type of the navigation property.
 
 
 <a name="PropertyRecommendationType"></a>
 ## [*PropertyRecommendationType*](./AI.xml#L59:~:text=<ComplexType%20Name="-,PropertyRecommendationType,-") *([Experimental](Common.md#Experimental))*
-AI-based recommendations for an entity type property
-
-In the specializations of this base type,
-          the `AIRecommendedFieldValue` is specialized to the primitive type of the entity type property and
-          the `AIRecommendedFieldDescription` is specialized to the string type of the corresponding text property.
+Base type containing AI-based recommendations for an entity type property
 
 Property|Type|Description
 :-------|:---|:----------
-[AIRecommendedFieldValue](./AI.xml#L67:~:text=<ComplexType%20Name="-,PropertyRecommendationType,-")|PrimitiveType|Recommended value
-[AIRecommendedFieldDescription](./AI.xml#L71:~:text=<ComplexType%20Name="-,PropertyRecommendationType,-")|String?|Description of the recommended value
-[AIRecommendedFieldScoreValue](./AI.xml#L74:~:text=<ComplexType%20Name="-,PropertyRecommendationType,-")|Decimal?|Confidence score of the recommended value
+[AIRecommendedFieldValue](./AI.xml#L62:~:text=<ComplexType%20Name="-,PropertyRecommendationType,-")|PrimitiveType|Recommended value<br>In the specializations of this base type, this property is specialized to the primitive type of the entity type property.
+[AIRecommendedFieldDescription](./AI.xml#L69:~:text=<ComplexType%20Name="-,PropertyRecommendationType,-")|String?|Description of the recommended value<br>In the specializations of this base type, this property is specialized to the string type of the text property corresponding to the entity type property.
+[AIRecommendedFieldScoreValue](./AI.xml#L75:~:text=<ComplexType%20Name="-,PropertyRecommendationType,-")|Decimal?|Confidence score of the recommended value
 
 <a name="RecommendationsRoleType"></a>
-## [RecommendationsRoleType](./AI.xml#L82:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-") *([Experimental](Common.md#Experimental))*
+## [RecommendationsRoleType](./AI.xml#L83:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-") *([Experimental](Common.md#Experimental))*
 **Type:** String
 
 
 
 Allowed Value|Description
 :------------|:----------
-[Input](./AI.xml#L86:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-")|The property is input for some recommendation
-[Output](./AI.xml#L90:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-")|The property or parameter is the target of some recommendation
-[InputOutput](./AI.xml#L94:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-")|The property is input for and the target of some recommendation
-[RequiredInput](./AI.xml#L98:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-")|The property is required input before any recommendations are requested
+[Input](./AI.xml#L87:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-")|The property is input for some recommendation
+[Output](./AI.xml#L91:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-")|The property or parameter is the target of some recommendation
+[InputOutput](./AI.xml#L95:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-")|The property is input for and the target of some recommendation
+[RequiredInput](./AI.xml#L99:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-")|The property is required input before any recommendations are requested
diff --git a/vocabularies/AI.xml b/vocabularies/AI.xml
@@ -47,29 +47,30 @@
           <Annotation Term="Core.Description" String="Nested structure containing recommendations" />
           <Annotation Term="Core.LongDescription">
             <String>The nested structure contains complex types that correspond to the entity type of the binding parameter
-            or one of its related entity types. Each complex type has
+            or one of its related entity types. Each complex type contains
             &lt;br&gt;- the same properties as the key of the corresponding entity type
             &lt;br&gt;- structural properties corresponding to non-key structural properties of the entity type for which recommendations are
-            available. The type of these properties is a collection of a specialization of [`PropertyRecommendationType`](#PropertyRecommendationType)
+            available. The type of such a property is a collection of a specialization of [`PropertyRecommendationType`](#PropertyRecommendationType)
             &lt;br&gt;- structural properties corresponding to navigation properties of the entity type.
-            The type of these properties is (a collection of) a nested complex type.</String>
+            The type of such a property is (a collection of) a nested complex type corresponding to the target entity type of the navigation property.</String>
           </Annotation>
         </ReturnType>
       </Function>
       <ComplexType Name="PropertyRecommendationType" Abstract="true">
         <Annotation Term="Common.Experimental" />
-        <Annotation Term="Core.Description" String="AI-based recommendations for an entity type property" />
-        <Annotation Term="Core.LongDescription">
-          <String>In the specializations of this base type,
-          the `AIRecommendedFieldValue` is specialized to the primitive type of the entity type property and
-          the `AIRecommendedFieldDescription` is specialized to the string type of the corresponding text property.</String>
-        </Annotation>
+        <Annotation Term="Core.Description" String="Base type containing AI-based recommendations for an entity type property" />
         <Property Name="AIRecommendedFieldValue" Type="Edm.PrimitiveType" Nullable="false">
           <Annotation Term="Core.Description" String="Recommended value" />
+          <Annotation Term="Core.LongDescription">
+            <String>In the specializations of this base type, this property is specialized to the primitive type of the entity type property.</String>
+          </Annotation>
           <Annotation Term="Common.Text" Path="AIRecommendedFieldDescription" />
         </Property>
         <Property Name="AIRecommendedFieldDescription" Type="Edm.String" Nullable="true">
           <Annotation Term="Core.Description" String="Description of the recommended value" />
+          <Annotation Term="Core.LongDescription">
+            <String>In the specializations of this base type, this property is specialized to the string type of the text property corresponding to the entity type property.</String>
+          </Annotation>
         </Property>
         <Property Name="AIRecommendedFieldScoreValue" Type="Edm.Decimal" Scale="variable" Nullable="true">
           <Annotation Term="Core.Description" String="Confidence score of the recommended value" />