Configuration
Inputs
| Input | Required | Default | Description |
|---|---|---|---|
api-key | Yes | — | Your LaunchGate API key |
suite | Yes | — | Eval suite slug |
output | Yes | — | The AI-generated output to evaluate |
input | No | "{}" | Input payload as JSON string |
fail-on-abort | No | "true" | Whether to fail the workflow step on aborted runs |
comment | No | "true" | Whether to post results as a PR comment |
api-url | No | "https://api.launchgate.ai" | LaunchGate API URL |
Outputs
| Output | Description |
|---|---|
status | Run status: cleared, aborted, error, or skipped |
pass-rate | Pass rate as a decimal (e.g., 0.85) |
run-id | The eval run ID |
Examples
Basic usage
- name: Run eval
uses: launchgate/eval-action@v1
with:
api-key: ${{ secrets.LAUNCHGATE_API_KEY }}
suite: "content-safety"
output: ${{ steps.generate.outputs.text }}With input context
- name: Run eval
uses: launchgate/eval-action@v1
with:
api-key: ${{ secrets.LAUNCHGATE_API_KEY }}
suite: "rag-faithfulness"
output: ${{ steps.generate.outputs.text }}
input: |
{
"context": "${{ steps.retrieve.outputs.context }}",
"query": "${{ steps.query.outputs.text }}"
}Non-blocking (warn only)
- name: Run eval (non-blocking)
uses: launchgate/eval-action@v1
with:
api-key: ${{ secrets.LAUNCHGATE_API_KEY }}
suite: "my-suite"
output: ${{ steps.generate.outputs.text }}
fail-on-abort: "false"Using outputs
- name: Run eval
id: eval
uses: launchgate/eval-action@v1
with:
api-key: ${{ secrets.LAUNCHGATE_API_KEY }}
suite: "my-suite"
output: ${{ steps.generate.outputs.text }}
- name: Check results
run: |
echo "Status: ${{ steps.eval.outputs.status }}"
echo "Pass rate: ${{ steps.eval.outputs.pass-rate }}"
echo "Run ID: ${{ steps.eval.outputs.run-id }}"Without PR comments
- name: Run eval (silent)
uses: launchgate/eval-action@v1
with:
api-key: ${{ secrets.LAUNCHGATE_API_KEY }}
suite: "my-suite"
output: ${{ steps.generate.outputs.text }}
comment: "false"Secrets
Add your API key as a repository secret:
- Go to your repository Settings → Secrets and variables → Actions
- Click New repository secret
- Name:
LAUNCHGATE_API_KEY - Value: Your LaunchGate API key
Last updated on