Package com.algolia.model.search
package com.algolia.model.search
-
ClassDescriptionAccess control list permissions.Type of indexing operation.AddApiKeyResponseGets or Sets advancedSyntaxFeaturesGets or Sets alternativesAsExactWhich part of the search query the pattern should match: - `startsWith`.API key object.Gets or Sets apiKeyOperationPrecision 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.Maximum radius for a search around a central location.Return all records with a valid `_geoloc` attribute.Assign userID parameters.AttributeToUpdateFilter or optional filter to be applied to the search.Filter to be applied to the search.BaseGetApiKeyResponseBaseIndexSettingsBaseSearchParamsBaseSearchParamsWithoutQueryBaseSearchResponseAssign userID parameters.Request body for updating dictionary entries.BatchDictionaryEntriesRequestBatch parameters.BatchRequestBatchResponseBatch parameters.BrowseParamsBrowseParamsObjectBrowseResponseUpdate to perform on the attribute.How to change the attribute.ConditionEffect of the rule.Object ID of the record to hide.ConsequenceParamsReplace or edit the search query.ConsequenceQueryObjectResponse and creation timestamp.CursorDeleteApiKeyResponseDeleteByParamsResponse, taskID, and deletion timestamp.DeleteSourceResponseActions 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 dictionaryTypeDetermines how many records of a group are included in the search results.EditType of edit.Error.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.Filter the search by facet values, so that only records with the same facet values are retrieved.FacetHitsOrder of facet names and facet values in your UI.Order of facet names.FacetsStatsFetchedIndexGetApiKeyResponseGetDictionarySettingsResponseGetLogsResponseRequest parameters.Request body for retrieving records.GetObjectsResponseGetTaskResponseUser IDs and clusters.HasPendingMappingsResponseHighlightResultSurround words that match the query with HTML tags for highlighting.Search result.Treat singular, plurals, and other forms of declensions as equivalent.Index settings.IndexSettingsAsSearchParamsDictionary language.ListApiKeysResponseClusters.ListIndicesResponseUser ID data.LogLogQueryGets or Sets logTypeMatchedGeoLocationWhether the whole query string matches or only a part.MixedSearchFiltersSearch mode the index will use to query for results.MultipleBatchRequestMultipleBatchResponseFilter by numeric facets.OperationIndexParamsOperation to perform on the index.Filters to promote or demote records in the search results.Parameters to apply to this search.PersonalizationPromoteRecord to promote.Records to promote.Determines if and how query words are interpreted as prefixes.Object with detailed information about the record's ranking.[Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/).RedirectRuleIndexMetadataRedirect rule data.Removes stop words from the search query.RemoveUserIdResponseStrategy for removing words from the query when it doesn't return any results.Extra data that can be used in the search UI.ReplaceSourceResponseRestrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.Rule object.SaveObjectResponseSaveSynonymResponseGets or Sets scopeTypeSearch parameter.SearchDictionaryEntriesResponseSearchForFacetsSearchForFacetsOptionsSearchForFacetValuesRequestSearchForFacetValuesResponseSearchForHitsSearchForHitsOptionsSearchHits<T>SearchHitsSearchMethodParamsSearchParamsEach parameter value, including the `query` must not be larger than 512 bytes.SearchParamsQuerySearchParamsStringSearchQuerySearchResponseSearchResponsesSearchResult<T>SearchResultRules search parameters.SearchRulesResponseStrategy for multiple search queries: - `none`.SearchSynonymsParamsSearchSynonymsResponse- `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).OKuserIDs data.SecuredAPIKeyRestrictionsSettings for the semantic search part of NeuralSearch.SnippetResultSnippets that show the context around a matching search query.Order of facet values that aren't explicitly positioned with the `order` setting.Source.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.ISO code for a supported language.Synonym object.Synonym type.Filter the search by values of the special `_tags` attribute.Task status, `published` if the task is completed, `notPublished` otherwise.TimeRangeWhether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.- `min`.UpdateApiKeyResponseResponse, taskID, and update timestamp.Response, taskID, unique object identifier, and an update timestamp.UpdatedRuleResponseUserHighlightResultUserHitUnique user ID.Value