eval-studio-client 1.2.5__py3-none-any.whl → 1.3.0__py3-none-any.whl

eval_studio_client/api/docs/V1AgentChatActivityDiagramRow.md

@@ -0,0 +1,30 @@
+# V1AgentChatActivityDiagramRow
+
+AgentChatActivityDiagramRow represents a row in the activity diagram.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nodes** | [**List[V1AgentChatActivityDiagramNode]**](V1AgentChatActivityDiagramNode.md) | Output only. List of nodes in this row. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_agent_chat_activity_diagram_row import V1AgentChatActivityDiagramRow
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1AgentChatActivityDiagramRow from a JSON string
+v1_agent_chat_activity_diagram_row_instance = V1AgentChatActivityDiagramRow.from_json(json)
+# print the JSON string representation of the object
+print(V1AgentChatActivityDiagramRow.to_json())
+
+# convert the object into a dict
+v1_agent_chat_activity_diagram_row_dict = v1_agent_chat_activity_diagram_row_instance.to_dict()
+# create an instance of V1AgentChatActivityDiagramRow from a dict
+v1_agent_chat_activity_diagram_row_from_dict = V1AgentChatActivityDiagramRow.from_dict(v1_agent_chat_activity_diagram_row_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1AgentChatScriptUsage.md

@@ -0,0 +1,33 @@
+# V1AgentChatScriptUsage
+
+AgentChatScriptUsage represents usage statistics for a single script.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Output only. Name of the script. | [optional] [readonly] 
+**success_count** | **int** | Output only. Number of successful executions. | [optional] [readonly] 
+**failure_count** | **int** | Output only. Number of failed executions. | [optional] [readonly] 
+**total_count** | **int** | Output only. Total number of executions. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_agent_chat_script_usage import V1AgentChatScriptUsage
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1AgentChatScriptUsage from a JSON string
+v1_agent_chat_script_usage_instance = V1AgentChatScriptUsage.from_json(json)
+# print the JSON string representation of the object
+print(V1AgentChatScriptUsage.to_json())
+
+# convert the object into a dict
+v1_agent_chat_script_usage_dict = v1_agent_chat_script_usage_instance.to_dict()
+# create an instance of V1AgentChatScriptUsage from a dict
+v1_agent_chat_script_usage_from_dict = V1AgentChatScriptUsage.from_dict(v1_agent_chat_script_usage_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1AgentChatScriptsBarChart.md

@@ -0,0 +1,30 @@
+# V1AgentChatScriptsBarChart
+
+AgentChatScriptsBarChart represents the bar chart for agent chat scripts usage.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scripts** | [**Dict[str, V1AgentChatScriptUsage]**](V1AgentChatScriptUsage.md) | Output only. Map of script name to script usage statistics. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_agent_chat_scripts_bar_chart import V1AgentChatScriptsBarChart
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1AgentChatScriptsBarChart from a JSON string
+v1_agent_chat_scripts_bar_chart_instance = V1AgentChatScriptsBarChart.from_json(json)
+# print the JSON string representation of the object
+print(V1AgentChatScriptsBarChart.to_json())
+
+# convert the object into a dict
+v1_agent_chat_scripts_bar_chart_dict = v1_agent_chat_scripts_bar_chart_instance.to_dict()
+# create an instance of V1AgentChatScriptsBarChart from a dict
+v1_agent_chat_scripts_bar_chart_from_dict = V1AgentChatScriptsBarChart.from_dict(v1_agent_chat_scripts_bar_chart_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1AgentChatToolUsage.md

@@ -0,0 +1,33 @@
+# V1AgentChatToolUsage
+
+AgentChatToolUsage represents usage statistics for a single tool.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Output only. Name of the tool. | [optional] [readonly] 
+**success_count** | **int** | Output only. Number of successful invocations. | [optional] [readonly] 
+**failure_count** | **int** | Output only. Number of failed invocations. | [optional] [readonly] 
+**total_count** | **int** | Output only. Total number of invocations. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_agent_chat_tool_usage import V1AgentChatToolUsage
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1AgentChatToolUsage from a JSON string
+v1_agent_chat_tool_usage_instance = V1AgentChatToolUsage.from_json(json)
+# print the JSON string representation of the object
+print(V1AgentChatToolUsage.to_json())
+
+# convert the object into a dict
+v1_agent_chat_tool_usage_dict = v1_agent_chat_tool_usage_instance.to_dict()
+# create an instance of V1AgentChatToolUsage from a dict
+v1_agent_chat_tool_usage_from_dict = V1AgentChatToolUsage.from_dict(v1_agent_chat_tool_usage_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1AgentChatToolsBarChart.md

@@ -0,0 +1,30 @@
+# V1AgentChatToolsBarChart
+
+AgentChatToolsBarChart represents the bar chart for agent chat tools usage.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tools** | [**Dict[str, V1AgentChatToolUsage]**](V1AgentChatToolUsage.md) | Output only. Map of tool name to tool usage statistics. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_agent_chat_tools_bar_chart import V1AgentChatToolsBarChart
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1AgentChatToolsBarChart from a JSON string
+v1_agent_chat_tools_bar_chart_instance = V1AgentChatToolsBarChart.from_json(json)
+# print the JSON string representation of the object
+print(V1AgentChatToolsBarChart.to_json())
+
+# convert the object into a dict
+v1_agent_chat_tools_bar_chart_dict = v1_agent_chat_tools_bar_chart_instance.to_dict()
+# create an instance of V1AgentChatToolsBarChart from a dict
+v1_agent_chat_tools_bar_chart_from_dict = V1AgentChatToolsBarChart.from_dict(v1_agent_chat_tools_bar_chart_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1AllMetricScores.md

@@ -0,0 +1,29 @@
+# V1AllMetricScores
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scores** | **List[float]** | Required. Metric scores for all baseline test cases. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_all_metric_scores import V1AllMetricScores
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1AllMetricScores from a JSON string
+v1_all_metric_scores_instance = V1AllMetricScores.from_json(json)
+# print the JSON string representation of the object
+print(V1AllMetricScores.to_json())
+
+# convert the object into a dict
+v1_all_metric_scores_dict = v1_all_metric_scores_instance.to_dict()
+# create an instance of V1AllMetricScores from a dict
+v1_all_metric_scores_from_dict = V1AllMetricScores.from_dict(v1_all_metric_scores_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1AppendTestCasesResponse.md

@@ -0,0 +1,29 @@
+# V1AppendTestCasesResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**test_cases** | [**List[V1TestCase]**](V1TestCase.md) | The list of added TestCases. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_append_test_cases_response import V1AppendTestCasesResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1AppendTestCasesResponse from a JSON string
+v1_append_test_cases_response_instance = V1AppendTestCasesResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1AppendTestCasesResponse.to_json())
+
+# convert the object into a dict
+v1_append_test_cases_response_dict = v1_append_test_cases_response_instance.to_dict()
+# create an instance of V1AppendTestCasesResponse from a dict
+v1_append_test_cases_response_from_dict = V1AppendTestCasesResponse.from_dict(v1_append_test_cases_response_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1BatchCreateLeaderboardsWithoutCacheRequest.md

@@ -0,0 +1,31 @@
+# V1BatchCreateLeaderboardsWithoutCacheRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requests** | [**List[V1CreateLeaderboardRequest]**](V1CreateLeaderboardRequest.md) | Required. Contains list of requests for leaderboards to be created. | [optional] 
+**dashboard_display_name** | **str** | Optional. Display name for the dashboard that will group the leaderboards. | [optional] 
+**dashboard_description** | **str** | Optional. Description for the dashboard that will group the leaderboards. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_batch_create_leaderboards_without_cache_request import V1BatchCreateLeaderboardsWithoutCacheRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1BatchCreateLeaderboardsWithoutCacheRequest from a JSON string
+v1_batch_create_leaderboards_without_cache_request_instance = V1BatchCreateLeaderboardsWithoutCacheRequest.from_json(json)
+# print the JSON string representation of the object
+print(V1BatchCreateLeaderboardsWithoutCacheRequest.to_json())
+
+# convert the object into a dict
+v1_batch_create_leaderboards_without_cache_request_dict = v1_batch_create_leaderboards_without_cache_request_instance.to_dict()
+# create an instance of V1BatchCreateLeaderboardsWithoutCacheRequest from a dict
+v1_batch_create_leaderboards_without_cache_request_from_dict = V1BatchCreateLeaderboardsWithoutCacheRequest.from_dict(v1_batch_create_leaderboards_without_cache_request_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1BatchCreateLeaderboardsWithoutCacheResponse.md

@@ -0,0 +1,29 @@
+# V1BatchCreateLeaderboardsWithoutCacheResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**operation** | [**V1Operation**](V1Operation.md) |  | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_batch_create_leaderboards_without_cache_response import V1BatchCreateLeaderboardsWithoutCacheResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1BatchCreateLeaderboardsWithoutCacheResponse from a JSON string
+v1_batch_create_leaderboards_without_cache_response_instance = V1BatchCreateLeaderboardsWithoutCacheResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1BatchCreateLeaderboardsWithoutCacheResponse.to_json())
+
+# convert the object into a dict
+v1_batch_create_leaderboards_without_cache_response_dict = v1_batch_create_leaderboards_without_cache_response_instance.to_dict()
+# create an instance of V1BatchCreateLeaderboardsWithoutCacheResponse from a dict
+v1_batch_create_leaderboards_without_cache_response_from_dict = V1BatchCreateLeaderboardsWithoutCacheResponse.from_dict(v1_batch_create_leaderboards_without_cache_response_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1BatchMarkOperationSeenByCreatorResponse.md

@@ -0,0 +1,29 @@
+# V1BatchMarkOperationSeenByCreatorResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**operations** | [**List[V1Operation]**](V1Operation.md) | The updated Operations. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_batch_mark_operation_seen_by_creator_response import V1BatchMarkOperationSeenByCreatorResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1BatchMarkOperationSeenByCreatorResponse from a JSON string
+v1_batch_mark_operation_seen_by_creator_response_instance = V1BatchMarkOperationSeenByCreatorResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1BatchMarkOperationSeenByCreatorResponse.to_json())
+
+# convert the object into a dict
+v1_batch_mark_operation_seen_by_creator_response_dict = v1_batch_mark_operation_seen_by_creator_response_instance.to_dict()
+# create an instance of V1BatchMarkOperationSeenByCreatorResponse from a dict
+v1_batch_mark_operation_seen_by_creator_response_from_dict = V1BatchMarkOperationSeenByCreatorResponse.from_dict(v1_batch_mark_operation_seen_by_creator_response_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1CmpLeaderboardReportsRequest.md

@@ -0,0 +1,33 @@
+# V1CmpLeaderboardReportsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**leaderboard_report_baseline** | **str** | Required. The baseline Leaderboard Report to compare against (JSON string). | [optional] 
+**leaderboard_report_current** | **str** | Required. The current Leaderboard Report to compare (JSON string). | [optional] 
+**text_similarity_metric** | [**V1TextSimilarityMetric**](V1TextSimilarityMetric.md) |  | [optional] 
+**llm_model_name_baseline** | **str** | Required. The baseline LLM model name to compare. | [optional] 
+**llm_model_name_current** | **str** | Required. The current LLM model name to compare. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_cmp_leaderboard_reports_request import V1CmpLeaderboardReportsRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1CmpLeaderboardReportsRequest from a JSON string
+v1_cmp_leaderboard_reports_request_instance = V1CmpLeaderboardReportsRequest.from_json(json)
+# print the JSON string representation of the object
+print(V1CmpLeaderboardReportsRequest.to_json())
+
+# convert the object into a dict
+v1_cmp_leaderboard_reports_request_dict = v1_cmp_leaderboard_reports_request_instance.to_dict()
+# create an instance of V1CmpLeaderboardReportsRequest from a dict
+v1_cmp_leaderboard_reports_request_from_dict = V1CmpLeaderboardReportsRequest.from_dict(v1_cmp_leaderboard_reports_request_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1CmpLeaderboardReportsResponse.md

@@ -0,0 +1,29 @@
+# V1CmpLeaderboardReportsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**leaderboard_cmp_report** | [**V1LeaderboardCmpReport**](V1LeaderboardCmpReport.md) |  | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_cmp_leaderboard_reports_response import V1CmpLeaderboardReportsResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1CmpLeaderboardReportsResponse from a JSON string
+v1_cmp_leaderboard_reports_response_instance = V1CmpLeaderboardReportsResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1CmpLeaderboardReportsResponse.to_json())
+
+# convert the object into a dict
+v1_cmp_leaderboard_reports_response_dict = v1_cmp_leaderboard_reports_response_instance.to_dict()
+# create an instance of V1CmpLeaderboardReportsResponse from a dict
+v1_cmp_leaderboard_reports_response_from_dict = V1CmpLeaderboardReportsResponse.from_dict(v1_cmp_leaderboard_reports_response_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1ComparisonItem.md

@@ -0,0 +1,36 @@
+# V1ComparisonItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**question** | **str** | The question being evaluated. | [optional] 
+**diff_flipped_metrics** | [**List[V1FlippedMetric]**](V1FlippedMetric.md) | List of metrics that flipped between baseline and current. | [optional] 
+**baseline_test_case_result** | [**V1TestCaseResult**](V1TestCaseResult.md) |  | [optional] 
+**baseline_diff_actual_output_meta** | [**V1ActualOutputMetaDiff**](V1ActualOutputMetaDiff.md) |  | [optional] 
+**baseline_diff_retrieved_context** | [**V1RetrievedContextDiff**](V1RetrievedContextDiff.md) |  | [optional] 
+**current_test_case_result** | [**V1TestCaseResult**](V1TestCaseResult.md) |  | [optional] 
+**current_diff_actual_output_meta** | [**V1ActualOutputMetaDiff**](V1ActualOutputMetaDiff.md) |  | [optional] 
+**current_diff_retrieved_context** | [**V1RetrievedContextDiff**](V1RetrievedContextDiff.md) |  | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_comparison_item import V1ComparisonItem
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ComparisonItem from a JSON string
+v1_comparison_item_instance = V1ComparisonItem.from_json(json)
+# print the JSON string representation of the object
+print(V1ComparisonItem.to_json())
+
+# convert the object into a dict
+v1_comparison_item_dict = v1_comparison_item_instance.to_dict()
+# create an instance of V1ComparisonItem from a dict
+v1_comparison_item_from_dict = V1ComparisonItem.from_dict(v1_comparison_item_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1ComparisonMetricScore.md

@@ -0,0 +1,30 @@
+# V1ComparisonMetricScore
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metric_name** | **str** | Metric name. | [optional] 
+**metric_score** | **float** | Metric score value. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_comparison_metric_score import V1ComparisonMetricScore
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ComparisonMetricScore from a JSON string
+v1_comparison_metric_score_instance = V1ComparisonMetricScore.from_json(json)
+# print the JSON string representation of the object
+print(V1ComparisonMetricScore.to_json())
+
+# convert the object into a dict
+v1_comparison_metric_score_dict = v1_comparison_metric_score_instance.to_dict()
+# create an instance of V1ComparisonMetricScore from a dict
+v1_comparison_metric_score_from_dict = V1ComparisonMetricScore.from_dict(v1_comparison_metric_score_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1ComparisonResult.md

@@ -0,0 +1,31 @@
+# V1ComparisonResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**diffs** | [**List[V1DiffItem]**](V1DiffItem.md) | List of differences between leaderboards. | [optional] 
+**leaderboards** | [**List[V1LeaderboardInfo]**](V1LeaderboardInfo.md) | Leaderboard information. | [optional] 
+**metrics_meta** | [**Dict[str, V1MetricMeta]**](V1MetricMeta.md) | Metadata about metrics. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_comparison_result import V1ComparisonResult
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ComparisonResult from a JSON string
+v1_comparison_result_instance = V1ComparisonResult.from_json(json)
+# print the JSON string representation of the object
+print(V1ComparisonResult.to_json())
+
+# convert the object into a dict
+v1_comparison_result_dict = v1_comparison_result_instance.to_dict()
+# create an instance of V1ComparisonResult from a dict
+v1_comparison_result_from_dict = V1ComparisonResult.from_dict(v1_comparison_result_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1ComparisonSummary.md

@@ -0,0 +1,31 @@
+# V1ComparisonSummary
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**recommendation_winner** | **str** | Winner of the comparison (baseline, current, or tie). | [optional] 
+**recommendation** | **str** | Recommendation text. | [optional] 
+**recommendation_confidence** | **str** | Confidence level of the recommendation. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_comparison_summary import V1ComparisonSummary
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ComparisonSummary from a JSON string
+v1_comparison_summary_instance = V1ComparisonSummary.from_json(json)
+# print the JSON string representation of the object
+print(V1ComparisonSummary.to_json())
+
+# convert the object into a dict
+v1_comparison_summary_dict = v1_comparison_summary_instance.to_dict()
+# create an instance of V1ComparisonSummary from a dict
+v1_comparison_summary_from_dict = V1ComparisonSummary.from_dict(v1_comparison_summary_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1CreateEvaluationRequest.md

@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **model_parameters** | **str** | Optional. Parameters overrides in JSON format. | [optional] 
 **h2ogpte_collection** | **str** | The existing collection name in H2OGPTe. | [optional] 
 **default_h2ogpte_model** | [**V1Model**](V1Model.md) |  | [optional] 
+**evaluation_type** | [**V1EvaluationType**](V1EvaluationType.md) |  | [optional] 
 
 ## Example
 

eval_studio_client/api/docs/V1CreateTestFromTestCasesRequest.md

@@ -0,0 +1,32 @@
+# V1CreateTestFromTestCasesRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tests_json** | **str** | Test Cases in JSON format. | [optional] 
+**url** | **str** | URL pointing to the Test Cases in JSON format to import. | [optional] 
+**test_display_name** | **str** | Required. Display name of the newly created Test. | [optional] 
+**test_description** | **str** | Optional. Description of the newly created Tests. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_create_test_from_test_cases_request import V1CreateTestFromTestCasesRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1CreateTestFromTestCasesRequest from a JSON string
+v1_create_test_from_test_cases_request_instance = V1CreateTestFromTestCasesRequest.from_json(json)
+# print the JSON string representation of the object
+print(V1CreateTestFromTestCasesRequest.to_json())
+
+# convert the object into a dict
+v1_create_test_from_test_cases_request_dict = v1_create_test_from_test_cases_request_instance.to_dict()
+# create an instance of V1CreateTestFromTestCasesRequest from a dict
+v1_create_test_from_test_cases_request_from_dict = V1CreateTestFromTestCasesRequest.from_dict(v1_create_test_from_test_cases_request_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1CreateTestFromTestCasesResponse.md

@@ -0,0 +1,29 @@
+# V1CreateTestFromTestCasesResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**test** | [**V1Test**](V1Test.md) |  | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_create_test_from_test_cases_response import V1CreateTestFromTestCasesResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1CreateTestFromTestCasesResponse from a JSON string
+v1_create_test_from_test_cases_response_instance = V1CreateTestFromTestCasesResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1CreateTestFromTestCasesResponse.to_json())
+
+# convert the object into a dict
+v1_create_test_from_test_cases_response_dict = v1_create_test_from_test_cases_response_instance.to_dict()
+# create an instance of V1CreateTestFromTestCasesResponse from a dict
+v1_create_test_from_test_cases_response_from_dict = V1CreateTestFromTestCasesResponse.from_dict(v1_create_test_from_test_cases_response_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1DashboardReport.md

@@ -0,0 +1,31 @@
+# V1DashboardReport
+
+DashboardReport represents the dashboard report which is formed by the results, models and evaluator.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**List[V1DashboardReportResult]**](V1DashboardReportResult.md) | Output only. List of per test case results. | [optional] [readonly] 
+**evaluator** | [**List[V1LeaderboardReportEvaluator]**](V1LeaderboardReportEvaluator.md) | Output only. Details of the evaluators which evaluated the model outputs to create the results. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_dashboard_report import V1DashboardReport
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1DashboardReport from a JSON string
+v1_dashboard_report_instance = V1DashboardReport.from_json(json)
+# print the JSON string representation of the object
+print(V1DashboardReport.to_json())
+
+# convert the object into a dict
+v1_dashboard_report_dict = v1_dashboard_report_instance.to_dict()
+# create an instance of V1DashboardReport from a dict
+v1_dashboard_report_from_dict = V1DashboardReport.from_dict(v1_dashboard_report_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

eval_studio_client/api/docs/V1DashboardReportResult.md

@@ -0,0 +1,39 @@
+# V1DashboardReportResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **str** | Output only. Composite unique key of the result formed by the model key and test case key. | [optional] [readonly] 
+**input** | **str** | Output only. Input prompt or text to be processed. | [optional] [readonly] 
+**expected_output** | **str** | Output only. Expected output or target result. | [optional] [readonly] 
+**actual_output** | **str** | Output only. Actual output produced by the model. | [optional] [readonly] 
+**model_key** | **str** | Output only. Unique identifier for the model used. | [optional] [readonly] 
+**test_case_key** | **str** | Output only. Unique identifier for the test case. | [optional] [readonly] 
+**metrics** | [**Dict[str, V1MetricScores]**](V1MetricScores.md) | Optional. All metrics values for the result. Maps evaluator ID to MetricScore. | [optional] 
+**result_error_map** | **Dict[str, str]** | Output only. Error message if processing resulted in failure. Maps evaluator ID to error message. | [optional] [readonly] 
+**human_decision** | [**V1HumanDecision**](V1HumanDecision.md) |  | [optional] 
+**comment** | **str** | Output only. Optional comment about the result. | [optional] [readonly] 
+**annotations** | **Dict[str, object]** | Output only. Additional annotations for the result. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_dashboard_report_result import V1DashboardReportResult
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1DashboardReportResult from a JSON string
+v1_dashboard_report_result_instance = V1DashboardReportResult.from_json(json)
+# print the JSON string representation of the object
+print(V1DashboardReportResult.to_json())
+
+# convert the object into a dict
+v1_dashboard_report_result_dict = v1_dashboard_report_result_instance.to_dict()
+# create an instance of V1DashboardReportResult from a dict
+v1_dashboard_report_result_from_dict = V1DashboardReportResult.from_dict(v1_dashboard_report_result_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+