Class SearchDataItemsRequest (1.89.0) 

SearchDataItemsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request message for DatasetService.SearchDataItems.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name Description
order_by_data_item str
A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending. This field is a member of oneof_ order.
order_by_annotation google.cloud.aiplatform_v1.types.SearchDataItemsRequest.OrderByAnnotation
Expression that allows ranking results based on annotation's property. This field is a member of oneof_ order.
dataset str
Required. The resource name of the Dataset from which to search DataItems. Format: projects/{project}/locations/{location}/datasets/{dataset}
saved_query str
The resource name of a SavedQuery(annotation set in UI). Format: projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query} All of the search will be done in the context of this SavedQuery.
data_labeling_job str
The resource name of a DataLabelingJob. Format: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job} If this field is set, all of the search will be done in the context of this DataLabelingJob.
data_item_filter str
An expression for filtering the DataItem that will be returned. - data_item_id - for = or !=. - labeled - for = or !=. - has_annotation(ANNOTATION_SPEC_ID) - true only for DataItem that have at least one annotation with annotation_spec_id = ANNOTATION_SPEC_ID in the context of SavedQuery or DataLabelingJob. For example: - data_item=1 - has_annotation(5)
annotations_filter str
An expression for filtering the Annotations that will be returned per DataItem. - annotation_spec_id - for = or !=.
annotation_filters MutableSequence[str]
An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. - annotation_spec_id - for = or !=. Must specify saved_query_id= - saved query id that annotations should belong to.
field_mask google.protobuf.field_mask_pb2.FieldMask
Mask specifying which fields of DataItemView to read.
annotations_limit int
If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used.
page_size int
Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.
order_by str
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
page_token str
A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.

Classes

OrderByAnnotation

OrderByAnnotation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Expression that allows ranking results based on annotation's property.

Methods

SearchDataItemsRequest

SearchDataItemsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request message for DatasetService.SearchDataItems.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields