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

feat: add FeedbackDataset search endpoint #3068

Merged
merged 23 commits into from
Jun 5, 2023
Merged

Conversation

gabrielmbmb
Copy link
Member

@gabrielmbmb gabrielmbmb commented Jun 2, 2023

Description

This PR introduces a new endpoint POST /api/v1/me/datasets/{dataset_id}/records/search that will allow the user to search records using some basic queries over the fields.

Closes #3067

Type of change

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested

New unit tests have been added to test the functionality of this new endpoint. In addition, I manually tested the endpoint using the Argilla dolly dataset.

Checklist

  • I have merged the original branch into my forked branch
  • I added relevant documentation
  • follows the style guidelines of this project
  • I did a self-review of my code
  • I made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)

@gabrielmbmb gabrielmbmb added type: enhancement Indicates new feature requests area: api Indicates that an issue or pull request is related to the Fast API server or REST endpoints labels Jun 2, 2023
@gabrielmbmb gabrielmbmb changed the title Feature/search endpoint feat: add FeedbackDataset search endpoint Jun 2, 2023
@codecov
Copy link

codecov bot commented Jun 2, 2023

Codecov Report

Patch coverage: 97.95% and project coverage change: +0.02 🎉

Comparison is base (77e7f37) 90.77% compared to head (fc5a2b7) 90.79%.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #3068      +/-   ##
===========================================
+ Coverage    90.77%   90.79%   +0.02%     
===========================================
  Files          208      209       +1     
  Lines        11199    11237      +38     
===========================================
+ Hits         10166    10203      +37     
- Misses        1033     1034       +1     
Flag Coverage Δ
pytest 90.79% <97.95%> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/argilla/server/contexts/datasets.py 96.03% <90.00%> (-0.34%) ⬇️
src/argilla/server/apis/v1/handlers/datasets.py 100.00% <100.00%> (ø)
src/argilla/server/enums.py 100.00% <100.00%> (ø)
src/argilla/server/policies.py 99.25% <100.00%> (+0.01%) ⬆️
src/argilla/server/schemas/v1/datasets.py 100.00% <100.00%> (ø)
src/argilla/server/search_engine.py 90.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@gabrielmbmb gabrielmbmb marked this pull request as ready for review June 5, 2023 09:13
Co-authored-by: Francisco Aranda <francis@argilla.io>
Copy link
Member

Choose a reason for hiding this comment

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

We can keep this definition here, but maybe in the future, we should consider moving it into the search module.

@frascuchon frascuchon merged commit 185ba23 into develop Jun 5, 2023
@frascuchon frascuchon deleted the feature/search-endpoint branch June 5, 2023 16:43
davidberenstein1957 pushed a commit that referenced this pull request Jun 5, 2023
# Description

This PR introduces a new endpoint `POST
/api/v1/me/datasets/{dataset_id}/records/search` that will allow the
user to search records using some basic queries over the fields.

Closes #3067

**Type of change**

- [x] New feature (non-breaking change which adds functionality)

**How Has This Been Tested**

New unit tests have been added to test the functionality of this new
endpoint. In addition, I manually tested the endpoint using the Argilla
dolly dataset.

**Checklist**

- [x] I have merged the original branch into my forked branch
- [ ] I added relevant documentation
- [x] follows the style guidelines of this project
- [x] I did a self-review of my code
- [ ] I made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)

---------

Co-authored-by: Francisco Aranda <francis@argilla.io>
davidberenstein1957 pushed a commit that referenced this pull request Jun 7, 2023
# Description

This PR introduces a new endpoint `POST
/api/v1/me/datasets/{dataset_id}/records/search` that will allow the
user to search records using some basic queries over the fields.

Closes #3067

**Type of change**

- [x] New feature (non-breaking change which adds functionality)

**How Has This Been Tested**

New unit tests have been added to test the functionality of this new
endpoint. In addition, I manually tested the endpoint using the Argilla
dolly dataset.

**Checklist**

- [x] I have merged the original branch into my forked branch
- [ ] I added relevant documentation
- [x] follows the style guidelines of this project
- [x] I did a self-review of my code
- [ ] I made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)

---------

Co-authored-by: Francisco Aranda <francis@argilla.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: api Indicates that an issue or pull request is related to the Fast API server or REST endpoints type: enhancement Indicates new feature requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feedback Dataset search endpoint
2 participants