4.0.0

New major version released!

→ Browse the Algolia documentation
→ Browse the changelog
→ Browse the commits

v3.0.0

v3.0.0

Changed

• Major version!: drop support for Python 2.7, add support for Python 3.9, 3.10 and 3.11 (#553)
• Major version!: remove recommendation client in favor of personalization (#554)

Fixed

• Unable to initialize SearchClient on Python 3.11 (#549)

1.17.0

• Introduce AB Testing feature - PR #408
  List/Create/Stop/Delete AB Tests programmatically
  Introduce new Analytics object, wrapper around the
  Analytics API (more methods to come).

• 2 methods about taskID initially available in the Index moved to the Client.
  You could get some taskID from the engine without necessarily have an instance of Index,
  instead of instantiating an index that you won't need, you can now call wait_task and get_task_status on the client.
  The original methods on the index still work and are not deprecated.

  client.wait_ask(index_name, taskID)
  client.get_task_status(index_name, taskID)

1.16.0

🎉 Note to contributors:
Everybody is now able to run the test on Travis, since we moved to temporary credentials.️ ⤵️
https://blog.algolia.com/travis-encrypted-variables-external-contributions/

• Deprecation: Keys should not be managed at the Index level but at the Client level

  All methods Index.(list|get|add|update)_api_keys() are now
  deprecated. If you already have keys on the Index, it would be best
  to delete them and regenerate new keys with client, adding the indexes
  restriction.

  Example:

  client.add_api_key({
      'acl': 'search',
      'indexes': 'my_index_name',
  })

• Feat: Let you define all API keys capabilities in one map for update_api_key and add_api_key

  Example:

  client.add_api_key({
      'acl': ['search'],
      'validity': 300,
      'maxQueriesPerIPPerHour': 100,
      'maxHitsPerQuery': 20,
      'indexes': ['dev_*'],
      'referers': ['algolia.com/*'],
      'queryParameters': 'typoTolerance=strict&ignorePlurals=false',
      'description': 'Limited search only API key for algolia.com'
  })

  instead of

  client.add_api_key(['search'], 300, 100, 20, ['dev_*'])

• Fix: Adding a rule with an empty ID failed silently, it will now raise an exception

• Fix: Index.get_objects requires an array for attributes_to_retrieve
  strings could be passed before but it would fail silently every time
  See #299

• Fix: When browsing, ensure cursor is passed in the body
  Cursor can become so long that the generated URL fails (error HTTP 414).

• Chore: Add Python version to the UserAgent

1.15.3

• Remove the [security] flair of requests

1.15.2

• Add 'page' and 'hitsPerPage' to list_user_ids
• Implement delete_by, an atomic delete_by_query
• Deprecate delete_by_query

1.15.0

• Implement iter_synonyms for browsing all the synonyms of an index
• Implement iter_rules for browsing all the rules of an index
• Add the scope parameter to copy_index to allow copying only the synonyms, or the rules, or the settings.

1.14.1

• Fix request_options not always optional

1.14.0

• Add per-request parameters
• Add multi-cluster support

1.12.0

Do not ship the certificates anymore