com.google.cloud.discoveryengine.v1beta

Interface RankRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RankRequest, RankRequest.Builder

public interface RankRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsUserLabels(String key) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
boolean	getIgnoreRecordDetailsInResponse() If true, the response will contain only record ID and score.
String	getModel() The identifier of the model to use.
com.google.protobuf.ByteString	getModelBytes() The identifier of the model to use.
String	getQuery() The query to use.
com.google.protobuf.ByteString	getQueryBytes() The query to use.
String	getRankingConfig() Required.
com.google.protobuf.ByteString	getRankingConfigBytes() Required.
RankingRecord	getRecords(int index) Required.
int	getRecordsCount() Required.
List<RankingRecord>	getRecordsList() Required.
RankingRecordOrBuilder	getRecordsOrBuilder(int index) Required.
List<? extends RankingRecordOrBuilder>	getRecordsOrBuilderList() Required.
int	getTopN() The number of results to return.
Map<String,String>	getUserLabels() Deprecated.
int	getUserLabelsCount() The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
Map<String,String>	getUserLabelsMap() The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
String	getUserLabelsOrDefault(String key, String defaultValue) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
String	getUserLabelsOrThrow(String key) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getRankingConfig

String getRankingConfig()

 Required. The resource name of the rank service config, such as
 `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.
 

string ranking_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The rankingConfig.

getRankingConfigBytes

com.google.protobuf.ByteString getRankingConfigBytes()

 Required. The resource name of the rank service config, such as
 `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.
 

string ranking_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for rankingConfig.

getModel

String getModel()

 The identifier of the model to use. It is one of:

 * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
 token size 512.

 It is set to `semantic-ranker-512@latest` by default if unspecified.
 

string model = 2;

Returns:

The model.

getModelBytes

com.google.protobuf.ByteString getModelBytes()

 The identifier of the model to use. It is one of:

 * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
 token size 512.

 It is set to `semantic-ranker-512@latest` by default if unspecified.
 

string model = 2;

Returns:

The bytes for model.

getTopN

int getTopN()

 The number of results to return. If this is unset or no bigger than zero,
 returns all results.
 

int32 top_n = 3;

Returns:

The topN.

getQuery

String getQuery()

 The query to use.
 

string query = 4;

Returns:

The query.

getQueryBytes

com.google.protobuf.ByteString getQueryBytes()

 The query to use.
 

string query = 4;

Returns:

The bytes for query.

getRecordsList

List<RankingRecord> getRecordsList()

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1beta.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

getRecords

RankingRecord getRecords(int index)

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1beta.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

getRecordsCount

int getRecordsCount()

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1beta.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

getRecordsOrBuilderList

List<? extends RankingRecordOrBuilder> getRecordsOrBuilderList()

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1beta.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

getRecordsOrBuilder

RankingRecordOrBuilder getRecordsOrBuilder(int index)

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1beta.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

getIgnoreRecordDetailsInResponse

boolean getIgnoreRecordDetailsInResponse()

 If true, the response will contain only record ID and score. By default, it
 is false, the response will contain record details.
 

bool ignore_record_details_in_response = 6;

Returns:

The ignoreRecordDetailsInResponse.

getUserLabelsCount

int getUserLabelsCount()

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 7;

containsUserLabels

boolean containsUserLabels(String key)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 7;

getUserLabels

@Deprecated
Map<String,String> getUserLabels()

Deprecated.

Use getUserLabelsMap() instead.

getUserLabelsMap

Map<String,String> getUserLabelsMap()

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 7;

getUserLabelsOrDefault

String getUserLabelsOrDefault(String key,
                              String defaultValue)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 7;

getUserLabelsOrThrow

String getUserLabelsOrThrow(String key)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 7;