Package org.apache.beam.sdk.extensions.ml

Class RecommendationAIPredict

java.lang.Object
org.apache.beam.sdk.transforms.PTransform<PCollection<com.google.api.client.json.GenericJson>,PCollectionTuple>
org.apache.beam.sdk.extensions.ml.RecommendationAIPredict
All Implemented Interfaces:
Serializable, HasDisplayData
public abstract class RecommendationAIPredict extends PTransform<PCollection<com.google.api.client.json.GenericJson>,PCollectionTuple>
A PTransform using the Recommendations AI API (https://cloud.google.com/recommendations). Takes an input PCollection of GenericJsons and creates PredictResponse.PredictionResults.

It is possible to provide a catalog name to which you want to add the user event (defaults to "default_catalog"). It is possible to provide a event store to which you want to add the user event (defaults to "default_event_store"). A placement id for the recommendation engine placement to be used.

See Also:

  • Field Details

    • SUCCESS_TAG

      public static final TupleTag<com.google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult> SUCCESS_TAG

    • FAILURE_TAG

      public static final TupleTag<com.google.cloud.recommendationengine.v1beta1.UserEvent> FAILURE_TAG

  • Constructor Details

    • RecommendationAIPredict

      public RecommendationAIPredict()

  • Method Details

    • projectId

      @Nullable public abstract String projectId()
      Returns:
      ID of Google Cloud project to be used for creating catalog items.

    • catalogName

      @Nullable public abstract String catalogName()
      Returns:
      Name of the catalog where the catalog items will be created.

    • eventStore

      @Nullable public abstract String eventStore()
      Returns:
      Name of the event store where the user events will be created.

    • placementId

      public abstract String placementId()
      Returns:
      ID of the recommendation engine placement.

    • withProjectId

      public RecommendationAIPredict withProjectId(String projectId)

    • withCatalogName

      public RecommendationAIPredict withCatalogName(String catalogName)

    • withEventStore

      public RecommendationAIPredict withEventStore(String eventStore)

    • withPlacementId

      public RecommendationAIPredict withPlacementId(String placementId)

    • expand

      public PCollectionTuple expand(PCollection<com.google.api.client.json.GenericJson> input)
      Description copied from class: PTransform
      Override this method to specify how this PTransform should be expanded on the given InputT.

      NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

      Composite transforms, which are defined in terms of other transforms, should return the output of one of the composed transforms. Non-composite transforms, which do not apply any transforms internally, should return a new unbound output and register evaluators (via backend-specific registration methods).

      Specified by:
      expand in class PTransform<PCollection<com.google.api.client.json.GenericJson>,PCollectionTuple>