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

Improve description of vector parameters in update collection REST call #2765

Merged
merged 1 commit into from
Oct 5, 2023

Conversation

timvisee
Copy link
Member

@timvisee timvisee commented Oct 5, 2023

Updates the description of the vector parameters map in the update collection REST call. This changes our OpenAPI specification, but only modifies the description.

Here, users must provide a map of named vectors. Therefore, the current description is wrong. It was also confusing how to update parameters in a collection with a single unnamed vector.

This changes the description from:

Vector data parameters to update. It is possible to provide one config for single vector mode and list of configs for multiple vectors mode.

to:

Map of vector data parameters to update for each named vector. To update parameters in a collection having a single unnamed vector, use an empty string as name.

The description is presented here (vectors field): https://qdrant.github.io/qdrant/redoc/index.html#tag/collections/operation/update_collection

Requested in Discord: https://discord.com/channels/907569970500743200/1151909233793704068/1159432223049662496

All Submissions:

  • Contributions should target the dev branch. Did you create your branch from dev?
  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?

@timvisee timvisee requested review from agourlay and generall October 5, 2023 12:27
@timvisee timvisee force-pushed the improve-update-collection-vectors-description branch from 2bc830c to 4d4401f Compare October 5, 2023 12:37
@agourlay agourlay merged commit 97b8964 into dev Oct 5, 2023
@agourlay agourlay deleted the improve-update-collection-vectors-description branch October 5, 2023 15:39
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