- 0.50.0 (latest)
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public interface RankRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getIgnoreRecordDetailsInResponse()
public abstract 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 | |
---|---|
Type | Description |
boolean |
The ignoreRecordDetailsInResponse. |
getModel()
public abstract 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 | |
---|---|
Type | Description |
String |
The model. |
getModelBytes()
public abstract 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 | |
---|---|
Type | Description |
ByteString |
The bytes for model. |
getQuery()
public abstract String getQuery()
The query to use.
string query = 4;
Returns | |
---|---|
Type | Description |
String |
The query. |
getQueryBytes()
public abstract ByteString getQueryBytes()
The query to use.
string query = 4;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for query. |
getRankingConfig()
public abstract String getRankingConfig()
Required. The resource name of the rank service config, such as
projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config
.
string ranking_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The rankingConfig. |
getRankingConfigBytes()
public abstract ByteString getRankingConfigBytes()
Required. The resource name of the rank service config, such as
projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config
.
string ranking_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for rankingConfig. |
getRecords(int index)
public abstract 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];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
RankingRecord |
getRecordsCount()
public abstract 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];
Returns | |
---|---|
Type | Description |
int |
getRecordsList()
public abstract 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];
Returns | |
---|---|
Type | Description |
List<RankingRecord> |
getRecordsOrBuilder(int index)
public abstract 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];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
RankingRecordOrBuilder |
getRecordsOrBuilderList()
public abstract 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];
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.discoveryengine.v1beta.RankingRecordOrBuilder> |
getTopN()
public abstract 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 | |
---|---|
Type | Description |
int |
The topN. |