All Classes and Interfaces
Class
Description
ABTest
ABTestResponse
AbTestsVariant
AbTestsVariantSearchParams
API key permissions: `addObject`: required to add or update records, copy or move an index.
Type of batch operation.
The action to perform on the Algolia index.
AddABTestsRequest
AddABTestsVariant
AddApiKeyResponse
Use this event to track when users add items to their shopping cart unrelated to a previous
Algolia request.
Use this event to track when users add items to their shopping cart after a previous Algolia
request.
Gets or Sets AddToCartEvent
Gets or Sets advancedSyntaxFeatures
Gets or Sets advancedSyntaxFeatures
Exception thrown in case of API failure such as 4XX, 5XX error.
Exception thrown when an error occurs during API requests.
Represents a retryable exception (4XX).
Exception thrown in case of API failure such as 4XX, 5XX error.
Exception thrown when an error occurs during the waitForTask strategy.
Exception thrown when an error occurs during the retry strategy.
Exception thrown when an error occurs during the Serialization/Deserialization process
Gets or Sets alternativesAsExact
Gets or Sets alternativesAsExact
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`).
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`).
Represents a base client for making API requests.
API key object.
Precision of a geographical search (in meters), to [group results that are more or less the same
distance from a central
point](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/in-depth/geo-ranking-precision/).
Precision of a geographical search (in meters), to [group results that are more or less the same
distance from a central
point](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/in-depth/geo-ranking-precision/).
AroundPrecision as Integer wrapper.
AroundPrecision as Integer wrapper.
AroundPrecision as List wrapper.
AroundPrecision as List wrapper.
AroundPrecisionFromValueInner
AroundPrecisionFromValueInner
[Maximum
radius](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#increase-the-search-radius)
for a geographical search (in meters).
[Maximum
radius](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#increase-the-search-radius)
for a geographical search (in meters).
AroundRadius as Integer wrapper.
AroundRadius as Integer wrapper.
Gets or Sets aroundRadiusAll
Gets or Sets aroundRadiusAll
Assign userID parameters.
AttributeToUpdate
AttributeToUpdate as String wrapper.
AuthAlgolia
AuthAlgoliaPartial
Authentication input used for token credentials.
Authentication input used for token credentials.
Authentication input for Basic login with username and password.
Authentication input for Basic login with username and password.
An authentication is used to login into a Source or a Destination.
The payload when creating an authentication.
Response from the API when the Authentication is successfully created.
Payload to search for multiple authentications, based on the given `authenticationIDs`.
Used to sort the Authentication list endpoint.
Type of the Authentication, defines what kind of object is stored in the input.
Payload to partially update an Authentication.
Response from the API when the Authentication is successfully updated.
Authentication input to connect to a Google service (e.g.
Authentication input to connect to a Google service (e.g.
AuthInput
AuthInputPartial
Authentication input for OAuth login.
Authentication input for OAuth login.
Automatic facet Filter.
Automatic facet Filter.
Names of facets to which automatic filtering must be applied; they must match the facet name of a
facet value placeholder in the query pattern.
Names of facets to which automatic filtering must be applied; they must match the facet name of a
facet value placeholder in the query pattern.
AutomaticFacetFilters as List wrapper.
AutomaticFacetFilters as List wrapper.
AutomaticFacetFilters as List wrapper.
AutomaticFacetFilters as List wrapper.
AverageClickEvent
BaseGetApiKeyResponse
BaseIndexSettings
BaseQuerySuggestionsConfigurationResponse
BaseQuerySuggestionsConfigurationWithIndex
BaseRecommendationsQuery
BaseRecommendedForYouQuery
BaseRecommendedForYouQueryParameters
BaseRecommendRequest
BaseResponse
BaseSearchParams
BaseSearchParams
BaseSearchParamsWithoutQuery
BaseSearchParamsWithoutQuery
BaseSearchResponse
BaseSearchResponse
BaseTrendingFacetsQuery
BaseTrendingItemsQuery
Assign userID parameters.
`batchDictionaryEntries` parameters.
BatchDictionaryEntriesRequest
Batch parameters.
BatchRequest
BatchResponse
Batch parameters.
BigCommerceChannel
BigCommerceMetafield
Gets or Sets BigQueryDataType
BrowseParams
BrowseParamsObject
BrowseResponse
To update an attribute without pushing the entire record, you can use these built-in operations.
Operation to apply to the attribute.
Use this event to track when users click facet filters in your user interface.
Use this event to track when users click items unrelated to a previous Algolia request.
Click event after an Algolia request.
Gets or Sets ClickEvent
ClickPosition
ClickThroughRateEvent
Condition
Condition
[Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences)
of a rule.
[Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences)
of a rule.
Unique identifier of the record to hide.
Unique identifier of the record to hide.
ConsequenceParams
ConsequenceParams
When providing a string, it replaces the entire query string.
When providing a string, it replaces the entire query string.
ConsequenceQuery as String wrapper.
ConsequenceQuery as String wrapper.
ConsequenceQueryObject
ConsequenceQueryObject
Gets or Sets ConversionEvent
ConversionRateEvent
ConvertedFilters
Use this event to track when users convert on items unrelated to a previous Algolia request.
Use this event to track when users convert after a previous Algolia request.
Response and creation timestamp.
CurrenciesValue
Cursor
Applies search parameters from [a restricted set of
options](https://www.algolia.com/doc/api-reference/api-methods/add-ab-test/#method-param-customsearchparameters).
DeleteApiKeyResponse
DeleteByParams
Response, taskID, and deletion timestamp.
Response, taskID, and deletion timestamp.
DeleteResponse
DeleteSourceResponse
DeleteUserProfileResponse
A destination describe how the data is indexed on the Algolia side.
The payload when creating a destination.
Response from the API when the Destination is successfully created.
DestinationIndexName
DestinationIndexPrefix
DestinationInput
Payload to search for multiple destinations, based on the given `destinationIDs`.
Used to sort the Destination list endpoint.
Type of the Destination, defines in which Algolia product the data will be stored.
Payload to partially update a Destination.
Response from the API when the Destination is successfully updated.
Actions to perform.
Dictionary entry.
Indicates whether a dictionary entry is active (`enabled`) or inactive (`disabled`).
Custom entries for a dictionary.
Enable or turn off the built-in Algolia stop words for a specific language.
Gets or Sets dictionaryType
Gets or Sets direction
The absolute value of the discount for this product, in units of `currency`.
Discount as Double wrapper.
Discount as String wrapper.
Enables [deduplication or grouping of results (Algolia's _distinct_
feature](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature)).
Enables [deduplication or grouping of results (Algolia's _distinct_
feature](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature)).
Distinct as Boolean wrapper.
Distinct as Boolean wrapper.
Distinct as Integer wrapper.
Distinct as Integer wrapper.
The type of the image.
The registry where the image is stored.
DockerSourceDiscover
DockerSourceStreams
Edit
Edit
Type of edit.
Type of edit.
Error.
Error.
Error.
Error.
Error.
Error.
Error.
Error.
Error.
An event describe a step of the task execution flow..
EventScoring
EventsItems
Used to sort the Event list endpoint.
The response of the Insights API.
Gets or Sets EventStatus
Gets or Sets EventType
Determines how the [Exact ranking
criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes)
is computed when the query contains only one word.
Determines how the [Exact ranking
criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes)
is computed when the query contains only one word.
Whether certain properties of the search response are calculated exhaustive (exact) or
approximated.
Whether certain properties of the search response are calculated exhaustive (exact) or
approximated.
Facet to use as category.
[Filter hits by facet
value](https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/).
[Filter hits by facet
value](https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/).
FacetFilters as List wrapper.
FacetFilters as List wrapper.
FacetFilters as String wrapper.
FacetFilters as String wrapper.
FacetHits
Defines the ordering of facets (widgets).
Defines the ordering of facets (widgets).
Ordering of facets (widgets).
Ordering of facets (widgets).
FacetScoring
FacetsStats
FacetsStats
FetchedIndex
A/B test filter effects resulting from configuration settings.
Empty searches removed from the A/B test as a result of configuration settings.
Outliers removed from the A/B test as a result of configuration settings.
GetApiKeyResponse
GetAverageClickPositionResponse
GetClickPositionsResponse
GetClickThroughRateResponse
GetConfigStatus200Response
GetConversationRateResponse
GetDictionarySettingsResponse
GetInventory403Response
GetLogFile200Response
GetLogsResponse
GetNoClickRateResponse
GetNoResultsRateResponse
Request parameters.
Record retrieval operation.
GetObjectsResponse
Recommend parameters.
GetRecommendationsResponse
GetRecommendTaskResponse
GetSearchesCountResponse
GetSearchesNoClicksResponse
GetSearchesNoResultsResponse
GetStatusResponse
GetTaskResponse
GetTopCountriesResponse
GetTopFilterAttribute
GetTopFilterAttributesResponse
GetTopFilterForAttribute
GetTopFilterForAttributeResponse
GetTopFiltersNoResultsResponse
GetTopFiltersNoResultsValue
GetTopFiltersNoResultsValues
GetTopHitsResponse
GetTopSearchesResponse
User IDs and clusters.
GetUsersCountResponse
GetUserTokenResponse
This interceptor compresses the HTTP request body.
HasPendingMappingsResponse
HighlightResult
HighlightResult
HighlightResult as Map<String, HighlightResultOption> wrapper.
HighlightResult as Map<String, HighlightResultOption> wrapper.
Show highlighted section and words matched on a query.
Show highlighted section and words matched on a query.
A single hit.
HttpRequester is responsible for making HTTP requests using the OkHttp client.
The Builder class for HttpRequester.
Treats singular, plurals, and other forms of declensions as matching terms.
Treats singular, plurals, and other forms of declensions as matching terms.
IgnorePlurals as Boolean wrapper.
IgnorePlurals as Boolean wrapper.
IgnorePlurals as List wrapper.
IgnorePlurals as List wrapper.
Incident details.
IncidentsInner
IncidentsResponse
IndexingTimeResponse
IndexingTimeResponseMetrics
Algolia index settings.
IndexSettingsAsSearchParams
IndexSettingsAsSearchParams
InfrastructureResponse
InfrastructureResponseMetrics
InsightsEvents
InventoryResponse
Utility class for JSON serialization and deserialization using Jackson.
Set the language for deduplicating singular and plural suggestions.
Dictionary language.
Languages as Boolean wrapper.
Languages as List wrapper.
LatencyResponse
LatencyResponseMetrics
ListABTestsResponse
ListApiKeysResponse
ListAuthenticationsResponse
Clusters.
ListDestinationsResponse
ListEventsResponse
ListIndicesResponse
ListSourcesResponse
A list of tasks with pagination details.
User ID data.
Log
An interceptor that facilitates HTTP logging based on the provided logging level.
The type of log entry.
LogQuery
Gets or Sets logType
Gets or Sets MappingTypeCSV
MatchedGeoLocation
MatchedGeoLocation
Indicates how well the attribute matched the search query.
Indicates how well the attribute matched the search query.
Gets or Sets MethodType
Gets or Sets Metric
MixedSearchFilters
MixedSearchFilters
MixedSearchFilters as List wrapper.
MixedSearchFilters as List wrapper.
MixedSearchFilters as String wrapper.
MixedSearchFilters as String wrapper.
Search mode the index will use to query for results.
Search mode the index will use to query for results.
MultipleBatchRequest
MultipleBatchResponse
NoClickRateEvent
NoResultsRateEvent
[Filter on numeric
attributes](https://www.algolia.com/doc/api-reference/api-parameters/numericFilters/).
[Filter on numeric
attributes](https://www.algolia.com/doc/api-reference/api-parameters/numericFilters/).
NumericFilters as List wrapper.
NumericFilters as List wrapper.
NumericFilters as String wrapper.
NumericFilters as String wrapper.
ObjectData
ObjectDataAfterSearch
The input for an `onDemand` task whose source is of type `bigquery` and for which extracted data
spans a given time range.
The trigger information of a task of type `onDemand`.
The trigger information of a task of type `onDemand`.
A task which is manually executed via the run task endpoint.
OperationIndexParams
Operation to perform (_move_ or _copy_).
Create filters to boost or demote records.
Create filters to boost or demote records.
OptionalFilters as List wrapper.
OptionalFilters as List wrapper.
OptionalFilters as String wrapper.
OptionalFilters as String wrapper.
Method for ordering results.
Used to order a sorted request.
Pagination
Additional search parameters.
Additional search parameters.
Gets or Sets Period
Personalization
Personalization
PersonalizationStrategyParams
Describe which platform the Authentication is used for.
Used to filter Authentication without platform property.
PlatformWithNone
The total price of a product, including any discounts, in units of `currency`.
Price as Double wrapper.
Price as String wrapper.
ProbesMetric
Promote
Promote
Record to promote.
Record to promote.
Records to promote.
Records to promote.
Use this event to track when users make a purchase unrelated to a previous Algolia request.
Use this event to track when users make a purchase after a previous Algolia request.
Gets or Sets PurchaseEvent
Query Suggestions configuration.
QuerySuggestionsConfigurationResponse
Query Suggestions configuration.
Determines how query words are [interpreted as
prefixes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
Determines how query words are [interpreted as
prefixes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
RankingInfo
RankingInfo
Recommendation model.
RecommendationsHit
RecommendationsHit as RecommendHit wrapper.
RecommendationsHits
RecommendationsQuery
RecommendationsRequest
RecommendationsResults
Recommended for you model.
RecommendedForYouQuery
RecommendedForYouQueryParameters
Recommend hit.
Gets or Sets recommendModels
Determines the indexing strategy to use for a given e-commerce source.
[Redirect results to a
URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/).
[Redirect results to a
URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/).
RedirectRuleIndexMetadata
RedirectRuleIndexMetadata
Redirect rule data.
Redirect rule data.
The region where the cluster is located.
Removes stop (common) words from the query before executing it.
Removes stop (common) words from the query before executing it.
RemoveStopWords as Boolean wrapper.
RemoveStopWords as Boolean wrapper.
RemoveStopWords as List wrapper.
RemoveStopWords as List wrapper.
RemoveUserIdResponse
Strategy to [remove
words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/)
from the query when it doesn't match any hits.
Strategy to [remove
words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/)
from the query when it doesn't match any hits.
Extra content for the search UI, for example, to control the [ordering and display of
facets](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/merchandising-facets/#merchandise-facets-and-their-values-in-the-manual-editor).
Extra content for the search UI, for example, to control the [ordering and display of
facets](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/merchandising-facets/#merchandise-facets-and-their-values-in-the-manual-editor).
ReplaceSourceResponse
Represents a mechanism for executing HTTP requests and deserializing responses.
Request options are used to pass extra parameters, headers, timeout to the request.
When [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) is enabled,
only records that match these filters will be affected by Dynamic Re-Ranking.
When [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) is enabled,
only records that match these filters will be affected by Dynamic Re-Ranking.
ReRankingApplyFilter as List wrapper.
ReRankingApplyFilter as List wrapper.
ReRankingApplyFilter as String wrapper.
ReRankingApplyFilter as String wrapper.
A retry strategy that implements
Interceptor, responsible for routing requests to hosts
based on their state and call type.Rule object.
Rule object.
RuleResponseMetadata
Run
RunListResponse
Gets or Sets RunOutcome
RunProgress
An identifier that pairs with the outcome reason.
The response from the run task API, containing an Observability Run ID and the time it was
created at.
Used to sort the Run list endpoint.
Gets or Sets RunStatus
Gets or Sets RunType
SaveObjectResponse
SaveSynonymResponse
The input for a `schedule` task whose source is of type `bigquery` and for which extracted data
spans a fixed number of days.
The trigger information for a task of type 'schedule'.
The trigger input for a task of type 'schedule'.
A task which is triggered by a schedule (cron expression).
Gets or Sets scopeType
`searchDictionaryEntries` parameters.
SearchEvent
SearchForFacets
SearchForFacetsOptions
SearchForFacetValuesRequest
SearchForFacetValuesResponse
SearchForHits
SearchForHitsOptions
SearchHits
SearchMethodParams
SearchNoClickEvent
SearchNoResultEvent
SearchParams
SearchParamsObject
SearchParamsObject
SearchParamsQuery
SearchParamsQuery
SearchParamsString
SearchQuery
Recommend rules search parameters.
SearchRecommendRulesResponse
SearchResponse
SearchResponses
SearchResult
Rules search parameters.
SearchRulesResponse
- `none`: executes all queries.
SearchSynonymsParams
SearchSynonymsResponse
- `default`: perform a search query - `facet` [searches for facet
values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
- `default`: perform a search query - `facet` [searches for facet
values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
OK
userIDs data.
Settings for the semantic search part of NeuralSearch.
Settings for the semantic search part of NeuralSearch.
Server
Gets or Sets ServerStatus
SetPersonalizationStrategyResponse
SnippetResult
SnippetResult
SnippetResult as Map<String, SnippetResultOption> wrapper.
SnippetResult as Map<String, SnippetResultOption> wrapper.
Snippeted attributes show parts of the matched attributes.
Snippeted attributes show parts of the matched attributes.
How to display the remaining items: - `count`: facet count (descending).
How to display the remaining items: - `count`: facet count (descending).
Source
Source.
SourceBigCommerce
SourceBigQuery
SourceCommercetools
SourceCreate
SourceCreateResponse
SourceCSV
SourceDocker
Configuration of an Algolia index for Query Suggestions.
SourceInput
SourceJSON
SourceSearch
Used to sort the Source list endpoint.
Gets or Sets SourceType
SourceUpdate
SourceUpdateCommercetools
SourceUpdateDocker
SourceUpdateInput
SourceUpdateResponse
Key-value pairs of [supported language ISO
codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/)
and boolean values.
Status of the cluster.
StatusResponse
The trigger input for a task of type 'subscription'.
A task which is triggered by an external subscription (e.g.
Synonym object.
Synonym type.
[Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
[Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
TagFilters as List wrapper.
TagFilters as List wrapper.
TagFilters as String wrapper.
TagFilters as String wrapper.
Task
The payload for a task creation.
The response from the API after a task creation.
TaskCreateTrigger
TaskInput
TaskSearch
Used to sort the Task list endpoint.
_published_ if the task has been processed, _notPublished_ otherwise.
_published_ if the task has been processed, _notPublished_ otherwise.
The payload for a task update.
The response from the API after a task update.
TimeInner
TimeRange
TopCountry
TopHit
TopHitsResponse
TopHitsResponseWithAnalytics
TopHitWithAnalytics
TopSearch
TopSearchesResponse
TopSearchesResponseWithAnalytics
TopSearchWithAnalytics
Trending facet hit.
Trending facets model.
TrendingFacetsQuery
Trending items model.
TrendingItemsQuery
Trigger
The type of the task reflect how it can be used: - onDemand: a task that runs manually -
schedule: a task that runs regularly, following a given cron expression - subscription: a task
that runs after a subscription event is received from an integration (e.g.
The trigger input for a task update.
Gets or Sets Type
Controls whether [typo
tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/)
is enabled and how it is applied.
Controls whether [typo
tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/)
is enabled and how it is applied.
TypoTolerance as Boolean wrapper.
TypoTolerance as Boolean wrapper.
Gets or Sets typoToleranceEnum
Gets or Sets typoToleranceEnum
UpdateApiKeyResponse
Response, taskID, and update timestamp.
Response, taskID, unique object identifier, and an update timestamp.
UpdatedRuleResponse
UserHighlightResult
UserHit
Unique user ID.
UserWithDate
Total monetary value of this event in units of `currency`.
Value
Value
Value as Double wrapper.
Value as String wrapper.
Variant
Use this method to capture active filters.
Use this event to track when users viewed items in the search results.
Gets or Sets ViewEvent
The window parameter represents the holds the dates used to query the Observability data from the
database in a given window.