Tonic Validate for Merges to Main

Github action to run Tonic Validate evaulation on merges to main branch. This action uses the open source Tonic Validate library to help track LLM performance over time.

Setup

To kick off a Tonic Validate evaluation after merging to your main branch, add the sample workflow to .github/workflows.

name: Tonic Validate
on:
  push:
    branches:
      - 'master'
      - 'main'

jobs:
  tonic-validate:
    runs-on: ubuntu-latest
    name: Tonic Validate
    env:
      TONIC_VALIDATE_API_KEY: ${{ secrets.TONIC_VALIDATE_API_KEY }}
      OPENAI_API_KEY:  ${{ secrets.OPENAI_API_KEY }}
      AZURE_OPENAI_KEY: ${{ secrets.AZURE_OPENAI_KEY}}
      AZURE_OPENAI_ENDPOINT: ${{ secrets.AZURE_OPENAI_ENDPOINT}}
    steps:
      - name: Checkout Repo
        uses: actions/checkout@v4      
      - name: Validate
        uses: TonicAI/[email protected]
        with:
          tonic_validate_project_id: <Tonic Validate Project Id>
          llm_response_path: <Path to Q&A for Evaluation>

This workflow requires that set a Tonic Validate API key (found in the Tonic Validate UI) and that you do one of the following:

• Set an OpenAI API key
• Set both an Azure API key and an Azure Endpoint URL

You also must provide a value for tonic_validate_project_id, which is the id for your Tonic Validate project, and llm_response_path, which is the path (relative to the root of your repository) to a JSON file that contains the questions and optional context and reference answers for Tonic Validate to evaluate.

Here is a sample set of questions and answers:

[
    {"llm_answer":"Paris", "benchmark_item":{"question":"What is the capital of Paris", "answer":"Paris"}},
    {"llm_answer":"Berlin", "benchmark_item":{"question":"What is the capital of Germany", "answer":"Berlin"}},
    {"llm_answer":"Sam Altman is the CEO of OpenAI", "llm_context_list": ["Sam Altman has been the CEO of OpenAI since 2019."], "benchmark_item":{"question":"Who is the CEO of OpenAI?", "answer":"Sam Altman"}},
]