- 1.63.0 (latest)
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.1
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.1
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