algoliasearch library

Classes

AddApiKeyResponse
AddedToCartObjectIDs
AddedToCartObjectIDsAfterSearch
AgentSegment
Represents a segment of algolia agent header.
ApiClient
An abstract class representing an API client with specific properties and options.
ApiKey
ApiRequest
Represents an API request to be sent to Algolia.
AssignUserIdParams
AutomaticFacetFilter
BannerImage
BannerImageUrl
BaseGetApiKeyResponse
BaseIndexSettings
BaseSearchParams
BaseSearchParamsWithoutQuery
BaseSearchResponse
BatchAssignUserIdsParams
BatchDictionaryEntriesParams
BatchDictionaryEntriesRequest
BatchParams
BatchRequest
BatchResponse
BatchWriteParams
BrowsePagination
BrowseParamsObject
BrowseResponse
BuiltInOperation
ClickedFilters
ClickedObjectIDs
ClickedObjectIDsAfterSearch
ClientOptions
Condition
Consequence
ConsequenceHide
ConsequenceParams
ConsequenceQueryObject
ConvertedFilters
ConvertedObjectIDs
ConvertedObjectIDsAfterSearch
CreatedAtResponse
Cursor
DeleteApiKeyResponse
DeleteByParams
DeletedAtResponse
DeleteSourceResponse
DictionaryEntry
DictionaryLanguage
DictionarySettingsParams
Edit
EventsResponse
Exhaustive
FacetHits
FacetOrdering
Facets
FacetStats
FetchedIndex
GetApiKeyResponse
GetDictionarySettingsResponse
GetLogsResponse
GetObjectsParams
GetObjectsRequest
GetObjectsResponse
GetTaskResponse
GetTopUserIdsResponse
HasPendingMappingsResponse
HighlightResultOption
Hit
Host
Represents an Algolia host.
HttpRequest
Represents an Http request.
HttpResponse
Represents an Http response
IndexSettings
IndexSettingsAsSearchParams
InsightsClient
InsightsEvents
Languages
ListApiKeysResponse
ListClustersResponse
ListIndicesResponse
ListUserIdsResponse
Log
LogQuery
MatchedGeoLocation
MultipleBatchRequest
MultipleBatchResponse
ObjectData
ObjectDataAfterSearch
OperationIndexParams
Params
Personalization
PromoteObjectID
PromoteObjectIDs
PurchasedObjectIDs
PurchasedObjectIDsAfterSearch
Range
RankingInfo
Redirect
RedirectRuleIndexData
RedirectRuleIndexMetadata
RedirectURL
RemoveUserIdResponse
RenderingContent
ReplaceAllObjectsResponse
ReplaceSourceResponse
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.
Rule
SaveObjectResponse
SaveSynonymResponse
SearchClient
SearchDictionaryEntriesParams
SearchDictionaryEntriesResponse
SearchForFacets
SearchForFacetsOptions
SearchForFacetValuesRequest
SearchForFacetValuesResponse
SearchForHits
SearchForHitsOptions
SearchHits
SearchMethodParams
SearchPagination
SearchParamsObject
SearchParamsQuery
SearchParamsString
SearchResponse
SearchResponses
SearchRulesParams
SearchRulesResponse
SearchSynonymsParams
SearchSynonymsResponse
SearchUserIdsParams
SearchUserIdsResponse
SecuredApiKeyRestrictions
SemanticSearch
SettingsResponse
SnippetResultOption
Source
StandardEntries
SynonymHit
TimeRange
UpdateApiKeyResponse
UpdatedAtResponse
UpdatedAtWithObjectIdResponse
UserHighlightResult
UserHit
UserId
Value
ViewedFilters
ViewedObjectIDs
WaitParams
Wait operation parameters.
Widgets
WithPrimary

Enums

Acl
Access control list permissions.
Action
Type of indexing operation.
AddToCartEvent
AdvancedSyntaxFeatures
AlternativesAsExact
Anchoring
Which part of the search query the pattern should match: - startsWith. The pattern must match the beginning of the query. - endsWith. The pattern must match the end of the query. - is. The pattern must match the query exactly. - contains. The pattern must match anywhere in the query. Empty queries are only allowed as patterns with anchoring: is.
ApiKeyOperation
AroundRadiusAll
Return all records with a valid _geoloc attribute. Don't filter by distance.
BooleanString
BuiltInOperationType
How to change the attribute.
CallType
Indicate whether the HTTP call performed is of type read (GET) or write (POST, PUT ..). Used to determine which timeout duration to use.
ClickEvent
ConversionEvent
DictionaryAction
Actions to perform.
DictionaryEntryState
Whether a dictionary entry is active.
DictionaryEntryType
Whether a dictionary entry is provided by Algolia (standard), or has been added by you (custom).
DictionaryType
EditType
Type of edit.
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.
LogType
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.
OperationType
Operation to perform on the index.
PurchaseEvent
QueryType
Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a 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.
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
ScopeType
SearchStrategy
Strategy for multiple search queries: - none. Run all queries. - stopIfEnoughMatches. Run the queries one by one, stopping as soon as a query matches at least the hitsPerPage number of results.
SearchTypeDefault
  • default: perform a search query - facet searches for facet values.
  • SearchTypeFacet
  • default: perform a search query - facet searches for facet values.
  • 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.
    SynonymType
    Synonym type.
    TaskStatus
    Task status, published if the task is completed, notPublished otherwise.
    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.
  • ViewEvent

    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.