> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vijil.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Set up Evaluate

> Learn how to setup Vijil Evaluate

[Vijil Evaluate](https://vijil.ai/evaluate) is a quality assurance framework that automates the testing of LLM applications. An **Evaluation** in Vijil is an automated test run where you select one or more AI agents and a test [Harness](/core-concepts/components/harness) (covering [Security](/core-concepts/dimensions/security), [Reliability](/core-concepts/dimensions/reliability), and [Safety](/core-concepts/dimensions/safety)) to systematically assess the quality, safety, and reliability of LLM applications.

## Prerequisites

Before setting up an Evaluation, you must have:

* A [Vijil Evaluate](https://vijil.ai/evaluate) account
* Set up an [Agent](https://docs.vijil.ai/tutorials/manage-agents)

## Setting up via Dashboard

1. Navigate to the [Evaluations](https://evaluate.vijil.ai/evaluations) section in the Vijil Evaluate.
2. From the **Create Evaluation > Select Agents** section, choose one or more [Agents](https://docs.vijil.ai/tutorials/manage-agents) you have previously created. If you do not have an Agent, press [Register Agent](https://docs.vijil.ai/tutorials/manage-agents).
   <img src="https://mintcdn.com/vijil/UMwyiC7_rVEftLkW/images/legacy/select_agents.webp?fit=max&auto=format&n=UMwyiC7_rVEftLkW&q=85&s=3c46174642ec9c525ab00fdb460ccf94" alt="Agent selection in an Evaluation" width="1914" height="911" data-path="images/legacy/select_agents.webp" />
3. In the **Select Harness** section, you can configure:
   * **Trust Scores** - Choose between Security, Reliability, and Safety, or select all.
   * **Custom** - Select your custom [Harness](/core-concepts/components/harness).
   * **Benchmarks** - Select specific benchmarks from the Trust Scores.
   * **Garak** - Select Garak Scenarios.
     <img src="https://mintcdn.com/vijil/UMwyiC7_rVEftLkW/images/legacy/select_harness.webp?fit=max&auto=format&n=UMwyiC7_rVEftLkW&q=85&s=c2af9c98439bfbfca42316d106c15374" alt="Harness selection in an Evaluation" width="1914" height="911" data-path="images/legacy/select_harness.webp" />
4. Under **Run Configuration**, you will see your selected Agent(s). By pressing on the dropdown <Icon icon="chevron-down" /> icon, you can configure:
   * **Temperature** - Controls the randomness of the model's output. A higher value (e.g., 1.0) produces more varied and creative responses, while a lower value (e.g., 0.1) makes responses more deterministic and focused.
   * **Top P** - A nucleus sampling parameter that limits token selection to the smallest set of tokens whose cumulative probability meets the specified threshold. Lower values restrict output to higher-probability tokens, while higher values allow more diversity.
   * **Max Completion Tokens** - Sets the maximum number of tokens the model can generate in a single response. Use this to control response length and manage resource consumption.
   * **Requests Timeout** - Specifies the maximum amount of time (in seconds) to wait for a response from the Agent before the request is considered failed and terminated.
     <img src="https://mintcdn.com/vijil/UMwyiC7_rVEftLkW/images/legacy/selected_agents.webp?fit=max&auto=format&n=UMwyiC7_rVEftLkW&q=85&s=f45b9d5e5049ac0eb7b203010790ca53" alt="Selected Agents shown" width="1914" height="911" data-path="images/legacy/selected_agents.webp" />
5. Enter an Evaluation name in the `Enter a name...` field.
   <img src="https://mintcdn.com/vijil/t1_8aRtSIj494eFA/images/legacy/evaluation_name.webp?fit=max&auto=format&n=t1_8aRtSIj494eFA&q=85&s=c13820426790b8a3c921348f9672f064" alt="Evaluation name entry" width="1914" height="911" data-path="images/legacy/evaluation_name.webp" />
6. Press Create.

<Info>
  Evaluations can take a few minutes to complete. To view details of a pending Evaluation, select it from the **List Evaluations** section.
</Info>

## Setting up via API

To run evaluation jobs through the Vijil Evalute API and interact with the results, you need to install the client library that provides the necessary functionalities. You can do so through downloading the library from PyPI.

```bash title="Shell" theme={null}
pip install -U vijil
```

To ensure you are using the latest version of the package, we recommend using the `-U` or `--upgrade` option.

You need a Vijil API key to authenticate remotely through the client library. You can obtain the API key by logging into your
Vijil account, going to the profile page on the dashboard, then copying the value in the **Token** field.

<img src="https://mintcdn.com/vijil/UMwyiC7_rVEftLkW/images/legacy/token-generation.webp?fit=max&auto=format&n=UMwyiC7_rVEftLkW&q=85&s=58f30dd692907184c3b16df7dbe8040e" alt="API Token Location | 80%" width="1287" height="841" data-path="images/legacy/token-generation.webp" />

After your obtain an API key, you can export it in the environment you intend to use the client inside.

```bash title="Shell" theme={null}
export VIJIL_API_KEY = <eyj-xxxx>
```

Alternatively, you can store the key in a `.env` file and load it into your Python environment using a library such as [python-dotenv](https://pypi.org/project/python-dotenv/).

This user token expires after 24 hours. If you plan to use the API over long periods of time, you should use machine-to-machine secrets to regularly refresh the token.
