📚 Documentation
Quick Links
- Home - Main documentation page
- Quickstart Guide - Get started quickly with Arize Toolkit
Tools Documentation
| Tool Category | Description |
|---|---|
| Model Tools | Access and manage models, retrieve performance metrics and inference volumes |
| Monitor Tools | Create, copy, and manage monitors and alerting |
| Custom Metrics Tools | Create and manage custom metrics |
| Language Model Tools | Work with prompts, annotations, and LLM features |
| Space & Organization Tools | Navigate and manage spaces, organizations, and models |
| Data Import Tools | Import data from cloud storage and databases |
| Dashboard Tools | Create and manage dashboards |
| Utility Tools | Client configuration and utility functions |
Extensions
| Extension | Description |
|---|---|
| Prompt Optimization | Automated prompt improvement based on historical performance |
For Developers
- Development Guide - Information about extending the toolkit
- Integration Tests - Running integration tests
Disclaimer
Although this package is used for development work with and within the Arize platform, it is not an Arize product. It is a open source project developed and maintained by an Arize Engineer. Feel free to add issues or reach out for help in the Arize community Slack channel.
Overview
Arize Toolkit is a set of tools packaged as a Python client that lets you easily interact with Arize AI APIs. Here's a quick overview of the main features in the current release:
- Access and manage models
- Retrieve performance metrics over a time period
- Retrieve inference volume over a time period
- Create, copy, and manage custom metrics
- Create, copy, and manage monitors and alerting
- Work with LLM features like prompts and annotations
- Import data from cloud storage (S3, GCS, Azure) and databases (BigQuery, Snowflake, Databricks)
- Create, update, and delete data import jobs with full lifecycle management
- Prompt Optimization Extension (optional): Automatically optimize prompts using meta-prompt techniques with feedback from evaluators
Installation
pip install arize_toolkit
Optional Dependencies
Prompt Optimization Extension
For automated prompt optimization using meta-prompt techniques, install with the prompt_optimizer extras:
pip install arize_toolkit[prompt_optimizer]
Client Setup
The Client class is the entrypoint for interacting with the toolkit. It provides maintains the connection information for making requests to the Arize APIs, and offers a wide range of operations for interacting with models, monitors, dashboards, and more.
API Key
To create a client, you need to provide your Arize API key. Use this reference to get your API key from the Arize UI.
Organization and Space
You will also need to provide an organization name and space name. To give some context, models are scoped to a space, and the space is scoped to an organization. These can be found by navigating to the Arize UI and looking at the upper left path in the Projects & Models page. They will be in the format organization/space.
For the example below, the organization is Demo Models and the space is Demo Model Manager.
For On Prem deployments
For SaaS users, the default API endpoint is always going to be https://api.arize.com.
If you are using an on prem deployment of Arize, you will need to provide the api_url parameter.
This parameters should just be the base url of your Arize instance.
1 maintainer
Metadata
1 maintainer
Release files for arize_toolkit 1.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| arize_toolkit-1.0.5.tar.gz | 3.8 MB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| arize_toolkit-1.0.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 3.8 MB
Release files / arize_toolkit-1.0.5.tar.gz
| Download URL | arize_toolkit-1.0.5.tar.gz |
|---|---|
| Size | 3.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b7b602310396ca16226b462274c2812dff6b29a7bd9dde161b1bd8ba0798e2c8
|
|
BLAKE2b-256 checksum How to use checksums |
56d33d4a1940f437693add224884697b831a2e906f3ce18b79f611456929226f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.21
|
Release files / arize_toolkit-1.0.5-py3-none-any.whl
| Download URL | arize_toolkit-1.0.5-py3-none-any.whl |
|---|---|
| Size | 68.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8c4d743319b5076432476ae63f71228e125013fda49b945196aded4ff97ffcd9
|
|
BLAKE2b-256 checksum How to use checksums |
2f1523f8a1154941f5d30ed4500d0c79ff5f2bb5ff09c5f62ef21785b00f4f00
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.21
|
Security for arize_toolkit 1.0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
