Package com.algolia.model.recommend

Class RelatedQuery

java.lang.Object
com.algolia.model.recommend.RelatedQuery
All Implemented Interfaces:
RecommendationsRequest
public class RelatedQuery extends Object implements RecommendationsRequest
RelatedQuery

  • Constructor Details

    • RelatedQuery

      public RelatedQuery()

  • Method Details

    • setIndexName

      public RelatedQuery setIndexName(String indexName)

    • getIndexName

      @Nonnull public String getIndexName()
      Index name (case-sensitive).

    • setThreshold

      public RelatedQuery setThreshold(Double threshold)

    • getThreshold

      @Nonnull public Double getThreshold()
      Minimum score a recommendation must have to be included in the response. minimum: 0 maximum: 100

    • setMaxRecommendations

      public RelatedQuery setMaxRecommendations(Integer maxRecommendations)

    • getMaxRecommendations

      @Nullable public Integer getMaxRecommendations()
      Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value. minimum: 1 maximum: 1000

    • setQueryParameters

      public RelatedQuery setQueryParameters(RecommendSearchParams queryParameters)

    • getQueryParameters

      @Nullable public RecommendSearchParams getQueryParameters()
      Get queryParameters

    • setModel

      public RelatedQuery setModel(RelatedModel model)

    • getModel

      @Nonnull public RelatedModel getModel()
      Get model

    • setObjectID

      public RelatedQuery setObjectID(String objectID)

    • getObjectID

      @Nonnull public String getObjectID()
      Unique record identifier.

    • setFallbackParameters

      public RelatedQuery setFallbackParameters(FallbackParams fallbackParameters)

    • getFallbackParameters

      @Nullable public FallbackParams getFallbackParameters()
      Get fallbackParameters

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object