Interface RecommendResponseOrBuilder (0.17.0)

public interface RecommendResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAttributionToken()

public abstract String getAttributionToken()

A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.

string attribution_token = 2;

Returns
TypeDescription
String

The attributionToken.

getAttributionTokenBytes()

public abstract ByteString getAttributionTokenBytes()

A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.

string attribution_token = 2;

Returns
TypeDescription
ByteString

The bytes for attributionToken.

getMissingIds(int index)

public abstract String getMissingIds(int index)

IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.

repeated string missing_ids = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The missingIds at the given index.

getMissingIdsBytes(int index)

public abstract ByteString getMissingIdsBytes(int index)

IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.

repeated string missing_ids = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the missingIds at the given index.

getMissingIdsCount()

public abstract int getMissingIdsCount()

IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.

repeated string missing_ids = 3;

Returns
TypeDescription
int

The count of missingIds.

getMissingIdsList()

public abstract List<String> getMissingIdsList()

IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.

repeated string missing_ids = 3;

Returns
TypeDescription
List<String>

A list containing the missingIds.

getResults(int index)

public abstract RecommendResponse.RecommendationResult getResults(int index)

A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).

repeated .google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
RecommendResponse.RecommendationResult

getResultsCount()

public abstract int getResultsCount()

A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).

repeated .google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult results = 1;

Returns
TypeDescription
int

getResultsList()

public abstract List<RecommendResponse.RecommendationResult> getResultsList()

A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).

repeated .google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult results = 1;

Returns
TypeDescription
List<RecommendationResult>

getResultsOrBuilder(int index)

public abstract RecommendResponse.RecommendationResultOrBuilder getResultsOrBuilder(int index)

A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).

repeated .google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
RecommendResponse.RecommendationResultOrBuilder

getResultsOrBuilderList()

public abstract List<? extends RecommendResponse.RecommendationResultOrBuilder> getResultsOrBuilderList()

A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).

repeated .google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult results = 1;

Returns
TypeDescription
List<? extends com.google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResultOrBuilder>

getValidateOnly()

public abstract boolean getValidateOnly()

True if RecommendRequest.validate_only was set.

bool validate_only = 4;

Returns
TypeDescription
boolean

The validateOnly.