com.algolia.search.RecommendClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of algoliasearch-core Show documentation
The newest version!
package com.algolia.search;

import com.algolia.search.exceptions.LaunderThrowable;
import com.algolia.search.models.HttpMethod;
import com.algolia.search.models.RequestOptions;
import com.algolia.search.models.common.CallType;
import com.algolia.search.models.indexing.RecommendHit;
import com.algolia.search.models.indexing.RecommendationsResult;
import com.algolia.search.models.recommend.*;
import java.io.Closeable;
import java.io.IOException;
import java.util.List;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import javax.annotation.Nonnull;

/**
 * Algolia's REST recommend client that wraps an instance of the transporter {@link HttpTransport}
 * which wraps the HTTP Client This client allows to build typed requests and read typed responses.
 * Requests are made under the Algolia's retry-strategy. This client is intended to be reused, and
 * it's thread-safe.
 *
 * @see Algolia.com
 */
public final class RecommendClient implements Closeable {

  /** The transport layer. Should be reused. */
  private final HttpTransport transport;

  /** Client's configuration. Must be reused. */
  private final SearchConfig config;

  public RecommendClient(@Nonnull SearchConfig config, @Nonnull HttpRequester httpRequester) {
    Objects.requireNonNull(httpRequester, "An httpRequester is required.");
    Objects.requireNonNull(config, "A configuration is required.");
    this.config = config;
    this.transport = new HttpTransport(config, httpRequester);
  }

  /**
   * Close the underlying Http Client
   *
   * @throws IOException if an I/O error occurs
   */
  @Override
  public void close() throws IOException {
    transport.close();
  }

  /** Transport object responsible for the serialization/deserialization and the retry strategy. */
  public HttpTransport getTransport() {
    return transport;
  }

  public SearchConfig getConfig() {
    return config;
  }

  // region get_recommendations
  /**
   * Returns recommendations for a specific model and objectID.
   *
   * @param requests a list of recommendation requests to execute
   * @param clazz The class held by the index. Could be your business object or {@link Object}
   */
  public  List> getRecommendations(
      @Nonnull List requests, @Nonnull Class clazz) {
    return LaunderThrowable.await(getRecommendationsAsync(requests, clazz));
  }

  /**
   * Returns recommendations for a specific model and objectID.
   *
   * @param requests a list of recommendation requests to execute
   * @param clazz The class held by the index. Could be your business object or {@link Object}
   * @param requestOptions options to pass to this request
   */
  public  List> getRecommendations(
      @Nonnull List requests,
      @Nonnull Class clazz,
      RequestOptions requestOptions) {
    return LaunderThrowable.await(getRecommendationsAsync(requests, clazz, requestOptions));
  }

  /**
   * Returns recommendations for a specific model and objectID.
   *
   * @param requests a list of recommendation requests to execute
   * @param clazz The class held by the index. Could be your business object or {@link Object}
   */
  public 
      CompletableFuture>> getRecommendationsAsync(
          @Nonnull List requests, @Nonnull Class clazz) {
    return getRecommendationsAsync(requests, clazz, null);
  }

  /**
   * Returns recommendations for a specific model and objectID.
   *
   * @param requests a list of recommendation requests to execute
   * @param clazz The class held by the index. Could be your business object or {@link Object}
   * @param requestOptions options to pass to this request
   */
  public 
      CompletableFuture>> getRecommendationsAsync(
          @Nonnull List requests,
          @Nonnull Class clazz,
          RequestOptions requestOptions) {
    Objects.requireNonNull(requests);
    Objects.requireNonNull(clazz);
    RecommendationsRequests data = new RecommendationsRequests<>(requests);
    return performGetRecommends(clazz, requestOptions, data);
  }
  // endregion

  // region get_related_products
  /**
   * Returns related products recommendations for a specific model and objectID.
   *
   * @param requests a list of recommendation requests to execute
   * @param clazz The class held by the index. Could be your business object or {@link Object}
   */
  public  List> getRelatedProducts(
      @Nonnull List requests, @Nonnull Class clazz) {
    return LaunderThrowable.await(getRelatedProductsAsync(requests, clazz));
  }

  /**
   * Returns related products recommendations for a specific model and objectID.
   *
   * @param requests a list of recommendation requests to execute
   * @param clazz The class held by the index. Could be your business object or {@link Object}
   * @param requestOptions options to pass to this request
   */
  public  List> getRelatedProducts(
      @Nonnull List requests,
      @Nonnull Class clazz,
      RequestOptions requestOptions) {
    return LaunderThrowable.await(getRelatedProductsAsync(requests, clazz, requestOptions));
  }

  /**
   * Returns related products recommendations for a specific model and objectID.
   *
   * @param requests a list of recommendation requests to execute
   * @param clazz The class held by the index. Could be your business object or {@link Object}
   */
  public 
      CompletableFuture>> getRelatedProductsAsync(
          @Nonnull List requests, @Nonnull Class clazz) {
    return getRelatedProductsAsync(requests, clazz, null);
  }

  /**
   * Returns related products recommendations for a specific model and objectID.
   *
   * @param requests a list of recommendation requests to execute
   * @param clazz The class held by the index. Could be your business object or {@link Object}
   * @param requestOptions options to pass to this request
   */
  public 
      CompletableFuture>> getRelatedProductsAsync(
          @Nonnull List requests,
          @Nonnull Class clazz,
          RequestOptions requestOptions) {
    Objects.requireNonNull(requests);
    Objects.requireNonNull(clazz);
    RecommendationsRequests data = new RecommendationsRequests<>(requests);
    return performGetRecommends(clazz, requestOptions, data);
  }
  // endregion

  // region get_frequently_bought_together
  /**
   * Returns frequently bought together recommendations for a specific model and objectID.
   *
   * @param requests a list of recommendation requests to execute
   * @param clazz The class held by the index. Could be your business object or {@link Object}
   */
  public  List> getFrequentlyBoughtTogether(
      @Nonnull List requests, @Nonnull Class clazz) {
    return LaunderThrowable.await(getFrequentlyBoughtTogetherAsync(requests, clazz));
  }

  /**
   * Returns frequently bought together recommendations for a specific model and objectID.
   *
   * @param requests a list of recommendation requests to execute
   * @param clazz The class held by the index. Could be your business object or {@link Object}
   * @param requestOptions options to pass to this request
   */
  public  List> getFrequentlyBoughtTogether(
      @Nonnull List requests,
      @Nonnull Class clazz,
      RequestOptions requestOptions) {
    return LaunderThrowable.await(
        getFrequentlyBoughtTogetherAsync(requests, clazz, requestOptions));
  }

  /**
   * Returns frequently bought together recommendations for a specific model and objectID.
   *
   * @param requests a list of recommendation requests to execute
   * @param clazz The class held by the index. Could be your business object or {@link Object}
   */
  public 
      CompletableFuture>> getFrequentlyBoughtTogetherAsync(
          @Nonnull List requests, @Nonnull Class clazz) {
    return getFrequentlyBoughtTogetherAsync(requests, clazz, null);
  }

  /**
   * Returns frequently bought together recommendations for a specific model and objectID.
   *
   * @param requests a list of recommendation requests to execute
   * @param clazz The class held by the index. Could be your business object or {@link Object}
   * @param requestOptions options to pass to this request
   */
  public 
      CompletableFuture>> getFrequentlyBoughtTogetherAsync(
          @Nonnull List requests,
          @Nonnull Class clazz,
          RequestOptions requestOptions) {
    Objects.requireNonNull(requests);
    Objects.requireNonNull(clazz);
    RecommendationsRequests data =
        new RecommendationsRequests<>(requests);
    return performGetRecommends(clazz, requestOptions, data);
  }
  // endregion

  @SuppressWarnings("unchecked")
  private 
      CompletableFuture>> performGetRecommends(
          Class clazz, RequestOptions requestOptions, RecommendationsRequests data) {
    return transport
        .executeRequestAsync(
            HttpMethod.POST,
            "/1/indexes/*/recommendations",
            CallType.READ,
            data,
            GetRecommendationsResponse.class,
            clazz,
            requestOptions)
        .thenComposeAsync(
            resp -> {
              CompletableFuture>> r = new CompletableFuture<>();
              r.complete(resp.getResults());
              return r;
            },
            config.getExecutor());
  }
}