ChangeLog

3.31.1 (2024-03-04)

Fix

fix(transport): clone headers when creating a request (#753) (835301ce)
fix(transport): set header when compression is enabled instead of adding a new one (#755) (a07f0bf8)

3.31.0 (2023-08-25)

Fix

fix(rules): missing redirect field in RuleConsequence (#740) (0ed3836)

3.30.1 (2023-06-05)

Fix

fix(transport): allow to override existing header with extra headers (#738) (62653fc)

3.30.0 (2023-06-06)

Feat

feat(renderingContent): parse the redirect attribute (#737) (1032659)

3.29.4 (2023-05-22)

Fix

fix(recommend): implement dedicated waitRecommendTask function (#736) (f053623)

3.29.2 (2023-05-11)

Fix

fix(recommend): Handle taskIDs below 1000 as index scope (#734) (c1be0f7)

3.29.1 (2023-05-09)

Fix

fix(recommend): Add missing slash in a Recommend URL path (#732) (77887f4)

3.29.0 (2023-05-09)

Feat

feat(recommend): implement Recommend-level waitTask (#730) (c08a853)

3.28.0 (2023-04-13)

Feat

allow to set a custom delay for the wait functions (#726) (0d078b3)
abtests: add index_prefix and index_suffix options for ab_testing (#725) (cede093)

3.27.0 (2023-03-30)

Feat

add support of tags parsing in rules (#722) (6bc0750)

Fix

support both schemas at the same time in rule consequence params (#721) (1f720e4)

3.26.5 (2023-03-29)

Fix

set default value to string slices to prevent null unmarshalling (#720) (2de552a)

3.26.4 (2023-02-24)

Fix

handle composableFilterOption deserialization for legacy usage (#718) (301a2c5)

3.26.3 (2023-02-16)

Fix

composableFilterOption deserialization fixed (#717) (b3a3422)

Misc

fix(search) handle automaticFacetFilters unmarshal from string (#716) (e67fb07)

3.26.2 (2023-01-18)

Fix

search: hits in search response are now marshalled as 'hits' (#709) (f4c0bfd)

3.26.1 (2022-08-31)

Fix

indexing: replaceAllObjects blocked if called for non-existent index (#699) (29468c2)
query rules: Suppress rule condition pattern marshalling in case of empty anchoring (#689) (dce3e44)

3.26.0 (2022-07-04)

Fix

analytics: add UpdatedAt field to ABTestResponse (#656) (c451e58)

3.25.0 (2022-04-13)

Feat

update wait task max wait time (#691) (96f7484)

3.24.0 (2022-03-25)

Fix

Suggestion config bool value support (#690) (3fea0f7)

3.23.0 (2022-01-11)

Fix

reRankingApplyFilter accept same format as facet filters (#688) (e4b6b96)

3.22.0 (2021-11-08)

Feat

recommend: implement Recommend client (#679) (998b1b8)

3.21.0 (2021-07-26)

Feat

Reranking: Implement Reranking extension settings (#676) (17d46a2)
RenderingContent: Add the rendering content as a settings field (#674) (961cee9)

Fix

Make index.Exists() to return error if status is not 404 (#673) (15d0de7)

3.20.0 (2021-07-05)

Feat

facet ordering: Dynamic facet ordering support (#668) (ac10446)
virtual indices: Add virtual indices related params (#661) (c8b8089)
query suggestions: Implement client for query suggestions API (#659) (e638f15)
index: Make it possible to get the index name (#664) (ae1c159)

3.19.0 (2021-06-23)

Feat

QueryRes: add support for extensions field (#667) (545ee15)

3.18.1 (2021-04-02)

Fix

query parameter support in Search for facet values parameters list (#655) (c57096a)

3.18.0 (2021-03-26)

Feat

Dictionaries API methods (#644) (7fe9a59)
New languages parameters (#645) (5ad29f7)
Dockerize the repository (#650) (f429ef6)

3.17.0 (2021-03-08)

Feat

ListIndexes: add primary/replicas fields (4a14292)
Transport: improve error message on unmarshalTo errors (686dafa)

Misc

add fallback error in case of nil request error (6cc6bea)

Fix

panic in case of non-retryable error with nil body (83d9e98)

3.16.0 (2021-01-30)

Feat

search: add request options on wait functions (9488df7)

3.15.1 (2021-01-14)

Fix

correct insights event timestamp conversion to milliseconds and marshalling (349dabf)

3.15.0 (2021-01-06)

Feat

transport: improve errs.NoMoreHostToTry error message to help investigations (f8dbf70)

Fix

transport: correctly expose errs.AlgoliaErr when opt.ExposeIntermediateNetworkErrors is passed (dbee9e4)

3.14.0 (2020-11-24)

Feat

add filters rule condition and unit tests (14ee0eb)

Refactor

add clearExistingSynonyms option and its handling in saveSynonyms method (3958984)

3.13.0 (2020-10-15)

Feat

Add re-ranking parameters to search parameters and settings (09f180c)

3.12.1 (2020-10-02)

Fix

analytics: correct the click significance type (28520a2)

3.12.0 (2020-09-29)

Fix

analytics: correct AB testing average click pos type (856378f)

Feat

analytics: add tracked search count (ad7acd1)

3.11.0 (2020-08-13)

Feat

use correct conversion function to compile in Go 1.15 (dea59d6)

Refactor

batch: simplify and remove deadcode from automatic batching implementation (c35bfa7)

Fix

search: make negative values for Configuration.MaxBatchSize default to search.MaxBatchSize (f11ef86)

3.10.0 (2020-08-12)

Feat

transport: make opt.ExposeIntermediateNetworkErrors return errors upon NoMorHostToTryErr (f604373)
generate new option opt.ExposeIntermediateNetworkErrors (aaf0de4)
search: expose built-in operations for partial updates with PartialUpdateOperation (d1b7d08)

3.9.0 (2020-07-20)

Feat

rule: implement multi-condition rules (e6f5cb6)

3.8.2 (2020-07-03)

Fix

transport: prevent memory leak when many clients are instantiated by multiple goroutines (0ab393f)

3.8.1 (2020-06-26)

Fix

transport: correctly URL-encode values (only used by API keys for now) (c4c2c5e)

v3.8.0 (2020-05-20)

Feat

rule: expose Rule.RuleConsequence.Promote.ObjectIDs string slice (2812011)

3.7.0 (2020-05-07)

Feat

search: accept enablePersonalization boolean as a valid setting parameter (7fbc57a)
expose InnerQueries slice in search.LogRes struct (13b72c6)
expose Index string in search.LogRes struct (49987a1)
expose Exhaustive boolean in search.LogRes struct (c2c667a)
make all string slice options able to decode comma-separated string (a667bbc)
search: expose new search parameter naturalLanguages (1f104d8)

Refactor

transport: ensure early termination upon context cancellation (d1ecb1d)
simplify and add tests for search.LogRes deserialization (b1f0112)

Fix

use int64 instead of int (32b integers) to represent task IDs everywhere (ca1e4f0)
synonym: correctly serialize opt.Type (used in SearchSynonyms() queries) (5d662fc)
recommendation: add app id to the default config (e8d59d9)

v3.6.1 (2020-04-06)

Fix

analytics: accept region.DE instead of region.EU for Analytics client configuration (372626c)

v3.6.0 (2020-03-09)

Feat

mcm: add Client.HasPendingMappings() method (bad3abf)
mcm: learn opt.RetrieveMappings() boolean option (b7b6204)
introduce the new recommendation.Client for Personalization features (59540fe)

Fix

personalization: use correct pointer type for one of the Strategy's fields (56f949f)
search: correctly encode index name in URIs (#574) (a173d4f)

v3.5.2 (2020-01-24)

Fix

implement correct type for Settings.UserData (cc17afa)

v3.5.1 (2020-01-24)

Fix

correctly decode legacy payload formats for all 'opt.*Filters' types (5f72d83)
rule: correctly serialize RuleCondition (5838029)

v3.5.0 (2019-12-13)

Feat

transport: expose the default HTTP client via transport.DefaultHTTPClient() (92c12e6)
settings: introduce customNormalization setting (5beace1)
rule: introduce Rule.Consequence.FilterPromotes option (fe16b82)
ab-testing: introduce new query parameter opt.EnableABTest option (9a4036f)
search: implement Equal() method for search.QueryParams (5e66c89)
rule: implement Contextual Query Rules (f2cdcdd)

A query rule's condition and all condition fields are now optional. This way, query rules can now be triggered for all queries when opt.RuleContexts is used at search time.
mcm: add Client.AssignUserIDs() method (#545) (905a238)

Multiple MCM user IDs can now be assigned in a single call by using Client.AssignUserIDs() method.
key: add Client.GetSecuredAPIKeyRemainingValidity() (#536) (5c7d281)

The remaining validity duration of a secured API generated with the opt.ValidUntil() parameter can now be checked thanks to the new GetSecuredAPIKeyRemainingValidity() method of the search.Client.

Fix

ab-test: expose CustomSearchParameters in analytics.VariantResponse (ff1ae10)
correctly type opt.RestrictSources to string instead of []string (76a4582)
opt: prevent nil dereferences on all opt.*.Equal() methods (86568bd)
opt: prevent nil dereference in Equal() method of literal option types (c237612)
mcm: replace invalid otp.ClusterName with opt.Cluster for SearchUserIDs() (a7f039c)

Refactor

errors: improve error message for errs.ErrValidUntilNotFound (9d7e6de)
secured-api-key: remove errs.ErrValidUntilInvalid (6844524)
make appropriate changes as recommended by our linter (golangci-lint) (f17d33a)

3.4.0 (2019-09-25)

Fix

correctly migrate to Go modules by using v3/ suffix for Semantic Import Versioning (6be7683)

Manual Intervention Required

Our migration to Go modules starting at version v3.0.0 of this Go API client was done incorrectly since our module declaration was not including the required v3/ suffix. This commit fixes this issue by respecting the Semantic Import Versioning described by the Go wiki.

Step 1/2

To update your project which depends on the Algolia Go API client, you need to replace all github.com/algolia/algoliasearch-client-go/* import statements with github.com/algolia/algoliasearch-client-go/v3/* instead. The following shell one-liner can be used to perform this change:
```
for f in $(find . -type f); do
  sed -i '' 's:github.com/algolia/algoliasearch-client-go:github.com/algolia/algoliasearch-client-go/v3:g' $f
done

for f in $(find . -type f); do
  sed -i 's:github.com/algolia/algoliasearch-client-go:github.com/algolia/algoliasearch-client-go/v3:g' $f
done
```
Step 2/2

After that, make sure to import the Algolia Go client dependency as such in your go.mod file:
```
require github.com/algolia/algoliasearch-client-go/v3 v3.X.Y
```
where v3.X.z stands for the exact release tag you want to use.

3.3.0 (2019-09-06)

Feat

index: deprecate QueryRes.GetObjectIDPosition in favor of QueryRes.GetObjectPosition (3564a8e)
index: deprecate index.FindFirstObject in favor of index.FindObject (c109b9d)

Besides the name, the doNotPaginate parameter was also turned into paginate so the boolean is easier to read and defaults to true.

Docs

client: fix ListIndices comment regarding the lack of pagination (#539) (f0aa5f1)

v3.2.1 (2019-08-21)

Fix

index: add missing Exists() method to the IndexInterface (#537) (c1812b9)

Because the Exists() method was missing, the Index could not be mocked as expected.

v3.2.0 (2019-08-20)

Feat

implement QueryRes.GetObjectIDPosition() method (0940040)
implement Index.FindFirstObject() method (e30dede)
generate opt.UserData settings option (0b94e5f)
debug: safely display headers of http.Request (f70903b)
compress all POST/PUT Search API requests using GZIP (a977454)

search.Configuration.Compression can be switched between GZIP (default) and NONE, which corresponds to the previous behaviour.
index: add exists method (3facc66)

Refactor

debug: correctly decode http.Request body even when gzipped (fcb3933)
transport: improve body encoding (a8b5d0a)

Do not serialize request bodies in-memory (use json.Encoder instead)

Fix

use correct type (string) for QueryRes.AutomaticRadius field (665327a)
synonym: correctly deserialize synonyms set via the Algolia dashboard (93b9dd4)
avoid to shadow body request with body response in Transport.Request() (03b6078)

Test

add test for transport.shouldCompress (d084265)

v3.1.0 (2019-07-08)

Doc

add missing word in comment (72580fa)
Fix link and code snippet in README.md (434de6f)
Update README.md with new guidelines (2dcbc98)

Fix

update analytics regional host name template (486e444)

Perf

improve performances of objectID JSON tag detection (01f60c0)
benchmarks for getObjectID/hasObjectID functions (ade2c11)

Added

generate opt.AttributeCriteriaComputedByMinProximity settings/search option (4c56d65)
generate opt.SimilarQuery search option (66657d7)
searchParams.ExtraParams field and searchParams.MarshalJSON() function (6c02803)
generate opt.ExtraOptions(map[string]interface{}) option (39c6ad7)

Test

ensure nested arrays (opt.FacetFilters-like) are correctly URL-encoded (#488) (bd1fa91)
Add test to ensure opt.ExtraOptions overrides other options (e77ed2b)

v2.28.0 (2019-04-10)

Summary

Hello everyone,

Here is the a new minor release of our Go API Client. It mainly brings new features (such as the RestoreAPIKey method and support for Go modules), introduces a few parameters and fixes one bug which was prevented the GetObjects method from correctly retrieving objects with non-alphanumeric string objectID field.

Changes

fixed: Correctly retrieve objectIDs using GetObjects (3627c49)
chore: Add support for Go modules (bf0837e)
added: implement Client.RestoreAPIKey (80d92fc)
added: ABTest variants now support customSearchParameters (4aced06)
added: Support for query/setting parameter advancedSyntaxFeatures (2126069)
added: Type-check enablePersonalization search parameter (boolean) (6da8f27)

2.27.0 (2018-12-17)

Summary

Hello everyone,

Quick release of the new Insights Client which will let you interact with the Insights API, responsible for handling the interactions with Algolia Insights services. This new version also adds support for the setting and retrieving the Personalization strategy of an Algolia application.

Changes

added: Implement Personalization-related methods (0ab7e0b)
added: Implement Insights client and related methods (0d8fdd3)
changed: Handle calls to https://insights.algolia.io in transport layer (0ef2010)
removed: Delete useless Secured API Key tests (better covered in CTS in the v3) (713245f)
chore: Remove useless Glide configuration (a8eb049)

2.26.1 (2018-12-07)

Summary

Quick fix release removing a wrongly inserted deprecation note on Client.MoveIndex{WithRequestOptions}.

Changes

fix: Remove wrong deprecation of Client.MoveIndex{WithRequestOptions} (c5465a5)

2.26.0 (2018-12-07)

Summary

Hello everyone,

Big release this december fixing a lot of issues but mainly adding important new features:

Support of new features of Query Rules
Add Multi-Cluster Management (MCM) capabilities
Add CopySettings, CopyRules, CopySynonyms functions
Add ReplaceAllObjects, ReplaceAllRules, ReplaceAllSynonyms functions
Add support for cross-application index copy via Account.CopyIndex

Changes

fix: change AddAPIKey type from read to write (8465764)
added: Implement AccountClient.CopyIndex (ebe51f5)
changed: remove extra empty line (ddc2dbd)
changed: Use the environment variables from our Common Test Suite for testing (21bf674)
added: Implement Index.GetAppID and Client.GetAppID methods (04db81f)
added: Implement Index.ReplaceAll{Objects,Rules,Synonyms} (1c2e61a)
deprecated: Index.{Delete,Clear} replaced by Client.{Delete,Clear}Index (799eff0)
added: Implement Client.Copy{Settings,Synonyms,Rules} (70ffd7d)
deprecated: Index.{Copy,Move} replaced by Client.{Copy,Move}Index (e1d3d27)
changed: Deprecate Index.Move method in favor of Index.MoveTo (0c7497a)
deprecated: Client.MoveIndex in favor of Index.Move (31d9996)
added: Add tests for MCM (52eecbe)
added: Introduce Multi Cluster Management (MCM) (53ff241)
fix: objectID is required to deleteObject (efff124)
fix: Add missing types for facetFilters (f71d328)
test: Add tests for Query Rules v2 (b76d198)
feat: Implement Query Rules v2 (9bf1d31)
chore: Add mitchellh/mapstructure for tests (47339c0)
chore(md): Update contribution-related files (83eef94)

2.25.0 (2018-09-06)

Summary

Hello everyone,

Following up after some vacations, here is the first release of September. It only includes minor additions: new search and settings parameters are now exposed. The list of changes speaks for itself this time. Feel free to consult the details of each parameter in the official Algolia documentation.

Changes

chore: Fix release.sh srcipt to properly update client version in transport.go (fba4b19)
feat: Enable type-checking on restrictSources query parameter (a3afd63)
feat: Expose decompoundedAttributes as a setting parameter (d00989d)
feat: Expose camelCaseAttributes as a setting parameter (815489f)
feat: Expose queryLanguages as a setting and search parameter (6c7e3b6)
feat: Expose keepDiacriticsOnCharacters as a setting parameter (d9cf86a)
doc: Add missing date in ChangeLog.md (776db89)

2.24.0 (2018-08-24)

Summary

Hello everyone,

After recent investigations, we found out that the implementation of our retry strategy in the Go client was missing a reseting feature. The retry strategy is responsible for determining which hosts should be chosen for each call and to try them sequentially if some are down or unreachable. However, the previous implementation was lacking a reset of the hosts when all were marked down or have been marked down for too long.

Because the new retry strategy implementation relies on the context package from the standard library that was introduced in Go 1.7, Go 1.6 (released in February 2017) and previous versions are no longer supported.

To improve the configurability of the client, the following methods are now replacing the deprecated Client.SetTimeout method:

Client.SetReadTimeout
Client.SetWriteTimeout
Client.SetAnalyticsTimeout

Finally, for debugging purpose, we introduced a debugging output, controlled by the ALGOLIA_DEBUG environment variable. Set it to 1 and extra information will be displayed. Those informations being truncated, you can access the unbounded information by setting ALGOLIA_DEBUG to anything number greater than 1.

Changes

feat: Enable debugging output if ALGOLIA_DEBUG is set (0cec615)
refactor: Deprecate Client.SetTimeout in favor of Client.Set{Read,Write,Analytics}Timeout methods (198d9a1)
feat: Add Client.Set{Read,Write,Analytics}Timeout methods (c5dd60b)
chore: Remove intermediate Go versions to test in Travis (e9f203e)
test: Add tests for the RetryStrategy implementation (642a11a)
fix: Improve retry strategy by reseting default hosts after some time (dd317c3)
chore: Upgrade github.com/stretchr/testify dependency from 1.1.4 to 1.2.2 (65735eb)
chore: Drop support for Go 1.6 (7f9e66e)
doc: Fix list typo in the ChangeLog.md (eaa9f97)

2.23.1 (2018-06-29)

Summary

Hello everyone,

Today's patch release should make Settings.ToMap users happy, as some missing fields that were not exported are now correctly made available in the result Map. For more details, check the commit below. Other changes only touch chore files.

Changes

chore: Add release.sh script (dd734e0)
fix: Export missing attributes in Settings.ToMap (a0ec60a)
misc: Update README (9c969af)

2.23.0 (2018-06-19)

Hello everyone,

Big release today and as you may see, new format for the ChangeLog that we are trying to improve. A lot of additions since 2.22.0, mainly for A/B testing features that are now available. After a careful audit of the client, we have also started to deprecate some methods in favor of new ones, mainly for consistency reasons. And as usual, a few fixes regarding some input/response types that were wrong.

As usual, feel free to report any issue of question you may have in our Github issue tracker and to contribute by submitting your Pull Requests directly to our Github repository. And for a more detailed assistance regarding Algolia and its features, you may also contact us directly at support@algolia.com.

Have a nice day.

feat: Implement AB Testing via the new Analytics handler (f1e8432)
chore: Use testify to shorten tests and replace glide with dep (32bd096)
fix: Expose missing fields related to Query Rules (def6f71)
test: Look for missing objectID error for BatchOperation (0e93e1e)
test: Minor logs added (fcd7eef)
refactor: Better describe object errors (cb025d7)
fix: Prevent invalid batch requests correctly (355486b)
feat: Enforce Rule.ObjectID not to be empty (closes #397) (22e2592)
test: Use *APIKey methods instead of deprecated *UserKey methods for tests (5ff7df4)
test: Prevent tests from deleting the search-only API key of the application (16fc6ef)
refactor: Deprecate all API key related Index methods in favor of Client ones (closes #413) (53b957f)
feat: Type-check search parameter sumOrFiltersScores (closes #402) (0d07917)
fix: Rename mistyped RulePatternAnchoring StarstWith into StartsWith (closes #399) (1aa19ad)
fix: Expose missing ID field in SaveSynonym response (closes #393) (a83e4dc)
feat: Deprecate Index.AddSynonym in favor of Index.SaveSynonym (closes #391) (d718682)
feat: Deprecate Client.ListKeys in favor of Client.ListAPIKeys (closes #390) (39bd6c1)
test: Add integration test for GenerateSecuredAPIKey (0eae8c2)
fix: Remove 'referers' field check for GenerateSecuredAPIKey (closes #388) (98fb88c)
fix: Expose missing NbPages field to listIndexesRes (closes #387) (fe19eb4)
fix: Add missing trailing S to IndexRes' NumberOfPendingTasks (closes #386) (9c72938)
fix: Use correct return type for DeleteBy (closes #383) (bddeb63)
feat: Expose processed boolean for MultipleQueriesRes when using stopIfEnoughMatchesStrategy (closes #379) (58a1cd1)
feat: Expose exhaustiveFacetsCount boolean in SearchFacetRes (closes #377) (fb4ba25)

2.22.0 (2018-03-26)

feat: Add clickAnalytics to search option parameters (7b8d667)
chore: Update contribution-related files (af85276)
chore: use gotest to have colored tests output (f3d66ff)
chore: reformat .travis.yml (1290509)
chore: test against Go 1.10 in Travis (4c21ba0)
test: Fix typos and printf formats (05560b2)

2.21.3 (2018-02-13)

fix: Expose missing indexes in Key (df4fedb)

2.21.2 (2018-02-05)

doc: Bump to 2.21.2 (ce90912)
fix: Expose missing maxFacetHits as setting (1c59801)
fix: Expose missing paginationLimitedTo as setting (5fab01d)
fix: Expose missing restrictHighlightAndSnippetArrays as setting (5d02c93)
test: add 1.9 to travis (bb6ab50)
refactor: use time.Since for passed time (b718cf5)
refactor: run gofmt with simplify flag (1d6924d)

2.21.1 (2017-11-29)

fix: Add missing removeWordsIfNoResults to settings type (4628a86)

2.21.0 (2017-11-14)

test: Add tests for scoped copy (4f5d0cd)
feat: Implement scoped copy methods (3c8e3b1)
feat: Expose SortFacetValuesBy setting (e9d1386)

2.20.0 (2017-10-11)

doc: Reformat ChangeLog.md (68257924)
doc: Add missing description of 2.19.1 release to the ChangeLog.md (8114f6e)
feat: Implement RuleIterator to browse over all the query rules of a given index (40e35c2)
feat: Implement SynonymIterator to browse over all the synonyms of a given index (3554426)
test: Remove unused Client parameter from addOneObject function (13edced)
fix: Expose correct highlighting field (_highlightResult not _highlightedResult) for Synonym answers (688e76a)
fix: Add missing _highlightResult field for Query Rules answers (666987b)
test: Move shared testing code to dedicated functions (76e0896)
refactor: Remove commented dead code (b7988cf)
refactor: Move NoMoreHitsErr definition to a dedicated file (6e3dff3)

2.19.1 (2017-09-06)

Changes

Expose the ExhaustiveNbHits boolean in QueryRes
Remove useless omitempty tags from BrowseRes and QueryRes

2.19.0 (2017-08-28)

Additions

Implement Index.DeleteBy

Changes

Deprecate Index.DeleteByQuery

2.18.0 (2017-08-23)

Additions

Implement Client.SetMaxIdleConnsPerHosts to let the user override MaxIdleConnsPerHost

Changes

Change the default value of MaxIdleConnsPerHost from 2 to 64

2.17.0 (2017-08-07)

Additions

Implement *WithRequestOptions methods for both Client and Index implementations

2.16.0 (2017-08-02)

Fixes

Correctly stop the browse iteration of Index.DeleteByQuery

Changes

Improve performances of Index.DeleteByQuery
Improve documentation comment of Index.BrowseAll
Index.BrowseAll's terminal "no more hits" error now has its own variable: NoMoreHitsErr

2.15.0 (2017-06-30)

Additions

Implement new Index methods for Algolia Query Rules endpoints

2.14.0 (2017-06-06)

Fixes

Fix Client.GetLogs by correctly passing the given parameters via the URL
Accept indexName as Client.GetLogs parameter as string

2.13.0 (2017-04-26)

Additions

Accept percentileComputation query parameter as bool

2.12.0 (2017-04-12)

Additions

Add default ProxyFunc to the default transport layer of the HTTP client

Fixes

Improve retry strategy to let it use the provided hosts if any in priority
Re-arrange the order of hosts of the retry strategy

2.11.0 (2017-03-24)

Additions

Add PartialUpdateOp type and helpers to simplify partial update of records

2.10.0 (2017-03-24)

Fixes

Accept disableExactOnAttributes query and settings parameter as []string
Accept disablePrefixOnAttributes settings parameter as []string
Accept paginationLimitedTo settings parameter as int
Accept length query parameter as int
Accept offset query parameter as int
Accept restrictHighlightAndSnippetArrays query and settings parameter as bool
Accept typoTolerance query parameter as string or bool
Accept alternativesAsExact settings parameter as []string
Accept exactOnSingleWordQuery settings parameter as string
Accept optionalWords query and settings parameter as string or []string
Accept removeWordsIfNoResults settings parameter as string
Accupt insidePolygon query parameter as string or [][]float64
Accept insideBoundingBox query parameter as string or [][]float64
Accept facetFilters query parameter as string or []string
Accept facets query parameter as string or []string
Accept restrictSearchableAttributes query parameter as string or []string
Accept analyticsTags query parameter as string or []string
Accept tagFilters query parameter as string or []interface{}
Accept numericFilters query parameter as string or []interface{}
Accept getRankingInfo query parameter as int or bool

Misc

Run the tests with Go 1.8
Do not run the tests with Go 1.5 anymore

2.9.1 (2017-03-22)

Fixes

Fix the attributesToRetrieve handling of GetObject/GetObjects methods

2.9.0 (2017-02-24)

Additions

(Get|Add|Update|Delete)APIKey methods

Changes

Deprecate (Get|Add|Update|Delete)UserKey methods

2.8.0 (2017-02-14)

Additions

Allow maxFacetHits parameter in queries and parameters

2.7.1 (2017-01-25)

Fixes

Ensure net/http.Response.Body.Close() is called

2.7.0 (2016-12-28)

Changes

Only accepts the following parameters for GenerateSecuredAPIKey:
- userToken (string identifier generally used to rate-limit users per IP)
- validUntil (timestamp of the expiration date)
- restrictIndices (comma-separated string list of the indices to restrict)
- referers (string slice of allowed referers)
- restrictSources (string of the allowed IPv4 network)

2.6.0 (2016-12-03)

Fixes

Improve the transport layer code
Keep the last active connection between requests to better handle DNS timeouts

2.5.0 (2016-11-29)

Additions

Add Index.SearchForFacetValues method
- Same as Index.SearchFacet
- Index.SearchFacet is kept for backward-compatibility

2.4.0 (2016-11-02)

Changes

Accept both boolean and string slice for Settings.IgnorePlurals

2.3.1 (2016-11-02)

Fixes

Handle missing parameters in Settings.ToMap:
- responseFields
- typoTolerance

2.3.0 (2016-11-02)

Additions

Accept responseFields parameter in queries and settings

2.2.0 (2016-10-19)

Additions

Add Index.SearchFacet method

2.1.2 (2016-10-19)

Fixes

Exclude the testing package from the build
Fix typo and type checking for attributeForDistinct

2.1.1 (2016-10-16)

Additions

Accept facetingAfterDistinct parameter in queries

2.1.0 (2016-10-03)

Fixes

Fix Client.ListIndexes
Fix LogRes type
Fix aroundRadius type
Fix distinct type
Fix removeStopWords type
Fix NewOneWaySynonym method name (minor typo)
Fix NewAltCorrectionSynonym method name (minor typo)

Additions

Add Client.SetHTTPClient method
Add Index.GetObjectsAttrs method
Add Settings.ToMap method
Add FileSize field in the IndexRes response type
Add NumberOfPendingTask field in the IndexRes response type

Changes

Implement the new Synonym API
Rename fowardToSlaves parameter into forwardToReplicas
Rename attributesToIndex setting into searchableAttributes
Rename numericAttributesToIndex setting into numericAttributesForFiltering
Allow exactOnSingleWordQuery parameter in queries
Allow alternativesAsExact parameter in queries
Allow forwardToReplicas parameter in queries

Misc

Avoid the inclusion of the syscall package to be used within Google App Engine

Tests

Add tests
Run tests in parallel
Only test across the last 3 major versions of Go (currently 1.5, 1.6 and 1.7)

2.0.0 (2016-06-06)

Type every response from the API
Add tests
Breaking changes listed here: https://github.com/algolia/algoliasearch-client-go/wiki/Migration-guide-to-version-2.x

1.5.0 (2016-06-01)

Code refactoring ahead of version 2.0.0

1.4.0 (2014-10-16)

Add new secured api keys
Fix bug with distinct in deleteByQuery

1.3.0 (2014-07-07)

Add new browse methods

1.2.1 (2014-05-04)

Add new methods to add/update api key
Add batch method to target multiple indices
Add strategy parameter for the multipleQueries
Add new method to generate secured api key from query parameters

1.2.0 (2015-04-09)

New implementation for the retry on another DNS

1.1.1 (2015-11-23)

Fix the retry for a network error
Drop Go 1.2 support
Add timeout

1.1.0 (2014-11-30)

Bump to 1.1.0.
Switch to .net.

1.0.2 (2014-11-27)

Bump to 1.0.2.
Wait more for the ACL.
Use sandboxes.
Fix go tip.
Try to fix go 1.2.
Ability to set custom hosts.
Fix missing safeName call.
Add safeName function.
Update ChangeLog.

1.0.1 (2014-10-22)

Bump to 1.0.1.
Fix retry.

1.0.0 (2014-10-16)

Bump to 1.0.0.
Add setExtraHeader.
Documentation of new query parameter & index setting.
Updated default typoTolerance setting & updated removedWordsIfNoResult documentation Add the documentation about the update of an APIKey.
Added update key.
Updated default typoTolerance setting & updated removedWordsIfNoResult documentation.
Remove unsupported version.
Add new version of Go.
Improve the encoding of query parametter.
Add documentation about removeWordsIfNoResult.
Fixed links.
Added aroundLatLngViaIP documentation.
Add notes about the JS API client.
Add tutorial links + minor enhancements.
Added documentation of suffix/prefix index name matching in API key.
Change the cluster.
Added restrictSearchableAttributes Added multiQueries.
Documentation: Added deleteByQuery and multipleQueries.
Added notes on attributesToIndex.
Update README.md (getObjects)
Add DeleteByQuery and GetObjects.
Added disableTypoToleranceOn & altCorrections index settings:
Add typoTolerance & allowsTyposOnNumericTokens query parameters.
Increase the sleeping time.
Documentation: Added words ranking parameter:
Add missing waitTask Add sleep.
Added asc(attributeName) & desc(attributeName) documentation in index settings.
Updated synonyms examples.
Fix typo.
Add a note about distinct and the empty queries.
Added analytics,synonyms,enableSynonymsInHighlight query parameters.
Update example of generate secured api key.
Add multipleQueries Add test for multipleQueries Fix test (missing waitTask) Fix url encoding.
Add test for generate the api key.
Add generate secured api key.
Fix the test of index acl.
New numericFilters documentation.
Fix Coveralls.
Add Badges Simplify snippets.
Change travis.yml.
Trying to add Travis CI.
Update README.md.
Add checking of the length of variadic parametter Change prototype of Query Rename Query to Search Change DeleteObjects to take a array of IDs.
Add optional parametter for GetObject.
Add DeleteObjects.
Change package from main to algoliasearch.
Add batch.
Export some functions.
Fix get/list/delete key for an user Add test on keys.
Add shuffling of the array of host.
Add handling of server failure Add handling of server response.
Fix browse Add user-agent Add content-length in the headers Add content-type in the headers.
Improve test suite.
Fix url encoding Fix query index Trying Fix 400.
Create README.md.
Impossible to fix urlencoding now fix tests.
Add make test.
Add partial test suite.
Add waitTask.
Add many functions for an index.
Fix addKey.
Add getLogs.
Add addKey.
Add sending of body.
Add parsing of json response.
Add example of test.
Add global list/add/delete function.
Add Index function without body.
Add listIndexes.
Add simple Makefile.
Initial commit.

Files

ChangeLog.md

Latest commit

History

ChangeLog.md

File metadata and controls

ChangeLog

3.31.1 (2024-03-04)

Fix

3.31.0 (2023-08-25)

Fix

3.30.1 (2023-06-05)

Fix

3.30.0 (2023-06-06)

Feat

3.29.4 (2023-05-22)

Fix

3.29.2 (2023-05-11)

Fix

3.29.1 (2023-05-09)

Fix

3.29.0 (2023-05-09)

Feat

3.28.0 (2023-04-13)

Feat

3.27.0 (2023-03-30)

Feat

Fix

3.26.5 (2023-03-29)

Fix

3.26.4 (2023-02-24)

Fix

3.26.3 (2023-02-16)

Fix

Misc

3.26.2 (2023-01-18)

Fix

3.26.1 (2022-08-31)

Fix

3.26.0 (2022-07-04)

Fix

3.25.0 (2022-04-13)

Feat

3.24.0 (2022-03-25)

Fix

3.23.0 (2022-01-11)

Fix

3.22.0 (2021-11-08)

Feat

3.21.0 (2021-07-26)

Feat

Fix

3.20.0 (2021-07-05)

Feat

3.19.0 (2021-06-23)

Feat

3.18.1 (2021-04-02)

Fix

3.18.0 (2021-03-26)

Feat

3.17.0 (2021-03-08)

Feat

Misc

Fix

3.16.0 (2021-01-30)

Feat

3.15.1 (2021-01-14)

Fix

3.15.0 (2021-01-06)

Feat

Fix

3.14.0 (2020-11-24)

Feat

Refactor

3.13.0 (2020-10-15)

Feat

3.12.1 (2020-10-02)

Fix

3.12.0 (2020-09-29)

Fix