eval-studio-client 1.0.3a1__py3-none-any.whl → 1.1.0a6__py3-none-any.whl

eval_studio_client/api/docs/PromptLibraryServiceApi.md

@@ -0,0 +1,155 @@
+# eval_studio_client.api.PromptLibraryServiceApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**prompt_library_service_import_test_cases**](PromptLibraryServiceApi.md#prompt_library_service_import_test_cases) | **POST** /v1/promptLibraryItems:importTestCases | 
+[**prompt_library_service_list_prompt_library_items**](PromptLibraryServiceApi.md#prompt_library_service_list_prompt_library_items) | **GET** /v1/promptLibraryItems | 
+
+
+# **prompt_library_service_import_test_cases**
+> V1Operation prompt_library_service_import_test_cases(body)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_import_test_cases_request import V1ImportTestCasesRequest
+from eval_studio_client.api.models.v1_operation import V1Operation
+from eval_studio_client.api.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = eval_studio_client.api.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with eval_studio_client.api.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = eval_studio_client.api.PromptLibraryServiceApi(api_client)
+    body = eval_studio_client.api.V1ImportTestCasesRequest() # V1ImportTestCasesRequest | 
+
+    try:
+        api_response = api_instance.prompt_library_service_import_test_cases(body)
+        print("The response of PromptLibraryServiceApi->prompt_library_service_import_test_cases:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling PromptLibraryServiceApi->prompt_library_service_import_test_cases: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1ImportTestCasesRequest**](V1ImportTestCasesRequest.md)|  | 
+
+### Return type
+
+[**V1Operation**](V1Operation.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | A successful response. |  -  |
+**0** | An unexpected error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **prompt_library_service_list_prompt_library_items**
+> V1ListPromptLibraryItemsResponse prompt_library_service_list_prompt_library_items(filter_by_categories=filter_by_categories, filter_by_purposes=filter_by_purposes, filter_by_evaluates=filter_by_evaluates, filter_by_origin=filter_by_origin, filter_by_test_case_count=filter_by_test_case_count, filter_by_test_count=filter_by_test_count, filter_by_fts=filter_by_fts)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_list_prompt_library_items_response import V1ListPromptLibraryItemsResponse
+from eval_studio_client.api.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = eval_studio_client.api.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with eval_studio_client.api.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = eval_studio_client.api.PromptLibraryServiceApi(api_client)
+    filter_by_categories = ['filter_by_categories_example'] # List[str] | Optional. Filter by categories. (optional)
+    filter_by_purposes = ['filter_by_purposes_example'] # List[str] | Optional. Filter by purposes. (optional)
+    filter_by_evaluates = ['filter_by_evaluates_example'] # List[str] | Optional. Filter by evaluates. (optional)
+    filter_by_origin = 'filter_by_origin_example' # str | Optional. Filter by origin. (optional)
+    filter_by_test_case_count = 56 # int | Optional. Filter by test case count. (optional)
+    filter_by_test_count = 56 # int | Optional. Filter by test count. (optional)
+    filter_by_fts = 'filter_by_fts_example' # str | Optional. Filter by FTS. (optional)
+
+    try:
+        api_response = api_instance.prompt_library_service_list_prompt_library_items(filter_by_categories=filter_by_categories, filter_by_purposes=filter_by_purposes, filter_by_evaluates=filter_by_evaluates, filter_by_origin=filter_by_origin, filter_by_test_case_count=filter_by_test_case_count, filter_by_test_count=filter_by_test_count, filter_by_fts=filter_by_fts)
+        print("The response of PromptLibraryServiceApi->prompt_library_service_list_prompt_library_items:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling PromptLibraryServiceApi->prompt_library_service_list_prompt_library_items: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **filter_by_categories** | [**List[str]**](str.md)| Optional. Filter by categories. | [optional] 
+ **filter_by_purposes** | [**List[str]**](str.md)| Optional. Filter by purposes. | [optional] 
+ **filter_by_evaluates** | [**List[str]**](str.md)| Optional. Filter by evaluates. | [optional] 
+ **filter_by_origin** | **str**| Optional. Filter by origin. | [optional] 
+ **filter_by_test_case_count** | **int**| Optional. Filter by test case count. | [optional] 
+ **filter_by_test_count** | **int**| Optional. Filter by test count. | [optional] 
+ **filter_by_fts** | **str**| Optional. Filter by FTS. | [optional] 
+
+### Return type
+
+[**V1ListPromptLibraryItemsResponse**](V1ListPromptLibraryItemsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | A successful response. |  -  |
+**0** | An unexpected error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

eval_studio_client/api/docs/ProtobufNullValue.md

@@ -0,0 +1,12 @@
+# ProtobufNullValue
+
+`NullValue` is a singleton enumeration to represent the null value for the `Value` type union.  The JSON representation for `NullValue` is JSON `null`.   - NULL_VALUE: Null value.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[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/RequiredTheDashboardToUpdate.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **leaderboards** | **List[str]** | Immutable. Resource names of the Leaderboards used in this Dashboard. | [optional] 
 **create_operation** | **str** | Output only. Operation resource name that created this Dashboard. | [optional] [readonly] 
 **demo** | **bool** | Output only. Whether the Dashboard is a demo resource or not. Demo resources are read only. | [optional] [readonly] 
+**type** | [**V1DashboardType**](V1DashboardType.md) |  | [optional] 
 
 ## Example
 

eval_studio_client/api/docs/RequiredTheTestCaseToUpdate.md

@@ -16,6 +16,9 @@ Name | Type | Description | Notes
 **answer** | **str** | Expected answer text. Model output. | [optional] 
 **constraints** | **List[str]** | Constraints on the model output. | [optional] 
 **condition** | **str** | Optional. Test case output condition, in a form of AIP-160 compliant filter expression. | [optional] 
+**perturbed_by** | **List[str]** | Output only. The list of perturbators applied to this test case. | [optional] [readonly] 
+**topics** | **List[str]** | Output only. The list of topics used to generate this test case. | [optional] [readonly] 
+**generator** | [**V1TestCasesGenerator**](V1TestCasesGenerator.md) |  | [optional] 
 
 ## Example
 

eval_studio_client/api/docs/RequiredTheTestToUpdate.md

@@ -16,6 +16,7 @@ Name | Type | Description | Notes
 **documents** | **List[str]** | Immutable. Resource names of Documents assigned to the Test. | [optional] 
 **tags** | **List[str]** | Tags assigned to the Test. | [optional] 
 **demo** | **bool** | Output only. Whether the Test is a demo resource or not. Demo resources are read only. | [optional] [readonly] 
+**type** | [**V1TestType**](V1TestType.md) |  | [optional] 
 
 ## Example
 

eval_studio_client/api/docs/RequiredTheUpdatedWorkflow.md

@@ -0,0 +1,47 @@
+# RequiredTheUpdatedWorkflow
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **str** | Human-readable name of the Workflow. | [optional] 
+**description** | **str** | Optional description of the Workflow. | [optional] 
+**create_time** | **datetime** | Output only. Immutable. Creation time of the Workflow. | [optional] [readonly] 
+**creator** | **str** | Output only. Immutable. Name of the user or service that requested creation of the Workflow. | [optional] [readonly] 
+**update_time** | **datetime** | Output only. Optional. Last update time of the Workflow. | [optional] [readonly] 
+**updater** | **str** | Output only. Name of the user or service that requested update of the Workflow. | [optional] [readonly] 
+**delete_time** | **datetime** | Output only. Optional. Deletion time of the Workflow. | [optional] [readonly] 
+**deleter** | **str** | Output only. Name of the user or service that requested deletion of the Workflow. | [optional] [readonly] 
+**type** | [**V1WorkflowType**](V1WorkflowType.md) |  | [optional] 
+**model** | **str** | Immutable. Resource name of the Model associated with this Workflow. | [optional] 
+**nodes** | **List[str]** | Output only. List of the WorkflowNodes in the Workflow. | [optional] [readonly] 
+**edges** | **List[str]** | Output only. List of the WorkflowEdges in the Workflow. | [optional] [readonly] 
+**outputs** | **Dict[str, object]** | Output only. Optional. Computed outputs of all the WorkflowNodes in the Workflow. | [optional] [readonly] 
+**output_artifacts** | [**Dict[str, V1WorkflowNodeArtifacts]**](V1WorkflowNodeArtifacts.md) | Output only. Optional. List of the WorkflowNodeArtifacts produces by all the WorkflowNodes in the Workflow. | [optional] [readonly] 
+**llm_model** | **str** | Immutable. LLM Model to use. | [optional] 
+**model_parameters** | **str** | Optional. Immutable. Model parameter overrides in JSON format. | [optional] 
+**document** | **str** | The resource name of a Document. | [optional] 
+**h2ogpte_collection** | **str** | Existing h2oGPTe collection. | [optional] 
+**cloned_from_workflow** | **str** | Optional. Output only. The Workflow that this Workflow was cloned from. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.required_the_updated_workflow import RequiredTheUpdatedWorkflow
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of RequiredTheUpdatedWorkflow from a JSON string
+required_the_updated_workflow_instance = RequiredTheUpdatedWorkflow.from_json(json)
+# print the JSON string representation of the object
+print(RequiredTheUpdatedWorkflow.to_json())
+
+# convert the object into a dict
+required_the_updated_workflow_dict = required_the_updated_workflow_instance.to_dict()
+# create an instance of RequiredTheUpdatedWorkflow from a dict
+required_the_updated_workflow_from_dict = RequiredTheUpdatedWorkflow.from_dict(required_the_updated_workflow_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/RequiredTheUpdatedWorkflowNode.md

@@ -0,0 +1,44 @@
+# RequiredTheUpdatedWorkflowNode
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parent** | **str** | Output only. Immutable. Resource name of the parent Workflow in format of `workflows/{workflow_id}/`. | [optional] [readonly] 
+**display_name** | **str** | Human-readable name of the WorkflowNode. | [optional] 
+**description** | **str** | Optional description of the WorkflowNode. | [optional] 
+**create_time** | **datetime** | Output only. Immutable. Creation time of the WorkflowNode. | [optional] [readonly] 
+**creator** | **str** | Output only. Immutable. Name of the user or service that requested creation of the WorkflowNode. | [optional] [readonly] 
+**update_time** | **datetime** | Output only. Optional. Last update time of the WorkflowNode. | [optional] [readonly] 
+**updater** | **str** | Output only. Name of the user or service that requested update of the WorkflowNode. | [optional] [readonly] 
+**delete_time** | **datetime** | Output only. Optional. Deletion time of the WorkflowNode. | [optional] [readonly] 
+**deleter** | **str** | Output only. Name of the user or service that requested deletion of the WorkflowNode. | [optional] [readonly] 
+**type** | [**V1WorkflowNodeType**](V1WorkflowNodeType.md) |  | [optional] 
+**parameters** | **object** | User-given parameters for the WorkflowNode. | [optional] 
+**outputs** | **object** | Output only. Computed outputs of the WorkflowNode. | [optional] [readonly] 
+**output_artifacts** | [**List[V1WorkflowNodeArtifact]**](V1WorkflowNodeArtifact.md) | Output only. Optional. List of the WorkflowNodeArtifacts produces by the WorkflowNode. | [optional] [readonly] 
+**status** | [**V1WorkflowNodeStatus**](V1WorkflowNodeStatus.md) |  | [optional] 
+**attributes** | [**V1WorkflowNodeAttributes**](V1WorkflowNodeAttributes.md) |  | [optional] 
+**processed_by_operation** | **str** | Output only. Optional. Resource name of the latest Operation that has processed or is currently processing this WorkflowNode. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.required_the_updated_workflow_node import RequiredTheUpdatedWorkflowNode
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of RequiredTheUpdatedWorkflowNode from a JSON string
+required_the_updated_workflow_node_instance = RequiredTheUpdatedWorkflowNode.from_json(json)
+# print the JSON string representation of the object
+print(RequiredTheUpdatedWorkflowNode.to_json())
+
+# convert the object into a dict
+required_the_updated_workflow_node_dict = required_the_updated_workflow_node_instance.to_dict()
+# create an instance of RequiredTheUpdatedWorkflowNode from a dict
+required_the_updated_workflow_node_from_dict = RequiredTheUpdatedWorkflowNode.from_dict(required_the_updated_workflow_node_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/TestCaseRelationshipServiceApi.md

@@ -0,0 +1,75 @@
+# eval_studio_client.api.TestCaseRelationshipServiceApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**test_case_relationship_service_list_test_case_relationships**](TestCaseRelationshipServiceApi.md#test_case_relationship_service_list_test_case_relationships) | **GET** /v1/{parent}/testCaseRelationships | 
+
+
+# **test_case_relationship_service_list_test_case_relationships**
+> V1ListTestCaseRelationshipsResponse test_case_relationship_service_list_test_case_relationships(parent)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_list_test_case_relationships_response import V1ListTestCaseRelationshipsResponse
+from eval_studio_client.api.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = eval_studio_client.api.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with eval_studio_client.api.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = eval_studio_client.api.TestCaseRelationshipServiceApi(api_client)
+    parent = 'parent_example' # str | The name of the Test whose TestCaseRelationships to retrieve.
+
+    try:
+        api_response = api_instance.test_case_relationship_service_list_test_case_relationships(parent)
+        print("The response of TestCaseRelationshipServiceApi->test_case_relationship_service_list_test_case_relationships:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling TestCaseRelationshipServiceApi->test_case_relationship_service_list_test_case_relationships: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **parent** | **str**| The name of the Test whose TestCaseRelationships to retrieve. | 
+
+### Return type
+
+[**V1ListTestCaseRelationshipsResponse**](V1ListTestCaseRelationshipsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | A successful response. |  -  |
+**0** | An unexpected error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

eval_studio_client/api/docs/TestCaseServiceApi.md

@@ -8,7 +8,7 @@ Method | HTTP request | Description
 [**test_case_service_create_test_case**](TestCaseServiceApi.md#test_case_service_create_test_case) | **POST** /v1/{parent}/testCases | 
 [**test_case_service_delete_test_case**](TestCaseServiceApi.md#test_case_service_delete_test_case) | **DELETE** /v1/{name_5} | 
 [**test_case_service_find_all_test_cases_by_id**](TestCaseServiceApi.md#test_case_service_find_all_test_cases_by_id) | **GET** /v1/tests/-/testCases:findAllTestCasesByID | 
-[**test_case_service_get_test_case**](TestCaseServiceApi.md#test_case_service_get_test_case) | **GET** /v1/{name_7} | 
+[**test_case_service_get_test_case**](TestCaseServiceApi.md#test_case_service_get_test_case) | **GET** /v1/{name_8} | 
 [**test_case_service_list_test_cases**](TestCaseServiceApi.md#test_case_service_list_test_cases) | **GET** /v1/{parent}/testCases | 
 [**test_case_service_update_test_case**](TestCaseServiceApi.md#test_case_service_update_test_case) | **PATCH** /v1/{testCase.name} | 
 
@@ -284,7 +284,7 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **test_case_service_get_test_case**
-> V1GetTestCaseResponse test_case_service_get_test_case(name_7)
+> V1GetTestCaseResponse test_case_service_get_test_case(name_8)
 
 
 
@@ -308,10 +308,10 @@ configuration = eval_studio_client.api.Configuration(
 with eval_studio_client.api.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = eval_studio_client.api.TestCaseServiceApi(api_client)
-    name_7 = 'name_7_example' # str | The name of the TestCase to retrieve. Format: tests/<UUID>/testCases/<UUID>
+    name_8 = 'name_8_example' # str | The name of the TestCase to retrieve. Format: tests/<UUID>/testCases/<UUID>
 
     try:
-        api_response = api_instance.test_case_service_get_test_case(name_7)
+        api_response = api_instance.test_case_service_get_test_case(name_8)
         print("The response of TestCaseServiceApi->test_case_service_get_test_case:\n")
         pprint(api_response)
     except Exception as e:
@@ -325,7 +325,7 @@ with eval_studio_client.api.ApiClient(configuration) as api_client:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **name_7** | **str**| The name of the TestCase to retrieve. Format: tests/&lt;UUID&gt;/testCases/&lt;UUID&gt; | 
+ **name_8** | **str**| The name of the TestCase to retrieve. Format: tests/&lt;UUID&gt;/testCases/&lt;UUID&gt; | 
 
 ### Return type
 

eval_studio_client/api/docs/TestClassServiceApi.md

@@ -4,12 +4,12 @@ All URIs are relative to *http://localhost*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**test_class_service_get_test_class**](TestClassServiceApi.md#test_class_service_get_test_class) | **GET** /v1/{name_8} | 
+[**test_class_service_get_test_class**](TestClassServiceApi.md#test_class_service_get_test_class) | **GET** /v1/{name_9} | 
 [**test_class_service_list_test_classes**](TestClassServiceApi.md#test_class_service_list_test_classes) | **GET** /v1/testClasses | 
 
 
 # **test_class_service_get_test_class**
-> V1GetTestClassResponse test_class_service_get_test_class(name_8)
+> V1GetTestClassResponse test_class_service_get_test_class(name_9)
 
 
 
@@ -33,10 +33,10 @@ configuration = eval_studio_client.api.Configuration(
 with eval_studio_client.api.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = eval_studio_client.api.TestClassServiceApi(api_client)
-    name_8 = 'name_8_example' # str | The name of the TestClass to retrieve. Format: testClasses/<UUID>
+    name_9 = 'name_9_example' # str | The name of the TestClass to retrieve. Format: testClasses/<UUID>
 
     try:
-        api_response = api_instance.test_class_service_get_test_class(name_8)
+        api_response = api_instance.test_class_service_get_test_class(name_9)
         print("The response of TestClassServiceApi->test_class_service_get_test_class:\n")
         pprint(api_response)
     except Exception as e:
@@ -50,7 +50,7 @@ with eval_studio_client.api.ApiClient(configuration) as api_client:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **name_8** | **str**| The name of the TestClass to retrieve. Format: testClasses/&lt;UUID&gt; | 
+ **name_9** | **str**| The name of the TestClass to retrieve. Format: testClasses/&lt;UUID&gt; | 
 
 ### Return type