Evaluate Using SDK
Evaluate Using SDK
Setup Evaluator
Install the Future AGI Python SDK using below command:We recommend you to set the
fi_api_key and fi_secret_key environment variables before using the Evaluator class, instead of passing them as parameters.This section walks you through the process of running your first evaluation using the Future AGI evaluation framework. To get started, we’ll use Tone Evaluation as an example.
a. Using Python SDK (Sync)
b. Using Python SDK (Async)
For long-running evaluations or when you want to run evaluations in the background, you can use the asynchronous evaluation feature. This is particularly useful when evaluating large datasets.Running Async Evaluations
To run an evaluation asynchronously, set theis_async parameter to True:Retrieving Results
Once you have the evaluation ID, you can retrieve the results at any time usingget_eval_result:To Evaluate the data on your own evaluation template which you have created, you can use the
evaluate function with the eval_templates parameter.Evaluate Using UI
Evaluate Using UI
Select a DatasetBefore running an evaluation, ensure you have selected a dataset. If no dataset is available, follow the steps to Add Dataset on the Future AGI platform.Read more about all the ways you can add datasetAccess the Evaluation Panel
- Navigate to your dataset.
- Click on the Evaluate button in the top-right menu.
- This will open the evaluation configuration panel.
- Click on the Add Evaluation button.
- You will be directed to the Evaluation List page. You can either create your own evaluation or select from the available templates built by Future AGI.
- Click on one of the available templates.
- Write the name of the evaluation and select the required dataset column.
- Click on the Add & Run button.
Creating a New Evaluation
Future AGI provides a wide range of evaluation templates to choose from. You can create your own evaluation to tailor your needs by following below simple steps:- Click on the Create your own eval button after clicking on the Add Evaluation button.
-
Write the name of the evaluation This name will be used to identify the evaluation in the evaluation list. only lower case letters, numbers and underscores are allowed in the name.
- Select either Use Future AGI Models or Use other LLMs
-
In the Rule Prompt, you can write the rules that the evaluation should follow. Use
{{}}to create a key (variable), that variable will be used in future when you configure the evaluation. -
Choose Output Type As either Pass/Fail or Percentage or Deterministic Choices
- Pass/Fail: The evaluation will return either Pass or Fail.
- Percentage: The evaluation will return a Score between 0 and 100.
- Deterministic Choices: The evaluation will return a categorical choice from the list of choices.
- Select the Tags for the evaluation that are suitable to use case.
- Write the description of the evaluation that will be used to identify the evaluation in the evaluation list.
- Checkmark on Check Internet to power your evaluation with the latest information.
- Click on the Create Evaluation button.