public final class RankRequest extends GeneratedMessageV3 implements RankRequestOrBuilder
Request message for
RankService.Rank
method.
Protobuf type google.cloud.discoveryengine.v1beta.RankRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
IGNORE_RECORD_DETAILS_IN_RESPONSE_FIELD_NUMBER
public static final int IGNORE_RECORD_DETAILS_IN_RESPONSE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MODEL_FIELD_NUMBER
public static final int MODEL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RANKING_CONFIG_FIELD_NUMBER
public static final int RANKING_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RECORDS_FIELD_NUMBER
public static final int RECORDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TOP_N_FIELD_NUMBER
public static final int TOP_N_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static RankRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RankRequest.Builder newBuilder()
newBuilder(RankRequest prototype)
public static RankRequest.Builder newBuilder(RankRequest prototype)
public static RankRequest parseDelimitedFrom(InputStream input)
public static RankRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RankRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RankRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RankRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RankRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RankRequest parseFrom(CodedInputStream input)
public static RankRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RankRequest parseFrom(InputStream input)
public static RankRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RankRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RankRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RankRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public RankRequest getDefaultInstanceForType()
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;
| Returns |
| Type |
Description |
boolean |
The ignoreRecordDetailsInResponse.
|
getModel()
The identifier of the model to use. It is one of:
string model = 2;
| Returns |
| Type |
Description |
String |
The model.
|
getModelBytes()
public ByteString getModelBytes()
The identifier of the model to use. It is one of:
string model = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for model.
|
getParserForType()
public Parser<RankRequest> getParserForType()
Overrides
getQuery()
The query to use.
string query = 4;
| Returns |
| Type |
Description |
String |
The query.
|
getQueryBytes()
public ByteString getQueryBytes()
The query to use.
string query = 4;
| Returns |
| Type |
Description |
ByteString |
The bytes for query.
|
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) = { ... }
| Returns |
| Type |
Description |
String |
The rankingConfig.
|
getRankingConfigBytes()
public 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 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
|
getRecordsCount()
public 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 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];
getRecordsOrBuilder(int index)
public 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
|
getRecordsOrBuilderList()
public 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> |
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public RankRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RankRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public RankRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
