adds include_vector to .query()

[dan-jacobson]

What kind of change does this PR introduce?

Feature: adds a include_vector argument to the collections.query() method. Defaults false, but it'll return the actual vector along with the ids.

What is the current behavior?

Current behavior is you can't get back the vectors along with the ids in the response. See the issue I made.

What is the new behavior?

You can get back the vector itself.

Additional context

Ideally I'd actually re-order some of the include_* on the query method. I think the best ordering is:

include_vector,
include_metadata,
include_score.

Because that way if you want to get everything back, you still get the (id, vec, metadata) in the same order as the original record, just with score appended. However, I think that'd technically be a breaking change because of re-ordering returns.

Idk, I don't feel that strongly about it.

[dan-jacobson]

@olirice what do you think?

[wang-sanity]

nice feature... getting vectors back would be great and matches with the behavior of most other vector db libs. right now I have to re-query the point ids again to get the vectors back

[olirice]

Could you give me an example of where its important to get the actual vector back?

[olirice]

new arguments have to go at the end of the args list but before kwargs. Otherwise, the meaning of

bar.query(
        data=query_vec,
        limit=top_k,
        filters=None,
        measure="cosine_distance",
        True,
        True
)

would change

[wang-sanity]

use case - say we have the financial report of a company, and we vectorize the doc into N chunks. From here, one simple way to construct a vector representation of the company is to take the average of these N chunks, for which we need the query to return the raw vectors themselves.

[olirice]

to get the pre-commit hooks to pass you can run

pip install pre-commit
pre-commit install
pre-commit run --all

then commit the changes it makes and push that back up

[dan-jacobson]

Oops, that's my bad. Linted and pushed.

[dan-jacobson]

Just bumping this -- I'm pretty sure it's ready to merge :)

[olirice]

Could you please update the corresponding docs for the query function?