RankRequest (proto-google-cloud-discoveryengine-v1alpha 0.45.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.discoveryengine.v1alpha.RankRequest

All Implemented Interfaces:

RankRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class RankRequest
extends com.google.protobuf.GeneratedMessageV3
implements RankRequestOrBuilder
```
```
 Request message for
 [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank]
 method.
 
```
Protobuf type google.cloud.discoveryengine.v1alpha.RankRequest
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RankRequest.Builder` Request message for [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank] method.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`IGNORE_RECORD_DETAILS_IN_RESPONSE_FIELD_NUMBER`
`static int`	`MODEL_FIELD_NUMBER`
`static int`	`QUERY_FIELD_NUMBER`
`static int`	`RANKING_CONFIG_FIELD_NUMBER`
`static int`	`RECORDS_FIELD_NUMBER`
`static int`	`TOP_N_FIELD_NUMBER`
`static int`	`USER_LABELS_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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`	`equals(Object obj)`
`static RankRequest`	`getDefaultInstance()`
`RankRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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.
`com.google.protobuf.Parser<RankRequest>`	`getParserForType()`
`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`	`getSerializedSize()`
`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
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`static RankRequest.Builder`	`newBuilder()`
`static RankRequest.Builder`	`newBuilder(RankRequest prototype)`
`RankRequest.Builder`	`newBuilderForType()`
`protected RankRequest.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static RankRequest`	`parseDelimitedFrom(InputStream input)`
`static RankRequest`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RankRequest`	`parseFrom(byte[] data)`
`static RankRequest`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RankRequest`	`parseFrom(ByteBuffer data)`
`static RankRequest`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RankRequest`	`parseFrom(com.google.protobuf.ByteString data)`
`static RankRequest`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RankRequest`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static RankRequest`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RankRequest`	`parseFrom(InputStream input)`
`static RankRequest`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<RankRequest>`	`parser()`
`RankRequest.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- RANKING_CONFIG_FIELD_NUMBER
```
public static final int RANKING_CONFIG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MODEL_FIELD_NUMBER
```
public static final int MODEL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TOP_N_FIELD_NUMBER
```
public static final int TOP_N_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- QUERY_FIELD_NUMBER
```
public static final int QUERY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RECORDS_FIELD_NUMBER
```
public static final int RECORDS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- IGNORE_RECORD_DETAILS_IN_RESPONSE_FIELD_NUMBER
```
public static final int IGNORE_RECORD_DETAILS_IN_RESPONSE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- USER_LABELS_FIELD_NUMBER
```
public static final int USER_LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getRankingConfig
```
public 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) = { ... }
Specified by:

getRankingConfig in interface RankRequestOrBuilder

Returns:

The rankingConfig.

getRankingConfigBytes
```
public com.google.protobuf.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) = { ... }
Specified by:

getRankingConfigBytes in interface RankRequestOrBuilder

Returns:

The bytes for rankingConfig.

getModel

public 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;

Specified by:: getModel in interface RankRequestOrBuilder
Returns:: The model.

getModelBytes

public 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;

Specified by:: getModelBytes in interface RankRequestOrBuilder
Returns:: The bytes for model.

getTopN

public int getTopN()

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

int32 top_n = 3;

Specified by:: getTopN in interface RankRequestOrBuilder
Returns:: The topN.

getQuery
```
public String getQuery()
```
```
 The query to use.
 
```
string query = 4;
Specified by:

getQuery in interface RankRequestOrBuilder

Returns:

The query.

getQueryBytes
```
public com.google.protobuf.ByteString getQueryBytes()
```
```
 The query to use.
 
```
string query = 4;
Specified by:

getQueryBytes in interface RankRequestOrBuilder

Returns:

The bytes for query.

getRecordsList
```
public List<RankingRecord> getRecordsList()
```
```
 Required. A list of records to rank. At most 200 records to rank.
 
```
repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getRecordsList in interface RankRequestOrBuilder

getRecordsOrBuilderList
```
public List<? extends RankingRecordOrBuilder> getRecordsOrBuilderList()
```
```
 Required. A list of records to rank. At most 200 records to rank.
 
```
repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getRecordsOrBuilderList in interface RankRequestOrBuilder

getRecordsCount
```
public int getRecordsCount()
```
```
 Required. A list of records to rank. At most 200 records to rank.
 
```
repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getRecordsCount in interface RankRequestOrBuilder

getRecords
```
public RankingRecord getRecords(int index)
```
```
 Required. A list of records to rank. At most 200 records to rank.
 
```
repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getRecords in interface RankRequestOrBuilder

getRecordsOrBuilder
```
public RankingRecordOrBuilder getRecordsOrBuilder(int index)
```
```
 Required. A list of records to rank. At most 200 records to rank.
 
```
repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getRecordsOrBuilder in interface RankRequestOrBuilder

getIgnoreRecordDetailsInResponse
```
public 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;
Specified by:

getIgnoreRecordDetailsInResponse in interface RankRequestOrBuilder

Returns:

The ignoreRecordDetailsInResponse.