Skip to content

Commit

Permalink
Update docs with select star option
Browse files Browse the repository at this point in the history
  • Loading branch information
nuric committed Sep 8, 2024
1 parent d203f1d commit 2977cac
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/content/docs/search/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ To search for points / documents in SemaDB, we make a post request to the search
The overall request consists of the following parts:

- **Query**: What to search for and how? This can be a text query, a vector query, or a hybrid query.
- **Select** (optional): What fields to return in the search results. It is often common to not return all fields in the search results, especially vector fields. You can select nested fields using the dot notation such as `nested.field` but they will be returned flattened to the top level for ease of access.
- **Select** (optional): What fields to return in the search results. It is often common to not return all fields in the search results, especially vector fields. You can select nested fields using the dot notation such as `nested.field` or use `*` to select all fields.
- If you don't select any fields, only the `_id` field along with any scoring / distance fields will be returned.
- **Sort** (optional): How to sort the search results. This can be based on a field or a distance from a vector. Any sort fields must be *selected* first.
- **Offset** (optional): How many results to skip from the beginning of the overall search results.
- **Limit**: How many results to return from the search results.
Expand Down

0 comments on commit 2977cac

Please sign in to comment.