AI prefixes

SAP · Oct 4, 2023 · aaf2fee · aaf2fee
1 parent 02fb049
commit aaf2fee
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 46 deletions.
diff --git a/docs/recommendations.md b/docs/recommendations.md
@@ -1,4 +1,4 @@
-Invocation flow for a recommendations function implementing the signature of [`Common.GetRecommendations`](../vocabularies/Common.md#GetRecommendations)
+Invocation flow for a recommendations function implementing the signature of [`Common.AIRecommendations`](../vocabularies/Common.md#AIRecommendations)
 
 ```mermaid
 sequenceDiagram

diff --git a/vocabularies/Common.json b/vocabularies/Common.json
@@ -1302,36 +1302,36 @@
           { "$Name": "Entity", "$Type": "Edm.EntityType" },
           {
             "$Name": "Targets",
-            "$Type": "Common.RecommendationsTargetsType",
+            "$Type": "Common.AIRecommendationsTargetsType",
             "@Core.Description": "Entities, properties or action/function parameters for which recommendations shall be retrieved",
             "@Core.LongDescription": "Implementations of this function MAY omit this parameter.\n            If this parameter is omitted (by the implementation or in the invocation), all recommendations are retrieved.",
             "@Core.OptionalParameter": {}
           }
         ],
         "$ReturnType": {
           "$Collection": true,
-          "$Type": "Common.PropertyRecommendationType",
+          "$Type": "Common.PropertyAIRecommendationType",
           "@Core.Description": "A collection of recommendations that differ in their `AIRecommendedFieldPath` property"
         }
       }
     ],
-    "RecommendationsTargetsType": {
+    "AIRecommendationsTargetsType": {
       "$Kind": "ComplexType",
       "@Common.Experimental": true,
       "URLs": {
         "$Collection": true,
         "@Core.IsURL": true,
         "@Core.Description": "URLs (relative to the request URL) that address entities, properties or action/function parameters for which recommendations shall be retrieved",
-        "@Core.LongDescription": "The request `SalesOrder('A')/ns.GetRecommendations?Targets={\"URLs\":[\"\",\"Items(10)\"]}`\n            retrieves recommendations for the entities `SalesOrder('A')` and `SalesOrder('A')/Items(10)`."
+        "@Core.LongDescription": "The request `SalesOrder('A')/ns.AIRecommendations?Targets={\"URLs\":[\"\",\"Items(10)\"]}`\n            retrieves recommendations for the entities `SalesOrder('A')` and `SalesOrder('A')/Items(10)`."
       }
     },
-    "PropertyRecommendationType": {
+    "PropertyAIRecommendationType": {
       "$Kind": "ComplexType",
       "@Common.Experimental": true,
       "AIRecommendedFieldPath": {
         "@Core.IsURL": true,
-        "@Core.Description": "URL (relative to the URL of the [`GetRecommendations`](#GetRecommendations) function request) addressing a property [OData-URL, section 4.6](https://docs.oasis-open.org/odata/odata/v4.01/os/part2-url-conventions/odata-v4.01-os-part2-url-conventions.html#sec_AddressingaProperty) that is targeted by this recommendation",
-        "@Core.LongDescription": "The request `SalesOrder('A')/ns.GetRecommendations?Targets=...`\n            might retrieve a recommendation with `\"AIRecommendedFieldPath\": \"Items(10)/Product\"`."
+        "@Core.Description": "URL (relative to the URL of the [`AIRecommendations`](#AIRecommendations) function request) addressing a property [OData-URL, section 4.6](https://docs.oasis-open.org/odata/odata/v4.01/os/part2-url-conventions/odata-v4.01-os-part2-url-conventions.html#sec_AddressingaProperty) that is targeted by this recommendation",
+        "@Core.LongDescription": "The request `SalesOrder('A')/ns.AIRecommendations?Targets=...`\n            might retrieve a recommendation with `\"AIRecommendedFieldPath\": \"Items(10)/Product\"`."
       },
       "AIRecommendedFieldValue": {
         "@Core.Description": "Recommended value, converted to string",
@@ -1343,12 +1343,12 @@
       },
       "AIAltvRecmddFldVals": {
         "$Collection": true,
-        "$Type": "Common.AlternativeRecommendationType",
+        "$Type": "Common.AlternativeAIRecommendationType",
         "@Core.Description": "A list of alternative values, sorted by confidence score in descending order",
         "@Core.LongDescription": "If a value is recommended via property `AIRecommendedFieldValue`, it must be the first entry in this list."
       }
     },
-    "AlternativeRecommendationType": {
+    "AlternativeAIRecommendationType": {
       "$Kind": "ComplexType",
       "@Common.Experimental": true,
       "AIRecommendedFieldValue": { "@Core.Description": "Alternatively recommended value, converted to string" },
@@ -1358,14 +1358,14 @@
         "@Core.Description": "Confidence score of the alternatively recommended value"
       }
     },
-    "RecommendationsRole": {
+    "AIRecommendationsRole": {
       "$Kind": "Term",
-      "$Type": "Common.RecommendationsRoleType",
+      "$Type": "Common.AIRecommendationsRoleType",
       "$AppliesTo": ["Property", "Parameter"],
       "@Common.Experimental": true,
       "@Core.Description": "Role of this property or parameter regarding AI-based recommendations"
     },
-    "RecommendationsRoleType": {
+    "AIRecommendationsRoleType": {
       "$Kind": "TypeDefinition",
       "$UnderlyingType": "Edm.String",
       "@Common.Experimental": true,

diff --git a/vocabularies/Common.md b/vocabularies/Common.md
@@ -110,7 +110,7 @@ Term|Type|Description
 [mediaUploadLink](./Common.xml#L1431:~:text=<Term%20Name="-,mediaUploadLink,-") *([Experimental](Common.md#Experimental))*|URL|<a name="mediaUploadLink"></a>URL for uploading new media content to a Document Management Service<br>In contrast to the `@odata.mediaEditLink` this URL allows to upload new media content without directly changing a stream property or media resource. The upload request typically uses HTTP POST with `Content-Type: multipart/form-data` following RFC 7578. The upload request must contain one multipart representing the content of the file. The `name` parameter in the `Content-Disposition` header (as described in RFC 7578) is irrelevant, but the `filename` parameter is expected. If the request succeeds the response will contain a JSON body of `Content-Type: application/json` with a JSON property `readLink`. The newly uploaded media resource can be linked to the stream property by changing the `@odata.mediaReadLink` to the value of this `readLink` in a subsequent PATCH request to the OData entity.
 [PrimitivePropertyPath](./Common.xml#L1446:~:text=<Term%20Name="-,PrimitivePropertyPath,-") *([Experimental](Common.md#Experimental))*|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|<a name="PrimitivePropertyPath"></a>A term or term property with this tag whose type is (a collection of) `Edm.PropertyPath` MUST resolve to a primitive structural property
 [WebSocketBaseURL](./Common.xml#L1451:~:text=<Term%20Name="-,WebSocketBaseURL,-") *([Experimental](Common.md#Experimental))*|URL|<a name="WebSocketBaseURL"></a>Base URL for WebSocket connections
-[RecommendationsRole](./Common.xml#L1529:~:text=<Term%20Name="-,RecommendationsRole,-") *([Experimental](Common.md#Experimental))*|[RecommendationsRoleType](#RecommendationsRoleType)|<a name="RecommendationsRole"></a>Role of this property or parameter regarding AI-based recommendations
+[AIRecommendationsRole](./Common.xml#L1529:~:text=<Term%20Name="-,AIRecommendationsRole,-") *([Experimental](Common.md#Experimental))*|[AIRecommendationsRoleType](#AIRecommendationsRoleType)|<a name="AIRecommendationsRole"></a>Role of this property or parameter regarding AI-based recommendations
 
 
 ## Functions
@@ -125,8 +125,8 @@ The function SHOULD compute the recommendations asynchronously, see [this diagra
 Parameter|Type|Description
 :--------|:---|:----------
 **[Entity](./Common.xml#L1470:~:text=<Function%20Name="-,AIRecommendations,-")**|EntityType|**Binding parameter**
-*[Targets](./Common.xml#L1471:~:text=<Function%20Name="-,AIRecommendations,-")*|[RecommendationsTargetsType](#RecommendationsTargetsType)|*Optional parameter:* Entities, properties or action/function parameters for which recommendations shall be retrieved<br>Implementations of this function MAY omit this parameter. If this parameter is omitted (by the implementation or in the invocation), all recommendations are retrieved.
-[&rarr;](./Common.xml#L1481:~:text=<Function%20Name="-,AIRecommendations,-")|\[[PropertyRecommendationType](#PropertyRecommendationType)\]|A collection of recommendations that differ in their `AIRecommendedFieldPath` property
+*[Targets](./Common.xml#L1471:~:text=<Function%20Name="-,AIRecommendations,-")*|[AIRecommendationsTargetsType](#AIRecommendationsTargetsType)|*Optional parameter:* Entities, properties or action/function parameters for which recommendations shall be retrieved<br>Implementations of this function MAY omit this parameter. If this parameter is omitted (by the implementation or in the invocation), all recommendations are retrieved.
+[&rarr;](./Common.xml#L1481:~:text=<Function%20Name="-,AIRecommendations,-")|\[[PropertyAIRecommendationType](#PropertyAIRecommendationType)\]|A collection of recommendations that differ in their `AIRecommendedFieldPath` property
 
 
 <a name="TextFormatType"></a>
@@ -448,43 +448,43 @@ Use terms [Aggregation.RecursiveHierarchy](https://github.com/oasis-tcs/odata-vo
 
 User ID
 
-<a name="RecommendationsTargetsType"></a>
-## [RecommendationsTargetsType](./Common.xml#L1485:~:text=<ComplexType%20Name="-,RecommendationsTargetsType,-") *([Experimental](Common.md#Experimental))*
+<a name="AIRecommendationsTargetsType"></a>
+## [AIRecommendationsTargetsType](./Common.xml#L1485:~:text=<ComplexType%20Name="-,AIRecommendationsTargetsType,-") *([Experimental](Common.md#Experimental))*
 
 
 Property|Type|Description
 :-------|:---|:----------
-[URLs](./Common.xml#L1487:~:text=<ComplexType%20Name="-,RecommendationsTargetsType,-")|\[URL\]|URLs (relative to the request URL) that address entities, properties or action/function parameters for which recommendations shall be retrieved<br>The request `SalesOrder('A')/ns.GetRecommendations?Targets={"URLs":["","Items(10)"]}` retrieves recommendations for the entities `SalesOrder('A')` and `SalesOrder('A')/Items(10)`.
+[URLs](./Common.xml#L1487:~:text=<ComplexType%20Name="-,AIRecommendationsTargetsType,-")|\[URL\]|URLs (relative to the request URL) that address entities, properties or action/function parameters for which recommendations shall be retrieved<br>The request `SalesOrder('A')/ns.AIRecommendations?Targets={"URLs":["","Items(10)"]}` retrieves recommendations for the entities `SalesOrder('A')` and `SalesOrder('A')/Items(10)`.
 
-<a name="PropertyRecommendationType"></a>
-## [PropertyRecommendationType](./Common.xml#L1496:~:text=<ComplexType%20Name="-,PropertyRecommendationType,-") *([Experimental](Common.md#Experimental))*
+<a name="PropertyAIRecommendationType"></a>
+## [PropertyAIRecommendationType](./Common.xml#L1496:~:text=<ComplexType%20Name="-,PropertyAIRecommendationType,-") *([Experimental](Common.md#Experimental))*
 
 
 Property|Type|Description
 :-------|:---|:----------
-[AIRecommendedFieldPath](./Common.xml#L1498:~:text=<ComplexType%20Name="-,PropertyRecommendationType,-")|URL|URL (relative to the URL of the [`GetRecommendations`](#GetRecommendations) function request) addressing a property [OData-URL, section 4.6](https://docs.oasis-open.org/odata/odata/v4.01/os/part2-url-conventions/odata-v4.01-os-part2-url-conventions.html#sec_AddressingaProperty) that is targeted by this recommendation<br>The request `SalesOrder('A')/ns.GetRecommendations?Targets=...` might retrieve a recommendation with `"AIRecommendedFieldPath": "Items(10)/Product"`.
-[AIRecommendedFieldValue](./Common.xml#L1506:~:text=<ComplexType%20Name="-,PropertyRecommendationType,-")|String|Recommended value, converted to string
-[AIRecommendedFieldDescription](./Common.xml#L1510:~:text=<ComplexType%20Name="-,PropertyRecommendationType,-")|String?|Description of the recommended value
-[AIAltvRecmddFldVals](./Common.xml#L1513:~:text=<ComplexType%20Name="-,PropertyRecommendationType,-")|\[[AlternativeRecommendationType](#AlternativeRecommendationType)\]|A list of alternative values, sorted by confidence score in descending order<br>If a value is recommended via property `AIRecommendedFieldValue`, it must be the first entry in this list.
+[AIRecommendedFieldPath](./Common.xml#L1498:~:text=<ComplexType%20Name="-,PropertyAIRecommendationType,-")|URL|URL (relative to the URL of the [`AIRecommendations`](#AIRecommendations) function request) addressing a property [OData-URL, section 4.6](https://docs.oasis-open.org/odata/odata/v4.01/os/part2-url-conventions/odata-v4.01-os-part2-url-conventions.html#sec_AddressingaProperty) that is targeted by this recommendation<br>The request `SalesOrder('A')/ns.AIRecommendations?Targets=...` might retrieve a recommendation with `"AIRecommendedFieldPath": "Items(10)/Product"`.
+[AIRecommendedFieldValue](./Common.xml#L1506:~:text=<ComplexType%20Name="-,PropertyAIRecommendationType,-")|String|Recommended value, converted to string
+[AIRecommendedFieldDescription](./Common.xml#L1510:~:text=<ComplexType%20Name="-,PropertyAIRecommendationType,-")|String?|Description of the recommended value
+[AIAltvRecmddFldVals](./Common.xml#L1513:~:text=<ComplexType%20Name="-,PropertyAIRecommendationType,-")|\[[AlternativeAIRecommendationType](#AlternativeAIRecommendationType)\]|A list of alternative values, sorted by confidence score in descending order<br>If a value is recommended via property `AIRecommendedFieldValue`, it must be the first entry in this list.
 
-<a name="AlternativeRecommendationType"></a>
-## [AlternativeRecommendationType](./Common.xml#L1520:~:text=<ComplexType%20Name="-,AlternativeRecommendationType,-") *([Experimental](Common.md#Experimental))*
+<a name="AlternativeAIRecommendationType"></a>
+## [AlternativeAIRecommendationType](./Common.xml#L1520:~:text=<ComplexType%20Name="-,AlternativeAIRecommendationType,-") *([Experimental](Common.md#Experimental))*
 
 
 Property|Type|Description
 :-------|:---|:----------
-[AIRecommendedFieldValue](./Common.xml#L1522:~:text=<ComplexType%20Name="-,AlternativeRecommendationType,-")|String|Alternatively recommended value, converted to string
-[AIRecommendedFieldScore](./Common.xml#L1525:~:text=<ComplexType%20Name="-,AlternativeRecommendationType,-")|Decimal?|Confidence score of the alternatively recommended value
+[AIRecommendedFieldValue](./Common.xml#L1522:~:text=<ComplexType%20Name="-,AlternativeAIRecommendationType,-")|String|Alternatively recommended value, converted to string
+[AIRecommendedFieldScore](./Common.xml#L1525:~:text=<ComplexType%20Name="-,AlternativeAIRecommendationType,-")|Decimal?|Confidence score of the alternatively recommended value
 
-<a name="RecommendationsRoleType"></a>
-## [RecommendationsRoleType](./Common.xml#L1533:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-") *([Experimental](Common.md#Experimental))*
+<a name="AIRecommendationsRoleType"></a>
+## [AIRecommendationsRoleType](./Common.xml#L1533:~:text=<TypeDefinition%20Name="-,AIRecommendationsRoleType,-") *([Experimental](Common.md#Experimental))*
 **Type:** String
 
 
 
 Allowed Value|Description
 :------------|:----------
-[Input](./Common.xml#L1537:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-")|The property is input for some recommendation
-[Output](./Common.xml#L1541:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-")|The property or parameter is the target of some recommendation
-[InputOutput](./Common.xml#L1545:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-")|The property is input for and the target of some recommendation
-[RequiredInput](./Common.xml#L1549:~:text=<TypeDefinition%20Name="-,RecommendationsRoleType,-")|The property is required input before any recommendations are requested
+[Input](./Common.xml#L1537:~:text=<TypeDefinition%20Name="-,AIRecommendationsRoleType,-")|The property is input for some recommendation
+[Output](./Common.xml#L1541:~:text=<TypeDefinition%20Name="-,AIRecommendationsRoleType,-")|The property or parameter is the target of some recommendation
+[InputOutput](./Common.xml#L1545:~:text=<TypeDefinition%20Name="-,AIRecommendationsRoleType,-")|The property is input for and the target of some recommendation
+[RequiredInput](./Common.xml#L1549:~:text=<TypeDefinition%20Name="-,AIRecommendationsRoleType,-")|The property is required input before any recommendations are requested