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

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

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#order_by

def order_by() -> ::String
Returns
  • (::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.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#saved_query

def saved_query() -> ::String
Returns
  • (::String) — Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.

#saved_query=

def saved_query=(value) -> ::String
Parameter
  • value (::String) — Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.
Returns
  • (::String) — Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.