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' |
Source code in src/cxas_scrapi/utils/eval_utils.py
parse_variables_input staticmethod ¶
Allows YAML to accept a list of strings OR a custom dictionary.
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
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 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 | |
get_latency_metrics_dfs ¶
Generates latency metrics DataFrames from results and traces.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
results | Optional[List[Any]] | An optional list of Eval Result List payload chunks. | None |
eval_names | Optional[List[str]] | Alternatively, an optional list of string Display Names / Names of Evals. | None |
app_name | Optional[str] | Optional override if retrieving Conversation traces dynamically. | None |
Source code in src/cxas_scrapi/utils/eval_utils.py
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 846 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 | |
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 |
|---|---|
Optional[Dict[str, Any]] | 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
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 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 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 | |
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 | Optional[str] | Optional parent App ID. Defaults to self.app_name. | None |
modality | str | "text" (default) or "audio". | 'text' |
run_count | Optional[int] | 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
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 | |
Conversation ¶
Bases: BaseModel
Conversations ¶
Bases: BaseModel
Turn ¶
Bases: BaseModel