com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1RankRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1RankRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1RankRequest
extends com.google.api.client.json.GenericJson

Request message for RankService.Rank method.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1RankRequest()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1RankRequest	clone()
Boolean	getIgnoreRecordDetailsInResponse() If true, the response will contain only record ID and score.
String	getModel() The identifier of the model to use.
String	getQuery() The query to use.
List<GoogleCloudDiscoveryengineV1RankingRecord>	getRecords() Required.
Integer	getTopN() The number of results to return.
Map<String,String>	getUserLabels() The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.
GoogleCloudDiscoveryengineV1RankRequest	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1RankRequest	setIgnoreRecordDetailsInResponse(Boolean ignoreRecordDetailsInResponse) If true, the response will contain only record ID and score.
GoogleCloudDiscoveryengineV1RankRequest	setModel(String model) The identifier of the model to use.
GoogleCloudDiscoveryengineV1RankRequest	setQuery(String query) The query to use.
GoogleCloudDiscoveryengineV1RankRequest	setRecords(List<GoogleCloudDiscoveryengineV1RankingRecord> records) Required.
GoogleCloudDiscoveryengineV1RankRequest	setTopN(Integer topN) The number of results to return.
GoogleCloudDiscoveryengineV1RankRequest	setUserLabels(Map<String,String> userLabels) 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 class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1RankRequest

public GoogleCloudDiscoveryengineV1RankRequest()

Method Detail

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.

Returns:

value or null for none

setIgnoreRecordDetailsInResponse

public GoogleCloudDiscoveryengineV1RankRequest setIgnoreRecordDetailsInResponse(Boolean ignoreRecordDetailsInResponse)

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

Parameters:

ignoreRecordDetailsInResponse - ignoreRecordDetailsInResponse or null for none

getModel

public String getModel()

The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maximum input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified.

Returns:

value or null for none

setModel

public GoogleCloudDiscoveryengineV1RankRequest setModel(String model)

The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maximum input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified.

Parameters:

model - model or null for none

getQuery

public String getQuery()

The query to use.

Returns:

value or null for none

setQuery

public GoogleCloudDiscoveryengineV1RankRequest setQuery(String query)

The query to use.

Parameters:

query - query or null for none

getRecords

public List<GoogleCloudDiscoveryengineV1RankingRecord> getRecords()

Required. A list of records to rank.

Returns:

value or null for none

setRecords

public GoogleCloudDiscoveryengineV1RankRequest setRecords(List<GoogleCloudDiscoveryengineV1RankingRecord> records)

Required. A list of records to rank.

Parameters:

records - records or null for none

getTopN

public Integer getTopN()

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

Returns:

value or null for none

setTopN

public GoogleCloudDiscoveryengineV1RankRequest setTopN(Integer topN)

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

Parameters:

topN - topN or null for none

getUserLabels

public Map<String,String> getUserLabels()

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.

Returns:

value or null for none

setUserLabels

public GoogleCloudDiscoveryengineV1RankRequest setUserLabels(Map<String,String> userLabels)

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.

Parameters:

userLabels - userLabels or null for none

set

public GoogleCloudDiscoveryengineV1RankRequest set(String fieldName,
                                                   Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1RankRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson