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.
- AroundPrecisionFromValueInner
- AutomaticFacetFilter
- BaseRecommendationsQuery
- BaseRecommendRequest
- BaseSearchParams
- BaseSearchParamsWithoutQuery
- BaseSearchResponse
- BaseSearchResponseRedirect
- BaseTrendingFacetsQuery
- BaseTrendingItemsQuery
- ClientOptions
- Condition
- Consequence
- ConsequenceHide
- ConsequenceParams
- ConsequenceQueryObject
- DeletedAtResponse
- Edit
- ErrorBase
- FacetOrdering
- Facets
- FacetsStats
- GetRecommendationsParams
- GetRecommendationsResponse
- GetRecommendTaskResponse
- HighlightResultOption
- Host
- Represents an Algolia host.
- HttpRequest
- Represents an Http request.
- HttpResponse
- Represents an Http response
- IndexSettingsAsSearchParams
- MatchedGeoLocation
- Params
- Personalization
- PromoteObjectID
- PromoteObjectIDs
- RankingInfo
- RecommendationsQuery
- RecommendationsResponse
- RecommendClient
- RecommendHit
- RecommendHits
- RedirectRuleIndexMetadata
- RedirectRuleIndexMetadataData
- 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.
- RuleResponse
- RuleResponseMetadata
- SearchParamsObject
- SearchParamsQuery
- SearchRecommendRulesParams
- SearchRecommendRulesResponse
- SemanticSearch
- SnippetResultOption
- TrendingFacetsQuery
- TrendingItemsQuery
- Value
Enums
- AdvancedSyntaxFeatures
- AlternativesAsExact
- Anchoring
-
Whether the pattern parameter matches the beginning (
startsWith) or end (endsWith) of the query string, is an exact match (is), or a partial match (contains). - AroundRadiusAll
- CallType
- Indicate whether the HTTP call performed is of type read (GET) or write (POST, PUT ..). Used to determine which timeout duration to use.
- EditType
- Type of edit.
- ExactOnSingleWordQuery
- Determines how the Exact ranking criterion is computed when the query contains only one word.
- MatchLevel
- Indicates how well the attribute matched the search query.
- Mode
- Search mode the index will use to query for results.
- QueryType
- Determines how query words are interpreted as prefixes.
- RecommendationModels
- Recommendation model.
- RecommendModels
- RemoveWordsIfNoResults
- Strategy to remove words from the query when it doesn't match any hits.
- RequestMethod
- Provides enumerated HTTP verbs
- SortRemainingBy
-
How to display the remaining items: -
count: facet count (descending). -alpha: alphabetical (ascending). -hidden: show only pinned values. - TaskStatus
- published if the task has been processed, notPublished otherwise.
- TrendingFacetsModel
- Trending facets model.
- TrendingItemsModel
- Trending items model.
- TypoToleranceEnum
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.