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: retrieve vectors when fetching records #4063

Conversation

jfcalvo
Copy link
Member

@jfcalvo jfcalvo commented Oct 26, 2023

Description

This PR add support to include=vectors and include=vectors:vector_settings_id_01,vector_settings_id_02 parameters in the following endpoints:

  • GET /api/v1/datasets/:dataset_id/records
  • GET /api/v1/me/datasets/:dataset_id/records
  • GET /api/v1/me/datasets/:dataset_id/records/search

Possible improvements to this PR:

  • Use vector names instead of vector settings ids for include like include=vectors:vector_name_01,vector_name_02.
  • Add support for include parameter to GET /api/v1/records/:record_id endpoint.

Closes #4051

Type of change

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

How Has This Been Tested

  • Running tests locally.

Checklist

  • 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 filled out the contributor form (see text above)
  • I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)

@jfcalvo jfcalvo marked this pull request as ready for review October 27, 2023 14:30
@github-actions
Copy link

The URL of the deployed environment for this PR is https://argilla-quickstart-pr-4063-ki24f765kq-no.a.run.app

@jfcalvo jfcalvo merged commit 9dd3522 into feature/feedback-dataset-semantic-similarity Oct 30, 2023
16 checks passed
@jfcalvo jfcalvo deleted the feature/retrieve-vectors-when-fetching-records branch October 30, 2023 14:33
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.

3 participants