Clearly note that searches don't include payload/vector data by default

This commit is contained in:
timvisee
2023-08-17 10:18:32 +02:00
parent b7990e3639
commit 19c5ad183d
2 changed files with 11 additions and 3 deletions
@@ -137,6 +137,10 @@ Example result of this API would be
The `result` contains ordered by `score` list of found point ids. The `result` contains ordered by `score` list of found point ids.
Note that payload and vector data is missing in these results by default.
See [payload and vector in the result](#payload-and-vector-in-the-result) on how
to include it.
*Available as of v0.10.0* *Available as of v0.10.0*
If the collection was created with multiple vectors, the name of the vector to use for searching should be provided: If the collection was created with multiple vectors, the name of the vector to use for searching should be provided:
@@ -179,8 +183,9 @@ It will exclude all results with a score worse than the given.
### Payload and vector in the result ### Payload and vector in the result
By default, retrieval methods do not return any stored information. By default, retrieval methods do not return any stored information such as
Additional parameters `with_vectors` and `with_payload` could alter this behavior. payload and vectors. Additional parameters `with_vectors` and `with_payload`
alter this behavior.
Example: Example:
@@ -285,7 +285,10 @@ print(search_result[2])
# ScoredPoint(id=3, score=1.208, ...) # ScoredPoint(id=3, score=1.208, ...)
``` ```
But result is different if we add a filter: Note that payload and vector data is missing in these results by default.
See [payload and vector in the result](../concepts/search#payload-and-vector-in-the-result) on how to enable it.
But the result is different if we add a filter:
```bash ```bash
curl -L -X POST 'http://localhost:6333/collections/test_collection/points/search' \ curl -L -X POST 'http://localhost:6333/collections/test_collection/points/search' \