Recommend API client

The Recommend API client is part of the algoliasearch package. You can install this package with pip:

1
pip install 'algoliasearch>=4,<5'

To use the Recommend client, add this import to your files:

1
2
from algoliasearch.recommend.client import RecommendClientSync
from json import loads

To create an instance of the client:

1
2
# In an asynchronous context, you can use RecommendClient instead, which exposes the exact same methods.
client = RecommendClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

Async code

To use the Recommend client in async environments, add these imports instead:

1
2
import asyncio
from algoliasearch.recommend.client import RecommendClient

The client supports the async with statement to automatically close open connections.

1
2
3
async def run():
    async with RecommendClient(ALGOLIA_APPLICATION_ID, ALGOLIA_API_KEY) as client:
        # client.search(...)

The method names are the same for synchronous and asynchronous methods.

List of methods

Each method makes one request to the Recommend API.

Recommendations

Rules