All Classes and Interfaces

Class
Description
ABTest
A/B test configuration.
 
ABTestResponse
AbTestsVariant
AbTestsVariantSearchParams
Access control list permissions.
Type of indexing operation.
Type of indexing operation.
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`.
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.
 
 
 
 
 
 
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.
Deprecated. 
 
 
Credentials for authenticating with Algolia.
Credentials for authenticating with the Algolia Insights API.
Credentials for authenticating with the Algolia Insights API.
Credentials for authenticating with Algolia.
Credentials for authenticating with an API key.
Credentials for authenticating with an API key.
Credentials for authenticating with user name and password.
Credentials for authenticating with user name and password.
Resource representing the information required to authenticate with a source or a destination.
Request body for creating a new authentication resource.
API response for the successful creation of an authentication resource.
Request body for searching for authentication resources.
Property by which to sort the list of authentication resources.
Type of authentication.
Request body for updating an authentication resource.
API response for a successful update of an authentication resource.
Credentials for authenticating with a Google service account, such as BigQuery.
Credentials for authenticating with a Google service account, such as BigQuery.
AuthInput
 
AuthInputPartial
 
 
Credentials for authenticating with OAuth 2.0.
Credentials for authenticating with OAuth 2.0.
Facet attribute.
Filter or optional filter to be applied to the search.
Filter to be applied to the search.
 
 
 
BaseResponse
Assign userID parameters.
Request body for updating dictionary entries.
BatchDictionaryEntriesRequest
Batch parameters.
BatchRequest
BatchRequest
BatchResponse
Batch parameters.
Batch parameters.
BigCommerceChannel
BigCommerceMetafield
Gets or Sets BigQueryDataType
BoughtTogetherQuery
BrowseParams
 
BrowseParamsObject
BrowseResponse
Update to perform on the attribute.
How to change the attribute.
BuiltInOperationValue
 
 
 
 
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
Click position.
 
 
 
Custom fields from commercetools to add to the records.
 
 
Condition that triggers the rule.
Condition
ConfigStatus
Query Suggestions configuration.
API response for retrieving Query Suggestions configurations.
Query Suggestions configuration.
Effect of the rule.
Effect of the rule.
Object ID of the record to hide.
ConsequenceParams
Replace or edit the search query.
 
 
ConsequenceQueryObject
Gets or Sets ConversionEvent
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.
Currency
Currency code.
DailyAddToCartRates
DailyAverageClicks
DailyClickThroughRates
DailyConversionRates
DailyNoClickRates
DailyNoResultsRates
DailyPurchaseRates
DailyRevenue
DailySearches
DailySearchesNoClicks
DailySearchesNoResults
DailyUsers
 
DeleteApiKeyResponse
DeleteByParams
Response, taskID, and deletion timestamp.
Response, taskID, and deletion timestamp.
DeleteResponse
DeleteSourceResponse
DeleteUserProfileResponse
Destinations are Algolia resources like indices or event streams.
API request body for creating a new destination.
API response for creating a new destination.
DestinationIndexName
DestinationInput
 
API request body for searching destinations.
Property by which to sort the destinations.
Destination type.
API request body for updating a destination.
API response for updating a destination.
Actions to perform.
Dictionary entry.
Whether a dictionary entry is active.
Whether a dictionary entry is provided by Algolia (standard), or has been added by you (custom).
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.
 
 
 
 
 
 
Image type.
Container registry name from where to pull the image.
DockerStreams
The selected streams of a singer or airbyte connector.
The strategy to use to fetch the data.
Edit
Type of edit.
Metric for which you want to detect the smallest relative difference.
Configuration for handling empty searches.
Empty searches removed from the A/B test as a result of configuration settings.
Type of entity to update.
Error.
Error.
Error.
Error.
Error.
Error.
Error.
Error.
Error.
Error.
ErrorItem
An event describe a step of the task execution flow..
EventScoring
EventsItems
 
Property by which to sort the list of task run events.
The response of the Insights API.
Gets or Sets EventStatus
Gets or Sets EventType
Event type.
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
FacetStats
FacetStats
FallbackParams
Frequently bought together model.
FetchedIndex
A/B test filter effects resulting from configuration settings.
ForbiddenError
GenerateTransformationCodePayload
GenerateTransformationCodeResponse
GetAddToCartRateResponse
GetApiKeyResponse
GetAverageClickPositionResponse
GetClickPositionsResponse
GetClickThroughRateResponse
GetConversionRateResponse
GetDictionarySettingsResponse
GetLogsResponse
GetNoClickRateResponse
GetNoResultsRateResponse
Request parameters.
Request body for retrieving records.
GetObjectsResponse
GetPurchaseRateResponse
Recommend request body.
GetRecommendationsResponse
GetRecommendTaskResponse
GetRevenue
GetSearchesCountResponse
GetSearchesNoClicksResponse
GetSearchesNoResultsResponse
GetStatusResponse
GetTaskResponse
GetTopCountriesResponse
GetTopFilterAttribute
GetTopFilterAttributesResponse
GetTopFilterForAttribute
GetTopFilterForAttributeResponse
GetTopFiltersNoResultsResponse
GetTopFiltersNoResultsValue
GetTopFiltersNoResultsValues
GetTopHitsResponse
 
GetTopSearchesResponse
 
User IDs and clusters.
GetUsersCountResponse
GetUserTokenResponse
Gets or Sets granularity
This interceptor compresses the HTTP request body.
HasPendingMappingsResponse
 
Object ID of the recommendation you want to exclude.
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.
IncidentEntry
IncidentsResponse
IndexingMetric
IndexingTimeResponse
Index settings.
IndexUsage
InfrastructureResponse
 
 
InsightsEvents
InvalidRequestError
InventoryResponse
Utility class for JSON serialization and deserialization using Jackson.
 
Languages for deduplicating singular and plural suggestions.
Dictionary language.
 
 
 
LatencyMetric
LatencyResponse
 
ListABTestsResponse
ListApiKeysResponse
ListAuthenticationsResponse
Clusters.
ListDestinationsResponse
ListEventsResponse
ListIndicesResponse
ListSourcesResponse
Configured tasks and pagination information.
Configured tasks and pagination information.
Configured transformations and pagination information.
User ID data.
Log
LogFile
 
An interceptor that facilitates HTTP logging based on the provided logging level.
 
Type of log entry.
LogQuery
Gets or Sets logType
Looking similar model.
LookingSimilarQuery
Describes how a field should be resolved by applying a set of directives.
Mapping format schema.
Transformations to apply to the 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.
HTTP method to be used for retrieving your data.
Gets or Sets Metric
Metrics
Configuration for the smallest difference between test variants you want to detect.
Search mode the index will use to query for results.
Search mode the index will use to query for results.
Model
 
MultipleBatchRequest
MultipleBatchResponse
Filter by numeric facets.
Filter by numeric facets.
 
 
 
 
 
 
ObjectData
ObjectDataAfterSearch
Trigger information for manually-triggered tasks.
Trigger information for manually-triggered tasks.
Task is run manually, with the `/run` endpoint.
OperationIndexParams
Operation to perform on the index.
Character that characterizes how the filter is applied.
Filters to promote or demote records in the search results.
Filters to promote or demote records in the search results.
 
 
 
 
 
 
Attribute by which to order the response items.
Ascending or descending sort order.
Configuration for handling outliers.
Outliers removed from the A/B test as a result of configuration settings.
Paginated API response.
 
Filter or boost recommendations matching a facet filter.
Gets or Sets Period
Personalization
Personalization
 
PersonalizationStrategyParams
Name of an ecommerce platform with which to authenticate.
Authentication resource not tied to any ecommerce platform, used for filtering.
PlatformWithNone
 
Total price of a product, including any discounts, in units of `currency`.
 
 
 
ProbesMetric
Promote
 
Object ID and position of the recommendation you want to pin.
Record 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
 
Determines if and how query words are interpreted as prefixes.
Determines if and how query words are interpreted as prefixes.
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.
Object with detailed information about the record's ranking.
Object with detailed information about the record's ranking.
RecommendationsHit
 
 
RecommendationsRequest
 
RecommendationsResults
 
\"Recommened for you\" model.
RecommendedForYouQuery
Recommend hit.
Gets or Sets recommendModels
Recommend rule.
Record type for ecommerce sources.
[Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only.
[Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only.
Redirect rule data.
Redirect rule data.
RedirectRuleIndexMetadata
RedirectRuleIndexMetadata
The redirect rule container.
The redirect rule container.
Region where the cluster is located.
Related products or similar content model.
RelatedQuery
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.
ReplaceAllObjectsResponse
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 metadata.
Run
RunListResponse
Task run outcome.
RunProgress
A code for the task run's outcome.
API response for running a task.
Property by which to sort the list of task runs.
RunSourcePayload
RunSourceResponse
Task run status.
Task run type.
SaveObjectResponse
SaveSynonymResponse
ScheduleABTestResponse
ScheduleABTestsRequest
Trigger information for scheduled tasks.
Trigger input for scheduled tasks.
Task runs on a schedule.
Gets or Sets scopeType
 
Search parameter.
SearchDictionaryEntriesResponse
SearchForFacets
SearchForFacetValuesRequest
SearchForFacetValuesResponse
SearchForHits
SearchMethodParams
SearchParams
SearchParams
 
Each parameter value, including the `query` must not be larger than 512 bytes.
Each parameter value, including the `query` must not be larger than 512 bytes.
Search parameters as query string.
SearchQuery
 
Recommend rules 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
SettingsResponse
Represents the required elements of the task input when using a `shopify` source.
Represents a market in Shopify.
Represents a metafield in Shopify.
SnippetResult
SnippetResult
 
 
 
 
 
 
 
 
Snippets that show the context around a matching search query.
Snippets that show the context around a matching search query.
Property by which to sort the list.
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
SourceShopify
Property by which to sort the list of sources.
Gets or Sets SourceType
SourceUpdate
SourceUpdateCommercetools
SourceUpdateDocker
SourceUpdateInput
 
SourceUpdateResponse
SourceUpdateShopify
SourceWatchResponse
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.
 
Gets or Sets Statistic
StatisticEntry
StatisticValue
 
 
 
A/B test status.
Status of the cluster.
StatusResponse
Input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed.
Trigger input for continuously running tasks.
Task runs continuously.
 
Trigger input for subscription tasks.
Task runs after receiving subscribed event.
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
API request body for creating a task.
API response for creating a task.
TaskCreateTrigger
 
Deprecated. 
Configuration of the task, depending on its type.
 
TaskSearch
Property by which to sort the list of tasks.
Task status, `published` if the task is completed, `notPublished` otherwise.
Task status, `published` if the task is completed, `notPublished` otherwise.
API request body for updating a task.
API response for updating a task.
Deprecated. 
 
Deprecated. 
TimeEntry
TimeRange
TopCountry
TopHit
TopHitsResponse
TopHitsResponseWithAnalytics
TopHitsResponseWithRevenueAnalytics
TopHitWithAnalytics
TopHitWithRevenueAnalytics
TopSearch
TopSearchesResponse
TopSearchesResponseWithAnalytics
TopSearchesResponseWithRevenueAnalytics
TopSearchWithAnalytics
TopSearchWithRevenueAnalytics
Transformation
API request body for creating a transformation.
API response for creating a transformation.
The error if the transformation failed.
List of available AI models for transformation purposes.
TransformationSearch
TransformationTry
TransformationTryResponse
API response for updating a transformation.
Trending facet hit.
Trending facet values model.
TrendingFacetsQuery
Trending items model.
TrendingItemsQuery
Trigger that runs the task.
 
Task trigger, describing when a task should run.
Trigger 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.
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
Time window by which to filter the observability data.