Skip to content
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

fix: Remove grounding module related types #270

Merged
merged 6 commits into from
Nov 7, 2024

Conversation

jjtang1985
Copy link
Contributor

@jjtang1985 jjtang1985 commented Nov 6, 2024

Context

This PR contains:

Definition of Done

  • Code is tested (Unit, E2E)
  • (Optional) Release notes updated

---
'@sap-ai-sdk/orchestration': minor
---
[Compatibility Note] Remove grounding module related types, which should not be used.
Copy link
Contributor

@deekshas8 deekshas8 Nov 7, 2024

Choose a reason for hiding this comment

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

[q] Do we really need a compatibility note? This was never part of the public api.
The fact that we also expose ModuleConfigs in index.ts is incorrect (unrelated to this PR).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For SDK user, I agree, it's not relevant, if they only use public APIs, so I deleted the compatibility notes.
I put it there, to make it transparent for those who noticed our grounding related code.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

will work on ModuleConfigs in a different PR.

@@ -9,7 +9,7 @@ import type { AzureContentSafety } from './azure-content-safety.js';
*/
export type AzureContentSafetyFilterConfig = {
/**
* String represents name of the filter provider.
* String represents name of the filter provider
Copy link
Contributor

Choose a reason for hiding this comment

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

[pp] I think these changes are fine for now. But it's better to have proper linted code. I would like to adjust our eslint config to fix such issues (and only disable consistent-typedefinitions rule).

Copy link
Contributor

@deekshas8 deekshas8 left a comment

Choose a reason for hiding this comment

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

LGTM. Please consider the comment about having the changeset.

@deekshas8 deekshas8 merged commit b850dc9 into main Nov 7, 2024
10 checks passed
@deekshas8 deekshas8 deleted the update-orchestration-spec-non-breaking branch November 7, 2024 14:48
@jjtang1985
Copy link
Contributor Author

Please consider the comment about having the changeset.

Removed already 😄

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.

2 participants