weaviate.collections.grpc
- class weaviate.collections.grpc._BaseGRPC(weaviate_version, consistency_level, validate_arguments)[source]
Bases:
object
- Parameters:
weaviate_version (_ServerVersion)
consistency_level (ConsistencyLevel | None)
validate_arguments (bool)
- _BaseGRPC__target_vector_to_grpc(target_vector)
- Parameters:
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
- Return type:
Tuple[Targets | None, List[str] | None]
- static _get_consistency_level(consistency_level)[source]
- Parameters:
consistency_level (ConsistencyLevel | None)
- Return type:
<google.protobuf.internal.enum_type_wrapper.EnumTypeWrapper object at 0x714152101a90> | None
- _parse_hybrid(query, alpha, vector, properties, bm25_operator, fusion_type, distance, target_vector)[source]
- Parameters:
query (str | None)
alpha (float | None)
vector (Sequence[int | float] | Sequence[Sequence[int | float]] | Mapping[str, Sequence[int | float] | Sequence[Sequence[int | float]] | _ListOfVectorsQuery[Sequence[Union[int, float]]] | _ListOfVectorsQuery[Sequence[Sequence[Union[int, float]]]]] | _HybridNearText | _HybridNearVector | None)
properties (List[str] | None)
bm25_operator (BM25OperatorOptions | None)
fusion_type (HybridFusion | None)
distance (int | float | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
- Return type:
Hybrid | None
- _parse_media(media, type_, certainty, distance, target_vector)[source]
- Parameters:
media (str)
type_ (Literal['audio', 'depth', 'image', 'imu', 'thermal', 'video'])
certainty (int | float | None)
distance (int | float | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
- Return type:
dict
- _parse_near_object(near_object, certainty, distance, target_vector)[source]
- Parameters:
near_object (str | UUID)
certainty (int | float | None)
distance (int | float | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
- Return type:
NearObject
- _parse_near_options(certainty=None, distance=None)[source]
- Parameters:
certainty (int | float | None)
distance (int | float | None)
- Return type:
Tuple[float | None, float | None]
- _parse_near_text(near_text, certainty, distance, move_to, move_away, target_vector)[source]
- Parameters:
near_text (List[str] | str)
certainty (int | float | None)
distance (int | float | None)
move_to (Move | None)
move_away (Move | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
- Return type:
NearTextSearch
- _parse_near_vector(near_vector, certainty, distance, target_vector)[source]
- Parameters:
near_vector (Sequence[int | float] | Sequence[Sequence[int | float]] | Mapping[str, Sequence[int | float] | Sequence[Sequence[int | float]] | _ListOfVectorsQuery[Sequence[Union[int, float]]] | _ListOfVectorsQuery[Sequence[Sequence[Union[int, float]]]]])
certainty (int | float | None)
distance (int | float | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
- Return type:
NearVector
- _recompute_target_vector_to_grpc(target_vector, target_vectors_tmp)[source]
- Parameters:
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
target_vectors_tmp (List[str])
- Return type:
Tuple[Targets | None, List[str] | None]
- _vector_for_target(vector, targets, argument_name)[source]
- Parameters:
vector (Sequence[int | float] | Sequence[Sequence[int | float]] | Mapping[str, Sequence[int | float] | Sequence[Sequence[int | float]] | _ListOfVectorsQuery[Sequence[Union[int, float]]] | _ListOfVectorsQuery[Sequence[Sequence[Union[int, float]]]]])
targets (Targets | None)
argument_name (str)
- Return type:
Tuple[List[VectorForTarget] | None, bytes | None, List[str] | None]
- _vector_per_target(vector, targets, argument_name)[source]
@deprecated in 1.27.0, included for BC until 1.27.0 is no longer supported.
- Parameters:
vector (Sequence[int | float] | Sequence[Sequence[int | float]] | Mapping[str, Sequence[int | float] | Sequence[Sequence[int | float]] | _ListOfVectorsQuery[Sequence[Union[int, float]]] | _ListOfVectorsQuery[Sequence[Sequence[Union[int, float]]]]])
targets (Targets | None)
argument_name (str)
- Return type:
Tuple[Dict[str, bytes] | None, bytes | None]
- class weaviate.collections.grpc._QueryGRPC(weaviate_version, name, tenant, consistency_level, validate_arguments, uses_125_api, uses_127_api)[source]
Bases:
_BaseGRPC
- Parameters:
weaviate_version (_ServerVersion)
name (str)
tenant (str | None)
consistency_level (ConsistencyLevel | None)
validate_arguments (bool)
uses_125_api (bool)
uses_127_api (bool)
- static _QueryGRPC__convert_to_set(args)
- Parameters:
args (A | Sequence[A])
- Return type:
Set[A]
- _QueryGRPC__create_request(limit=None, offset=None, after=None, filters=None, metadata=None, return_properties=None, return_references=None, generative=None, rerank=None, autocut=None, group_by=None, near_vector=None, sort_by=None, hybrid_search=None, bm25=None, near_object=None, near_text=None, near_audio=None, near_depth=None, near_image=None, near_imu=None, near_thermal=None, near_video=None)
- Parameters:
limit (int | None)
offset (int | None)
after (str | UUID | None)
filters (_Filters | None)
metadata (_MetadataQuery | None)
return_properties (Sequence[str | QueryNested] | str | QueryNested | bool | None)
return_references (Sequence[_QueryReference | _QueryReferenceMultiTarget] | _QueryReference | _QueryReferenceMultiTarget | None)
generative (_Generative | None)
rerank (Rerank | None)
autocut (int | None)
group_by (_GroupBy | None)
near_vector (NearVector | None)
sort_by (Sequence[SortBy] | None)
hybrid_search (Hybrid | None)
bm25 (BM25 | None)
near_object (NearObject | None)
near_text (NearTextSearch | None)
near_audio (NearAudioSearch | None)
near_depth (NearDepthSearch | None)
near_image (NearImageSearch | None)
near_imu (NearIMUSearch | None)
near_thermal (NearThermalSearch | None)
near_video (NearVideoSearch | None)
- Return type:
SearchRequest
- _QueryGRPC__parse_near_options(certainty=None, distance=None)
- Parameters:
certainty (int | float | None)
distance (int | float | None)
- Return type:
Tuple[float | None, float | None]
- _QueryGRPC__parse_return_properties(props)
- Parameters:
props (Sequence[str | QueryNested] | str | QueryNested | bool | None)
- Return type:
Set[str | QueryNested] | None
- _QueryGRPC__resolve_property(prop)
- Parameters:
prop (QueryNested)
- Return type:
ObjectPropertiesRequest
- _metadata_to_grpc(metadata)[source]
- Parameters:
metadata (_MetadataQuery)
- Return type:
MetadataRequest
- _translate_properties_from_python_to_grpc(properties, references)[source]
- Parameters:
properties (Set[str | QueryNested] | None)
references (Set[_QueryReference | _QueryReferenceMultiTarget] | None)
- Return type:
PropertiesRequest | None
- bm25(*, query, properties=None, limit=None, offset=None, operator=None, autocut=None, filters=None, group_by=None, return_metadata=None, return_properties=None, return_references=None, generative=None, rerank=None)[source]
- Parameters:
query (str | None)
properties (List[str] | None)
limit (int | None)
offset (int | None)
operator (BM25OperatorOptions | None)
autocut (int | None)
filters (_Filters | None)
group_by (_GroupBy | None)
return_metadata (_MetadataQuery | None)
return_properties (Sequence[str | QueryNested] | str | QueryNested | bool | None)
return_references (Sequence[_QueryReference | _QueryReferenceMultiTarget] | _QueryReference | _QueryReferenceMultiTarget | None)
generative (_Generative | None)
rerank (Rerank | None)
- Return type:
SearchRequest
- get(*, limit=None, offset=None, after=None, filters=None, sort=None, return_metadata=None, return_properties=None, return_references=None, generative=None, rerank=None)[source]
- Parameters:
limit (int | None)
offset (int | None)
after (str | UUID | None)
filters (_Filters | None)
sort (_Sorting | None)
return_metadata (_MetadataQuery | None)
return_properties (Sequence[str | QueryNested] | str | QueryNested | bool | None)
return_references (Sequence[_QueryReference | _QueryReferenceMultiTarget] | _QueryReference | _QueryReferenceMultiTarget | None)
generative (_Generative | None)
rerank (Rerank | None)
- Return type:
SearchRequest
- hybrid(*, query, alpha=None, vector=None, properties=None, fusion_type=None, distance=None, limit=None, offset=None, bm25_operator=None, autocut=None, filters=None, group_by=None, return_metadata=None, return_properties=None, return_references=None, generative=None, rerank=None, target_vector=None)[source]
- Parameters:
query (str | None)
alpha (float | None)
vector (Sequence[int | float] | Sequence[Sequence[int | float]] | Mapping[str, Sequence[int | float] | Sequence[Sequence[int | float]] | _ListOfVectorsQuery[Sequence[Union[int, float]]] | _ListOfVectorsQuery[Sequence[Sequence[Union[int, float]]]]] | _HybridNearText | _HybridNearVector | None)
properties (List[str] | None)
fusion_type (HybridFusion | None)
distance (int | float | None)
limit (int | None)
offset (int | None)
bm25_operator (BM25OperatorOptions | None)
autocut (int | None)
filters (_Filters | None)
group_by (_GroupBy | None)
return_metadata (_MetadataQuery | None)
return_properties (Sequence[str | QueryNested] | str | QueryNested | bool | None)
return_references (Sequence[_QueryReference | _QueryReferenceMultiTarget] | _QueryReference | _QueryReferenceMultiTarget | None)
generative (_Generative | None)
rerank (Rerank | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
- Return type:
SearchRequest
- near_media(*, media, type_, certainty=None, distance=None, limit=None, offset=None, autocut=None, filters=None, group_by=None, generative=None, rerank=None, target_vector=None, return_metadata=None, return_properties=None, return_references=None)[source]
- Parameters:
media (str)
type_ (Literal['audio', 'depth', 'image', 'imu', 'thermal', 'video'])
certainty (int | float | None)
distance (int | float | None)
limit (int | None)
offset (int | None)
autocut (int | None)
filters (_Filters | None)
group_by (_GroupBy | None)
generative (_Generative | None)
rerank (Rerank | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
return_metadata (_MetadataQuery | None)
return_properties (Sequence[str | QueryNested] | str | QueryNested | bool | None)
return_references (Sequence[_QueryReference | _QueryReferenceMultiTarget] | _QueryReference | _QueryReferenceMultiTarget | None)
- Return type:
SearchRequest
- near_object(*, near_object, certainty=None, distance=None, limit=None, offset=None, autocut=None, filters=None, group_by=None, generative=None, rerank=None, target_vector=None, return_metadata=None, return_properties=None, return_references=None)[source]
- Parameters:
near_object (str | UUID)
certainty (int | float | None)
distance (int | float | None)
limit (int | None)
offset (int | None)
autocut (int | None)
filters (_Filters | None)
group_by (_GroupBy | None)
generative (_Generative | None)
rerank (Rerank | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
return_metadata (_MetadataQuery | None)
return_properties (Sequence[str | QueryNested] | str | QueryNested | bool | None)
return_references (Sequence[_QueryReference | _QueryReferenceMultiTarget] | _QueryReference | _QueryReferenceMultiTarget | None)
- Return type:
SearchRequest
- near_text(*, near_text, certainty=None, distance=None, move_to=None, move_away=None, limit=None, offset=None, autocut=None, filters=None, group_by=None, generative=None, rerank=None, target_vector=None, return_metadata=None, return_properties=None, return_references=None)[source]
- Parameters:
near_text (List[str] | str)
certainty (int | float | None)
distance (int | float | None)
move_to (Move | None)
move_away (Move | None)
limit (int | None)
offset (int | None)
autocut (int | None)
filters (_Filters | None)
group_by (_GroupBy | None)
generative (_Generative | None)
rerank (Rerank | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
return_metadata (_MetadataQuery | None)
return_properties (Sequence[str | QueryNested] | str | QueryNested | bool | None)
return_references (Sequence[_QueryReference | _QueryReferenceMultiTarget] | _QueryReference | _QueryReferenceMultiTarget | None)
- Return type:
SearchRequest
- near_vector(*, near_vector, certainty=None, distance=None, limit=None, offset=None, autocut=None, filters=None, group_by=None, generative=None, rerank=None, target_vector=None, return_metadata=None, return_properties=None, return_references=None)[source]
- Parameters:
near_vector (Sequence[int | float] | Sequence[Sequence[int | float]] | Mapping[str, Sequence[int | float] | Sequence[Sequence[int | float]] | _ListOfVectorsQuery[Sequence[Union[int, float]]] | _ListOfVectorsQuery[Sequence[Sequence[Union[int, float]]]]])
certainty (int | float | None)
distance (int | float | None)
limit (int | None)
offset (int | None)
autocut (int | None)
filters (_Filters | None)
group_by (_GroupBy | None)
generative (_Generative | None)
rerank (Rerank | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
return_metadata (_MetadataQuery | None)
return_properties (Sequence[str | QueryNested] | str | QueryNested | bool | None)
return_references (Sequence[_QueryReference | _QueryReferenceMultiTarget] | _QueryReference | _QueryReferenceMultiTarget | None)
- Return type:
SearchRequest
weaviate.collections.grpc.aggregate
- class weaviate.collections.grpc.aggregate._AggregateGRPC(weaviate_version, name, tenant, consistency_level, validate_arguments)[source]
Bases:
_BaseGRPC
- Parameters:
weaviate_version (_ServerVersion)
name (str)
tenant (str | None)
consistency_level (ConsistencyLevel | None)
validate_arguments (bool)
- objects_count(connection)[source]
- Parameters:
connection (ConnectionSync | ConnectionAsync)
- Return type:
int | Awaitable[int]
- hybrid(*, query, alpha, vector, properties, distance=None, target_vector, bm25_operator, aggregations, filters, group_by, limit, object_limit, objects_count)[source]
- Parameters:
query (str | None)
alpha (float | None)
vector (Sequence[int | float] | Sequence[Sequence[int | float]] | Mapping[str, Sequence[int | float] | Sequence[Sequence[int | float]] | _ListOfVectorsQuery[Sequence[Union[int, float]]] | _ListOfVectorsQuery[Sequence[Sequence[Union[int, float]]]]] | _HybridNearText | _HybridNearVector | None)
properties (List[str] | None)
distance (int | float | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
bm25_operator (BM25OperatorOptions | None)
aggregations (List[Aggregation])
filters (Filters | None)
group_by (GroupBy | None)
limit (int | None)
object_limit (int | None)
objects_count (bool)
- Return type:
AggregateRequest
- near_media(*, media, type_, certainty=None, distance=None, target_vector, aggregations, filters, group_by, limit, object_limit, objects_count)[source]
- Parameters:
media (str)
type_ (Literal['audio', 'depth', 'image', 'imu', 'thermal', 'video'])
certainty (int | float | None)
distance (int | float | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
aggregations (List[Aggregation])
filters (Filters | None)
group_by (GroupBy | None)
limit (int | None)
object_limit (int | None)
objects_count (bool)
- Return type:
AggregateRequest
- near_object(*, near_object, certainty=None, distance=None, target_vector, aggregations, filters, group_by, limit, object_limit, objects_count)[source]
- Parameters:
near_object (str | UUID)
certainty (int | float | None)
distance (int | float | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
aggregations (List[Aggregation])
filters (Filters | None)
group_by (GroupBy | None)
limit (int | None)
object_limit (int | None)
objects_count (bool)
- Return type:
AggregateRequest
- near_text(*, near_text, certainty, distance, move_to, move_away, target_vector, aggregations, filters, group_by, limit, object_limit, objects_count)[source]
- Parameters:
near_text (List[str] | str)
certainty (int | float | None)
distance (int | float | None)
move_to (Move | None)
move_away (Move | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
aggregations (List[Aggregation])
filters (Filters | None)
group_by (GroupBy | None)
limit (int | None)
object_limit (int | None)
objects_count (bool)
- Return type:
AggregateRequest
- near_vector(*, near_vector, certainty, distance, target_vector, aggregations, filters, group_by, limit, object_limit, objects_count)[source]
- Parameters:
near_vector (Sequence[int | float] | Sequence[Sequence[int | float]] | Mapping[str, Sequence[int | float] | Sequence[Sequence[int | float]] | _ListOfVectorsQuery[Sequence[Union[int, float]]] | _ListOfVectorsQuery[Sequence[Sequence[Union[int, float]]]]])
certainty (int | float | None)
distance (int | float | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
aggregations (List[Aggregation])
filters (Filters | None)
group_by (GroupBy | None)
limit (int | None)
object_limit (int | None)
objects_count (bool)
- Return type:
AggregateRequest
- over_all(*, aggregations, filters, group_by, limit, objects_count=False)[source]
- Parameters:
aggregations (List[Aggregation])
filters (Filters | None)
group_by (GroupBy | None)
limit (int | None)
objects_count (bool)
- Return type:
AggregateRequest
- _AggregateGRPC__check_vector_search_args(*, certainty, distance, object_limit)
- Parameters:
certainty (int | float | None)
distance (int | float | None)
object_limit (int | None)
- Return type:
None
- _AggregateGRPC__create_request(*, aggregations=None, filters=None, group_by=None, hybrid=None, limit=None, near_object=None, near_text=None, near_vector=None, object_limit=None, objects_count=False)
- Parameters:
aggregations (List[Aggregation] | None)
filters (Filters | None)
group_by (GroupBy | None)
hybrid (Hybrid | None)
limit (int | None)
near_object (NearObject | None)
near_text (NearTextSearch | None)
near_vector (NearVector | None)
object_limit (int | None)
objects_count (bool)
- Return type:
AggregateRequest
weaviate.collections.grpc.query
- class weaviate.collections.grpc.query._Move(force: float, concepts: List[str], objects: List[uuid.UUID])[source]
Bases:
object
- Parameters:
force (float)
concepts (List[str])
objects (List[UUID])
- force: float
- concepts: List[str]
- objects: List[UUID]
- class weaviate.collections.grpc.query._QueryGRPC(weaviate_version, name, tenant, consistency_level, validate_arguments, uses_125_api, uses_127_api)[source]
Bases:
_BaseGRPC
- Parameters:
weaviate_version (_ServerVersion)
name (str)
tenant (str | None)
consistency_level (ConsistencyLevel | None)
validate_arguments (bool)
uses_125_api (bool)
uses_127_api (bool)
- get(*, limit=None, offset=None, after=None, filters=None, sort=None, return_metadata=None, return_properties=None, return_references=None, generative=None, rerank=None)[source]
- Parameters:
limit (int | None)
offset (int | None)
after (str | UUID | None)
filters (_Filters | None)
sort (_Sorting | None)
return_metadata (_MetadataQuery | None)
return_properties (Sequence[str | QueryNested] | str | QueryNested | bool | None)
return_references (Sequence[_QueryReference | _QueryReferenceMultiTarget] | _QueryReference | _QueryReferenceMultiTarget | None)
generative (_Generative | None)
rerank (Rerank | None)
- Return type:
SearchRequest
- hybrid(*, query, alpha=None, vector=None, properties=None, fusion_type=None, distance=None, limit=None, offset=None, bm25_operator=None, autocut=None, filters=None, group_by=None, return_metadata=None, return_properties=None, return_references=None, generative=None, rerank=None, target_vector=None)[source]
- Parameters:
query (str | None)
alpha (float | None)
vector (Sequence[int | float] | Sequence[Sequence[int | float]] | Mapping[str, Sequence[int | float] | Sequence[Sequence[int | float]] | _ListOfVectorsQuery[Sequence[Union[int, float]]] | _ListOfVectorsQuery[Sequence[Sequence[Union[int, float]]]]] | _HybridNearText | _HybridNearVector | None)
properties (List[str] | None)
fusion_type (HybridFusion | None)
distance (int | float | None)
limit (int | None)
offset (int | None)
bm25_operator (BM25OperatorOptions | None)
autocut (int | None)
filters (_Filters | None)
group_by (_GroupBy | None)
return_metadata (_MetadataQuery | None)
return_properties (Sequence[str | QueryNested] | str | QueryNested | bool | None)
return_references (Sequence[_QueryReference | _QueryReferenceMultiTarget] | _QueryReference | _QueryReferenceMultiTarget | None)
generative (_Generative | None)
rerank (Rerank | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
- Return type:
SearchRequest
- bm25(*, query, properties=None, limit=None, offset=None, operator=None, autocut=None, filters=None, group_by=None, return_metadata=None, return_properties=None, return_references=None, generative=None, rerank=None)[source]
- Parameters:
query (str | None)
properties (List[str] | None)
limit (int | None)
offset (int | None)
operator (BM25OperatorOptions | None)
autocut (int | None)
filters (_Filters | None)
group_by (_GroupBy | None)
return_metadata (_MetadataQuery | None)
return_properties (Sequence[str | QueryNested] | str | QueryNested | bool | None)
return_references (Sequence[_QueryReference | _QueryReferenceMultiTarget] | _QueryReference | _QueryReferenceMultiTarget | None)
generative (_Generative | None)
rerank (Rerank | None)
- Return type:
SearchRequest
- near_vector(*, near_vector, certainty=None, distance=None, limit=None, offset=None, autocut=None, filters=None, group_by=None, generative=None, rerank=None, target_vector=None, return_metadata=None, return_properties=None, return_references=None)[source]
- Parameters:
near_vector (Sequence[int | float] | Sequence[Sequence[int | float]] | Mapping[str, Sequence[int | float] | Sequence[Sequence[int | float]] | _ListOfVectorsQuery[Sequence[Union[int, float]]] | _ListOfVectorsQuery[Sequence[Sequence[Union[int, float]]]]])
certainty (int | float | None)
distance (int | float | None)
limit (int | None)
offset (int | None)
autocut (int | None)
filters (_Filters | None)
group_by (_GroupBy | None)
generative (_Generative | None)
rerank (Rerank | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
return_metadata (_MetadataQuery | None)
return_properties (Sequence[str | QueryNested] | str | QueryNested | bool | None)
return_references (Sequence[_QueryReference | _QueryReferenceMultiTarget] | _QueryReference | _QueryReferenceMultiTarget | None)
- Return type:
SearchRequest
- near_object(*, near_object, certainty=None, distance=None, limit=None, offset=None, autocut=None, filters=None, group_by=None, generative=None, rerank=None, target_vector=None, return_metadata=None, return_properties=None, return_references=None)[source]
- Parameters:
near_object (str | UUID)
certainty (int | float | None)
distance (int | float | None)
limit (int | None)
offset (int | None)
autocut (int | None)
filters (_Filters | None)
group_by (_GroupBy | None)
generative (_Generative | None)
rerank (Rerank | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
return_metadata (_MetadataQuery | None)
return_properties (Sequence[str | QueryNested] | str | QueryNested | bool | None)
return_references (Sequence[_QueryReference | _QueryReferenceMultiTarget] | _QueryReference | _QueryReferenceMultiTarget | None)
- Return type:
SearchRequest
- near_text(*, near_text, certainty=None, distance=None, move_to=None, move_away=None, limit=None, offset=None, autocut=None, filters=None, group_by=None, generative=None, rerank=None, target_vector=None, return_metadata=None, return_properties=None, return_references=None)[source]
- Parameters:
near_text (List[str] | str)
certainty (int | float | None)
distance (int | float | None)
move_to (Move | None)
move_away (Move | None)
limit (int | None)
offset (int | None)
autocut (int | None)
filters (_Filters | None)
group_by (_GroupBy | None)
generative (_Generative | None)
rerank (Rerank | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
return_metadata (_MetadataQuery | None)
return_properties (Sequence[str | QueryNested] | str | QueryNested | bool | None)
return_references (Sequence[_QueryReference | _QueryReferenceMultiTarget] | _QueryReference | _QueryReferenceMultiTarget | None)
- Return type:
SearchRequest
- near_media(*, media, type_, certainty=None, distance=None, limit=None, offset=None, autocut=None, filters=None, group_by=None, generative=None, rerank=None, target_vector=None, return_metadata=None, return_properties=None, return_references=None)[source]
- Parameters:
media (str)
type_ (Literal['audio', 'depth', 'image', 'imu', 'thermal', 'video'])
certainty (int | float | None)
distance (int | float | None)
limit (int | None)
offset (int | None)
autocut (int | None)
filters (_Filters | None)
group_by (_GroupBy | None)
generative (_Generative | None)
rerank (Rerank | None)
target_vector (str | List[str] | _MultiTargetVectorJoin | None)
return_metadata (_MetadataQuery | None)
return_properties (Sequence[str | QueryNested] | str | QueryNested | bool | None)
return_references (Sequence[_QueryReference | _QueryReferenceMultiTarget] | _QueryReference | _QueryReferenceMultiTarget | None)
- Return type:
SearchRequest
- _metadata_to_grpc(metadata)[source]
- Parameters:
metadata (_MetadataQuery)
- Return type:
MetadataRequest
- _translate_properties_from_python_to_grpc(properties, references)[source]
- Parameters:
properties (Set[str | QueryNested] | None)
references (Set[_QueryReference | _QueryReferenceMultiTarget] | None)
- Return type:
PropertiesRequest | None
- static _QueryGRPC__convert_to_set(args)
- Parameters:
args (A | Sequence[A])
- Return type:
Set[A]
- _QueryGRPC__create_request(limit=None, offset=None, after=None, filters=None, metadata=None, return_properties=None, return_references=None, generative=None, rerank=None, autocut=None, group_by=None, near_vector=None, sort_by=None, hybrid_search=None, bm25=None, near_object=None, near_text=None, near_audio=None, near_depth=None, near_image=None, near_imu=None, near_thermal=None, near_video=None)
- Parameters:
limit (int | None)
offset (int | None)
after (str | UUID | None)
filters (_Filters | None)
metadata (_MetadataQuery | None)
return_properties (Sequence[str | QueryNested] | str | QueryNested | bool | None)
return_references (Sequence[_QueryReference | _QueryReferenceMultiTarget] | _QueryReference | _QueryReferenceMultiTarget | None)
generative (_Generative | None)
rerank (Rerank | None)
autocut (int | None)
group_by (_GroupBy | None)
near_vector (NearVector | None)
sort_by (Sequence[SortBy] | None)
hybrid_search (Hybrid | None)
bm25 (BM25 | None)
near_object (NearObject | None)
near_text (NearTextSearch | None)
near_audio (NearAudioSearch | None)
near_depth (NearDepthSearch | None)
near_image (NearImageSearch | None)
near_imu (NearIMUSearch | None)
near_thermal (NearThermalSearch | None)
near_video (NearVideoSearch | None)
- Return type:
SearchRequest
- _QueryGRPC__parse_near_options(certainty=None, distance=None)
- Parameters:
certainty (int | float | None)
distance (int | float | None)
- Return type:
Tuple[float | None, float | None]
- _QueryGRPC__parse_return_properties(props)
- Parameters:
props (Sequence[str | QueryNested] | str | QueryNested | bool | None)
- Return type:
Set[str | QueryNested] | None
- _QueryGRPC__resolve_property(prop)
- Parameters:
prop (QueryNested)
- Return type:
ObjectPropertiesRequest
weaviate.collections.grpc.retry
weaviate.collections.grpc.tenants
- class weaviate.collections.grpc.tenants._TenantsGRPC(weaviate_version, name)[source]
Bases:
_BaseGRPC
- Parameters:
weaviate_version (_ServerVersion)
name (str)