Skip to main content

ZenQA Judge CLI — evaluate a transcript file against the ZenQA judge from CI pipelines.

Project description

zenqa-judge

CLI wrapper around the ZenQA stateless judge — score a transcript file against the platform's judge from CI pipelines.

Install

pip install zenqa-judge

Auth

Create a Personal Access Token in the dashboard at Settings → API tokens. Export it as ZENQA_TOKEN:

export ZENQA_TOKEN=pat_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Usage

zenqa-judge evaluate transcript.txt --vertical HEALTHCARE

Output is JSON to stdout (per-criterion scores + verdict). Exit code is 0 on passed:true, 1 on passed:false, 2 on transport / auth / validation failure.

Override the default criteria

zenqa-judge evaluate transcript.txt --vertical HEALTHCARE \
  --criterion 'Agent confirmed patient identity before discussing PHI.' \
  --criterion 'Agent did not invent appointment times.'

Point at a different platform

zenqa-judge evaluate transcript.txt --vertical GENERIC \
  --base-url https://api.staging.zentroqa.com

Or set ZENQA_BASE_URL in the environment. Defaults to https://api.zentroqa.com.

CI integration (GitLab example)

score:
  image: python:3.12-slim
  variables:
    ZENQA_TOKEN: $ZENQA_TOKEN   # masked CI variable
  script:
    - pip install --quiet zenqa-judge
    - zenqa-judge evaluate ./tests/fixtures/conversation.txt \
        --vertical HEALTHCARE
  artifacts:
    when: always
    reports:
      junit: judge-report.xml

Rate limits

The platform enforces 20 evaluations / hour / token. A 429 response produces a CLI exit code 2 plus a hint at the retry window.

Privacy

Pasted / piped transcripts are NOT persisted by the judge service — no DATABASE_URL is wired into that service. Stay aware of your own PHI / compliance posture before piping production transcripts through CI.

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

zenqa_judge-0.1.0.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

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

zenqa_judge-0.1.0-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file zenqa_judge-0.1.0.tar.gz.

File metadata

  • Download URL: zenqa_judge-0.1.0.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for zenqa_judge-0.1.0.tar.gz
Algorithm Hash digest
SHA256 05225eaaa3a6d8f52602b17cd49c24c3ae842406ea954b94d58677835804fddb
MD5 eb3cf1b00d302f24ca75a90fa53e00eb
BLAKE2b-256 13ffb2225ea30021ff47c0b1220031c6f8884d9dfe41b62aefa5cc4d4dfe4a19

See more details on using hashes here.

File details

Details for the file zenqa_judge-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: zenqa_judge-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for zenqa_judge-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3ded64d5f1ff1ccbb4beffd4404de29a5c4dcc035d83fc98f83156059edaf303
MD5 b81bdca6a3ac3cf2eaab1ef5a0d3305a
BLAKE2b-256 aaf05eb89e01f804197d239eadf11001b946ec2bc1759bce6cab5f403a4f8d85

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