Interface RecommendResponseOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
RecommendResponse
,RecommendResponse.Builder
public interface RecommendResponseOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getAttributionToken()
A unique attribution token.com.google.protobuf.ByteString
getAttributionTokenBytes()
A unique attribution token.String
getMissingIds(int index)
IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.com.google.protobuf.ByteString
getMissingIdsBytes(int index)
IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.int
getMissingIdsCount()
IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.List<String>
getMissingIdsList()
IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.RecommendResponse.RecommendationResult
getResults(int index)
A list of recommended Documents.int
getResultsCount()
A list of recommended Documents.List<RecommendResponse.RecommendationResult>
getResultsList()
A list of recommended Documents.RecommendResponse.RecommendationResultOrBuilder
getResultsOrBuilder(int index)
A list of recommended Documents.List<? extends RecommendResponse.RecommendationResultOrBuilder>
getResultsOrBuilderList()
A list of recommended Documents.boolean
getValidateOnly()
True if [RecommendRequest.validate_only][google.cloud.discoveryengine.v1beta.RecommendRequest.validate_only] was set.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getResultsList
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;
-
getResults
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;
-
getResultsCount
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;
-
getResultsOrBuilderList
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;
-
getResultsOrBuilder
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;
-
getAttributionToken
String getAttributionToken()
A unique attribution token. This should be included in the [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.
string attribution_token = 2;
- Returns:
- The attributionToken.
-
getAttributionTokenBytes
com.google.protobuf.ByteString getAttributionTokenBytes()
A unique attribution token. This should be included in the [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.
string attribution_token = 2;
- Returns:
- The bytes for attributionToken.
-
getMissingIdsList
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:
- A list containing the missingIds.
-
getMissingIdsCount
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:
- The count of missingIds.
-
getMissingIds
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;
- Parameters:
index
- The index of the element to return.- Returns:
- The missingIds at the given index.
-
getMissingIdsBytes
com.google.protobuf.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;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the missingIds at the given index.
-
getValidateOnly
boolean getValidateOnly()
True if [RecommendRequest.validate_only][google.cloud.discoveryengine.v1beta.RecommendRequest.validate_only] was set.
bool validate_only = 4;
- Returns:
- The validateOnly.
-
-