EvalUtils¶
EvalUtils extends Evaluations with convenience methods for working with YAML-based evaluation files — the format used by the CXAS Scrapi eval runner. It knows how to load conversations from a YAML file, validate them against a Pydantic schema, and convert them to pandas DataFrames for analysis or reporting.
Think of EvalUtils as the bridge between your local eval files and the CXAS API: load from disk, inspect or transform, then push or run via the inherited Evaluations methods.
Key Pydantic models you'll encounter:
Conversation— one test conversation with turns, expectations, tags, and session parameters.Turn— a single round-trip withusertext,agentresponse, and optionaltool_calls.Conversations— the top-level container, supportingcommon_session_parametersshared across all conversations.
Quick Example¶
from cxas_scrapi import EvalUtils
app_name = "projects/my-project/locations/us/apps/my-app-id"
eu = EvalUtils(app_name=app_name)
# Load a YAML eval file
conversations = eu.load_golden_evals_from_yaml("evals/billing_evals.yaml")
print(f"Loaded {len(conversations.conversations)} conversations")
# Convert to a DataFrame for analysis
df = eu.evals_to_dataframe(conversations)
print(df[["conversation", "turns", "expectations"]].head())
# Export evaluation results to a spreadsheet-ready format
results_df = eu.get_evaluation_results_dataframe()
results_df.to_csv("eval_results.csv", index=False)
Reference¶
EvalUtils ¶
Bases: Evaluations
Utility class for processing and exporting CXAS Evaluation Results.
Initializes the EvalUtils class for processing Evaluation Results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
app_name | str | CXAS App ID (projects/{project}/locations/{location}/apps/{app}). | required |
env | str | Environment override (default: PROD). | 'PROD' |
**kwargs | Any | Additional arguments passed to the parent class (Evaluations). | {} |
Source code in src/cxas_scrapi/utils/eval_utils.py
parse_variables_input staticmethod ¶
Allows YAML to accept a list, a JSON string OR a dictionary.
See :func:_parse_variables_input for the accepted shapes.
Source code in src/cxas_scrapi/utils/eval_utils.py
score_result_audio staticmethod ¶
Score a single result using audio-correct method. In audio mode, taskCompleted is broken (always False). Use goalScore AND allExpectationsSatisfied instead.
Source code in src/cxas_scrapi/utils/eval_utils.py
evals_to_dataframe ¶
Provides three simplified views of the evaluation data.
Returns:
| Type | Description |
|---|---|
dict[str, Any] | A dict with 'summary', 'failures', and 'trace' DataFrames. |
Source code in src/cxas_scrapi/utils/eval_utils.py
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 | |
get_latency_metrics_dfs ¶
Generates latency metrics DataFrames from results and traces.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
results | list[Any] | None | An optional list of Eval Result List payload chunks. | None |
eval_names | list[str] | None | Alternatively, an optional list of string Display Names / Names of Evals. | None |
app_name | str | None | Optional override if retrieving Conversation traces dynamically. | None |
Source code in src/cxas_scrapi/utils/eval_utils.py
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 | |
to_bigquery ¶
Exports a pandas DataFrame to a Google BigQuery table.
Source code in src/cxas_scrapi/utils/eval_utils.py
load_golden_eval_from_yaml ¶
Parses a YAML file and creates a Golden eval input from it.
Supports two formats: 1. A compressed YAML format matching tests/testdata/compressed_example.yaml 2. A YAML format matching the YAML from export_app, e.g. tests/testdata/exported_eval_example.yaml
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
yaml_file_path | str | Path to the YAML file to be parsed. | required |
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None | A dictionary matching the Golden Evaluation proto structure. |
Source code in src/cxas_scrapi/utils/eval_utils.py
load_golden_evals_from_yaml ¶
Parses a YAML file and returns a list of Golden eval inputs.
Similar to load_golden_eval_from_yaml, but returns all conversations found in a dataset format instead of just the first one.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
yaml_file_path | str | Path to the YAML file to be parsed. | required |
Returns:
| Type | Description |
|---|---|
list[dict[str, Any]] | A list of dictionaries matching the Golden Evaluation proto structure. |
Source code in src/cxas_scrapi/utils/eval_utils.py
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 | |
wait_for_run_and_get_results ¶
Polls for completion of an evaluation run and returns results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
run_name | str | Name of the evaluation run. | required |
timeout_seconds | int | Max time to wait. | 300 |
Returns:
| Type | Description |
|---|---|
list[dict[str, Any]] | A list of evaluation results. |
Source code in src/cxas_scrapi/utils/eval_utils.py
create_and_run_evaluation_from_yaml ¶
Loads, creates, and runs an evaluation from a YAML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
yaml_file_path | str | Path to the YAML file. | required |
app_name | str | None | Optional parent App ID. Defaults to self.app_name. | None |
modality | str | "text" (default) or "audio". | 'text' |
run_count | int | None | Number of times to run the evaluation. Default is 1 per golden, 5 per scenario. | None |
Returns:
| Type | Description |
|---|---|
dict[str, Any] | A dictionary containing the evaluation and the run response. |
Source code in src/cxas_scrapi/utils/eval_utils.py
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 | |
Conversation ¶
Bases: BaseModel
Conversations ¶
Bases: BaseModel
Turn ¶
Bases: BaseModel