Package com.google.cloud.recommendationengine.v1beta1

Class PredictRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.recommendationengine.v1beta1.PredictRequest
All Implemented Interfaces:
PredictRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class PredictRequest extends com.google.protobuf.GeneratedMessage implements PredictRequestOrBuilder
 Request message for Predict method.
Protobuf type google.cloud.recommendationengine.v1beta1.PredictRequest
See Also:

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       Required. Full resource name of the format:
 `{name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}`
 The id of the recommendation engine placement. This id is used to identify
 the set of models that will be used to make the prediction.

 We currently support three placements with the following IDs by default:

 * `shopping_cart`: Predicts items frequently bought together with one or
 more catalog items in the same shopping session. Commonly displayed after
 `add-to-cart` events, on product detail pages, or on the shopping cart
 page.

 * `home_page`: Predicts the next product that a user will most likely
 engage with or purchase based on the shopping or viewing history of the
 specified `userId` or `visitorId`. For example - Recommendations for you.

 * `product_detail`: Predicts the next product that a user will most likely
 engage with or purchase. The prediction is based on the shopping or
 viewing history of the specified `userId` or `visitorId` and its
 relevance to a specified `CatalogItem`. Typically used on product detail
 pages. For example - More items like this.

 * `recently_viewed_default`: Returns up to 75 items recently viewed by the
 specified `userId` or `visitorId`, most recent ones first. Returns
 nothing if neither of them has viewed any items yet. For example -
 Recently viewed.

 The full list of available placements can be seen at
 https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getName in interface PredictRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. Full resource name of the format:
 `{name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}`
 The id of the recommendation engine placement. This id is used to identify
 the set of models that will be used to make the prediction.

 We currently support three placements with the following IDs by default:

 * `shopping_cart`: Predicts items frequently bought together with one or
 more catalog items in the same shopping session. Commonly displayed after
 `add-to-cart` events, on product detail pages, or on the shopping cart
 page.

 * `home_page`: Predicts the next product that a user will most likely
 engage with or purchase based on the shopping or viewing history of the
 specified `userId` or `visitorId`. For example - Recommendations for you.

 * `product_detail`: Predicts the next product that a user will most likely
 engage with or purchase. The prediction is based on the shopping or
 viewing history of the specified `userId` or `visitorId` and its
 relevance to a specified `CatalogItem`. Typically used on product detail
 pages. For example - More items like this.

 * `recently_viewed_default`: Returns up to 75 items recently viewed by the
 specified `userId` or `visitorId`, most recent ones first. Returns
 nothing if neither of them has viewed any items yet. For example -
 Recently viewed.

 The full list of available placements can be seen at
 https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getNameBytes in interface PredictRequestOrBuilder
      Returns:
      The bytes for name.

    • hasUserEvent

      public boolean hasUserEvent()
       Required. Context about the user, what they are looking at and what action
 they took to trigger the predict request. Note that this user event detail
 won't be ingested to userEvent logs. Thus, a separate userEvent write
 request is required for event logging.
      .google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasUserEvent in interface PredictRequestOrBuilder
      Returns:
      Whether the userEvent field is set.

    • getUserEvent

      public UserEvent getUserEvent()
       Required. Context about the user, what they are looking at and what action
 they took to trigger the predict request. Note that this user event detail
 won't be ingested to userEvent logs. Thus, a separate userEvent write
 request is required for event logging.
      .google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getUserEvent in interface PredictRequestOrBuilder
      Returns:
      The userEvent.

    • getUserEventOrBuilder

      public UserEventOrBuilder getUserEventOrBuilder()
       Required. Context about the user, what they are looking at and what action
 they took to trigger the predict request. Note that this user event detail
 won't be ingested to userEvent logs. Thus, a separate userEvent write
 request is required for event logging.
      .google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getUserEventOrBuilder in interface PredictRequestOrBuilder

    • getPageSize

      public int getPageSize()
       Optional. Maximum number of results to return per page. Set this property
 to the number of prediction results required. If zero, the service will
 choose a reasonable default.
      int32 page_size = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageSize in interface PredictRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

      public String getPageToken()
       Optional. The previous PredictResponse.next_page_token.
      string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageToken in interface PredictRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       Optional. The previous PredictResponse.next_page_token.
      string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageTokenBytes in interface PredictRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • getFilter

      public String getFilter()
       Optional. Filter for restricting prediction results. Accepts values for
 tags and the `filterOutOfStockItems` flag.

 * Tag expressions. Restricts predictions to items that match all of the
 specified tags. Boolean operators `OR` and `NOT` are supported if the
 expression is enclosed in parentheses, and must be separated from the
 tag values by a space. `-"tagA"` is also supported and is equivalent to
 `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings
 with a size limit of 1 KiB.

 * filterOutOfStockItems. Restricts predictions to items that do not have a
 stockState value of OUT_OF_STOCK.

 Examples:

 * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")
 * filterOutOfStockItems  tag=(-"promotional")
 * filterOutOfStockItems
      string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilter in interface PredictRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       Optional. Filter for restricting prediction results. Accepts values for
 tags and the `filterOutOfStockItems` flag.

 * Tag expressions. Restricts predictions to items that match all of the
 specified tags. Boolean operators `OR` and `NOT` are supported if the
 expression is enclosed in parentheses, and must be separated from the
 tag values by a space. `-"tagA"` is also supported and is equivalent to
 `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings
 with a size limit of 1 KiB.

 * filterOutOfStockItems. Restricts predictions to items that do not have a
 stockState value of OUT_OF_STOCK.

 Examples:

 * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")
 * filterOutOfStockItems  tag=(-"promotional")
 * filterOutOfStockItems
      string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilterBytes in interface PredictRequestOrBuilder
      Returns:
      The bytes for filter.

    • getDryRun

      public boolean getDryRun()
       Optional. Use dryRun mode for this prediction query. If set to true, a
 dummy model will be used that returns arbitrary catalog items.
 Note that the dryRun mode should only be used for testing the API, or if
 the model is not ready.
      bool dry_run = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDryRun in interface PredictRequestOrBuilder
      Returns:
      The dryRun.

    • getParamsCount

      public int getParamsCount()
      Description copied from interface: PredictRequestOrBuilder
       Optional. Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem
 object will be returned in the
 `PredictResponse.PredictionResult.itemMetadata` object in the method
 response.
 * `returnItemScore`: Boolean. If set to true, the prediction 'score'
 corresponding to each returned item will be set in the `metadata`
 field in the prediction response. The given 'score' indicates the
 probability of an item being clicked/purchased given the user's context
 and history.
      map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getParamsCount in interface PredictRequestOrBuilder

    • containsParams

      public boolean containsParams(String key)
       Optional. Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem
 object will be returned in the
 `PredictResponse.PredictionResult.itemMetadata` object in the method
 response.
 * `returnItemScore`: Boolean. If set to true, the prediction 'score'
 corresponding to each returned item will be set in the `metadata`
 field in the prediction response. The given 'score' indicates the
 probability of an item being clicked/purchased given the user's context
 and history.
      map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsParams in interface PredictRequestOrBuilder

    • getParams

      @Deprecated public Map<String,com.google.protobuf.Value> getParams()
      Deprecated.
      Use getParamsMap() instead.
      Specified by:
      getParams in interface PredictRequestOrBuilder

    • getParamsMap

      public Map<String,com.google.protobuf.Value> getParamsMap()
       Optional. Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem
 object will be returned in the
 `PredictResponse.PredictionResult.itemMetadata` object in the method
 response.
 * `returnItemScore`: Boolean. If set to true, the prediction 'score'
 corresponding to each returned item will be set in the `metadata`
 field in the prediction response. The given 'score' indicates the
 probability of an item being clicked/purchased given the user's context
 and history.
      map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getParamsMap in interface PredictRequestOrBuilder

    • getParamsOrDefault

      public com.google.protobuf.Value getParamsOrDefault(String key, com.google.protobuf.Value defaultValue)
       Optional. Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem
 object will be returned in the
 `PredictResponse.PredictionResult.itemMetadata` object in the method
 response.
 * `returnItemScore`: Boolean. If set to true, the prediction 'score'
 corresponding to each returned item will be set in the `metadata`
 field in the prediction response. The given 'score' indicates the
 probability of an item being clicked/purchased given the user's context
 and history.
      map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getParamsOrDefault in interface PredictRequestOrBuilder

    • getParamsOrThrow

      public com.google.protobuf.Value getParamsOrThrow(String key)
       Optional. Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem
 object will be returned in the
 `PredictResponse.PredictionResult.itemMetadata` object in the method
 response.
 * `returnItemScore`: Boolean. If set to true, the prediction 'score'
 corresponding to each returned item will be set in the `metadata`
 field in the prediction response. The given 'score' indicates the
 probability of an item being clicked/purchased given the user's context
 and history.
      map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getParamsOrThrow in interface PredictRequestOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: PredictRequestOrBuilder
       Optional. The labels for the predict request.

 * Label keys can contain lowercase letters, digits and hyphens, must start
 with a letter, and must end with a letter or digit.
 * Non-zero label values can contain lowercase letters, digits and hyphens,
 must start with a letter, and must end with a letter or digit.
 * No more than 64 labels can be associated with a given request.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsCount in interface PredictRequestOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Optional. The labels for the predict request.

 * Label keys can contain lowercase letters, digits and hyphens, must start
 with a letter, and must end with a letter or digit.
 * Non-zero label values can contain lowercase letters, digits and hyphens,
 must start with a letter, and must end with a letter or digit.
 * No more than 64 labels can be associated with a given request.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface PredictRequestOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface PredictRequestOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Optional. The labels for the predict request.

 * Label keys can contain lowercase letters, digits and hyphens, must start
 with a letter, and must end with a letter or digit.
 * Non-zero label values can contain lowercase letters, digits and hyphens,
 must start with a letter, and must end with a letter or digit.
 * No more than 64 labels can be associated with a given request.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface PredictRequestOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Optional. The labels for the predict request.

 * Label keys can contain lowercase letters, digits and hyphens, must start
 with a letter, and must end with a letter or digit.
 * Non-zero label values can contain lowercase letters, digits and hyphens,
 must start with a letter, and must end with a letter or digit.
 * No more than 64 labels can be associated with a given request.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface PredictRequestOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Optional. The labels for the predict request.

 * Label keys can contain lowercase letters, digits and hyphens, must start
 with a letter, and must end with a letter or digit.
 * Non-zero label values can contain lowercase letters, digits and hyphens,
 must start with a letter, and must end with a letter or digit.
 * No more than 64 labels can be associated with a given request.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface PredictRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static PredictRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PredictRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PredictRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PredictRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PredictRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PredictRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PredictRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PredictRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PredictRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PredictRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PredictRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PredictRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public PredictRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static PredictRequest.Builder newBuilder()

    • newBuilder

      public static PredictRequest.Builder newBuilder(PredictRequest prototype)

    • toBuilder

      public PredictRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected PredictRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static PredictRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PredictRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<PredictRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public PredictRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder