algoliasearch-scala
algoliasearch-scala
API
algoliasearch
abtesting
ABTest
ABTestConfiguration
ABTestResponse
AbTestsVariant
AbTestsVariantSearchParams
AddABTestsRequest
AddABTestsVariant
AddABTestsVariant
AddABTestsVariantSerializer
AddABTestsVariantTrait
Currency
CustomSearchParams
Effect
Effect
AddToCartRate
ClickThroughRate
ConversionRate
PurchaseRate
EffectSerializer
EmptySearch
ErrorBase
ErrorBaseSerializer
FilterEffects
FilterEffectsEmptySearch
FilterEffectsOutliers
JsonSupport
ListABTestsResponse
MinimumDetectableEffect
Outliers
Status
Status
Active
Expired
Failed
Stopped
StatusSerializer
Variant
analytics
ClickPositionsInner
CurrenciesValue
DailyAddToCartRates
DailyAverageClicks
DailyClickThroughRates
DailyConversionRates
DailyNoClickRates
DailyNoResultsRates
DailyPurchaseRates
DailyRevenue
DailySearches
DailySearchesNoClicks
DailySearchesNoResults
DailyUsers
Direction
Direction
Asc
Desc
DirectionSerializer
ErrorBase
ErrorBaseSerializer
GetAddToCartRateResponse
GetAverageClickPositionResponse
GetClickPositionsResponse
GetClickThroughRateResponse
GetConversionRateResponse
GetNoClickRateResponse
GetNoResultsRateResponse
GetPurchaseRateResponse
GetRevenue
GetSearchesCountResponse
GetSearchesNoClicksResponse
GetSearchesNoResultsResponse
GetStatusResponse
GetTopCountriesResponse
GetTopFilterAttribute
GetTopFilterAttributesResponse
GetTopFilterForAttribute
GetTopFilterForAttributeResponse
GetTopFiltersNoResultsResponse
GetTopFiltersNoResultsValue
GetTopFiltersNoResultsValues
GetTopHitsResponse
GetTopHitsResponse
GetTopHitsResponseSerializer
GetTopHitsResponseTrait
GetTopSearchesResponse
GetTopSearchesResponse
GetTopSearchesResponseSerializer
GetTopSearchesResponseTrait
GetUsersCountResponse
JsonSupport
Operator
Operator
Colon
Equal
GreaterThan
GreaterThanOrEqualTo
LessThan
LessThanOrEqualTo
NotEqual
OperatorSerializer
OrderBy
OrderBy
AverageClickPosition
ClickThroughRate
ConversionRate
SearchCount
OrderBySerializer
TopCountry
TopHit
TopHitWithAnalytics
TopHitWithRevenueAnalytics
TopHitsResponse
TopHitsResponseWithAnalytics
TopHitsResponseWithRevenueAnalytics
TopSearch
TopSearchWithAnalytics
TopSearchWithRevenueAnalytics
TopSearchesResponse
TopSearchesResponseWithAnalytics
TopSearchesResponseWithRevenueAnalytics
api
AbtestingClient
AbtestingClient
AnalyticsClient
AnalyticsClient
IngestionClient
IngestionClient
InsightsClient
InsightsClient
MonitoringClient
MonitoringClient
PersonalizationClient
PersonalizationClient
QuerySuggestionsClient
QuerySuggestionsClient
RecommendClient
RecommendClient
SearchClient
SearchClient
UsageClient
UsageClient
config
AgentSegment
AgentSegment
CallType
CallType
Read
Write
ClientConfig
ClientOptions
ClientOptions
Builder
CompressionType
CompressionType
Gzip
None
Host
HttpRequest
HttpRequest
Builder
LogLevel
LogLevel
Basic
Body
Headers
None
Logger
Logger
Logging
Logging
RequestOptions
RequestOptions
Builder
Requester
exception
AlgoliaApiException
AlgoliaClientException
AlgoliaRequestException
AlgoliaRetryException
AlgoliaRuntimeException
AlgoliaWaitException
extension
SearchClientExtensions
ingestion
ActionType
ActionType
Append
Partial
Replace
Save
ActionTypeSerializer
AuthAPIKey
AuthAPIKeyPartial
AuthAlgolia
AuthAlgoliaInsights
AuthAlgoliaInsightsPartial
AuthAlgoliaPartial
AuthBasic
AuthBasicPartial
AuthGoogleServiceAccount
AuthGoogleServiceAccountPartial
AuthInput
AuthInput
AuthInputPartial
AuthInputPartial
AuthInputPartialSerializer
AuthInputPartialTrait
AuthInputSerializer
AuthInputTrait
AuthOAuth
AuthOAuthPartial
Authentication
AuthenticationCreate
AuthenticationCreateResponse
AuthenticationSearch
AuthenticationSortKeys
AuthenticationSortKeys
AuthType
CreatedAt
Name
Platform
UpdatedAt
AuthenticationSortKeysSerializer
AuthenticationType
AuthenticationType
Algolia
AlgoliaInsights
ApiKey
Basic
GoogleServiceAccount
Oauth
AuthenticationTypeSerializer
AuthenticationUpdate
AuthenticationUpdateResponse
BigCommerceChannel
BigCommerceMetafield
BigQueryDataType
BigQueryDataType
Ga360
Ga4
BigQueryDataTypeSerializer
CommercetoolsCustomFields
DeleteResponse
Destination
DestinationCreate
DestinationCreateResponse
DestinationIndexName
DestinationIndexPrefix
DestinationInput
DestinationInput
DestinationInputSerializer
DestinationInputTrait
DestinationSearch
DestinationSortKeys
DestinationSortKeys
CreatedAt
Name
Type
UpdatedAt
DestinationSortKeysSerializer
DestinationType
DestinationType
Insights
Search
DestinationTypeSerializer
DestinationUpdate
DestinationUpdateResponse
DockerImageType
DockerImageType
Airbyte
Custom
Singer
DockerImageTypeSerializer
DockerRegistry
DockerRegistry
Dockerhub
Ghcr
DockerRegistrySerializer
ErrorBase
ErrorBaseSerializer
Event
EventSortKeys
EventSortKeys
PublishedAt
Status
Type
EventSortKeysSerializer
EventStatus
EventStatus
Created
Critical
Failed
Retried
Started
Succeeded
EventStatusSerializer
EventType
EventType
Fetch
Log
Record
Transform
EventTypeSerializer
JsonSupport
ListAuthenticationsResponse
ListDestinationsResponse
ListEventsResponse
ListSourcesResponse
ListTasksResponse
ListTransformationsResponse
MappingFieldDirective
MappingFormatSchema
MappingFormatSchema
MappingkitV1
MappingFormatSchemaSerializer
MappingInput
MappingKitAction
MappingTypeCSV
MappingTypeCSV
Boolean
Float
Integer
Json
String
MappingTypeCSVSerializer
MethodType
MethodType
GET
POST
MethodTypeSerializer
OnDemandDateUtilsInput
OnDemandTrigger
OnDemandTriggerInput
OnDemandTriggerType
OnDemandTriggerType
OnDemand
OnDemandTriggerTypeSerializer
OrderKeys
OrderKeys
Asc
Desc
OrderKeysSerializer
Pagination
Platform
Platform
Bigcommerce
Commercetools
Shopify
PlatformNone
PlatformNone
None
PlatformNoneSerializer
PlatformSerializer
PlatformWithNone
PlatformWithNone
PlatformWithNoneSerializer
PlatformWithNoneTrait
RecordType
RecordType
Product
Variant
RecordTypeSerializer
Run
RunListResponse
RunOutcome
RunOutcome
Failure
Processing
Success
RunOutcomeSerializer
RunProgress
RunReasonCode
RunReasonCode
Blocking
Critical
Discarded
Internal
NoEvents
Ok
TooManyErrors
RunReasonCodeSerializer
RunResponse
RunSortKeys
RunSortKeys
CreatedAt
Status
UpdatedAt
RunSortKeysSerializer
RunStatus
RunStatus
Created
Finished
Idled
Skipped
Started
RunStatusSerializer
RunType
RunType
Discover
Reindex
Update
RunTypeSerializer
ScheduleDateUtilsInput
ScheduleTrigger
ScheduleTriggerInput
ScheduleTriggerType
ScheduleTriggerType
Schedule
ScheduleTriggerTypeSerializer
ShopifyInput
ShopifyMarket
ShopifyMetafield
SortKeys
SortKeys
CreatedAt
Name
Type
UpdatedAt
SortKeysSerializer
Source
SourceBigCommerce
SourceBigQuery
SourceCSV
SourceCommercetools
SourceCreate
SourceCreateResponse
SourceDocker
SourceGA4BigQueryExport
SourceInput
SourceInput
SourceInputSerializer
SourceInputTrait
SourceJSON
SourceSearch
SourceShopify
SourceShopifyBase
SourceSortKeys
SourceSortKeys
CreatedAt
Name
Type
UpdatedAt
SourceSortKeysSerializer
SourceType
SourceType
Bigcommerce
Bigquery
Commercetools
Csv
Docker
Ga4BigqueryExport
Json
Sfcc
Shopify
SourceTypeSerializer
SourceUpdate
SourceUpdateCommercetools
SourceUpdateDocker
SourceUpdateInput
SourceUpdateInput
SourceUpdateInputSerializer
SourceUpdateInputTrait
SourceUpdateResponse
SourceUpdateShopify
SourceWatchResponse
StreamingTrigger
StreamingTriggerType
StreamingTriggerType
Streaming
StreamingTriggerTypeSerializer
StreamingUtilsInput
SubscriptionTrigger
SubscriptionTriggerType
SubscriptionTriggerType
Subscription
SubscriptionTriggerTypeSerializer
Task
TaskCreate
TaskCreateResponse
TaskCreateTrigger
TaskCreateTrigger
TaskCreateTriggerSerializer
TaskCreateTriggerTrait
TaskInput
TaskInput
TaskInputSerializer
TaskInputTrait
TaskSearch
TaskSortKeys
TaskSortKeys
Action
CreatedAt
Enabled
TriggerType
UpdatedAt
TaskSortKeysSerializer
TaskUpdate
TaskUpdateResponse
Transformation
TransformationCreate
TransformationCreateResponse
TransformationSearch
TransformationTry
TransformationTryResponse
TransformationTryResponseError
TransformationUpdateResponse
Trigger
Trigger
TriggerSerializer
TriggerTrait
TriggerType
TriggerType
OnDemand
Schedule
Streaming
Subscription
TriggerTypeSerializer
TriggerUpdateInput
Window
insights
AddToCartEvent
AddToCartEvent
AddToCart
AddToCartEventSerializer
AddedToCartObjectIDs
AddedToCartObjectIDsAfterSearch
ClickEvent
ClickEvent
Click
ClickEventSerializer
ClickedFilters
ClickedObjectIDs
ClickedObjectIDsAfterSearch
ConversionEvent
ConversionEvent
Conversion
ConversionEventSerializer
ConvertedFilters
ConvertedObjectIDs
ConvertedObjectIDsAfterSearch
Discount
Discount
DoubleValue
StringValue
DiscountSerializer
ErrorBase
ErrorBaseSerializer
EventsItems
EventsItems
EventsItemsSerializer
EventsItemsTrait
EventsResponse
InsightsEvents
JsonSupport
ObjectData
ObjectDataAfterSearch
Price
Price
DoubleValue
StringValue
PriceSerializer
PurchaseEvent
PurchaseEvent
Purchase
PurchaseEventSerializer
PurchasedObjectIDs
PurchasedObjectIDsAfterSearch
Value
Value
DoubleValue
StringValue
ValueSerializer
ViewEvent
ViewEvent
View
ViewEventSerializer
ViewedFilters
ViewedObjectIDs
internal
interceptor
RetryStrategy
AlgoliaAgent
AlgoliaAgent
HttpRequester
Builder
JsonSerializer
JsonSerializer
StatefulHost
monitoring
ErrorBase
ErrorBaseSerializer
GetServers403Response
Incident
IncidentsInner
IncidentsResponse
IndexingTimeResponse
IndexingTimeResponseMetrics
InfrastructureResponse
InfrastructureResponseMetrics
InventoryResponse
JsonSupport
LatencyResponse
LatencyResponseMetrics
Metric
Metric
AvgBuildTime
CpuUsage
RamIndexingUsage
RamSearchUsage
SsdUsage
Star
MetricSerializer
ModelType
ModelType
Cluster
ModelTypeSerializer
Period
Period
Day
Hour
Minute
Month
Week
PeriodSerializer
ProbesMetric
Region
Region
Au
Br
Ca
De
Eu
Hk
In
Jp
Sg
Uae
Uk
Usc
Use
Usw
Za
RegionSerializer
Server
ServerStatus
ServerStatus
PRODUCTION
ServerStatusSerializer
Status
Status
DegradedPerformance
MajorOutage
Operational
PartialOutage
StatusResponse
StatusSerializer
TimeInner
personalization
DeleteUserProfileResponse
ErrorBase
ErrorBaseSerializer
EventScoring
EventType
EventType
Click
Conversion
View
EventTypeSerializer
FacetScoring
GetUserTokenResponse
JsonSupport
PersonalizationStrategyParams
SetPersonalizationStrategyResponse
querysuggestions
AppID
BaseResponse
Configuration
ConfigurationResponse
ConfigurationWithIndex
ErrorBase
ErrorBaseSerializer
Facet
GetConfigStatus200Response
GetLogFile200Response
JsonSupport
Languages
Languages
BooleanValue
SeqOfString
LanguagesSerializer
LogLevel
LogLevel
ERROR
INFO
SKIP
LogLevelSerializer
SourceIndex
recommend
AdvancedSyntaxFeatures
AdvancedSyntaxFeatures
ExactPhrase
ExcludeWords
AdvancedSyntaxFeaturesSerializer
AlternativesAsExact
AlternativesAsExact
IgnorePlurals
MultiWordsSynonym
SingleWordSynonym
AlternativesAsExactSerializer
AroundPrecision
AroundPrecision
IntValue
SeqOfAroundPrecisionFromValueInner
AroundPrecisionFromValueInner
AroundPrecisionSerializer
AroundRadius
AroundRadius
IntValue
AroundRadiusAll
AroundRadiusAll
All
AroundRadiusAllSerializer
AroundRadiusSerializer
AroundRadiusTrait
AutoFacetFilter
BaseRecommendRequest
BaseSearchParams
BaseSearchParamsWithoutQuery
BaseSearchResponse
BaseSearchResponseSerializer
BoughtTogetherQuery
Condition
Consequence
DeletedAtResponse
Distinct
Distinct
BooleanValue
IntValue
DistinctSerializer
ErrorBase
ErrorBaseSerializer
ExactOnSingleWordQuery
ExactOnSingleWordQuery
Attribute
None
Word
ExactOnSingleWordQuerySerializer
Exhaustive
FacetFilters
FacetFilters
SeqOfFacetFilters
StringValue
FacetFiltersSerializer
FacetOrdering
Facets
FacetsStats
FallbackParams
FbtModel
FbtModel
BoughtTogether
FbtModelSerializer
FrequentlyBoughtTogether
GetRecommendTaskResponse
GetRecommendationsParams
GetRecommendationsResponse
HideConsequenceObject
HighlightResult
HighlightResult
MapOfStringHighlightResultOption
SeqOfHighlightResultOption
HighlightResultOption
HighlightResultSerializer
HighlightResultTrait
IgnorePlurals
IgnorePlurals
BooleanValue
SeqOfSupportedLanguage
IgnorePluralsSerializer
IndexSettingsAsSearchParams
JsonSupport
LookingSimilar
LookingSimilarModel
LookingSimilarModel
LookingSimilar
LookingSimilarModelSerializer
LookingSimilarQuery
MatchLevel
MatchLevel
Full
None
Partial
MatchLevelSerializer
MatchedGeoLocation
Mode
Mode
KeywordSearch
NeuralSearch
ModeSerializer
NumericFilters
NumericFilters
SeqOfNumericFilters
StringValue
NumericFiltersSerializer
OptionalFilters
OptionalFilters
SeqOfOptionalFilters
StringValue
OptionalFiltersSerializer
ParamsConsequence
Personalization
PromoteConsequenceObject
QueryType
QueryType
PrefixAll
PrefixLast
PrefixNone
QueryTypeSerializer
RankingInfo
ReRankingApplyFilter
ReRankingApplyFilter
SeqOfReRankingApplyFilter
StringValue
ReRankingApplyFilterSerializer
RecommendHit
RecommendHitSerializer
RecommendModels
RecommendModels
BoughtTogether
RelatedProducts
TrendingFacets
TrendingItems
RecommendModelsSerializer
RecommendRule
RecommendRuleMetadata
RecommendationsHit
RecommendationsHit
RecommendHitValue
RecommendationsHitSerializer
RecommendationsHitTrait
RecommendationsHits
RecommendationsRequest
RecommendationsRequest
RecommendationsRequestSerializer
RecommendationsRequestTrait
RecommendationsResults
RecommendedForYou
RecommendedForYouModel
RecommendedForYouModel
RecommendedForYou
RecommendedForYouModelSerializer
RecommendedForYouQuery
Redirect
RedirectRuleIndexMetadata
RedirectRuleIndexMetadataData
RelatedModel
RelatedModel
RelatedProducts
RelatedModelSerializer
RelatedProducts
RelatedQuery
RemoveStopWords
RemoveStopWords
BooleanValue
SeqOfSupportedLanguage
RemoveStopWordsSerializer
RemoveWordsIfNoResults
RemoveWordsIfNoResults
AllOptional
FirstWords
LastWords
None
RemoveWordsIfNoResultsSerializer
RenderingContent
SearchParams
SearchParamsObject
SearchParamsQuery
SearchRecommendRulesParams
SearchRecommendRulesResponse
SemanticSearch
SnippetResult
SnippetResult
MapOfStringSnippetResultOption
SeqOfSnippetResultOption
SnippetResultOption
SnippetResultSerializer
SnippetResultTrait
SortRemainingBy
SortRemainingBy
Alpha
Count
Hidden
SortRemainingBySerializer
SupportedLanguage
SupportedLanguage
Af
Ar
Az
Bg
Bn
Ca
Cs
Cy
Da
De
El
En
Eo
Es
Et
Eu
Fa
Fi
Fo
Fr
Ga
Gl
He
Hi
Hu
Hy
Id
Is
It
Ja
Ka
Kk
Ko
Ku
Ky
Lt
Lv
Mi
Mn
Mr
Ms
Mt
Nb
Nl
No
Ns
Pl
Ps
Pt
PtBr
Qu
Ro
Ru
Sk
Sq
Sv
Sw
Ta
Te
Th
Tl
Tn
Tr
Tt
Uk
Ur
Uz
Zh
SupportedLanguageSerializer
TagFilters
TagFilters
SeqOfTagFilters
StringValue
TagFiltersSerializer
TaskStatus
TaskStatus
NotPublished
Published
TaskStatusSerializer
TrendingFacetHit
TrendingFacets
TrendingFacetsModel
TrendingFacetsModel
TrendingFacets
TrendingFacetsModelSerializer
TrendingFacetsQuery
TrendingItems
TrendingItemsModel
TrendingItemsModel
TrendingItems
TrendingItemsModelSerializer
TrendingItemsQuery
TypoTolerance
TypoTolerance
BooleanValue
TypoToleranceEnum
TypoToleranceEnum
Min
Strict
TypoToleranceEnumSerializer
TypoToleranceSerializer
TypoToleranceTrait
Value
search
Acl
Acl
AddObject
Analytics
Browse
DeleteIndex
DeleteObject
EditSettings
Inference
ListIndexes
Logs
Personalization
Recommendation
Search
SeeUnretrievableAttributes
Settings
Usage
AclSerializer
Action
Action
AddObject
Clear
Delete
DeleteObject
PartialUpdateObject
PartialUpdateObjectNoCreate
UpdateObject
ActionSerializer
AddApiKeyResponse
AdvancedSyntaxFeatures
AdvancedSyntaxFeatures
ExactPhrase
ExcludeWords
AdvancedSyntaxFeaturesSerializer
AlternativesAsExact
AlternativesAsExact
IgnorePlurals
MultiWordsSynonym
SingleWordSynonym
AlternativesAsExactSerializer
Anchoring
Anchoring
Contains
EndsWith
Is
StartsWith
AnchoringSerializer
ApiKey
ApiKeyOperation
ApiKeyOperation
Add
Delete
Update
ApiKeyOperationSerializer
AroundPrecision
AroundPrecision
IntValue
SeqOfAroundPrecisionFromValueInner
AroundPrecisionFromValueInner
AroundPrecisionSerializer
AroundRadius
AroundRadius
IntValue
AroundRadiusAll
AroundRadiusAll
All
AroundRadiusAllSerializer
AroundRadiusSerializer
AroundRadiusTrait
AssignUserIdParams
AttributeToUpdate
AttributeToUpdate
StringValue
AttributeToUpdateSerializer
AttributeToUpdateTrait
AutomaticFacetFilter
AutomaticFacetFilters
AutomaticFacetFilters
SeqOfAutomaticFacetFilter
SeqOfString
AutomaticFacetFiltersEvidence
AutomaticFacetFiltersEvidence
SeqOfAutomaticFacetFilterEvidence
SeqOfStringEvidence
AutomaticFacetFiltersSerializer
BaseGetApiKeyResponse
BaseIndexSettings
BaseSearchParams
BaseSearchParamsWithoutQuery
BaseSearchResponse
BaseSearchResponseSerializer
BatchAssignUserIdsParams
BatchDictionaryEntriesParams
BatchDictionaryEntriesRequest
BatchParams
BatchRequest
BatchResponse
BatchWriteParams
BrowseParams
BrowseParams
BrowseParamsObject
BrowseParamsSerializer
BrowseParamsTrait
BrowseResponse
BuiltInOperation
BuiltInOperationType
BuiltInOperationType
Add
AddUnique
Decrement
Increment
IncrementFrom
IncrementSet
Remove
BuiltInOperationTypeSerializer
Condition
Consequence
ConsequenceHide
ConsequenceParams
ConsequenceQuery
ConsequenceQuery
StringValue
ConsequenceQueryObject
ConsequenceQuerySerializer
ConsequenceQueryTrait
CreatedAtResponse
Cursor
DeleteApiKeyResponse
DeleteByParams
DeleteSourceResponse
DeletedAtResponse
DictionaryAction
DictionaryAction
AddEntry
DeleteEntry
DictionaryActionSerializer
DictionaryEntry
DictionaryEntrySerializer
DictionaryEntryState
DictionaryEntryState
Disabled
Enabled
DictionaryEntryStateSerializer
DictionaryLanguage
DictionarySettingsParams
DictionaryType
DictionaryType
Compounds
Plurals
Stopwords
DictionaryTypeSerializer
Distinct
Distinct
BooleanValue
IntValue
DistinctSerializer
Edit
EditType
EditType
Remove
Replace
EditTypeSerializer
ErrorBase
ErrorBaseSerializer
ExactOnSingleWordQuery
ExactOnSingleWordQuery
Attribute
None
Word
ExactOnSingleWordQuerySerializer
Exhaustive
FacetFilters
FacetFilters
SeqOfFacetFilters
StringValue
FacetFiltersSerializer
FacetHits
FacetOrdering
Facets
FacetsStats
FetchedIndex
GetApiKeyResponse
GetDictionarySettingsResponse
GetLogsResponse
GetObjectsParams
GetObjectsRequest
GetObjectsResponse
GetTaskResponse
GetTopUserIdsResponse
HasPendingMappingsResponse
HighlightResult
HighlightResult
MapOfStringHighlightResultOption
SeqOfHighlightResultOption
HighlightResultOption
HighlightResultSerializer
HighlightResultTrait
Hit
HitSerializer
IgnorePlurals
IgnorePlurals
BooleanValue
SeqOfSupportedLanguage
IgnorePluralsSerializer
IndexSettings
IndexSettingsAsSearchParams
JsonSupport
Languages
ListApiKeysResponse
ListClustersResponse
ListIndicesResponse
ListUserIdsResponse
Log
LogQuery
LogType
LogType
All
Build
Error
Query
LogTypeSerializer
MatchLevel
MatchLevel
Full
None
Partial
MatchLevelSerializer
MatchedGeoLocation
Mode
Mode
KeywordSearch
NeuralSearch
ModeSerializer
MultipleBatchRequest
MultipleBatchResponse
NumericFilters
NumericFilters
SeqOfNumericFilters
StringValue
NumericFiltersSerializer
OperationIndexParams
OperationType
OperationType
Copy
Move
OperationTypeSerializer
OptionalFilters
OptionalFilters
SeqOfOptionalFilters
StringValue
OptionalFiltersSerializer
Params
Personalization
Promote
Promote
PromoteObjectID
PromoteObjectIDs
PromoteSerializer
PromoteTrait
QueryType
QueryType
PrefixAll
PrefixLast
PrefixNone
QueryTypeSerializer
RankingInfo
ReRankingApplyFilter
ReRankingApplyFilter
SeqOfReRankingApplyFilter
StringValue
ReRankingApplyFilterSerializer
Redirect
RedirectRuleIndexMetadata
RedirectRuleIndexMetadataData
RemoveStopWords
RemoveStopWords
BooleanValue
SeqOfSupportedLanguage
RemoveStopWordsSerializer
RemoveUserIdResponse
RemoveWordsIfNoResults
RemoveWordsIfNoResults
AllOptional
FirstWords
LastWords
None
RemoveWordsIfNoResultsSerializer
RenderingContent
ReplaceAllObjectsResponse
ReplaceSourceResponse
Rule
SaveObjectResponse
SaveSynonymResponse
ScopeType
ScopeType
Rules
Settings
Synonyms
ScopeTypeSerializer
SearchDictionaryEntriesParams
SearchDictionaryEntriesResponse
SearchForFacetValuesRequest
SearchForFacetValuesResponse
SearchForFacets
SearchForFacetsOptions
SearchForHits
SearchForHitsOptions
SearchHits
SearchHitsSerializer
SearchMethodParams
SearchParams
SearchParams
SearchParamsObject
SearchParamsQuery
SearchParamsSerializer
SearchParamsString
SearchParamsTrait
SearchQuery
SearchQuery
SearchQuerySerializer
SearchQueryTrait
SearchResponse
SearchResponses
SearchResult
SearchResult
SearchResultSerializer
SearchResultTrait
SearchRulesParams
SearchRulesResponse
SearchStrategy
SearchStrategy
None
StopIfEnoughMatches
SearchStrategySerializer
SearchSynonymsParams
SearchSynonymsResponse
SearchSynonymsResponseSerializer
SearchTypeDefault
SearchTypeDefault
Default
SearchTypeDefaultSerializer
SearchTypeFacet
SearchTypeFacet
Facet
SearchTypeFacetSerializer
SearchUserIdsParams
SearchUserIdsResponse
SecuredApiKeyRestrictions
SemanticSearch
SnippetResult
SnippetResult
MapOfStringSnippetResultOption
SeqOfSnippetResultOption
SnippetResultOption
SnippetResultSerializer
SnippetResultTrait
SortRemainingBy
SortRemainingBy
Alpha
Count
Hidden
SortRemainingBySerializer
Source
StandardEntries
SupportedLanguage
SupportedLanguage
Af
Ar
Az
Bg
Bn
Ca
Cs
Cy
Da
De
El
En
Eo
Es
Et
Eu
Fa
Fi
Fo
Fr
Ga
Gl
He
Hi
Hu
Hy
Id
Is
It
Ja
Ka
Kk
Ko
Ku
Ky
Lt
Lv
Mi
Mn
Mr
Ms
Mt
Nb
Nl
No
Ns
Pl
Ps
Pt
PtBr
Qu
Ro
Ru
Sk
Sq
Sv
Sw
Ta
Te
Th
Tl
Tn
Tr
Tt
Uk
Ur
Uz
Zh
SupportedLanguageSerializer
SynonymHit
SynonymType
SynonymType
Altcorrection1
Altcorrection2
Onewaysynonym
Placeholder
Synonym
SynonymTypeSerializer
TagFilters
TagFilters
SeqOfTagFilters
StringValue
TagFiltersSerializer
TaskStatus
TaskStatus
NotPublished
Published
TaskStatusSerializer
TimeRange
TypoTolerance
TypoTolerance
BooleanValue
TypoToleranceEnum
TypoToleranceEnum
Min
Strict
TypoToleranceEnumSerializer
TypoToleranceSerializer
TypoToleranceTrait
UpdateApiKeyResponse
UpdatedAtResponse
UpdatedAtWithObjectIdResponse
UpdatedRuleResponse
UserHighlightResult
UserHit
UserId
Value
usage
ErrorBase
ErrorBaseSerializer
GetUsage200Response
GetUsage200ResponseStatisticsInner
GetUsage400Response
GetUsage400ResponseError
GetUsage400ResponseErrorErrorsInner
Granularity
Granularity
Daily
Hourly
GranularitySerializer
JsonSupport
Statistic
Statistic
90pProcessingTime
99pProcessingTime
AclOperations
AddApiKeyOperations
AddRecordOperations
AvgProcessingTime
AvgUsedSearchCapacity
BatchOperations
BatchRulesOperations
BatchSynonymOperations
BrowseOperations
ClearIndexOperations
ClearRulesOperations
ClearSynonymOperations
CopyMoveOperations
DataSize
DegradedQueriesMaxCapacityQueriesImpacted
DegradedQueriesMaxCapacitySecondsImpacted
DegradedQueriesSsdUsedQueriesImpacted
DegradedQueriesSsdUsedSecondsImpacted
DeleteApiKeyOperations
DeleteByQueryOperations
DeleteIndexOperations
DeleteRecordOperations
DeleteRulesOperations
DeleteSynonymOperations
FileSize
GetApiKeyOperations
GetApiKeysOperations
GetLogOperations
GetRecordOperations
GetRulesOperations
GetSettingsOperations
GetSynonymOperations
IndexingOperations
ListApiKeyOperations
ListIndicesOperations
MaxQps
MultiQueriesOperations
PartialUpdateRecordOperations
QueriesAboveLastMsProcessingTime
QueriesOperations
QuerySynonymOperations
QuerysuggestionsTotalAclOperations
QuerysuggestionsTotalIndexingOperations
QuerysuggestionsTotalOperations
QuerysuggestionsTotalReadOperations
QuerysuggestionsTotalRecordsOperations
QuerysuggestionsTotalRulesOperations
QuerysuggestionsTotalSearchOperations
QuerysuggestionsTotalSearchRequests
QuerysuggestionsTotalSynonymOperations
QuerysuggestionsTotalWriteOperations
RecordOperations
Records
RegionAvgUsedSearchCapacity
RegionMaxQps
RegionUsedSearchCapacity
RuleOperations
SaveRulesOperations
SearchOperations
SearchRulesOperations
SetSettingsOperations
Star
SynonymOperations
TotalAclOperations
TotalAvgUsedSearchCapacity
TotalIndexingOperations
TotalMaxQps
TotalOperations
TotalReadOperations
TotalRecommendRequests
TotalRecordsOperations
TotalRulesOperations
TotalSearchOperations
TotalSearchRequests
TotalSynonymOperations
TotalUsedSearchCapacity
TotalWriteOperations
UpdateApiKeyOperations
UpdateRecordOperations
UpdateSynonymOperations
UsedSearchCapacity
WaitTaskOperations
StatisticSerializer
StatisticValue
StatisticValue
IntValue
MapOfStringInt
StatisticValueSerializer
ApiClient
BuildInfo
algoliasearch-scala
/
algoliasearch
/
algoliasearch.search
/
Promote
Promote
algoliasearch.search.Promote
See the
Promote
companion object
sealed
trait
Promote
Promote
Attributes
Companion
object
Graph
Reset zoom
Hide graph
Show graph
Supertypes
class
Object
trait
Matchable
class
Any
Known subtypes
trait
PromoteTrait
class
PromoteObjectID
class
PromoteObjectIDs
In this article
Attributes