Ruby API client changelog

​

3.40.0

• chore(deps): dependencies 2026-05-15 (#6400)
• chore(deps): dependencies 2026-05-18 (#6429)
• feat(ruby): add TransformationOptions for ingestion transporter configuration (#6313)
• fix(specs): document abTest field on listIndices response (#6443)
• fix(specs): clean up abTest schema on listIndices response (#6448)
• fix(specs): BREAKING CHANGE – add searchResponsePartial fallback to searchResult oneOf (#6350)
  For those of you who want really clean responses without hits nor facets, we added a third fallback type to the search response. It should not impact the rest of the users.
• feat(ruby): BREAKING CHANGE – expose maximum number of retries (#6461)
  We updated the default number of retries to account for customers with huge indices, and made it configurable if you prefer to fail early. The impact is that the retry time will be longer in case of issue, but it shouldn’t impact most customers: those who don’t have issues.

​

3.39.1

• fix(specs): Ingestion API - update destination payload (#6320)
• chore(deps): dependencies 2026-04-20 (#6259)
• fix(clients): validate empty string for required string parameters (#6338)
• chore(deps): dependencies 2026-05-04 (#6322)

​

3.39.0

• feat(specs): add Algolia Index as a native connector in ingestion client (#6290)
• fix(specs): compostion run payload example for external injected items (#6291)
• feat(specs): add feedsOrder to composition run params (#6314)

​

3.38.0

• refactor(specs): split injection schema (#6224)
• feat(specs): introduce recommend source in Comp API client (#6227)
• fix(specs): clarify getIndexingTime (#6276)
• feat(specs): query categorization (#6258)

​

3.37.1

• fix(clients): add discriminator fields for InjectedItemSource oneOf (#6170)
• chore(deps): dependencies 2026-04-06 (#6200)

​

3.37.0

• feat(clients): response decompression (#6095)
• fix(specs): remove query parameter that are not accepted by the Composition API (#6128)
• chore(deps): dependencies 2026-03-16 (#6102)

​

3.36.1

• fix(specs): add deprecated field condition in rule schemas (#5983)

​

3.36.0

• feat(specs): add optional feedID to composition result set (#5991)
• fix(specs): invalid API format for multi feed in Comp API (#5993)

​

3.35.1

• docs(specs): align with style guides (#5930)
• fix(specs): insights-api timestamp documentation (#5925)
• fix(ruby): Implement host reset (#5922)
• fix(specs): BREAKING CHANGE – remove unnecessary required fields (#5959)
  The SearchResponse model now accepts query and params as optional parameters, as they are not always returned by the API.
• fix(specs): add missing redirect property to rule consequence schema (#5934)
• chore(deps): dependencies 2026-02-09 (#5935)

​

3.35.0

• feat(specs): conditions is not required anymore in composition rules (#5853)
• docs(SearchParams): Document that filter scores are supported in virtual replicas (#5716)
• fix(specs): BREAKING CHANGE – remove baseRecommendRequest from trendingFacets [CR-10264] (#5858)
  The TrendingFacets model has been updated to reflect the API response.
• docs: BREAKING CHANGE – authentication type can’t be updated (#5824)
  The AuthenticationUpdate model has been updated to reflect that the type field can’t be updated.
• fix(specs): allow additionalProperties on insights-api events (#5885)
• fix(specs): BREAKING CHANGE – more accurate composition behavior typing (#5892)
  The CompositionBehavior model is now a union type for better accuracy.
• feat(specs): BREAKING CHANGE – Ingestion API: new code property in oauth authentication (#5897)
  The AuthOAuth and AuthOAuthPartial models have been updated to reflect that the clientId field is now optional, and the code field can be set.

​

3.34.4

• chore: agentic config prep (#5825)

​

3.34.3

• fix(specs): BREAKING CHANGE — remove fields requirement from run response in CompAPI client (#5809)
  Some fields from the Composition Run search response were marked as required while they were optional on the API side. This has been fixed, but might impact the client types.
• chore(deps): dependencies 2025-12-29 (#5792)

​

3.34.2

• chore(deps): dependencies 2025-12-22 (#5775)

​

3.34.1

• refactor(specs): extract results field in a dedicated directory (#5739)
• chore(deps): dependencies 2025-11-24 (#5653)
• refactor(specs): re-organise response for Composition API (#5744)
• fix(specs): update list with NLU permissions (#5769)

​

3.34.0

• chore(scripts): update the jira action (#5678)
• chore(scripts): remove component from jira ticket (#5680)
• feat(specs): add sortBy query param and sortingStrategy (#5686)
• feat(specs): add sortBy trigger on Composition Rules (#5707)
• docs(abtests): Added documentation for featureFilters configuration i… (#5688)

​

3.33.0

• feat(specs): allow enablePersonalization query parameter at run time for Composition API (#5651)

​

3.32.0

• feat(specs): add useImagesObjects property in commercetools source input (#5586)
• fix(specs): Add title values to key oneOfs (#5581)
• fix(specs): update run reason in observability (#5623)
• fix(specs): add tags and scope to rules (#5625)

​

3.31.0

• feat(clients): remove schedule capabilities (#5552)
• chore(deps): dependencies 2025-11-03 (#5553)
• feat(specs): add fallbackParameters to Frequently bought together [RECO-2443] (#5579)

​

3.30.0

• feat(specs): add renderingContent query parameter in Composition API main injection (#5549)
• fix(specs): add ACL to missing endpoints (#5529)
• feat(specs): add specific documentation for facets query parameter in Composition API (#5477)

​

3.29.0

• fix(specs): ingestion small fix + added source input descriptions (#5515)
• feat(specs): add facets query parameter available at run time (#5486)

​

3.28.1

• chore(deps): dependencies 2025-10-13 (#5453)
• fix(clients): upgrade linter (#5476)
• chore: remove dead links (#5472)
• docs: replace links for the new doc (#5478)

​

3.28.0

• feat(specs): add compositions deduplication setting (#5418)
• fix(clients): add a default idleConnTimeout (#5442)
• fix(clients): move default timeouts to the constructor (#5443)
• chore(deps): dependencies 2025-09-29 (#5393)

​

3.27.0

• feat(specs): add partialNoCreate action to ingestion specs (#5389)

​

3.26.0

• chore(deps): dependencies 2025-09-08 (#5310)
• fix(specs): normalize spelling of summaries (#5340)
• feat(specs): allow filtering transformations type (#5363)
• chore(deps): dependencies 2025-09-15 (#5341)
• feat(specs): merge composition & composition-full (#5333)
• chore(deps): dependencies 2025-09-22 (#5369)
• fix(clients): initialize page variable in Ruby helpers (#5370)

​

3.25.0

• fix(specs): Cross-reference filerPromotes to relevant guide (#5279)
• feat(specs): add put task endpoint to ingestion api (#5281)
• fix(specs): add getVersion parameter to getSettings (#5254)
• chore(website): exclude schema from generated variables file (#5306)
• fix(clients): link to support/help center on unreachable hosts (#5305)

​

3.24.0

• refactor(specs): mutualise code between Search API & Comp API for search query parameters (#5125)
• feat(specs): add fields for metadata in composition injectedItems (#5241)
• feat(specs): abtests stopped at (#5275)

​

3.23.0

• chore(deps): dependencies 2025-07-28 (#5161)
• feat(clients): add new abtesting-v3 package to clients + stabilize alpha js package (#5157)

​

3.22.1

• refactor(specs): add interface to manipulate query parameter between composition API & Search API (#5123)
• chore(deps): dependencies 2025-07-21 (#5129)
• fix(specs): value/price clarifications in the Insights API (#5154)

​

3.22.0

• feat(specs): document runMetadata parameter (#5087)
• fix(specs): averageClickPosition return type (#5089)

​

3.21.1

• fix(specs): update sourceRun docs (#5057)
• fix(specs): allow one sided rule validity (#5060)

​

3.21.0

• feat(specs): abtesting winsorizedAmount (#5053)

​

3.20.0

• feat(clients): add replaceAllObjectsWithTransformation (#5008)
• chore(spec): fix comment of custom path (#5014)

​

3.19.0

• feat(specs): update try transformation specs for no-code (#4974)
• fix(clients): processingTimeMS should be optional (#5004)
• feat(specs): add new ingestion property for push (#5007)

​

3.18.0

• feat(specs): add with transformation helpers (#4931)

​

3.17.0

• fix(specs): typo (#4854)
• chore(deps): dependencies 2025-05-19 (#4853)
• feat(specs): add global push endpoint (#4855)
• fix(specs): updated watchResponse (#4879)
• feat(specs): update transformation specs for no-code (#4901)
• fix(specs): more indexing actions to push (#4930)
• fix(specs): wrong ACL for getSettings (#4933)

​

3.16.0

• fix(specs): add x-acl to insights endpoints (#4822)
• feat(scripts): add push to mcp-node on release (#4784)

​

3.15.5

• chore(deps): dependencies 2025-04-21 (#4762)
• chore(deps): dependencies 2025-04-28 (#4785)

​

3.15.4

• fix(specs): condition cant be numeric filter (#4726)
• fix(specs): event.status can be null (#4727)
• fix(specs): add missing recordType collection (#4728)
• fix(ruby): avoid mutating frozen string literals by replacing upcase! (#4755)
• fix(clients): correctly deserialize SearchResult (#4756)

​

3.15.3

• fix(specs): userData is any type (#4702)
• docs(partialUpdate): add note about multiple operations (#4721)
• fix(specs): message is not required in WatchResponse (#4723)

​

3.15.2

• fix(ruby): remove integer empty check (#4698)
• fix(specs): make the updateAt non-null in ingestion (#4697)

​

3.15.1

• chore: deprecate mcm methods (#4694)
• chore: assert long lasting requests on the ingestion api (#4615)

​

3.15.0

• feat(specs): add CT Query predicate property (#4654)

​

3.14.0

• feat(specs): add the owner attributes to ingestion resources (#4616)

​

3.13.0

• feat(specs): add subscriptionAction to ingestion specs (#4587)

​

3.12.3

• chore(scripts): point jira issues to another epic (#4505)
• chore(deps): dependencies 2025-03-03 (#4511)
• fix(specs): Increase optionalWords visibility in docs (#4559)

​

3.12.2

• chore(deps): dependencies 2025-02-17 (#4459)

​

3.12.1

• fix(specs): responseFields description (#4399)
• fix(specs): add a linter to assert that type is present (#4393)

​

3.12.0

• feat(specs): only use shortname in the source input (#4287)
• fix(specs): move customRanking and keepDiacriticsOnCharacters to indexSettings (#4324)
• feat(clients): endpoint level timeout part 2 (#4318)
• fix(specs): optionalFilters additional explanation (#4353)
• fix(specs): ingestion expected and received events type (#4356)
• fix(specs): extend Analytics descriptions (#4360)
• fix(specs): remove the processing outcome (#4359)
• fix(specs): adjust style for banner descriptions (#4362)
• fix(ruby): rename object_id reserved word to algolia_object_id (#4381)
• feat(specs): rename composition to composition-full (private) and add composition (public) (#4357)

​

3.11.0

• fix(specs): drop singer from ingestion specs (#4281)
• chore(deps): dependencies 2024-12-30 (#4286)
• feat(clients): cleanup after replaceAllObjects failure (#3824)
• chore(deps): dependencies 2025-01-06 (#4299)
• feat(specs): add notification settings to tasks (#4297)
• fix(ruby): use discriminators for oneOf (#4310)
• feat(clients): add optionnal scopes to replaceAllObjects (#4296)
• chore: revert release (#4314)

​

3.10.2

• chore: trigger auto close pr (#4250)
• fix(ruby): Set default hits_per_page for SearchClient#browse_objects using accessor (#4253)
• fix(clients): support dict in helpers (#4254)
• fix(specs): endpoint level timeout for ingestion (#4251)

​

3.10.1

• fix(clients): lock version (#4228)
• fix(ruby): handle unknown attributes in index_exists (#4231)
• fix(specs): enable watcher for push (#4229)
• fix(specs): add ignoreConjugations to AlternativesAsExact (#4230)

​

3.10.0

• fix(specs): different summaries for saveObject/addOrUpdate methods (#4223)
• feat(specs): add watch to pushTask ingestion (#4224)

​

3.9.0

• feat(specs): add info and link about indexing rate limits (#4136)
• fix(specs): nb_api_calls in getLogs response is optional (#4142)
• chore(deps): dependencies 2024-11-25 (#4145)
• fix(specs): consequence is required when saving rules (#4146)
• fix(specs): saveRule response type (#4170)
• feat(clients): allow batch size on objects helper (#4172)
• fix(specs): remove SFCC source type (#4190)
• fix(ruby): expose static helper (#4191)
• fix(specs): add sourceType to listTasks (#4193)
• feat(generators): allow per-spec timeouts (#4173)
• chore(deps): dependencies 2024-12-09 (#4197)

​

3.8.2

• fix(cts): add tests for HTML error (#4097)

​

3.8.1

• fix(specs): make the searchParams compatible with v4 (#4108)
• fix(specs): remove private beta endpoint from recommend (#4110)

​

3.8.0

• feat(specs): add estimate path and responses (#4057)
• feat(specs): update estimate response type (#4101)

​

3.7.1

• fix(specs): add secrets payload for updates (#4061)
• fix(clients): update browse iterator (#4058)

​

3.7.0

• feat(specs): add secrets authentications to ingestion (#4054)

​

3.6.0

• fix(ruby): provide default ttl (#4027)
• feat(specs): add missing message attribute to GetObjectsResponse [skip-bc] (#4029)
• fix(specs): support synonyms type in camel case [skip-bc] (#4031)
• feat(clients): expose waitForTasks to batch helpers [skip-bc] (#4030)

​

3.5.4

• fix(specs): results in getObjects is required (#4024)

​

3.5.3

• docs(analytics): constrain pagination only to limit query parameter (#4012)

​

3.5.2

• fix(specs): Typo tolernace on words (#3968)
• fix(specs): Add context to hitsPerPage (#3969)
• fix(ruby): add helper to add segment to user agent (#3972)
• fix(clients): escape char in comments (#3973)
• fix(specs): alternativesAsExact is plurals and synonyms (#3974)
• fix(specs): Separators are non-alphanumeric characters (#3978)
• fix(specs): multiple clients fixes (#3971)

​

3.5.1

• fix(ruby): only prefix model by client:: (#3923)
• fix(specs): Typos in API descriptions (#3932)
• fix(clients): remove all client side validation expect null check (#3936)
• fix(specs): use the read transporter for browse (#3938)
• fix(specs): correct type for banners [skip-bc] (#3939)

​

3.5.0

• fix(specs): update analytics and abtesting max pagination query limit (#3696)
• feat(specs): add support for widgets / banners in search for the csharp client (#3870)
• fix(specs): correct typos is Search API (#3898)
• chore: revert and fix release (#3922)

​

3.4.0

• chore(clients): add workflow to auto-close PR (#3834)
• fix(specs): API key description will be obfuscated (#3840)
• feat(specs): add recommend batch rules endpoint (#3782)

​

3.3.4

• fix(specs): correct query params for ingestion [skip-bc] (#3830)

​

3.3.3

• fix(specs): recommend remove unsupported query parameters [RECO-2345] [skip-bc] (#3692)
• fix(specs): remove models from ingestion specs [skip-bc] (#3774)

​

3.3.2

• fix(specs): update search api specs [skip-bc] (#3760)
• chore(deps): dependencies 2024-09-16 [skip-bc] (#3704)

​

3.3.1

• fix(specs): remove usage [skip-bc] (#3691)
• feat(specs): add (optional) _automaticInsights to search result (#3688)

​

3.3.0

• feat(clients): helper to switch API key in use (#3616)
• fix(specs): note on Analytics API server (#3650)
• feat(clients): add helper to check if an index exists (#3646)
• fix(specs): note on insights API server (#3649)
• fix(specs): don’t extend $ref objects (#3623)

​

3.2.4

• fix(specs): usage api (#3624)
• fix(specs): no links across API specs (#3643)

​

3.2.3

• fix(specs): ignorePlurals can be a boolean string (#3620)
• fix(clients): correly parse usage hosts (#3622)

​

3.2.2

• fix(specs): ingestion push task payload [skip-bc] (#3607)

​

3.2.1

• fix(specs): partial update operation (#3486)

​

3.2.0

• feat(specs): push source type (#3600)
• fix(specs): filter run list by type (#3577)
• docs(specs): update api’s length minimum value (#3574)

​

3.1.1

• fix(clients): highlight and snippet results e2e (#3567)
• fix(specs): another wrong link (#3570)
• chore(specs): breaking change method names mapping table (#3568)
• fix(clients): mention main branch instead of master (#3566)
• fix(specs): broken link (#3559)

​

3.1.0

• feat(specs): add /schedule endpoint (#3350)

​

3.0.2

• chore(specs): update rendered title for search params (#3553)

​

3.0.1

• fix(specs): delete user token processing time (#3525)

​

3.0.0

New major version released! Browse our documentation

• fix(specs): required ingestion search params (#3516)

​

3.0.0.beta.16

• feat(specs): recursive snippets and highlights result (#3497)

​

3.0.0.beta.15

• feat(specs): add authentications to ingestion transformations (#3494)

​

3.0.0.beta.14

• feat(specs): add generate code endpoint to ingestion specs (#3489)
• fix(specs): ingestion docker task input (#3488)
• fix(specs): ingestion search endpoint (#3487)

​

3.0.0.beta.13

• feat(specs): add transformation copilot to ingestion (#3479)
• fix(specs): ingestion destination reject indexPrefix (#3478)
• fix(specs): ingestion destinations and transformations (#3477)
• fix(clients): move the license to the root (#3457)
• fix(specs): dictionary entry for stopwords has type property (#3456)
• fix(specs): body is not required in multiple batch request (#3454)
• feat(specs): add runSource endpoint (#3453)
• chore(clients): remove mention of GA (#3452)

​

3.0.0.beta.12

• fix(specs): built-in ops accept also int (#3450)
• fix(specs): required prop for dictionaryEntry (#3449)
• feat(clients): delete unused models (#3445)
• fix(specs): proper title with linter (#3444)
• fix(specs): getObject return object (#3446)
• fix(specs): clarify decompounding limitations (#3227)

​

3.0.0.beta.11

• feat(specs): add v2 endpoints for ingestion (#3416)
• fix(specs): add primary to get settings response (#3415)
• chore(specs): add eslint rule to avoid cross-references (#3413)
• fix(specs): remove cross-references of analytics (#3414)
• feat(specs): add v2 endpoints for ingestion (#3410)
• fix(specs): remove cross-specs references (#3412)
• fix(ruby): add more retry error details (#3384)

​

3.0.0.beta.10

• fix(specs): update shopify feature flags (#3380)
• feat(clients): add api key helper test (#3338)
• fix(specs): recommend non required parameters (#3355)
• fix(specs): results is required in GetRecommendationsResponse (#3357)

​

3.0.0.beta.9

• fix(specs): browse response required properties (#3348)
• fix(specs): ingestion task and transformation (#3347)
• fix(ruby): add the base64 dependency (#3345)
• fix(ruby): use rubyfmt instead of rubocop (#3334)
• fix(specs): clarify browse parameters (#3333)

​

3.0.0.beta.8

• feat(specs): add redirect to renderingContent (#3296)

​

3.0.0.beta.7

• chore(ruby): scope to last commit (#3266)
• fix(clients): update ingestion transformations description and fix taggroups (#3265)

​

3.0.0.beta.6

• feat(clients): generate common LICENSE (#3258)
• fix(clients): update README snippets and contributing guides (#3257)
• feat(clients): add saveObjects, deleteObjects and partialUpdateObjects helpers (#3180)
• fix(specs): virtual is a fetchedIndex props (#3255)
• fix(specs): add virtual index settings and update renderingContent (#3254)
• fix(clients): chunked batch helper size property consistency (#3253)

​

3.0.0.beta.5

• feat(specs): add transformations endpoints to ingestion (#3215)
• fix(specs): update discover endpoint (#3212)
• feat(specs): add validate endpoint (#3087)
• chore(clients): use the ruff python formatter (#3204)
• fix(clients): reduce common tests flakyness (#3205)
• feat(ruby): add chunked_batch and replace_all_objects helpers (#3208)
• feat(clients): add chunkedBatch helper for Kotlin and Scala (#3206)
• feat(clients): add generateSecuredApiKey to java (#3167)

​

3.0.0.beta.4

• feat(clients): add generate_secured_api_key to ruby (#3166)
• fix(clients): safer replaceAllObjects + metis compliant (#3164)

​

3.0.0.beta.3

• fix(clients): remove unused models from lite clients (#3159)
• feat(clients): add waitForAppTask helper (#3158)
• fix(clients): chunked batch helper (#3154)
• fix(specs): rankingInfo required properties (#3157)
• feat(specs): add getAppTask endpoint to search (#3156)
• fix(specs): dont mention index api keys (#3117)

​

3.0.0.beta.2

• fix(specs): exhaustiveFacetsCount is not deprecated for sffv (#3089)
• fix(specs): simplify filter types (#3042)

​

3.0.0.beta.1

• feat(specs): promote @kai687 to code owner (#3014)
• fix(specs): remove periods on summaries (#3013)

​

3.0.0.alpha.18

• fix(specs): attribute and index names case sensitive (#2990)
• feat(specs): update shopify source and task inputs (#2987)
• fix(specs): Personalization API (#2982)
• fix(specs): a/b testing (#2981)

​

3.0.0.alpha.17

• fix(specs): recommend api (#2958)
• fix(specs): update documentation for consistency (#2976)
• feat(clients): add usage client (#2960)
• feat(specs): add algoliaInsights auth type (#2959)
• fix(specs): usage api (#2954)
• fix(specs): crawler api (#2949)

​

3.0.0.alpha.16

• fix(specs): query suggestions api (#2924)
• fix(specs): ingestion api reference (#2918)

​

3.0.0.alpha.15

• fix(specs): more flexible custom methods (#2889)

​

3.0.0.alpha.14

• fix(specs): make languages an enum (#2865)

​

3.0.0.alpha.13

• feat(specs): insights api reference (#2859)
• feat(specs): add ga4BigqueryExport, streaming and append options to task inputs (#2858)
• feat(specs): improve API reference documentation (#2831)

​

3.0.0.alpha.12

• feat(specs): Add MappingInput to Task Inputs (#2787)

​

3.0.0.alpha.11

• fix(specs): add queryID to search response (#2801)
• chore(specs): remove JSON specs and new worlds logic (#2794)

​

3.0.0.alpha.10

• fix(specs): add missing attributes for CT Source update (#2792)
• fix(clients): replace all objects (#2762)
• fix(clients): browse synonyms page not in response (#2757)

​

3.0.0.alpha.9

• fix(specs): allow custom fields to be nullable (#2746)

​

3.0.0.alpha.8

• feat(specs): add CustomFields to CT Source Input (#2742)
• fix(clients): add e2e tests for analytics API (#2737)

​

3.0.0.alpha.7

• feat(ruby): add browse helpers (#2669)

​

3.0.0.alpha.6

• fix(specs): correct searchSynonyms parameters (#2595)
• feat(specs): import crawler and usage specs from new world repo (#2598)
• feat(specs): AB testing tracked user count (#2596)
• feat(ruby): add wait helpers (#2577)
• fix(clients): support the rest of the languages (#2571)
• fix(clients): monitoring for JavaScript and Python (#2568)
• fix(ruby): make the snippets pretty (#2562)
• fix(ruby): correct oneOf deserialization (#2559)
• feat(specs): add acl permissions to operations (#2555)
• fix(specs): rename clearAllSynonyms to clearSynonyms (#2553)

​

3.0.0.alpha.5

• feat(specs): update Insights API spec (#2376)
• chore(clients): provide snippets for all languages (#2518)
• feat(clients): generate code snippets from cts (#2511)
• fix(ruby): exclude vendor from bundled gem (#2512)

​

3.0.0.alpha.4

• fix(ruby): release using Trusted Publishing (#2504)

​

3.0.0.alpha.3

• feat(clients): deserialize in e2e and SFFV response (#2500)
• chore(clients): add more e2e (#2497)

​

3.0.0.alpha.2

• fix(specs): port recommend changes (#2476)

​

3.0.0.alpha.1

• fix(ruby): support ruby alpha format (#2447)
• chore(ruby): setup release (#2446)
• feat(ruby): client tests (#2445)
• feat(ruby): e2e CTS (#2439)
• feat(ruby): add CTS (#2401)
• fix(ruby): support additionalProperties: true (#2418)
• fix(ruby): customize linter (#2409)
• feat(ruby): make hit generic (#2400)
• feat(ruby): retry strategy (#2383)
• fix(ruby): make the playground work (#2379)
• fix(specs): provide non clashing names for custom methods (#2369)
• fix(specs): highlight result map definition (#2312)
• fix(ruby): add libraries in the Dockerfile (#2333)
• chore(ruby): fix renovate config (#2314)
• feat(ruby): setup client (#2311)