Skip to content

Add @Consumption.aiHint annotation to consumption vocabulary - #186

Open
vyshnavigadamsetti wants to merge 2 commits into
mainfrom
add-consumption-ai-hint
Open

Add @Consumption.aiHint annotation to consumption vocabulary#186
vyshnavigadamsetti wants to merge 2 commits into
mainfrom
add-consumption-ai-hint

Conversation

@vyshnavigadamsetti

Copy link
Copy Markdown
Member

Added

  • Added @Consumption.aiHint annotation for AI consumption hints
    • Provides a free-text hint for AI consumers (e.g., LLMs or AI agents) on how to use or interpret an Entity, Type, or Service — kept separate from human-readable @EndUserText descriptions
    • For JSON-based metadata formats, the corresponding property is x-sap-ai-hint

Changes from #169

This supersedes #169. Based on review feedback from @frankejoe:

  • @Consumption.aiHint is added directly to the existing consumption.md/consumption.yaml files rather than a separate @AI vocabulary
  • Annotation name follows CDS camelCase convention (aiHint instead of AIHint)

Closes #169

- Added @Consumption.aiHint to consumption.yaml and consumption.md
- Follows CDS camelCase convention (aiHint, not AIHint)
- Placed in existing @consumption vocabulary per review feedback on #169
@open-resource-discovery-bot

open-resource-discovery-bot commented Jul 24, 2026

Copy link
Copy Markdown
PR Preview

QR code for preview link

🚀 View preview at:
https://sap.github.io/csn-interop-pr-preview/csn-interop-specification/pr-186/

Built to branch main at 2026-07-28 12:05 UTC.
open-resource-discovery/pr-preview-action

Comment thread spec/v1/annotations/consumption.md Outdated
Comment on lines +7 to +11
## Annotations Overview

| Annotation | Targets | Description |
| ----------------------- | --------------------- | -------------------------------------------------------------------------------- |
| `@Consumption.aiHint` | Entity, Type, Service | Free-text hint for AI consumers on how to use or interpret the annotated element |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure we need this, as we already get a autogenerated table / ToC. Can you check for consistency with other vocabularies?

But it's good that you add a dedicated description for the aiHint. It -might- be better put to an .outro.md, but not sure.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

checked other vocabularies and none have a manual one. Removed the overview table. Kept the @Consumption.aiHint section in consumption.md for now

@frankejoe frankejoe left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vyshnavigadamsetti : we need to wait until the annotatoin change request is approved

But thereafter I am fine with the definition

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants