Skip to content

Commit ff4338c

Browse files
g-despotclaude
andcommitted
docs: shorten the boost param docstring on the query executors
Keep the boost= Args entry to a single sentence. The Boost factory methods (filter/time_decay/numeric_decay/numeric_property/blend) are already listed on the Boost class docstring, so repeating them on all 14 query/generate executors was redundant. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 87ab09c commit ff4338c

14 files changed

Lines changed: 14 additions & 14 deletions

File tree

weaviate/collections/queries/bm25/generate/executor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ def bm25(
396396
filters: The filters to apply to the search.
397397
group_by: How the results should be grouped by a specific property.
398398
rerank: How the results should be reranked. NOTE: A `rerank-*` module must be enabled for this functionality to work.
399-
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them. Build one with `Boost.filter()`, `Boost.time_decay()`, `Boost.numeric_decay()`, `Boost.numeric_property()`, or `Boost.blend()`.
399+
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them.
400400
include_vector: Whether to include the vector in the results. If not specified, this is set to False.
401401
return_metadata: The metadata to return for each object, defaults to `None`.
402402
return_properties: The properties to return for each object.

weaviate/collections/queries/bm25/query/executor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ def bm25(
331331
filters: The filters to apply to the search.
332332
group_by: How the results should be grouped by a specific property.
333333
rerank: How the results should be reranked. NOTE: A `rerank-*` module must be enabled for this functionality to work.
334-
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them. Build one with `Boost.filter()`, `Boost.time_decay()`, `Boost.numeric_decay()`, `Boost.numeric_property()`, or `Boost.blend()`.
334+
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them.
335335
include_vector: Whether to include the vector in the results. If not specified, this is set to False.
336336
return_metadata: The metadata to return for each object, defaults to `None`.
337337
return_properties: The properties to return for each object.

weaviate/collections/queries/hybrid/generate/executor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -475,7 +475,7 @@ def hybrid(
475475
filters: The filters to apply to the search.
476476
group_by: How the results should be grouped by a specific property.
477477
rerank: How the results should be reranked. NOTE: A `rerank-*` module must be enabled for this functionality to work.
478-
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them. Build one with `Boost.filter()`, `Boost.time_decay()`, `Boost.numeric_decay()`, `Boost.numeric_property()`, or `Boost.blend()`.
478+
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them.
479479
target_vector: The name of the vector space to search in for named vector configurations. Required if multiple spaces are configured.
480480
include_vector: Whether to include the vector in the results. If not specified, this is set to False.
481481
return_metadata: The metadata to return for each object, defaults to `None`.

weaviate/collections/queries/hybrid/query/executor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -411,7 +411,7 @@ def hybrid(
411411
filters: The filters to apply to the search.
412412
group_by: How the results should be grouped by a specific property.
413413
rerank: How the results should be reranked. NOTE: A `rerank-*` module must be enabled for this functionality to work.
414-
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them. Build one with `Boost.filter()`, `Boost.time_decay()`, `Boost.numeric_decay()`, `Boost.numeric_property()`, or `Boost.blend()`.
414+
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them.
415415
target_vector: The name of the vector space to search in for named vector configurations. Required if multiple spaces are configured.
416416
include_vector: Whether to include the vector in the results. If not specified, this is set to False.
417417
return_metadata: The metadata to return for each object, defaults to `None`.

weaviate/collections/queries/near_image/generate/executor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -430,7 +430,7 @@ def near_image(
430430
filters: The filters to apply to the search.
431431
group_by: How the results should be grouped by a specific property.
432432
rerank: How the results should be reranked. NOTE: A `rerank-*` module must be enabled for this functionality to work.
433-
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them. Build one with `Boost.filter()`, `Boost.time_decay()`, `Boost.numeric_decay()`, `Boost.numeric_property()`, or `Boost.blend()`.
433+
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them.
434434
target_vector: The name of the vector space to search in for named vector configurations. Required if multiple spaces are configured.
435435
include_vector: Whether to include the vector in the results. If not specified, this is set to False.
436436
return_metadata: The metadata to return for each object, defaults to `None`.

weaviate/collections/queries/near_image/query/executor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ def near_image(
369369
filters: The filters to apply to the search.
370370
group_by: How the results should be grouped by a specific property.
371371
rerank: How the results should be reranked. NOTE: A `rerank-*` module must be enabled for this functionality to work.
372-
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them. Build one with `Boost.filter()`, `Boost.time_decay()`, `Boost.numeric_decay()`, `Boost.numeric_property()`, or `Boost.blend()`.
372+
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them.
373373
target_vector: The name of the vector space to search in for named vector configurations. Required if multiple spaces are configured.
374374
include_vector: Whether to include the vector in the results. If not specified, this is set to False.
375375
return_metadata: The metadata to return for each object, defaults to `None`.

weaviate/collections/queries/near_media/generate/executor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,7 @@ def near_media(
445445
filters: The filters to apply to the search.
446446
group_by: How the results should be grouped by a specific property.
447447
rerank: How the results should be reranked. NOTE: A `rerank-*` module must be enabled for this functionality to work.
448-
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them. Build one with `Boost.filter()`, `Boost.time_decay()`, `Boost.numeric_decay()`, `Boost.numeric_property()`, or `Boost.blend()`.
448+
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them.
449449
target_vector: The name of the vector space to search in for named vector configurations. Required if multiple spaces are configured.
450450
include_vector: Whether to include the vector in the results. If not specified, this is set to False.
451451
return_metadata: The metadata to return for each object, defaults to `None`.

weaviate/collections/queries/near_media/query/executor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,7 @@ def near_media(
384384
filters: The filters to apply to the search.
385385
group_by: How the results should be grouped by a specific property.
386386
rerank: How the results should be reranked. NOTE: A `rerank-*` module must be enabled for this functionality to work.
387-
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them. Build one with `Boost.filter()`, `Boost.time_decay()`, `Boost.numeric_decay()`, `Boost.numeric_property()`, or `Boost.blend()`.
387+
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them.
388388
target_vector: The name of the vector space to search in for named vector configurations. Required if multiple spaces are configured.
389389
include_vector: Whether to include the vector in the results. If not specified, this is set to False.
390390
return_metadata: The metadata to return for each object, defaults to `None`.

weaviate/collections/queries/near_object/generate/executor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,7 @@ def near_object(
426426
filters: The filters to apply to the search.
427427
group_by: How the results should be grouped by a specific property.
428428
rerank: How the results should be reranked. NOTE: A `rerank-*` module must be enabled for this functionality to work.
429-
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them. Build one with `Boost.filter()`, `Boost.time_decay()`, `Boost.numeric_decay()`, `Boost.numeric_property()`, or `Boost.blend()`.
429+
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them.
430430
target_vector: The name of the vector space to search in for named vector configurations. Required if multiple spaces are configured.
431431
include_vector: Whether to include the vector in the results. If not specified, this is set to False.
432432
return_metadata: The metadata to return for each object, defaults to `None`.

weaviate/collections/queries/near_object/query/executor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ def near_object(
368368
filters: The filters to apply to the search.
369369
group_by: How the results should be grouped by a specific property.
370370
rerank: How the results should be reranked. NOTE: A `rerank-*` module must be enabled for this functionality to work.
371-
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them. Build one with `Boost.filter()`, `Boost.time_decay()`, `Boost.numeric_decay()`, `Boost.numeric_property()`, or `Boost.blend()`.
371+
boost: A `Boost` that re-scores the search candidates to promote or demote objects without removing them.
372372
target_vector: The name of the vector space to search in for named vector configurations. Required if multiple spaces are configured.
373373
include_vector: Whether to include the vector in the results. If not specified, this is set to False.
374374
return_metadata: The metadata to return for each object, defaults to `None`.

0 commit comments

Comments
 (0)