-
Notifications
You must be signed in to change notification settings - Fork 0
Update README files #112
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
Open
lisajulia
wants to merge
3
commits into
chore/import-sap-document-ai
Choose a base branch
from
adapt-readme-files
base: chore/import-sap-document-ai
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Update README files #112
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| # cds-starter-ai | ||
|
|
||
| A zero-source convenience module that bundles all SAP AI plugins for CAP Java into a single dependency. | ||
|
Schmarvinius marked this conversation as resolved.
|
||
|
|
||
| ## What it includes | ||
|
|
||
| | Module | Scope | Description | | ||
| |---|---|---| | ||
| | [`cds-feature-ai-core`](../cds-feature-ai-core/README.md) | `compile` | Bridges CAP Java to SAP AI Core — resource groups, deployments, configurations, inference client | | ||
| | [`cds-feature-recommendations`](../cds-feature-recommendations/README.md) | `runtime` | AI-powered field recommendations for Fiori Elements draft UIs | | ||
|
|
||
| `cds-feature-sap-document-ai` is currently **not** included as the plugin is not yet fully multi-tenant-ready. It will be added to the starter once MT support is complete. Add it as an explicit dependency if you need it today. | ||
|
|
||
| ## Setup | ||
|
|
||
| ```xml | ||
| <dependency> | ||
| <groupId>com.sap.cds</groupId> | ||
| <artifactId>cds-starter-ai</artifactId> | ||
| <version>${cds-ai.version}</version> | ||
| </dependency> | ||
| ``` | ||
|
|
||
| Both plugins auto-register via Java's `ServiceLoader` — no further code changes are required. | ||
|
|
||
| For the Node.js side of `cds-feature-recommendations`, also add the `@cap-js/ai` CDS plugin to your `package.json`: | ||
|
|
||
| ```json | ||
| { | ||
| "dependencies": { | ||
| "@cap-js/ai": "^1" | ||
| } | ||
| } | ||
| ``` | ||
|
lisajulia marked this conversation as resolved.
|
||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Java 17+ | ||
| - CAP Java 4.9+ | ||
| - An [SAP AI Core](https://help.sap.com/docs/sap-ai-core) service binding (for production use) | ||
| - A [SAP Document Information Extraction](https://help.sap.com/docs/document-ai) service binding (once `cds-feature-sap-document-ai` is included) | ||
|
Schmarvinius marked this conversation as resolved.
|
||
|
|
||
| Without the respective bindings the plugins fall back to mock implementations — useful for local development. | ||
|
|
||
| ## Related | ||
|
|
||
| - [SAP AI Core Documentation](https://help.sap.com/docs/sap-ai-core) | ||
| - [SAP AI SDK for Java](https://github.com/SAP/ai-sdk-java) | ||
| - [`cds-feature-sap-document-ai`](../cds-feature-sap-document-ai/README.md) — standalone document extraction plugin | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.