eval-studio-client 1.0.3__py3-none-any.whl → 1.1.0__py3-none-any.whl

eval_studio_client/api/docs/V1InitWorkflowNodeResponse.md

@@ -0,0 +1,29 @@
+# V1InitWorkflowNodeResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**node** | [**V1WorkflowNode**](V1WorkflowNode.md) |  | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_init_workflow_node_response import V1InitWorkflowNodeResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1InitWorkflowNodeResponse from a JSON string
+v1_init_workflow_node_response_instance = V1InitWorkflowNodeResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1InitWorkflowNodeResponse.to_json())
+
+# convert the object into a dict
+v1_init_workflow_node_response_dict = v1_init_workflow_node_response_instance.to_dict()
+# create an instance of V1InitWorkflowNodeResponse from a dict
+v1_init_workflow_node_response_from_dict = V1InitWorkflowNodeResponse.from_dict(v1_init_workflow_node_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/V1LabeledTestCase.md

@@ -0,0 +1,31 @@
+# V1LabeledTestCase
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Required. The test case resource name. | [optional] 
+**metric_value** | **float** | Required. The metric value. | [optional] 
+**label** | **bool** | Required. Human label. True means the test case should be labeled as passed (positive), false means failed (negative). | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_labeled_test_case import V1LabeledTestCase
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1LabeledTestCase from a JSON string
+v1_labeled_test_case_instance = V1LabeledTestCase.from_json(json)
+# print the JSON string representation of the object
+print(V1LabeledTestCase.to_json())
+
+# convert the object into a dict
+v1_labeled_test_case_dict = v1_labeled_test_case_instance.to_dict()
+# create an instance of V1LabeledTestCase from a dict
+v1_labeled_test_case_from_dict = V1LabeledTestCase.from_dict(v1_labeled_test_case_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/V1LeaderboardReport.md

@@ -0,0 +1,32 @@
+# V1LeaderboardReport
+
+LeaderboardReport represents the leaderboard report which is formed by the results, models and evaluator.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**List[V1LeaderboardReportResult]**](V1LeaderboardReportResult.md) | Output only. List of per test case results. | [optional] [readonly] 
+**models** | [**List[V1LeaderboardReportModel]**](V1LeaderboardReportModel.md) | Output only. List of models which were used to create the results. | [optional] [readonly] 
+**evaluator** | [**V1LeaderboardReportEvaluator**](V1LeaderboardReportEvaluator.md) |  | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_leaderboard_report import V1LeaderboardReport
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1LeaderboardReport from a JSON string
+v1_leaderboard_report_instance = V1LeaderboardReport.from_json(json)
+# print the JSON string representation of the object
+print(V1LeaderboardReport.to_json())
+
+# convert the object into a dict
+v1_leaderboard_report_dict = v1_leaderboard_report_instance.to_dict()
+# create an instance of V1LeaderboardReport from a dict
+v1_leaderboard_report_from_dict = V1LeaderboardReport.from_dict(v1_leaderboard_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/V1LeaderboardReportActualOutputData.md

@@ -0,0 +1,31 @@
+# V1LeaderboardReportActualOutputData
+
+ActualOutputData represents the actual output data.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **str** | Output only. Text fragment. | [optional] [readonly] 
+**metrics** | **object** | Output only. Metrics parsed as string to Value map. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_leaderboard_report_actual_output_data import V1LeaderboardReportActualOutputData
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1LeaderboardReportActualOutputData from a JSON string
+v1_leaderboard_report_actual_output_data_instance = V1LeaderboardReportActualOutputData.from_json(json)
+# print the JSON string representation of the object
+print(V1LeaderboardReportActualOutputData.to_json())
+
+# convert the object into a dict
+v1_leaderboard_report_actual_output_data_dict = v1_leaderboard_report_actual_output_data_instance.to_dict()
+# create an instance of V1LeaderboardReportActualOutputData from a dict
+v1_leaderboard_report_actual_output_data_from_dict = V1LeaderboardReportActualOutputData.from_dict(v1_leaderboard_report_actual_output_data_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/V1LeaderboardReportActualOutputMeta.md

@@ -0,0 +1,31 @@
+# V1LeaderboardReportActualOutputMeta
+
+ActualOutputMeta represents the metadata about the actual output.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tokenization** | **str** | Output only. Actual output data tokenization like sentence_level_punkt. | [optional] [readonly] 
+**data** | [**List[V1LeaderboardReportActualOutputData]**](V1LeaderboardReportActualOutputData.md) | Output only. Actual output data - list of text fragments coupled with the metric values. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_leaderboard_report_actual_output_meta import V1LeaderboardReportActualOutputMeta
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1LeaderboardReportActualOutputMeta from a JSON string
+v1_leaderboard_report_actual_output_meta_instance = V1LeaderboardReportActualOutputMeta.from_json(json)
+# print the JSON string representation of the object
+print(V1LeaderboardReportActualOutputMeta.to_json())
+
+# convert the object into a dict
+v1_leaderboard_report_actual_output_meta_dict = v1_leaderboard_report_actual_output_meta_instance.to_dict()
+# create an instance of V1LeaderboardReportActualOutputMeta from a dict
+v1_leaderboard_report_actual_output_meta_from_dict = V1LeaderboardReportActualOutputMeta.from_dict(v1_leaderboard_report_actual_output_meta_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/V1LeaderboardReportEvaluator.md

@@ -0,0 +1,42 @@
+# V1LeaderboardReportEvaluator
+
+Evaluator represents the evaluator which evaluated the model outputs to create the results.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | Output only. Evaluator ID. | [optional] [readonly] 
+**name** | **str** | Output only. Evaluator short name based on its class name. | [optional] [readonly] 
+**display_name** | **str** | Output only. Evaluator display name. | [optional] [readonly] 
+**tagline** | **str** | Optional. Evaluator one row description. | [optional] 
+**description** | **str** | Output only. Evaluator description. | [optional] [readonly] 
+**brief_description** | **str** | Optional. Brief description. | [optional] 
+**model_types** | **List[str]** | Output only. List of model types like rag. | [optional] [readonly] 
+**can_explain** | **List[str]** | Optional. List of experiment types the Explainer can explain like regression or multinomial. | [optional] 
+**explanation_scopes** | **List[str]** | Output only. List of explanation scopes like global or local. | [optional] [readonly] 
+**explanations** | [**List[V1LeaderboardReportExplanation]**](V1LeaderboardReportExplanation.md) | Output only. List of explanation types created by the Evaluator. | [optional] [readonly] 
+**parameters** | [**List[V1LeaderboardReportEvaluatorParameter]**](V1LeaderboardReportEvaluatorParameter.md) | Output only. List of parameter type definitions. | [optional] [readonly] 
+**keywords** | **List[str]** | Output only. List of keywords. | [optional] [readonly] 
+**metrics_meta** | [**List[V1LeaderboardReportMetricsMetaEntry]**](V1LeaderboardReportMetricsMetaEntry.md) | Output only. List of metrics metadata for metrics created by the Evaluator. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_leaderboard_report_evaluator import V1LeaderboardReportEvaluator
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1LeaderboardReportEvaluator from a JSON string
+v1_leaderboard_report_evaluator_instance = V1LeaderboardReportEvaluator.from_json(json)
+# print the JSON string representation of the object
+print(V1LeaderboardReportEvaluator.to_json())
+
+# convert the object into a dict
+v1_leaderboard_report_evaluator_dict = v1_leaderboard_report_evaluator_instance.to_dict()
+# create an instance of V1LeaderboardReportEvaluator from a dict
+v1_leaderboard_report_evaluator_from_dict = V1LeaderboardReportEvaluator.from_dict(v1_leaderboard_report_evaluator_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/V1LeaderboardReportEvaluatorParameter.md

@@ -0,0 +1,38 @@
+# V1LeaderboardReportEvaluatorParameter
+
+Evaluation parameter definition.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Output only. Evaluator parameter ID. | [optional] [readonly] 
+**description** | **str** | Output only. Parameter description. | [optional] [readonly] 
+**comment** | **str** | Optional. Parameter comment. | [optional] 
+**type** | **str** | Output only. Parameter type like float or string. | [optional] [readonly] 
+**predefined** | **List[object]** | Optional. Predefined parameter values - numeric or non-numeric enum. | [optional] 
+**tags** | **List[str]** | Optional. Parameter tags. | [optional] 
+**min** | **float** | Optional. Parameter value lower range. | [optional] 
+**max** | **float** | Optional. Parameter value upper range. | [optional] 
+**category** | **str** | Optional. Parameter category. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_leaderboard_report_evaluator_parameter import V1LeaderboardReportEvaluatorParameter
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1LeaderboardReportEvaluatorParameter from a JSON string
+v1_leaderboard_report_evaluator_parameter_instance = V1LeaderboardReportEvaluatorParameter.from_json(json)
+# print the JSON string representation of the object
+print(V1LeaderboardReportEvaluatorParameter.to_json())
+
+# convert the object into a dict
+v1_leaderboard_report_evaluator_parameter_dict = v1_leaderboard_report_evaluator_parameter_instance.to_dict()
+# create an instance of V1LeaderboardReportEvaluatorParameter from a dict
+v1_leaderboard_report_evaluator_parameter_from_dict = V1LeaderboardReportEvaluatorParameter.from_dict(v1_leaderboard_report_evaluator_parameter_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/V1LeaderboardReportExplanation.md

@@ -0,0 +1,34 @@
+# V1LeaderboardReportExplanation
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**explanation_type** | **str** | Output only. Explanation type ID. | [optional] [readonly] 
+**name** | **str** | Output only. Explanation display name. | [optional] [readonly] 
+**category** | **str** | Output only. Explanation display category. | [optional] [readonly] 
+**scope** | **str** | Optional. Explanation scope like global or local. | [optional] 
+**has_local** | **str** | Optional. Local explanation type id associated with (this) global explanation. | [optional] 
+**formats** | **List[str]** | Optional. List of formats available for the explanation. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_leaderboard_report_explanation import V1LeaderboardReportExplanation
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1LeaderboardReportExplanation from a JSON string
+v1_leaderboard_report_explanation_instance = V1LeaderboardReportExplanation.from_json(json)
+# print the JSON string representation of the object
+print(V1LeaderboardReportExplanation.to_json())
+
+# convert the object into a dict
+v1_leaderboard_report_explanation_dict = v1_leaderboard_report_explanation_instance.to_dict()
+# create an instance of V1LeaderboardReportExplanation from a dict
+v1_leaderboard_report_explanation_from_dict = V1LeaderboardReportExplanation.from_dict(v1_leaderboard_report_explanation_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/V1LeaderboardReportMetricsMetaEntry.md

@@ -0,0 +1,41 @@
+# V1LeaderboardReportMetricsMetaEntry
+
+MetricsMetaEntry represents the metadata about the metric.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **str** | Output only. Metric key. | [optional] [readonly] 
+**display_name** | **str** | Output only. Metric display name. | [optional] [readonly] 
+**data_type** | **str** | Output only. Metric data type like float or string. | [optional] [readonly] 
+**display_value** | **str** | Output only. Metric display value. | [optional] [readonly] 
+**description** | **str** | Output only. Metric description. | [optional] [readonly] 
+**value_range** | **List[float]** | Optional. Metric value range for numeric scores. | [optional] 
+**value_enum** | **List[str]** | Optional. Metric value enum for non-numeric scores. | [optional] 
+**higher_is_better** | **bool** | Output only. Metric higher is better. | [optional] [readonly] 
+**threshold** | **float** | Output only. Metric threshold. | [optional] [readonly] 
+**is_primary_metric** | **bool** | Output only. Metric is primary. | [optional] [readonly] 
+**parent_metric** | **str** | Output only. This metric parent. | [optional] [readonly] 
+**exclude** | **bool** | Output only. Whether to exclude the metric. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_leaderboard_report_metrics_meta_entry import V1LeaderboardReportMetricsMetaEntry
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1LeaderboardReportMetricsMetaEntry from a JSON string
+v1_leaderboard_report_metrics_meta_entry_instance = V1LeaderboardReportMetricsMetaEntry.from_json(json)
+# print the JSON string representation of the object
+print(V1LeaderboardReportMetricsMetaEntry.to_json())
+
+# convert the object into a dict
+v1_leaderboard_report_metrics_meta_entry_dict = v1_leaderboard_report_metrics_meta_entry_instance.to_dict()
+# create an instance of V1LeaderboardReportMetricsMetaEntry from a dict
+v1_leaderboard_report_metrics_meta_entry_from_dict = V1LeaderboardReportMetricsMetaEntry.from_dict(v1_leaderboard_report_metrics_meta_entry_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/V1LeaderboardReportModel.md

@@ -0,0 +1,37 @@
+# V1LeaderboardReportModel
+
+Model represents the evaluated model whose outputs were evaluated to create the results.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**connection** | **str** | Output only. Connection key. | [optional] [readonly] 
+**model_type** | **str** | Output only. Model type. | [optional] [readonly] 
+**name** | **str** | Output only. Model display name. | [optional] [readonly] 
+**collection_id** | **str** | Optional. Collection ID. | [optional] 
+**collection_name** | **str** | Optional. Collection name. | [optional] 
+**llm_model_name** | **str** | Output only. LLM model name. | [optional] [readonly] 
+**documents** | **List[str]** | Output only. List of documents. | [optional] [readonly] 
+**key** | **str** | Output only. Model key. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_leaderboard_report_model import V1LeaderboardReportModel
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1LeaderboardReportModel from a JSON string
+v1_leaderboard_report_model_instance = V1LeaderboardReportModel.from_json(json)
+# print the JSON string representation of the object
+print(V1LeaderboardReportModel.to_json())
+
+# convert the object into a dict
+v1_leaderboard_report_model_dict = v1_leaderboard_report_model_instance.to_dict()
+# create an instance of V1LeaderboardReportModel from a dict
+v1_leaderboard_report_model_from_dict = V1LeaderboardReportModel.from_dict(v1_leaderboard_report_model_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/V1LeaderboardReportResult.md

@@ -0,0 +1,45 @@
+# V1LeaderboardReportResult
+
+
+## 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] 
+**corpus** | **List[str]** | Output only. Collection of corpus documents to be used during evaluation. | [optional] [readonly] 
+**context** | **List[str]** | Output only. List of contextual information or references. | [optional] [readonly] 
+**categories** | **List[str]** | Output only. List of categories or labels for classification. | [optional] [readonly] 
+**relationships** | [**List[V1LeaderboardReportResultRelationship]**](V1LeaderboardReportResultRelationship.md) | Output only. List of relationships or associations between entities. | [optional] [readonly] 
+**expected_output** | **str** | Output only. Expected output or target result. | [optional] [readonly] 
+**output_constraints** | **List[str]** | Output only. List of constraints that should be applied to the output. | [optional] [readonly] 
+**output_condition** | **str** | Output only. Condition that output should satisfy. | [optional] [readonly] 
+**actual_output** | **str** | Output only. Actual output produced by the model. | [optional] [readonly] 
+**actual_duration** | **float** | Output only. Duration of processing in seconds. | [optional] [readonly] 
+**cost** | **float** | Output only. Cost of processing in currency units. | [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** | [**List[V1MetricScore]**](V1MetricScore.md) | Optional. All metrics values for the result. | [optional] 
+**result_error_message** | **str** | Output only. Error message if processing resulted in failure. | [optional] [readonly] 
+**actual_output_meta** | [**List[V1LeaderboardReportActualOutputMeta]**](V1LeaderboardReportActualOutputMeta.md) | Output only. Additional metadata about the actual output. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_leaderboard_report_result import V1LeaderboardReportResult
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1LeaderboardReportResult from a JSON string
+v1_leaderboard_report_result_instance = V1LeaderboardReportResult.from_json(json)
+# print the JSON string representation of the object
+print(V1LeaderboardReportResult.to_json())
+
+# convert the object into a dict
+v1_leaderboard_report_result_dict = v1_leaderboard_report_result_instance.to_dict()
+# create an instance of V1LeaderboardReportResult from a dict
+v1_leaderboard_report_result_from_dict = V1LeaderboardReportResult.from_dict(v1_leaderboard_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)
+
+

eval_studio_client/api/docs/V1LeaderboardReportResultRelationship.md

@@ -0,0 +1,32 @@
+# V1LeaderboardReportResultRelationship
+
+Relationship represents the relationship between result entries.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **str** | Output only. Type of the relationship. | [optional] [readonly] 
+**target** | **str** | Output only. Source result of the relationship. | [optional] [readonly] 
+**target_type** | **str** | Output only. Target type of the relationship like test_case. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_leaderboard_report_result_relationship import V1LeaderboardReportResultRelationship
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1LeaderboardReportResultRelationship from a JSON string
+v1_leaderboard_report_result_relationship_instance = V1LeaderboardReportResultRelationship.from_json(json)
+# print the JSON string representation of the object
+print(V1LeaderboardReportResultRelationship.to_json())
+
+# convert the object into a dict
+v1_leaderboard_report_result_relationship_dict = v1_leaderboard_report_result_relationship_instance.to_dict()
+# create an instance of V1LeaderboardReportResultRelationship from a dict
+v1_leaderboard_report_result_relationship_from_dict = V1LeaderboardReportResultRelationship.from_dict(v1_leaderboard_report_result_relationship_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/V1ListPromptLibraryItemsResponse.md

@@ -0,0 +1,29 @@
+# V1ListPromptLibraryItemsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**prompt_library_items** | [**List[V1PromptLibraryItem]**](V1PromptLibraryItem.md) | Prompt library items (test suites). | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_list_prompt_library_items_response import V1ListPromptLibraryItemsResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ListPromptLibraryItemsResponse from a JSON string
+v1_list_prompt_library_items_response_instance = V1ListPromptLibraryItemsResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1ListPromptLibraryItemsResponse.to_json())
+
+# convert the object into a dict
+v1_list_prompt_library_items_response_dict = v1_list_prompt_library_items_response_instance.to_dict()
+# create an instance of V1ListPromptLibraryItemsResponse from a dict
+v1_list_prompt_library_items_response_from_dict = V1ListPromptLibraryItemsResponse.from_dict(v1_list_prompt_library_items_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/V1ListTestCaseLibraryItemsResponse.md

@@ -0,0 +1,29 @@
+# V1ListTestCaseLibraryItemsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**prompt_library_items** | [**List[V1PromptLibraryItem]**](V1PromptLibraryItem.md) | Test suites library items. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_list_test_case_library_items_response import V1ListTestCaseLibraryItemsResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ListTestCaseLibraryItemsResponse from a JSON string
+v1_list_test_case_library_items_response_instance = V1ListTestCaseLibraryItemsResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1ListTestCaseLibraryItemsResponse.to_json())
+
+# convert the object into a dict
+v1_list_test_case_library_items_response_dict = v1_list_test_case_library_items_response_instance.to_dict()
+# create an instance of V1ListTestCaseLibraryItemsResponse from a dict
+v1_list_test_case_library_items_response_from_dict = V1ListTestCaseLibraryItemsResponse.from_dict(v1_list_test_case_library_items_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/V1ListTestCaseRelationshipsResponse.md

@@ -0,0 +1,29 @@
+# V1ListTestCaseRelationshipsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**test_case_relationships** | [**List[V1TestCaseRelationship]**](V1TestCaseRelationship.md) | The TestCaseRelationships that were requested. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_list_test_case_relationships_response import V1ListTestCaseRelationshipsResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ListTestCaseRelationshipsResponse from a JSON string
+v1_list_test_case_relationships_response_instance = V1ListTestCaseRelationshipsResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1ListTestCaseRelationshipsResponse.to_json())
+
+# convert the object into a dict
+v1_list_test_case_relationships_response_dict = v1_list_test_case_relationships_response_instance.to_dict()
+# create an instance of V1ListTestCaseRelationshipsResponse from a dict
+v1_list_test_case_relationships_response_from_dict = V1ListTestCaseRelationshipsResponse.from_dict(v1_list_test_case_relationships_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/V1ListWorkflowDependenciesResponse.md

@@ -0,0 +1,30 @@
+# V1ListWorkflowDependenciesResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nodes** | [**List[V1WorkflowNode]**](V1WorkflowNode.md) | The list of the WorkflowNodes related to requested workflow. | [optional] 
+**dependencies** | [**List[V1DependencyList]**](V1DependencyList.md) | The dependency map for the workflow. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_list_workflow_dependencies_response import V1ListWorkflowDependenciesResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ListWorkflowDependenciesResponse from a JSON string
+v1_list_workflow_dependencies_response_instance = V1ListWorkflowDependenciesResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1ListWorkflowDependenciesResponse.to_json())
+
+# convert the object into a dict
+v1_list_workflow_dependencies_response_dict = v1_list_workflow_dependencies_response_instance.to_dict()
+# create an instance of V1ListWorkflowDependenciesResponse from a dict
+v1_list_workflow_dependencies_response_from_dict = V1ListWorkflowDependenciesResponse.from_dict(v1_list_workflow_dependencies_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/V1ListWorkflowsResponse.md

@@ -0,0 +1,29 @@
+# V1ListWorkflowsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**workflows** | [**List[V1Workflow]**](V1Workflow.md) | The Workflows requested. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_list_workflows_response import V1ListWorkflowsResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ListWorkflowsResponse from a JSON string
+v1_list_workflows_response_instance = V1ListWorkflowsResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1ListWorkflowsResponse.to_json())
+
+# convert the object into a dict
+v1_list_workflows_response_dict = v1_list_workflows_response_instance.to_dict()
+# create an instance of V1ListWorkflowsResponse from a dict
+v1_list_workflows_response_from_dict = V1ListWorkflowsResponse.from_dict(v1_list_workflows_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/V1MetricScore.md

@@ -0,0 +1,31 @@
+# V1MetricScore
+
+MetricScore represents the metric score.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **str** | Required. Metric key. | [optional] 
+**value** | **float** | Required. Metric value - consider NaN, Infinity or -Infinity for float representation. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_metric_score import V1MetricScore
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1MetricScore from a JSON string
+v1_metric_score_instance = V1MetricScore.from_json(json)
+# print the JSON string representation of the object
+print(V1MetricScore.to_json())
+
+# convert the object into a dict
+v1_metric_score_dict = v1_metric_score_instance.to_dict()
+# create an instance of V1MetricScore from a dict
+v1_metric_score_from_dict = V1MetricScore.from_dict(v1_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/V1MetricScores.md

@@ -0,0 +1,29 @@
+# V1MetricScores
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scores** | [**List[V1MetricScore]**](V1MetricScore.md) | Required. The metric scores. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_metric_scores import V1MetricScores
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1MetricScores from a JSON string
+v1_metric_scores_instance = V1MetricScores.from_json(json)
+# print the JSON string representation of the object
+print(V1MetricScores.to_json())
+
+# convert the object into a dict
+v1_metric_scores_dict = v1_metric_scores_instance.to_dict()
+# create an instance of V1MetricScores from a dict
+v1_metric_scores_from_dict = V1MetricScores.from_dict(v1_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)
+
+