Google Cloud Ai Platform V1 Client - Class OrderByAnnotation (0.13.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class OrderByAnnotation.

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

Generated from protobuf message google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ saved_query string

Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.

↳ order_by 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.

getSavedQuery

Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.

Returns
TypeDescription
string

setSavedQuery

Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrderBy

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
TypeDescription
string

setOrderBy

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this