Skip to content

docs(query): document that limit=0 uses the server's default limit #2164

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.

Sign up for GitHub

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

Open
g-despot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(query): document that limit=0 uses the server's default limit #2164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion weaviate/collections/queries/bm25/generate/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,7 @@ def bm25(
grouped_task: The prompt to use for RaG on the entire result set.
grouped_properties: The properties to use in the RaG on the entire result set.
query_properties: The properties to search in. If not specified, all properties are searched.
limit: The maximum number of results to return. If not specified, the default limit specified by the server is returned.
limit: The maximum number of results to return. If not specified or set to `0`, the server's default limit is used.
offset: The offset to start from. If not specified, the retrieval begins from the first object in the server.
auto_limit: The maximum number of [autocut](https://weaviate.io/developers/weaviate/api/graphql/additional-operators#autocut) results to return. If not specified, no limit is applied.
filters: The filters to apply to the search.
Expand Down
2 changes: 1 addition & 1 deletion weaviate/collections/queries/bm25/query/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ def bm25(
Args:
query: The keyword-based query to search for, REQUIRED. If None, a normal search will be performed.
query_properties: The properties to search in. If not specified, all properties are searched.
limit: The maximum number of results to return. If not specified, the default limit specified by the server is returned.
limit: The maximum number of results to return. If not specified or set to `0`, the server's default limit is used.
offset: The offset to start from. If not specified, the retrieval begins from the first object in the server.
auto_limit: The maximum number of [autocut](https://weaviate.io/developers/weaviate/api/graphql/additional-operators#autocut) results to return. If not specified, no limit is applied.
filters: The filters to apply to the search.
Expand Down
2 changes: 1 addition & 1 deletion weaviate/collections/queries/fetch_objects/generate/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ def fetch_objects(
single_prompt: The prompt to use for RaG on each object individually.
grouped_task: The prompt to use for RaG on the entire result set.
grouped_properties: The properties to use in the RaG on the entire result set.
limit: The maximum number of results to return. If not specified, the default limit specified by Weaviate is returned.
limit: The maximum number of results to return. If not specified or set to `0`, the server's default limit is used.
offset: The offset to start from. If not specified, the retrieval begins from the first object in Weaviate.
after: The UUID of the object to start from. If not specified, the retrieval begins from the first object in Weaviate.
filters: The filters to apply to the retrieval.
Expand Down
2 changes: 1 addition & 1 deletion weaviate/collections/queries/fetch_objects/query/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ def fetch_objects(
"""Retrieve the objects in this collection without any search.

Args:
limit: The maximum number of results to return. If not specified, the default limit specified by the server is returned.
limit: The maximum number of results to return. If not specified or set to `0`, the server's default limit is used.
offset: The offset to start from. If not specified, the retrieval begins from the first object in the server.
after: The UUID of the object to start from. If not specified, the retrieval begins from the first object in the server.
filters: The filters to apply to the retrieval.
Expand Down
2 changes: 1 addition & 1 deletion weaviate/collections/queries/hybrid/generate/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,7 @@ def hybrid(
vector: The specific vector to search for. If not specified, the query is vectorized and used in the similarity search.
query_properties: The properties to search in. If not specified, all properties are searched.
fusion_type: The type of fusion to apply. If not specified, the default fusion type specified by the server is used.
limit: The maximum number of results to return. If not specified, the default limit specified by the server is returned.
limit: The maximum number of results to return. If not specified or set to `0`, the server's default limit is used.
offset: The offset to start from. If not specified, the retrieval begins from the first object in the server.
auto_limit: The maximum number of [autocut](https://weaviate.io/developers/weaviate/api/graphql/additional-operators#autocut) results to return. If not specified, no limit is applied.
filters: The filters to apply to the search.
Expand Down
2 changes: 1 addition & 1 deletion weaviate/collections/queries/hybrid/query/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,7 @@ def hybrid(
vector: The specific vector to search for. If not specified, the query is vectorized and used in the similarity search.
query_properties: The properties to search in. If not specified, all properties are searched.
fusion_type: The type of fusion to apply. If not specified, the default fusion type specified by the server is used.
limit: The maximum number of results to return. If not specified, the default limit specified by the server is returned.
limit: The maximum number of results to return. If not specified or set to `0`, the server's default limit is used.
offset: The offset to start from. If not specified, the retrieval begins from the first object in the server.
bm25_operator: The BM25 operator to use. If not specified, the default operator specified by the server is used.
auto_limit: The maximum number of [autocut](https://weaviate.io/developers/weaviate/api/graphql/additional-operators#autocut) results to return. If not specified, no limit is applied.
Expand Down
2 changes: 1 addition & 1 deletion weaviate/collections/queries/near_image/generate/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,7 +426,7 @@ def near_image(
near_image: The image file to search on, REQUIRED. This can be a base64 encoded string of the binary, a path to the file, or a file-like object.
certainty: The minimum similarity score to return. If not specified, the default certainty specified by the server is used.
distance: The maximum distance to search. If not specified, the default distance specified by the server is used.
limit: The maximum number of results to return. If not specified, the default limit specified by the server is returned.
limit: The maximum number of results to return. If not specified or set to `0`, the server's default limit is used.
offset: The offset to start from. If not specified, the retrieval begins from the first object in the server.
auto_limit: The maximum number of [autocut](https://weaviate.io/developers/weaviate/api/graphql/additional-operators#autocut) results to return. If not specified, no limit is applied.
filters: The filters to apply to the search.
Expand Down
2 changes: 1 addition & 1 deletion weaviate/collections/queries/near_image/query/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ def near_image(
near_image: The image file to search on, REQUIRED. This can be a base64 encoded string of the binary, a path to the file, or a file-like object.
certainty: The minimum similarity score to return. If not specified, the default certainty specified by the server is used.
distance: The maximum distance to search. If not specified, the default distance specified by the server is used.
limit: The maximum number of results to return. If not specified, the default limit specified by the server is returned.
limit: The maximum number of results to return. If not specified or set to `0`, the server's default limit is used.
offset: The offset to start from. If not specified, the retrieval begins from the first object in the server.
auto_limit: The maximum number of [autocut](https://weaviate.io/developers/weaviate/api/graphql/additional-operators#autocut) results to return. If not specified, no limit is applied.
filters: The filters to apply to the search.
Expand Down
2 changes: 1 addition & 1 deletion weaviate/collections/queries/near_media/generate/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,7 @@ def near_media(
media_type: The type of the provided media file, REQUIRED.
certainty: The minimum similarity score to return. If not specified, the default certainty specified by the server is used.
distance: The maximum distance to search. If not specified, the default distance specified by the server is used.
limit: The maximum number of results to return. If not specified, the default limit specified by the server is returned.
limit: The maximum number of results to return. If not specified or set to `0`, the server's default limit is used.
offset: The offset to start from. If not specified, the retrieval begins from the first object in the server.
auto_limit: The maximum number of [autocut](https://weaviate.io/developers/weaviate/api/graphql/additional-operators#autocut) results to return. If not specified, no limit is applied.
filters: The filters to apply to the search.
Expand Down
2 changes: 1 addition & 1 deletion weaviate/collections/queries/near_media/query/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ def near_media(
media_type: The type of the provided media file, REQUIRED.
certainty: The minimum similarity score to return. If not specified, the default certainty specified by the server is used.
distance: The maximum distance to search. If not specified, the default distance specified by the server is used.
limit: The maximum number of results to return. If not specified, the default limit specified by the server is returned.
limit: The maximum number of results to return. If not specified or set to `0`, the server's default limit is used.
offset: The offset to start from. If not specified, the retrieval begins from the first object in the server.
auto_limit: The maximum number of [autocut](https://weaviate.io/developers/weaviate/api/graphql/additional-operators#autocut) results to return. If not specified, no limit is applied.
filters: The filters to apply to the search.
Expand Down
2 changes: 1 addition & 1 deletion weaviate/collections/queries/near_object/generate/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -422,7 +422,7 @@ def near_object(
near_object: The UUID of the object to search on, REQUIRED.
certainty: The minimum similarity score to return. If not specified, the default certainty specified by the server is used.
distance: The maximum distance to search. If not specified, the default distance specified by the server is used.
limit: The maximum number of results to return. If not specified, the default limit specified by the server is returned.
limit: The maximum number of results to return. If not specified or set to `0`, the server's default limit is used.
offset: The offset to start from. If not specified, the retrieval begins from the first object in the server.
auto_limit: The maximum number of [autocut](https://weaviate.io/developers/weaviate/api/graphql/additional-operators#autocut) results to return. If not specified, no limit is applied.
filters: The filters to apply to the search.
Expand Down
2 changes: 1 addition & 1 deletion weaviate/collections/queries/near_object/query/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ def near_object(
near_object: The UUID of the object to search on, REQUIRED.
certainty: The minimum similarity score to return. If not specified, the default certainty specified by the server is used.
distance: The maximum distance to search. If not specified, the default distance specified by the server is used.
limit: The maximum number of results to return. If not specified, the default limit specified by the server is returned.
limit: The maximum number of results to return. If not specified or set to `0`, the server's default limit is used.
offset: The offset to start from. If not specified, the retrieval begins from the first object in the server.
auto_limit: The maximum number of [autocut](https://weaviate.io/developers/weaviate/api/graphql/additional-operators#autocut) results to return. If not specified, no limit is applied.
filters: The filters to apply to the search.
Expand Down
2 changes: 1 addition & 1 deletion weaviate/collections/queries/near_text/generate/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ def near_text(
query: The text or texts to search on, REQUIRED.
certainty: The minimum similarity score to return. If not specified, the default certainty specified by the server is used.
distance: The maximum distance to search. If not specified, the default distance specified by the server is used.
limit: The maximum number of results to return. If not specified, the default limit specified by the server is returned.
limit: The maximum number of results to return. If not specified or set to `0`, the server's default limit is used.
offset: The offset to start from. If not specified, the retrieval begins from the first object in the server.
auto_limit: The maximum number of [autocut](https://weaviate.io/developers/weaviate/api/graphql/additional-operators#autocut) results to return. If not specified, no limit is applied.
filters: The filters to apply to the search.
Expand Down
2 changes: 1 addition & 1 deletion weaviate/collections/queries/near_text/query/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ def near_text(
query: The text or texts to search on, REQUIRED.
certainty: The minimum similarity score to return. If not specified, the default certainty specified by the server is used.
distance: The maximum distance to search. If not specified, the default distance specified by the server is used.
limit: The maximum number of results to return. If not specified, the default limit specified by the server is returned.
limit: The maximum number of results to return. If not specified or set to `0`, the server's default limit is used.
offset: The offset to start from. If not specified, the retrieval begins from the first object in the server.
auto_limit: The maximum number of [autocut](https://weaviate.io/developers/weaviate/api/graphql/additional-operators#autocut) results to return. If not specified, no limit is applied.
filters: The filters to apply to the search.
Expand Down
2 changes: 1 addition & 1 deletion weaviate/collections/queries/near_vector/generate/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -422,7 +422,7 @@ def near_vector(
near_vector: The vector to search on, REQUIRED. This can be a base64 encoded string of the binary, a path to the file, or a file-like object.
certainty: The minimum similarity score to return. If not specified, the default certainty specified by the server is used.
distance: The maximum distance to search. If not specified, the default distance specified by the server is used.
limit: The maximum number of results to return. If not specified, the default limit specified by the server is returned.
limit: The maximum number of results to return. If not specified or set to `0`, the server's default limit is used.
offset: The offset to start from. If not specified, the retrieval begins from the first object in the server.
auto_limit: The maximum number of [autocut](https://weaviate.io/developers/weaviate/api/graphql/additional-operators#autocut) results to return. If not specified, no limit is applied.
filters: The filters to apply to the search.
Expand Down
2 changes: 1 addition & 1 deletion weaviate/collections/queries/near_vector/query/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ def near_vector(
near_vector: The vector to search on, REQUIRED. This can be a base64 encoded string of the binary, a path to the file, or a file-like object.
certainty: The minimum similarity score to return. If not specified, the default certainty specified by the server is used.
distance: The maximum distance to search. If not specified, the default distance specified by the server is used.
limit: The maximum number of results to return. If not specified, the default limit specified by the server is returned.
limit: The maximum number of results to return. If not specified or set to `0`, the server's default limit is used.
offset: The offset to start from. If not specified, the retrieval begins from the first object in the server.
auto_limit: The maximum number of [autocut](https://weaviate.io/developers/weaviate/api/graphql/additional-operators#autocut) results to return. If not specified, no limit is applied.
filters: The filters to apply to the search.
Expand Down
Loading