algolia_client_recommend library

Classes

AgentSegment
Represents a segment of algolia agent header.
ApiClient
An abstract class representing an API client with specific properties and options.
ApiRequest
Represents an API request to be sent to Algolia.
AutoFacetFilter
BaseRecommendRequest
BaseSearchParams
BaseSearchParamsWithoutQuery
BaseSearchResponse
BoughtTogetherQuery
ClientOptions
Condition
Consequence
DeletedAtResponse
ErrorBase
Exhaustive
FacetOrdering
Facets
FacetStats
FallbackParams
FrequentlyBoughtTogether
GetRecommendationsParams
GetRecommendationsResponse
GetRecommendTaskResponse
HideConsequenceObject
HighlightResultOption
Host
Represents an Algolia host.
HttpRequest
Represents an Http request.
HttpResponse
Represents an Http response
IndexSettingsAsSearchParams
LookingSimilar
LookingSimilarQuery
MatchedGeoLocation
ParamsConsequence
Personalization
PromoteConsequenceObject
Range
RankingInfo
RecommendationsHits
RecommendationsResults
RecommendClient
RecommendedForYou
RecommendedForYouQuery
RecommendHit
RecommendRule
Redirect
RedirectRuleIndexData
RedirectRuleIndexMetadata
RedirectURL
RelatedProducts
RelatedQuery
RenderingContent
Requester
A contract Requester to define an interface for handling HTTP requests and responses.
RequestOptions
Represents options for configuring a request to an endpoint.
RetryStrategy
Component to run http requests with retry logic.
RuleMetadata
SearchPagination
SearchParams
SearchParamsObject
SearchParamsQuery
SearchRecommendRulesParams
SearchRecommendRulesResponse
SemanticSearch
SnippetResultOption
TrendingFacetHit
TrendingFacets
TrendingFacetsQuery
TrendingItems
TrendingItemsQuery
Value

Enums

AdvancedSyntaxFeatures
AlternativesAsExact
AroundRadiusAll
Return all records with a valid _geoloc attribute. Don't filter by distance.
BooleanString
CallType
Indicate whether the HTTP call performed is of type read (GET) or write (POST, PUT ..). Used to determine which timeout duration to use.
ExactOnSingleWordQuery
Determines how the Exact ranking criterion is computed when the search query has only one word. - attribute. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for "road" will match the value "road", but not "road trip". - none. The Exact ranking criterion is ignored on single-word searches. - word. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't.
FbtModel
Frequently bought together model. This model recommends items that have been purchased within 1 day with the item with the ID objectID.
LookingSimilarModel
Looking similar model. This model recommends items that look similar to the item with the ID objectID based on image attributes in your index.
MatchLevel
Whether the whole query string matches or only a part.
Mode
Search mode the index will use to query for results. This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
QueryType
Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as prefix (prefixLast). To turn off prefix search, use prefixNone. Avoid prefixAll, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see Prefix searching.
RecommendedForYouModel
"Recommened for you" model.
RecommendModels
RelatedModel
Related products or similar content model. This model recommends items that are similar to the item with the ID objectID. Similarity is determined from the user interactions and attributes.
RemoveWordsIfNoResults
Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results. - none. No words are removed when a query doesn't return results. - lastWords. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - firstWords. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - allOptional. Treat all words as optional. For more information, see Remove words to improve results.
RequestMethod
Provides enumerated HTTP verbs
SortRemainingBy
Order of facet values that aren't explicitly positioned with the order setting. - count. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. - alpha. Sort facet values alphabetically. - hidden. Don't show facet values that aren't explicitly positioned.
SupportedLanguage
ISO code for a supported language.
TaskStatus
Task status, published if the task is completed, notPublished otherwise.
TrendingFacetsModel
Trending facet values model. This model recommends trending facet values for the specified facet attribute.
TrendingItemsModel
Trending items model. Trending items are determined from the number of conversion events collected on them.
TypoToleranceEnum
  • min. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - strict. Return matches with the two lowest numbers of typos. With strict, the Typo ranking criterion is applied first in the ranking setting.
  • Exceptions / Errors

    AlgoliaApiException
    Exception thrown when the Algolia API returns an error.
    AlgoliaException
    Abstract base class for all Algolia exceptions.
    AlgoliaIOException
    Exception thrown when there is an input/output error during a request to the Algolia API.
    AlgoliaTimeoutException
    Exception thrown when a request to the Algolia API times out.
    AlgoliaWaitException
    Exception thrown when an error occurs during the wait strategy. For example: maximum number of retry exceeded.
    UnreachableHostsException
    Exception thrown when all hosts for the Algolia API are unreachable.