All Classes and Interfaces

Class
Description
ABTest
 
ABTestResponse
AbTestsVariant
AbTestsVariantSearchParams
Access control list permissions.
Type of indexing 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
 
Which part of the search query the pattern should match: - `startsWith`.
Which part of the search query the pattern should match: - `startsWith`.
Represents a base client for making API requests.
API key object.
Gets or Sets apiKeyOperation
Precision of a coordinate-based search in meters to group results with similar distances.
Precision of a coordinate-based search in meters to group results with similar distances.
 
 
 
 
 
 
Range object with lower and upper values in meters to define custom ranges.
Range object with lower and upper values in meters to define custom ranges.
Maximum radius for a search around a central location.
Maximum radius for a search around a central location.
 
 
 
 
Return all records with a valid `_geoloc` attribute.
Return all records with a valid `_geoloc` attribute.
Assign userID parameters.
AttributeToUpdate
 
 
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, with obfuscated input.
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.
Filter or optional filter to be applied to the search.
Filter or optional filter to be applied to the search.
Filter to be applied to the search.
Filter to be applied to the search.
 
 
 
 
 
 
AverageClickEvent
BaseGetApiKeyResponse
BaseIndexSettings
BaseQuerySuggestionsConfigurationResponse
BaseQuerySuggestionsConfigurationWithIndex
BaseRecommendationsQuery
BaseRecommendedForYouQuery
BaseRecommendedForYouQueryParameters
BaseRecommendRequest
BaseResponse
BaseSearchParams
BaseSearchParams
BaseSearchParamsWithoutQuery
BaseSearchParamsWithoutQuery
BaseSearchResponse
BaseSearchResponse
BaseTrendingFacetsQuery
BaseTrendingItemsQuery
Assign userID parameters.
Request body for updating dictionary entries.
BatchDictionaryEntriesRequest
Batch parameters.
BatchRequest
BatchResponse
Batch parameters.
BigCommerceChannel
BigCommerceMetafield
Gets or Sets BigQueryDataType
BrowseParams
 
BrowseParamsObject
BrowseResponse
Update to perform on the attribute.
How to change 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
 
 
 
Custom fields from Commercetools to index in the records (see https://docs.commercetools.com/tutorials/custom-types).
 
 
Condition
Condition
Effect of the rule.
Effect of the rule.
Object ID of the record to hide.
Object ID of the record to hide.
ConsequenceParams
ConsequenceParams
Replace or edit the search query.
Replace or edit the search query.
 
 
 
 
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.
Whether a dictionary entry is active.
Dictionary type.
Turn on or off the built-in Algolia stop words for a specific language.
Gets or Sets dictionaryType
Gets or Sets direction
Absolute value of the discount for this product, in units of `currency`.
 
 
 
Determines how many records of a group are included in the search results.
Determines how many records of a group are included in the search results.
 
 
 
 
 
 
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 search query has 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 search query has 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 the search by facet values, so that only records with the same facet values are retrieved.
Filter the search by facet values, so that only records with the same facet values are retrieved.
 
 
 
 
 
 
FacetHits
Order of facet names and facet values in your UI.
Order of facet names and facet values in your UI.
Order of facet names.
Order of facet names.
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.
Request body for retrieving records.
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
 
 
 
 
 
 
Surround words that match the query with HTML tags for highlighting.
Surround words that match the query with HTML tags for highlighting.
Search result.
 
 
 
 
HttpRequester is responsible for making HTTP requests using the OkHttp client.
The Builder class for HttpRequester.
Treat singular, plurals, and other forms of declensions as equivalent.
Treat singular, plurals, and other forms of declensions as equivalent.
 
 
 
 
 
 
Incident details.
IncidentsInner
IncidentsResponse
IndexingTimeResponse
IndexingTimeResponseMetrics
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.
 
 
 
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
Describes how a field should be resolved by applying a set of directives.
Transformations to apply to source, serialized as a JSON string.
Describes how a destination object should be resolved by means of applying a set of directives.
Gets or Sets MappingTypeCSV
MatchedGeoLocation
MatchedGeoLocation
Whether the whole query string matches or only a part.
Whether the whole query string matches or only a part.
Gets or Sets MethodType
Gets or Sets Metric
MixedSearchFilters
MixedSearchFilters
 
 
 
 
 
 
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 by numeric facets.
Filter by numeric facets.
 
 
 
 
 
 
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 on the index.
Filters to promote or demote records in the search results.
Filters to promote or demote records in the search results.
 
 
 
 
 
 
Method for ordering results.
Used to order a sorted request.
Pagination
 
Parameters to apply to this search.
Parameters to apply to this search.
Gets or Sets Period
Personalization
Personalization
 
PersonalizationStrategyParams
Describe which platform the Authentication is used for.
Used to filter Authentication without platform property.
PlatformWithNone
 
Total price of a product, including any discounts, in units of `currency`.
 
 
 
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 if and how query words are interpreted as prefixes.
Determines if and how query words are interpreted as prefixes.
Object with detailed information about the record's ranking.
Object with detailed information about the record's ranking.
Recommendation model.
RecommendationsHit
 
 
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 words from the search query.
Removes stop words from the search query.
 
 
 
 
 
 
RemoveUserIdResponse
Strategy for removing words from the query when it doesn't return any results.
Strategy for removing words from the query when it doesn't return any results.
Extra data that can be used in the search UI.
Extra data that can be used in the search UI.
ReplaceSourceResponse
Represents a mechanism for executing HTTP requests and deserializing responses.
Request options are used to pass extra parameters, headers, timeout to the request.
Restrict [Dynamic Re-ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
Restrict [Dynamic Re-ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
 
 
 
 
 
 
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
 
Search parameter.
SearchDictionaryEntriesResponse
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
Strategy for multiple search queries: - `none`.
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.
SecuredAPIKeyRestrictions
Settings for the semantic search part of NeuralSearch.
Settings for the semantic search part of NeuralSearch.
Server
Gets or Sets ServerStatus
SetPersonalizationStrategyResponse
SnippetResult
SnippetResult
 
 
 
 
 
 
Snippets that show the context around a matching search query.
Snippets that show the context around a matching search query.
Order of facet values that aren't explicitly positioned with the `order` setting.
Order of facet values that aren't explicitly positioned with the `order` setting.
Source
Source.
SourceBigCommerce
SourceBigQuery
SourceCommercetools
SourceCreate
SourceCreateResponse
SourceCSV
SourceDocker
SourceGA4BigQueryExport
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 'streaming'.
A task that runs continuously.
The input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed.
 
The trigger input for a task of type 'subscription'.
A task which is triggered by an external subscription (e.g.
ISO code for a supported language.
ISO code for a supported language.
Synonym object.
Synonym type.
Filter the search by values of the special `_tags` attribute.
Filter the search by values of the special `_tags` attribute.
 
 
 
 
 
 
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.
Task status, `published` if the task is completed, `notPublished` otherwise.
Task status, `published` if the task is completed, `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
Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
 
 
 
 
- `min`.
- `min`.
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
 
 
 
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.