Adapt diagram

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

Hide file tree

Showing 5 changed files with 28 additions and 16 deletions.
diff --git a/_layouts/default.html b/_layouts/default.html
@@ -44,8 +44,8 @@ <h1><a href="{{ "/" | absolute_url }}">{{ site.title | default: site.github.repo
 
     <script type="module">
       import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs";
-      mermaid.initialize({startOnLoad: true});
-      mermaid.init(undefined, document.querySelectorAll('.language-mermaid'));
+      mermaid.initialize({startOnLoad: false});
+      mermaid.run({nodes: document.querySelectorAll('.language-mermaid')});
     </script>
 
   </body>

diff --git a/docs/recommendations.md b/docs/recommendations.md
@@ -15,7 +15,7 @@ sequenceDiagram
   par
     server ->> server: GET SalesOrder('A')?$expand=... for side effects
   and
-    server ->> server: GET SalesOrder('A')/AI.Recommendations?AIRecommendationTargets=...<br>Prefer: respond-async
+    server ->> server: GET SalesOrder('A')/AI.Recommendations<br>Prefer: respond-async
     server ->>+ task: call function ... starting new task
   end
   server -->> client: $batch response with<br>Location header for recommendations

diff --git a/vocabularies/AI.json b/vocabularies/AI.json
@@ -42,16 +42,17 @@
       "$Abstract": true,
       "@Common.Experimental": true,
       "@Core.Description": "Base type containing AI-based recommendations for an entity type property",
+      "@Core.LongDescription": "Specializations of this base type have three properties:\n- a property that is the target of a [`Common.Text`](Common.md#Text) annotation, its name may differ from `AIRecommendedFieldValue`\n- a property to which the `Common.Text` annotation evaluates, its name may differ from `AIRecommendedFieldDescription`\n- a property named `AIRecommendedFieldScoreValue`.",
       "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.",
+        "@Core.LongDescription": "In 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.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."
+        "@Core.LongDescription": "In 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#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
+[RecommendationsRole](./AI.xml#L85:~: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
@@ -30,21 +30,26 @@ Parameter|Type|Description
 ## [*PropertyRecommendationType*](./AI.xml#L59:~:text=<ComplexType%20Name="-,PropertyRecommendationType,-") *([Experimental](Common.md#Experimental))*
 Base type containing AI-based recommendations for an entity type property
 
+Specializations of this base type have three properties:
+- a property that is the target of a [`Common.Text`](Common.md#Text) annotation, its name may differ from `AIRecommendedFieldValue`
+- a property to which the `Common.Text` annotation evaluates, its name may differ from `AIRecommendedFieldDescription`
+- a property named `AIRecommendedFieldScoreValue`.
+
 Property|Type|Description
 :-------|:---|:----------
-[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
+[AIRecommendedFieldValue](./AI.xml#L68:~:text=<ComplexType%20Name="-,PropertyRecommendationType,-")|PrimitiveType|Recommended value<br>In specializations of this base type, this property is specialized to the primitive type of the entity type property.
+[AIRecommendedFieldDescription](./AI.xml#L75:~:text=<ComplexType%20Name="-,PropertyRecommendationType,-")|String?|Description of the recommended value<br>In 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#L81:~:text=<ComplexType%20Name="-,PropertyRecommendationType,-")|Decimal?|Confidence score of the recommended value
 
 <a name="RecommendationsRoleType"></a>
-## [RecommendationsRoleType](./AI.xml#L83:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-") *([Experimental](Common.md#Experimental))*
+## [RecommendationsRoleType](./AI.xml#L89:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-") *([Experimental](Common.md#Experimental))*
 **Type:** String
 
 
 
 Allowed Value|Description
 :------------|:----------
-[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
+[Input](./AI.xml#L93:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-")|The property is input for some recommendation
+[Output](./AI.xml#L97:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-")|The property or parameter is the target of some recommendation
+[InputOutput](./AI.xml#L101:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-")|The property is input for and the target of some recommendation
+[RequiredInput](./AI.xml#L105:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-")|The property is required input before any recommendations are requested
diff --git a/vocabularies/AI.xml b/vocabularies/AI.xml
@@ -59,17 +59,23 @@
       <ComplexType Name="PropertyRecommendationType" Abstract="true">
         <Annotation Term="Common.Experimental" />
         <Annotation Term="Core.Description" String="Base type containing AI-based recommendations for an entity type property" />
+        <Annotation Term="Core.LongDescription">
+          <String>Specializations of this base type have three properties:
+- a property that is the target of a [`Common.Text`](Common.md#Text) annotation, its name may differ from `AIRecommendedFieldValue`
+- a property to which the `Common.Text` annotation evaluates, its name may differ from `AIRecommendedFieldDescription`
+- a property named `AIRecommendedFieldScoreValue`.</String>
+        </Annotation>
         <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>
+            <String>In 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>
+            <String>In 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">