Skip to main content

Client library for the CRM AI Agent Benchmarking API

Project description

CRM Benchmark Library

A Python client library for the CRM AI Agent Benchmarking API. This library allows AI agent developers to authenticate, load datasets, evaluate responses, and submit results to the CRM AI Agent Challenge leaderboard.

Installation

pip install crm-benchmark-lib

Quick Start

from crm_benchmark_lib import BenchmarkClient

# Initialize client
client = BenchmarkClient(api_key="your_api_key")

# Authenticate
client.authenticate(agent_name="MyAwesomeAgent")

# Define an agent function
def my_agent(question, data):
    # Your AI agent implementation here
    # Process the question and data to generate a response
    return "Agent response"

# Run evaluation on all datasets and submit results
results = client.run_and_submit(my_agent, "MyAwesomeAgent")

Features

  • Authenticate with the benchmarking API
  • Load datasets for evaluation
  • Submit agent responses for evaluation
  • Get detailed feedback on agent performance
  • Automatic submission to the leaderboard

Development

Setup

  1. Clone the repository
  2. Install dependencies: pip install -r requirements.txt
  3. Run tests: pytest tests/

Publishing

  1. Update version in __init__.py and setup.py
  2. Build the package: python -m build
  3. Upload to PyPI: python -m twine upload dist/*

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crm_benchmark_lib-0.2.1.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

crm_benchmark_lib-0.2.1-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file crm_benchmark_lib-0.2.1.tar.gz.

File metadata

  • Download URL: crm_benchmark_lib-0.2.1.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.13

File hashes

Hashes for crm_benchmark_lib-0.2.1.tar.gz
Algorithm Hash digest
SHA256 feac41ce5767f1ab3c2d3969d467e4f9df28a0c5c9292a031198e048fdd2630f
MD5 00c57f858cff304d9589f0b5bb8f8b66
BLAKE2b-256 adcd75eaea9f989f92d7c235dca488cdf9aeeaa9e5ad6f81a759e1c75e848731

See more details on using hashes here.

File details

Details for the file crm_benchmark_lib-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for crm_benchmark_lib-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4a3a2b9e5d6898d8c9507f7103ec62481ebe3566242f7ce991db3ae6c3c6bcca
MD5 34e50be7404d4d9af1a5618ed98b8290
BLAKE2b-256 a2ce1a73e601ac4c0aa8ae82bc1cd5651f438b87479f54e86049da17f307a1bd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page