aymara-ai 0.4.0

A Python SDK for using Aymara to test your AI alignment.

Aymara Python SDK

Hi! 👋 We're Aymara.

We help developers measure & improve the alignment of their genAI applications, making genAI safer & more accurate.

So we built this library for you.

Our Python SDK provides convenient access to the Aymara REST API from Python 3.9+. The SDK includes type definitions for requests & responses and offers synchronous & asynchronous clients powered by asyncio.

Access our API with a free trial or upgrade for access to full funcionality.

If you found a bug, have a question, or want to request a feature, say hello at [e-mail] or open an issue on our GitHub repo.

Documentation

docs.aymara.ai/sdk_reference has our full library API.

Features

Now

• Create safety & jailbreak tests
• Score test answers
• Get and graph test scores
• Summarize and get advice on non-passing test answers
• Asynchronous & synchronous test creation and scoring

Upcoming

• Hallucination tests
• Text-to-image tests
• AI regulation tests

Installation

You will need the Aymara GitHub personal access token from your company. Treat the token like a password and never share it or include it in your code. Instead, add it to your env variables:

export GITHUB_PAT=[GITHUB_PAT]

Then, create a virtual environment and install the SDK from GitHub:

pip install aymara-ai

Configuration

The SDK needs to know who you are. Create an env variable with your Aymara API key:

export AYMARA_API_KEY=[AYMARA_API_KEY]

Or supply your key directly to the client:

client = AymaraAI(api_key="your_api_key")

Usage

Refer to this notebook for a walkthrough of how to use the SDK.

Versioning

This package generally follows SemVer conventions. Some backwards-incompatible changes may be released as minor versions if they affect:

1. Static types without breaking runtime behavior.
2. Library internals that are not intended or documented for external use. (Please open an issue if you are relying on internals).
3. Virtually no users in practice.

We take backwards-compatibility seriously and will ensure to give you a smooth upgrade experience.

Requirements

Python 3.9 or higher.