-
Notifications
You must be signed in to change notification settings - Fork 0
Comments from #49: Document changes #67
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -40,9 +40,12 @@ Or use the starter that bundles this with `cds-feature-ai-core`: | |||||||||||
| - An [SAP AI Core](https://help.sap.com/docs/sap-ai-core) service binding (see [`cds-feature-ai-core`](../cds-feature-ai-core/README.md)) | ||||||||||||
| - Entity must be **draft-enabled** (`@odata.draft.enabled`) | ||||||||||||
| - At least one field annotated with a **value list** | ||||||||||||
| - The `@cap-js/ai` CDS plugin must be installed (provides the model enhancement that adds `SAP_Recommendations` as a navigation property) | ||||||||||||
| - The `SAP_Recommendations` navigation property must be added to the entities that should receive recommendations by | ||||||||||||
| - either installing the `@cap-js/ai` CDS plugin (automatically provides the model enhancement that adds `SAP_Recommendations` as a navigation property) | ||||||||||||
| - or adding the `SAP_Recommendations`property manually. | ||||||||||||
| Without the `SAP_Recommendations` navigation property, the predictions will be computed but not serialized in OData responses. | ||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Clarity / Logic: The "Without the The indentation on line 46 (
Suggested change
Double-check suggestion before committing. Edit this comment for amendments. Please provide feedback on the review comment by checking the appropriate box:
|
||||||||||||
|
|
||||||||||||
| ### CDS Plugin | ||||||||||||
| #### CDS Plugin | ||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Inconsistency: The "CDS Plugin" and "Adding the SAP_Recommendations…" sections are headed with Consider restoring "CDS Plugin" and "Adding the SAP_Recommendations navigation property manually" as
Suggested change
Double-check suggestion before committing. Edit this comment for amendments. Please provide feedback on the review comment by checking the appropriate box:
|
||||||||||||
|
|
||||||||||||
| Add `@cap-js/ai` to your project's `package.json`: | ||||||||||||
|
|
||||||||||||
|
|
@@ -55,7 +58,7 @@ Add `@cap-js/ai` to your project's `package.json`: | |||||||||||
| } | ||||||||||||
| ``` | ||||||||||||
|
|
||||||||||||
| Then run `npm install`. The plugin hooks into the CDS compiler and automatically adds the `SAP_Recommendations` navigation property to draft-enabled entities that have value-list fields. Without this plugin, predictions will be computed but not serialized in OData responses. | ||||||||||||
| Then run `npm install`. The plugin hooks into the CDS compiler and automatically adds the `SAP_Recommendations` navigation property to draft-enabled entities that have value-list fields. | ||||||||||||
|
|
||||||||||||
| Since the Java module `cds-feature-ai-core` already provides the `AICore` service CDS model, disable the duplicate model from `@cap-js/ai` in your `.cdsrc.json`: | ||||||||||||
|
|
||||||||||||
|
|
@@ -68,6 +71,41 @@ Since the Java module `cds-feature-ai-core` already provides the `AICore` servic | |||||||||||
| } | ||||||||||||
| } | ||||||||||||
| ``` | ||||||||||||
| #### Adding the SAP_Recommendations navigation property manually | ||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Formatting: Missing blank line before the new The new
Suggested change
Double-check suggestion before committing. Edit this comment for amendments. Please provide feedback on the review comment by checking the appropriate box:
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Inconsistency: The heading level for the new manual section should match the restored
Suggested change
Double-check suggestion before committing. Edit this comment for amendments. Please provide feedback on the review comment by checking the appropriate box:
|
||||||||||||
|
|
||||||||||||
| If you cannot use the CDS plugin, add the `SAP_Recommendations` navigation property directly in your CDS model. You need to: | ||||||||||||
|
|
||||||||||||
| 1. **Define a `RecommendationItem_*` type** for each CDS primitive type used by your value-list fields. Each type must contain the four fixed fields shown below — only `RecommendedFieldValue` varies by type. | ||||||||||||
| 2. **Extend each target entity** with a `SAP_Recommendations` composition that has one entry per value-list field, using the field name as the property name and the matching `RecommendationItem_*` type. | ||||||||||||
|
|
||||||||||||
| The property names inside `SAP_Recommendations` must exactly match the field names on the entity (e.g. `genre_ID`, `author_ID`). | ||||||||||||
|
|
||||||||||||
| ```cds | ||||||||||||
| // Define one type per CDS primitive used by your value-list fields | ||||||||||||
| type RecommendationItem_Integer { | ||||||||||||
| RecommendedFieldValue : Integer; | ||||||||||||
| RecommendedFieldDescription : String; | ||||||||||||
| RecommendedFieldScoreValue : Decimal; | ||||||||||||
| RecommendedFieldIsSuggestion: Boolean; | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
| type RecommendationItem_UUID { | ||||||||||||
| RecommendedFieldValue : UUID; | ||||||||||||
| RecommendedFieldDescription : String; | ||||||||||||
| RecommendedFieldScoreValue : Decimal; | ||||||||||||
| RecommendedFieldIsSuggestion: Boolean; | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
| // Extend your entity — one entry per value-list field | ||||||||||||
| extend my.Books with { | ||||||||||||
| SAP_Recommendations: Composition of one { | ||||||||||||
| genre_ID : many RecommendationItem_Integer; | ||||||||||||
| author_ID: many RecommendationItem_UUID; | ||||||||||||
| } | ||||||||||||
| } | ||||||||||||
| ``` | ||||||||||||
|
|
||||||||||||
| See also the [SAP Fiori Elements – Recommendations documentation](https://help.sap.com/docs/SAPUI5/b2f662dd9d7a4ec680056733050b4d34/1a6324d5ad7f4034a93f911b4e53e080.html). | ||||||||||||
|
|
||||||||||||
| ## Enabling Recommendations | ||||||||||||
|
|
||||||||||||
|
|
||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: Missing space before
propertyin the bullet pointSAP_Recommendationspropertyis missing a space between the backtick and the wordproperty`. This makes the sentence read awkwardly and the missing space may confuse readers skimming the text.Consider adding the missing space.
Double-check suggestion before committing. Edit this comment for amendments.
Please provide feedback on the review comment by checking the appropriate box: