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

Hiding the model internal data when retrieving index settings if the model is a Marqtune model. #1018

Merged
merged 13 commits into from
Nov 5, 2024

Conversation

keshav
Copy link
Contributor

@keshav keshav commented Oct 21, 2024

  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
    This PR introduces a feature to hide internal model data if a model is flagged as a Marqtune model in the/indexes//settings response. Additionally, it includes tests to verify that the model's internal data is appropriately blocked for Marqtune models.

  • What is the current behavior? (You can also link to an open issue here)
    Currently, the model properties in index settings include internal model data, such as the model's name, dimensions, and model location, even if the model is a Marqtune model. This could expose internal model details that should remain within Marqo ecosystem.

  • What is the new behavior (if this is a feature change)?
    With this change, if a model is marked as a Marqtune model using the "isMarqtuneModel" property, the index settings API will block internal model data, returning only the "isMarqtuneModel": True property in the response. This aligns with internal implementation of Marqtune models.

  • Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
    No, this PR does not introduce a breaking change. Users can continue to access model properties as usual, with the exception that Marqtune model data is intentionally removed.

  • Other information:

    • Added new test cases to verify that internal model properties are hidden for Marqtune models.
    • Verified that non-Marqtune models retain all their original properties in the index settings response.
    • This change does not affect existing index structures or other API functionality.
  • Related Python client changes (link commit/PR here)
    NA

  • Related documentation changes (link commit/PR here)
    There is no documentation on this feature yet.

  • Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes/features)

@keshav keshav requested review from farshidz and wanliAlex October 21, 2024 23:25
@keshav keshav temporarily deployed to marqo-test-suite October 21, 2024 23:27 — with GitHub Actions Inactive
@keshav keshav temporarily deployed to marqo-test-suite October 21, 2024 23:27 — with GitHub Actions Inactive
@keshav keshav temporarily deployed to marqo-test-suite October 21, 2024 23:27 — with GitHub Actions Inactive
@keshav keshav requested a review from papa99do October 21, 2024 23:28
@keshav keshav temporarily deployed to marqo-test-suite November 5, 2024 21:51 — with GitHub Actions Inactive
@keshav keshav temporarily deployed to marqo-test-suite November 5, 2024 21:51 — with GitHub Actions Inactive
@keshav keshav temporarily deployed to marqo-test-suite November 5, 2024 21:51 — with GitHub Actions Inactive
@keshav keshav merged commit a31660c into mainline Nov 5, 2024
11 of 12 checks passed
@keshav keshav deleted the feature/MOC-413/block-model-internal-data branch November 5, 2024 23:37
vicilliar pushed a commit that referenced this pull request Nov 29, 2024
…model is a Marqtune model. (#1018)

Co-authored-by: Jesse Clark <[email protected]>
Co-authored-by: TomHamer <[email protected]>
Co-authored-by: Farshid Zavareh <[email protected]>
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