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

[ENH] Add reqeust metadata to query and get vectors #2069

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Ishiihara
Copy link
Contributor

@Ishiihara Ishiihara commented Apr 26, 2024

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • This PR changes the proto definition to include collection_version and log_position as request metadata.
  • New functionality
    • ...

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

Copy link
Contributor Author

Ishiihara commented Apr 26, 2024

Copy link

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

@Ishiihara Ishiihara marked this pull request as ready for review April 26, 2024 22:11
@Ishiihara Ishiihara force-pushed the liquan_cache_invalidation_proto branch from 5eb28ce to 34d989e Compare April 26, 2024 22:14
@Ishiihara Ishiihara force-pushed the liquan_cache_invalidation_proto branch from 65206f1 to 46b770f Compare April 26, 2024 23:20
message GetVectorsRequest {
repeated string ids = 1;
string segment_id = 2;
optional RequestMetadata query_metadata = 3;
Copy link
Collaborator

@HammadB HammadB Apr 26, 2024

Choose a reason for hiding this comment

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

should we just make this part of the contract rather than shoving it in

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.

None yet

2 participants