algoliasearch_lite library

Classes

AddApiKeyResponse
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.
AroundPrecisionFromValueInner
AutomaticFacetFilter
BaseGetApiKeyResponse
BaseIndexSettings
BaseSearchParams
BaseSearchParamsWithoutQuery
BaseSearchResponse
BaseSearchResponseRedirect
BrowseParamsObject
BrowseResponse
BuiltInOperation
ClientOptions
Condition
Consequence
ConsequenceHide
ConsequenceParams
ConsequenceQueryObject
Cursor
DeleteByParams
DictionaryEntry
DictionaryLanguage
Edit
ErrorBase
FacetHits
FacetOrdering
Facets
FacetsStats
FetchedIndex
GetApiKeyResponse
HighlightResultOption
Hit
Host
Represents an Algolia host.
HttpRequest
Represents an Http request.
HttpResponse
Represents an Http response
IndexSettings
IndexSettingsAsSearchParams
Languages
ListIndicesResponse
MatchedGeoLocation
Params
Personalization
PromoteObjectID
PromoteObjectIDs
RankingInfo
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.
Rule
SearchClient
SearchForFacets
SearchForFacetsOptions
SearchForFacetValuesResponse
SearchForHits
SearchForHitsOptions
SearchHits
SearchMethodParams
SearchParamsObject
SearchParamsQuery
SearchParamsString
SearchResponse
SearchResponses
SearchSynonymsResponse
SemanticSearch
SnippetResultOption
Source
StandardEntries
SynonymHit
TimeRange
UpdatedRuleResponse
UserId
Value

Enums

Acl
API key permissions: addObject: required to add or update records, copy or move an index. analytics: required to access the Analytics API. browse: required to view records deleteIndex: required to delete indices. deleteObject: required to delete records. editSettings: required to change index settings. inference: required to access the Inference API. listIndexes: required to list indices. logs: required to access logs of search and indexing operations. recommendation: required to access the Personalization and Recommend APIs. search: required to search records seeUnretrievableAttributes: required to retrieve unretrievableAttributes for all operations that return records. settings: required to examine index settings.
Action
Type of batch operation.
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
BuiltInOperationType
Operation to apply to 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.
DictionaryAction
Actions to perform.
DictionaryEntryState
Indicates whether a dictionary entry is active (enabled) or inactive (disabled).
DictionaryType
EditType
Type of edit.
ExactOnSingleWordQuery
Determines how the Exact ranking criterion is computed when the query contains only one word.
LogType
MatchLevel
Indicates how well the attribute matched the search query.
Mode
Search mode the index will use to query for results.
OperationType
Operation to perform (move or copy).
QueryType
Determines how query words are interpreted as prefixes.
RemoveWordsIfNoResults
Strategy to remove words from the query when it doesn't match any hits.
RequestMethod
Provides enumerated HTTP verbs
ScopeType
SearchStrategy
  • none: executes all queries. - stopIfEnoughMatches: executes queries one by one, stopping further query execution 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
    How to display the remaining items: - count: facet count (descending). - alpha: alphabetical (ascending). - hidden: show only pinned values.
    SynonymType
    Synonym type.
    TaskStatus
    published if the task has been processed, notPublished otherwise.
    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.