Reference documentation and code samples for the Vector Search V1 API class Google::Cloud::VectorSearch::V1::AggregateDataObjectsRequest.
Request message for DataObjectSearchService.AggregateDataObjects.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#aggregate
def aggregate() -> ::Google::Cloud::VectorSearch::V1::AggregationMethod- (::Google::Cloud::VectorSearch::V1::AggregationMethod) — Required. The aggregation method to apply to the query.
#aggregate=
def aggregate=(value) -> ::Google::Cloud::VectorSearch::V1::AggregationMethod- value (::Google::Cloud::VectorSearch::V1::AggregationMethod) — Required. The aggregation method to apply to the query.
- (::Google::Cloud::VectorSearch::V1::AggregationMethod) — Required. The aggregation method to apply to the query.
#filter
def filter() -> ::Google::Protobuf::Struct-
(::Google::Protobuf::Struct) — Optional. A JSON filter expression, e.g.
{"genre": {"$eq": "sci-fi"}}, represented as agoogle.protobuf.Struct.An empty filter (
{}) matches all data objects. Otherwise, each JSON object in the filter must have exactly one key: either a field name mapped to one operator ({"price": {"$lt": 100}}), or a logical operator:$andor$orwith a list of filters, or$notwith one filter. Field operators and their values:$eqand$netake a string, number or bool;$lt,$lte,$gtand$gtetake a number;$in,$ninand$alltake a list of strings;$existstakes a bool. Several keys in one object (implicit AND) and implicit equality ({"genre": "sci-fi"}) are rejected; use$andand$eqinstead.Logical operators can be nested at most 2 levels deep, e.g.
{"$and": [{"$or": [{"a": {"$eq": 1}}, {"b": {"$eq": 2}}]}]}. Deeper filters are rejected withINVALID_ARGUMENT.
#filter=
def filter=(value) -> ::Google::Protobuf::Struct-
value (::Google::Protobuf::Struct) — Optional. A JSON filter expression, e.g.
{"genre": {"$eq": "sci-fi"}}, represented as agoogle.protobuf.Struct.An empty filter (
{}) matches all data objects. Otherwise, each JSON object in the filter must have exactly one key: either a field name mapped to one operator ({"price": {"$lt": 100}}), or a logical operator:$andor$orwith a list of filters, or$notwith one filter. Field operators and their values:$eqand$netake a string, number or bool;$lt,$lte,$gtand$gtetake a number;$in,$ninand$alltake a list of strings;$existstakes a bool. Several keys in one object (implicit AND) and implicit equality ({"genre": "sci-fi"}) are rejected; use$andand$eqinstead.Logical operators can be nested at most 2 levels deep, e.g.
{"$and": [{"$or": [{"a": {"$eq": 1}}, {"b": {"$eq": 2}}]}]}. Deeper filters are rejected withINVALID_ARGUMENT.
-
(::Google::Protobuf::Struct) — Optional. A JSON filter expression, e.g.
{"genre": {"$eq": "sci-fi"}}, represented as agoogle.protobuf.Struct.An empty filter (
{}) matches all data objects. Otherwise, each JSON object in the filter must have exactly one key: either a field name mapped to one operator ({"price": {"$lt": 100}}), or a logical operator:$andor$orwith a list of filters, or$notwith one filter. Field operators and their values:$eqand$netake a string, number or bool;$lt,$lte,$gtand$gtetake a number;$in,$ninand$alltake a list of strings;$existstakes a bool. Several keys in one object (implicit AND) and implicit equality ({"genre": "sci-fi"}) are rejected; use$andand$eqinstead.Logical operators can be nested at most 2 levels deep, e.g.
{"$and": [{"$or": [{"a": {"$eq": 1}}, {"b": {"$eq": 2}}]}]}. Deeper filters are rejected withINVALID_ARGUMENT.
#parent
def parent() -> ::String-
(::String) — Required. The resource name of the Collection for which to query.
Format:
projects/{project}/locations/{location}/collections/{collection}
#parent=
def parent=(value) -> ::String-
value (::String) — Required. The resource name of the Collection for which to query.
Format:
projects/{project}/locations/{location}/collections/{collection}
-
(::String) — Required. The resource name of the Collection for which to query.
Format:
projects/{project}/locations/{location}/collections/{collection}