Interface RecommendResponseOrBuilder (0.45.0)

Version 0.45.0

• 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 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
Type	Description
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
Type	Description
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
Name	Description
index	int The index of the element to return.

Returns
Type	Description
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
Name	Description
index	int The index of the value to return.

Returns
Type	Description
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
Type	Description
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
Type	Description
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.v1alpha.RecommendResponse.RecommendationResult results = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
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.v1alpha.RecommendResponse.RecommendationResult results = 1;

Returns
Type	Description
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.v1alpha.RecommendResponse.RecommendationResult results = 1;

Returns
Type	Description
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.v1alpha.RecommendResponse.RecommendationResult results = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
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.v1alpha.RecommendResponse.RecommendationResult results = 1;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResultOrBuilder>

getValidateOnly()

public abstract boolean getValidateOnly()

True if RecommendRequest.validate_only was set.

bool validate_only = 4;

Returns
Type	Description
boolean	The validateOnly.