Algolia Python API Client

The client returns response objects that can be used directly or serialized to JSON. Use the .to_json() method on the response object to get a JSON string representation of the result.

# Example of using the response object
print(response)

# Example of converting the response to a JSON string
print(response.to_json())

Install the algoliasearch package using pip. The client supports Python versions 3.8 and above. It is recommended to install version 4.x.

pip install --upgrade 'algoliasearch>=4.0,<5.0'

The A/B Testing V3 client allows you to manage experiments, including listing, retrieving, estimating, and stopping A/B tests. Most operations require the analytics or editSettings API Key ACLs.

Key Operations:

• List and Retrieve: Use list_ab_tests to find configured tests and get_ab_test to fetch specific details by ID.
• Estimation: Use estimate_ab_test to predict sample size and duration based on traffic and expected effect size (requires analytics ACL).
• Lifecycle Management: Use stop_ab_test to end an experiment or delete_ab_test to remove it entirely.
• Settings Management: Use save_variant_settings to capture settings from a winning variant and get_ab_test_settings to retrieve them.

For all major composition operations (search, save_rules, search_composition_rules, search_for_facet_values, and update_sorting_strategy_composition), there is a corresponding method suffixed with _with_http_info.

Use these methods when you need to access the raw ApiResponse[str] object (containing headers, status codes, etc.) instead of the deserialized response object. This is useful for debugging or handling specific HTTP-level metadata.

The CompositionClientSync class is used to manage Algolia compositions synchronously. You can initialize it by providing your app_id and api_key. For advanced configurations, use the create_with_config class method to pass a custom CompositionConfig and TransporterSync.

_client = CompositionClientSync("YOUR_ALGOLIA_APP_ID", "YOUR_ALGOLIA_API_KEY")
# Or using named arguments
_client_with_named_args = CompositionClientSync(app_id="YOUR_ALGOLIA_APP_ID", api_key="YOUR_ALGOLIA_API_KEY")

The AgentStudioClientSync class is used to interact with Algolia Agent Studio synchronously. You can initialize it by providing your app_id and api_key. For advanced configurations, use the create_with_config class method to pass a custom AgentStudioConfig and TransporterSync.

_client = AgentStudioClientSync("YOUR_ALGOLIA_APP_ID", "YOUR_ALGOLIA_API_KEY")
# Or using named arguments
_client_with_named_args = AgentStudioClientSync(app_id="YOUR_ALGOLIA_APP_ID", api_key="YOUR_ALGOLIA_API_KEY")

To use the Algolia A/B Testing V3 API, instantiate the AbtestingV3Client class. You can initialize it using positional arguments or named arguments. You must provide your app_id, api_key, and the region (either 'de' or 'us').

You can also use create_with_config to initialize the client with a custom AbtestingV3Config and Transporter for advanced configuration.

from algoliasearch.abtesting_v3.client import AbtestingV3Client

# Using positional arguments
client = AbtestingV3Client("YOUR_ALGOLIA_APP_ID", "YOUR_ALGOLIA_API_KEY", "us")

# Using named arguments
client = AbtestingV3Client(app_id="YOUR_ALGOLIA_APP_ID", api_key="YOUR_ALGOLIA_API_KEY", region="us")

The AbtestingClient is used to manage A/B testing experiments. You can initialize it by providing your Algolia application ID, API key, and the region of your application ('de' or 'us').

For advanced configuration, use AbtestingClient.create_with_config to pass a custom AbtestingConfig and Transporter.

from algoliasearch.abtesting.client import AbtestingClient

# Basic initialization
client = AbtestingClient(
    app_id="YOUR_ALGOLIA_APP_ID", 
    api_key="YOUR_ALGOLIA_API_KEY", 
    region="us"
)

The CompositionClient is the primary entry point for managing Algolia search compositions. You can initialize it by providing your app_id and api_key. It also supports advanced configuration using a CompositionConfig object and a custom Transporter.

from algoliasearch.composition.client import CompositionClient

# Basic initialization
client = CompositionClient(
    app_id="YOUR_ALGOLIA_APP_ID",
    api_key="YOUR_ALGOLIA_API_KEY"
)

# Using a context manager (recommended for automatic cleanup)
async with CompositionClient(app_id="ID", api_key="KEY") as client:
    # perform operations
    pass

To use the A/B Testing V3 API synchronously, instantiate the AbtestingV3ClientSync class. You must provide your Algolia app_id, api_key, and the region (either 'de' or 'us').

You can also provide a custom transporter or config for advanced setup. The client supports the context manager pattern (with statement) to ensure the underlying transporter is closed properly.

from algoliasearch.abtesting_v3.client import AbtestingV3ClientSync

# Basic initialization
client = AbtestingV3ClientSync(
    app_id="YOUR_ALGOLIA_APP_ID",
    api_key="YOUR_ALGOLIA_API_KEY",
    region="us"
)

# Using as a context manager to ensure connection closure
with AbtestingV3ClientSync(app_id="ID", api_key="KEY", region="us") as client:
    # perform operations
    pass

For synchronous workflows, use the AbtestingClientSync class. It is initialized similarly to the asynchronous AbtestingClient using app_id, api_key, and region.

from algoliasearch.abtesting.client import AbtestingClientSync

client = AbtestingClientSync(
    app_id="YOUR_ALGOLIA_APP_ID", 
    api_key="YOUR_ALGOLIA_API_KEY", 
    region="us"
)