Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class SearchDataItemsRequest.
Request message for DatasetService.SearchDataItems.
Generated from protobuf message google.cloud.aiplatform.v1.SearchDataItemsRequest
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ order_by_data_item |
string
A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending. |
↳ order_by_annotation |
SearchDataItemsRequest\OrderByAnnotation
Expression that allows ranking results based on annotation's property. |
↳ dataset |
string
Required. The resource name of the Dataset from which to search DataItems. Format: |
↳ saved_query |
string
The resource name of a SavedQuery(annotation set in UI). Format: |
↳ data_labeling_job |
string
The resource name of a DataLabelingJob. Format: |
↳ data_item_filter |
string
An expression for filtering the DataItem that will be returned. * * |
↳ annotations_filter |
string
An expression for filtering the Annotations that will be returned per DataItem. * * |
↳ annotation_filters |
string[]
An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * * |
↳ field_mask |
Google\Protobuf\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 |
string
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. |
↳ page_token |
string
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. |
getOrderByDataItem
A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasOrderByDataItem
setOrderByDataItem
A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderByAnnotation
Expression that allows ranking results based on annotation's property.
| Returns | |
|---|---|
| Type | Description |
SearchDataItemsRequest\OrderByAnnotation|null |
|
hasOrderByAnnotation
setOrderByAnnotation
Expression that allows ranking results based on annotation's property.
| Parameter | |
|---|---|
| Name | Description |
var |
SearchDataItemsRequest\OrderByAnnotation
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataset
Required. The resource name of the Dataset from which to search DataItems.
Format:
projects/{project}/locations/{location}/datasets/{dataset}
| Returns | |
|---|---|
| Type | Description |
string |
|
setDataset
Required. The resource name of the Dataset from which to search DataItems.
Format:
projects/{project}/locations/{location}/datasets/{dataset}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSavedQuery
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSavedQuery
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataLabelingJob
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDataLabelingJob
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataItemFilter
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_IDin the context of SavedQuery or DataLabelingJob. For example:
data_item=1has_annotation(5)
| Returns | |
|---|---|
| Type | Description |
string |
|
setDataItemFilter
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_IDin the context of SavedQuery or DataLabelingJob. For example:
data_item=1has_annotation(5)
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnnotationsFilter
An expression for filtering the Annotations that will be returned per DataItem.
annotation_spec_id- for = or !=.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAnnotationsFilter
An expression for filtering the Annotations that will be returned per DataItem.
annotation_spec_id- for = or !=.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnnotationFilters
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 specifysaved_query_id=- saved query id that annotations should belong to.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setAnnotationFilters
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 specifysaved_query_id=- saved query id that annotations should belong to.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFieldMask
Mask specifying which fields of DataItemView to read.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null |
|
hasFieldMask
clearFieldMask
setFieldMask
Mask specifying which fields of DataItemView to read.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnnotationsLimit
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.
| Returns | |
|---|---|
| Type | Description |
int |
|
setAnnotationsLimit
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Requested page size. Server may return fewer results than requested.
Default and maximum page size is 100.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Requested page size. Server may return fewer results than requested.
Default and maximum page size is 100.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
A comma-separated list of fields to order by, sorted in ascending order.
Use "desc" after a field name for descending.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
A comma-separated list of fields to order by, sorted in ascending order.
Use "desc" after a field name for descending.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrder
| Returns | |
|---|---|
| Type | Description |
string |
|