Class: Google::Cloud::AIPlatform::V1::SearchDataItemsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/dataset_service.rb

Overview

Request message for DatasetService.SearchDataItems.

Defined Under Namespace

Classes: OrderByAnnotation

Instance Attribute Summary collapse

Instance Attribute Details

#annotation_filters ⇒ ::Array<::String>

Returns 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.


492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#annotations_filter ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns 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 !=.


492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#annotations_limit ⇒ ::Integer

Returns 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.



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_item_filter ⇒ ::String

Returns 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)


492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_labeling_job ⇒ ::String

Returns 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.



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#dataset ⇒ ::String

Returns 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}



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#field_mask ⇒ ::Google::Protobuf::FieldMask

Returns Mask specifying which fields of DataItemView to read.

Returns:



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#order_by ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns 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.



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#order_by_annotation ⇒ ::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest::OrderByAnnotation

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

Note: The following fields are mutually exclusive: order_by_annotation, order_by_data_item. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#order_by_data_item ⇒ ::String

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

Note: The following fields are mutually exclusive: order_by_data_item, order_by_annotation. If a field in that set is populated, all other fields in the set will automatically be cleared.

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.

    Note: The following fields are mutually exclusive: order_by_data_item, order_by_annotation. If a field in that set is populated, all other fields in the set will automatically be cleared.



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#page_size ⇒ ::Integer

Returns 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.



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#page_token ⇒ ::String

Returns 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:



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#saved_query ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns 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.



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset_service.rb', line 492

class SearchDataItemsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Expression that allows ranking results based on annotation's property.
  # @!attribute [rw] saved_query
  #   @return [::String]
  #     Required. Saved query of the Annotation. Only Annotations belong to this
  #     saved query will be considered for ordering.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     A comma-separated list of annotation fields to order by, sorted in
  #     ascending order. Use "desc" after a field name for descending. Must also
  #     specify saved_query.
  class OrderByAnnotation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end