Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::SearchDataItemsRequest (v0.21.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::SearchDataItemsRequest.

Request message for DatasetService.SearchDataItems.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#annotation_filters

def annotation_filters() -> ::Array<::String>

Returns

(::Array<::String>) —
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.

#annotation_filters=

def annotation_filters=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) —
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.

Returns

(::Array<::String>) —
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.

#annotations_filter

def annotations_filter() -> ::String

Returns

(::String) —
An expression for filtering the Annotations that will be returned per DataItem.
- annotation_spec_id - for = or !=.

#annotations_filter=

def annotations_filter=(value) -> ::String

Parameter

value (::String) —
An expression for filtering the Annotations that will be returned per DataItem.
- annotation_spec_id - for = or !=.

Returns

(::String) —
An expression for filtering the Annotations that will be returned per DataItem.
- annotation_spec_id - for = or !=.

#annotations_limit

def annotations_limit() -> ::Integer

Returns

(::Integer) — 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.

#annotations_limit=

def annotations_limit=(value) -> ::Integer

Parameter

value (::Integer) — 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

(::Integer) — 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.

#data_item_filter

def data_item_filter() -> ::String

Returns

(::String) —
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)

#data_item_filter=

def data_item_filter=(value) -> ::String

Parameter

value (::String) —
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)

Returns

(::String) —
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)

#data_labeling_job

def data_labeling_job() -> ::String

Returns

(::String) — 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_labeling_job=

def data_labeling_job=(value) -> ::String

Parameter

value (::String) — 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

(::String) — 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.

#dataset

def dataset() -> ::String

Returns

(::String) — Required. The resource name of the Dataset from which to search DataItems. Format: projects/{project}/locations/{location}/datasets/{dataset}

#dataset=

def dataset=(value) -> ::String

Parameter

value (::String) — Required. The resource name of the Dataset from which to search DataItems. Format: projects/{project}/locations/{location}/datasets/{dataset}

Returns

(::String) — Required. The resource name of the Dataset from which to search DataItems. Format: projects/{project}/locations/{location}/datasets/{dataset}

#field_mask

def field_mask() -> ::Google::Protobuf::FieldMask

Returns

(::Google::Protobuf::FieldMask) — Mask specifying which fields of DataItemView to read.

#field_mask=

def field_mask=(value) -> ::Google::Protobuf::FieldMask

Parameter

value (::Google::Protobuf::FieldMask) — Mask specifying which fields of DataItemView to read.

Returns

(::Google::Protobuf::FieldMask) — Mask specifying which fields of DataItemView to read.

#order_by

def order_by() -> ::String

Returns

(::String) — A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

#order_by=

def order_by=(value) -> ::String

Parameter

value (::String) — A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

Returns

(::String) — A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

#order_by_annotation

def order_by_annotation() -> ::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest::OrderByAnnotation

Returns

(::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest::OrderByAnnotation) — Expression that allows ranking results based on annotation's property.

#order_by_annotation=

def order_by_annotation=(value) -> ::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest::OrderByAnnotation

Parameter

value (::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest::OrderByAnnotation) — Expression that allows ranking results based on annotation's property.

Returns

(::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest::OrderByAnnotation) — Expression that allows ranking results based on annotation's property.

#order_by_data_item

def order_by_data_item() -> ::String

Returns

(::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_data_item=

def order_by_data_item=(value) -> ::String

Parameter

value (::String) — A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

Returns

(::String) — A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

#page_size

def page_size() -> ::Integer

Returns

(::Integer) — Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.

#page_size=

def page_size=(value) -> ::Integer

Parameter

value (::Integer) — Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.

Returns

(::Integer) — Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.

#page_token

def page_token() -> ::String

Returns

(::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.

#page_token=

def page_token=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#saved_query

def saved_query() -> ::String

Returns

(::String) — 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.

#saved_query=

def saved_query=(value) -> ::String

Parameter

value (::String) — 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

(::String) — 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.