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.
AddABTestsRequest
AddABTestsVariant
 
 
AddApiKeyResponse
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 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`).
 
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/).
 
 
 
 
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).
 
 
 
 
Gets or Sets aroundRadiusAll
Gets or Sets aroundRadiusAll
Assign userID parameters.
AttributeToUpdate
 
 
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.
 
 
 
 
AverageClickEvent
BaseGetApiKeyResponse
BaseIndexSettings
BaseRecommendationsQuery
BaseRecommendRequest
BaseResponse
BaseSearchParams
BaseSearchParams
BaseSearchParamsWithoutQuery
BaseSearchParamsWithoutQuery
BaseSearchResponse
BaseSearchResponse
[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/).
BaseTrendingFacetsQuery
BaseTrendingItemsQuery
Assign userID parameters.
`batchDictionaryEntries` parameters.
BatchDictionaryEntriesRequest
Batch parameters.
BatchRequest
BatchResponse
Batch parameters.
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.
 
 
 
 
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.
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.
DeleteSourceResponse
DeleteUserProfileResponse
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
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)).
 
 
 
 
Edit
Edit
Type of edit.
Type of edit.
Error.
Error.
Error.
Error.
Error.
Error.
Error.
Error.
EventScoring
EventsItems
 
 
The response of the Insights API.
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.
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/).
 
 
 
 
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
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
HasPendingMappingsResponse
HighlightResult
HighlightResult
 
 
 
 
Show highlighted section and words matched on a query.
Show highlighted section and words matched on a query.
A single hit.
 
 
Treats singular, plurals, and other forms of declensions as matching terms.
Treats singular, plurals, and other forms of declensions as matching terms.
 
 
 
 
Incident details.
IncidentsInner
IncidentsResponse
IndexingTimeResponse
IndexingTimeResponseMetrics
Algolia index settings.
IndexSettingsAsSearchParams
IndexSettingsAsSearchParams
InfrastructureResponse
InfrastructureResponseMetrics
 
InsightsEvents
InventoryResponse
 
Set the language for deduplicating singular and plural suggestions.
Dictionary language.
 
 
LatencyResponse
LatencyResponseMetrics
 
ListABTestsResponse
ListApiKeysResponse
Clusters.
ListIndicesResponse
User ID data.
Log
The type of log entry.
 
LogQuery
Gets or Sets logType
MatchedGeoLocation
MatchedGeoLocation
Indicates how well the attribute matched the search query.
Indicates how well the attribute matched the search query.
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 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/).
 
 
 
 
OperationIndexParams
Operation to perform (_move_ or _copy_).
Create filters to boost or demote records.
Create filters to boost or demote records.
 
 
 
 
Method for ordering results.
Additional search parameters.
Additional search parameters.
Gets or Sets Period
Personalization
Personalization
 
PersonalizationStrategyParams
ProbesMetric
Promote
Promote
 
 
 
 
Record to promote.
Record to promote.
Records to promote.
Records to promote.
 
Query Suggestions configuration.
QuerySuggestionsConfigurationResponse
QuerySuggestionsConfigurationResponseAllOf
Query Suggestions configuration.
QuerySuggestionsConfigurationWithIndexAllOf
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.
RecommendationsQuery
RecommendationsRequest
 
 
RecommendationsResponse
 
Recommend hit.
RecommendHits
Gets or Sets recommendModels
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.
 
 
 
 
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
 
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.
 
 
 
 
 
Rule object.
Rule object.
RuleResponseMetadata
SaveObjectResponse
SaveSynonymResponse
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
 
 
 
 
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.
Configuration of an Algolia index for Query Suggestions.
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
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/).
 
 
 
 
_published_ if the task has been processed, _notPublished_ otherwise.
_published_ if the task has been processed, _notPublished_ otherwise.
 
TimeInner
TimeRange
TopCountry
TopHit
TopHitsResponse
TopHitsResponseWithAnalytics
TopHitWithAnalytics
TopSearch
TopSearchesResponse
TopSearchesResponseWithAnalytics
TopSearchWithAnalytics
Trending facets model.
TrendingFacetsQuery
Trending items model.
TrendingItemsQuery
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.
 
 
 
 
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
 
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