eval-studio-client 1.0.0a1__py3-none-any.whl → 1.1.0a5__py3-none-any.whl

eval_studio_client/api/docs/WorkflowServiceApi.md

@@ -0,0 +1,488 @@
+# eval_studio_client.api.WorkflowServiceApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**workflow_service_batch_delete_workflows**](WorkflowServiceApi.md#workflow_service_batch_delete_workflows) | **POST** /v1/workflows:batchDelete | BatchDeleteWorkflows deletes Workflows by names. If any of the Workflows do not exist an error is returned.
+[**workflow_service_clone_workflow**](WorkflowServiceApi.md#workflow_service_clone_workflow) | **POST** /v1/{name_1}:clone | CloneWorkflow clones an existing Workflow.
+[**workflow_service_create_workflow**](WorkflowServiceApi.md#workflow_service_create_workflow) | **POST** /v1/workflows | CreateWorkflow creates a Workflow.
+[**workflow_service_delete_workflow**](WorkflowServiceApi.md#workflow_service_delete_workflow) | **DELETE** /v1/{name_9} | DeleteWorkflow deletes a Workflow by name. If the Workflow does not exist an error is returned.
+[**workflow_service_get_workflow**](WorkflowServiceApi.md#workflow_service_get_workflow) | **GET** /v1/{name_12} | GetWorkflow retrieves a Workflow by name. Deleted Workflow is returned without error, it has a delete_time and deleter fields set.
+[**workflow_service_list_workflows**](WorkflowServiceApi.md#workflow_service_list_workflows) | **GET** /v1/workflows | ListWorkflows lists Workflows.
+[**workflow_service_update_workflow**](WorkflowServiceApi.md#workflow_service_update_workflow) | **PATCH** /v1/{workflow.name} | UpdateWorkflow updates a Workflow. The update_mask is used to specify the fields to be updated.
+
+
+# **workflow_service_batch_delete_workflows**
+> V1BatchDeleteWorkflowsResponse workflow_service_batch_delete_workflows(body)
+
+BatchDeleteWorkflows deletes Workflows by names. If any of the Workflows do not exist an error is returned.
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_batch_delete_workflows_request import V1BatchDeleteWorkflowsRequest
+from eval_studio_client.api.models.v1_batch_delete_workflows_response import V1BatchDeleteWorkflowsResponse
+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.WorkflowServiceApi(api_client)
+    body = eval_studio_client.api.V1BatchDeleteWorkflowsRequest() # V1BatchDeleteWorkflowsRequest | 
+
+    try:
+        # BatchDeleteWorkflows deletes Workflows by names. If any of the Workflows do not exist an error is returned.
+        api_response = api_instance.workflow_service_batch_delete_workflows(body)
+        print("The response of WorkflowServiceApi->workflow_service_batch_delete_workflows:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowServiceApi->workflow_service_batch_delete_workflows: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1BatchDeleteWorkflowsRequest**](V1BatchDeleteWorkflowsRequest.md)|  | 
+
+### Return type
+
+[**V1BatchDeleteWorkflowsResponse**](V1BatchDeleteWorkflowsResponse.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)
+
+# **workflow_service_clone_workflow**
+> V1CloneWorkflowResponse workflow_service_clone_workflow(name_1, body)
+
+CloneWorkflow clones an existing Workflow.
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_clone_workflow_response import V1CloneWorkflowResponse
+from eval_studio_client.api.models.workflow_service_clone_workflow_request import WorkflowServiceCloneWorkflowRequest
+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.WorkflowServiceApi(api_client)
+    name_1 = 'name_1_example' # str | Required. The name of the Workflow to clone.
+    body = eval_studio_client.api.WorkflowServiceCloneWorkflowRequest() # WorkflowServiceCloneWorkflowRequest | 
+
+    try:
+        # CloneWorkflow clones an existing Workflow.
+        api_response = api_instance.workflow_service_clone_workflow(name_1, body)
+        print("The response of WorkflowServiceApi->workflow_service_clone_workflow:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowServiceApi->workflow_service_clone_workflow: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name_1** | **str**| Required. The name of the Workflow to clone. | 
+ **body** | [**WorkflowServiceCloneWorkflowRequest**](WorkflowServiceCloneWorkflowRequest.md)|  | 
+
+### Return type
+
+[**V1CloneWorkflowResponse**](V1CloneWorkflowResponse.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)
+
+# **workflow_service_create_workflow**
+> V1CreateWorkflowResponse workflow_service_create_workflow(workflow)
+
+CreateWorkflow creates a Workflow.
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_create_workflow_response import V1CreateWorkflowResponse
+from eval_studio_client.api.models.v1_workflow import V1Workflow
+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.WorkflowServiceApi(api_client)
+    workflow = eval_studio_client.api.V1Workflow() # V1Workflow | Required. The Workflow to create.
+
+    try:
+        # CreateWorkflow creates a Workflow.
+        api_response = api_instance.workflow_service_create_workflow(workflow)
+        print("The response of WorkflowServiceApi->workflow_service_create_workflow:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowServiceApi->workflow_service_create_workflow: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **workflow** | [**V1Workflow**](V1Workflow.md)| Required. The Workflow to create. | 
+
+### Return type
+
+[**V1CreateWorkflowResponse**](V1CreateWorkflowResponse.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)
+
+# **workflow_service_delete_workflow**
+> V1DeleteWorkflowResponse workflow_service_delete_workflow(name_9)
+
+DeleteWorkflow deletes a Workflow by name. If the Workflow does not exist an error is returned.
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_delete_workflow_response import V1DeleteWorkflowResponse
+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.WorkflowServiceApi(api_client)
+    name_9 = 'name_9_example' # str | Required. The name of the Workflow to delete.
+
+    try:
+        # DeleteWorkflow deletes a Workflow by name. If the Workflow does not exist an error is returned.
+        api_response = api_instance.workflow_service_delete_workflow(name_9)
+        print("The response of WorkflowServiceApi->workflow_service_delete_workflow:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowServiceApi->workflow_service_delete_workflow: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name_9** | **str**| Required. The name of the Workflow to delete. | 
+
+### Return type
+
+[**V1DeleteWorkflowResponse**](V1DeleteWorkflowResponse.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)
+
+# **workflow_service_get_workflow**
+> V1GetWorkflowResponse workflow_service_get_workflow(name_12)
+
+GetWorkflow retrieves a Workflow by name. Deleted Workflow is returned without error, it has a delete_time and deleter fields set.
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_get_workflow_response import V1GetWorkflowResponse
+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.WorkflowServiceApi(api_client)
+    name_12 = 'name_12_example' # str | Required. The name of the Workflow to retrieve.
+
+    try:
+        # GetWorkflow retrieves a Workflow by name. Deleted Workflow is returned without error, it has a delete_time and deleter fields set.
+        api_response = api_instance.workflow_service_get_workflow(name_12)
+        print("The response of WorkflowServiceApi->workflow_service_get_workflow:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowServiceApi->workflow_service_get_workflow: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name_12** | **str**| Required. The name of the Workflow to retrieve. | 
+
+### Return type
+
+[**V1GetWorkflowResponse**](V1GetWorkflowResponse.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)
+
+# **workflow_service_list_workflows**
+> V1ListWorkflowsResponse workflow_service_list_workflows()
+
+ListWorkflows lists Workflows.
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_list_workflows_response import V1ListWorkflowsResponse
+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.WorkflowServiceApi(api_client)
+
+    try:
+        # ListWorkflows lists Workflows.
+        api_response = api_instance.workflow_service_list_workflows()
+        print("The response of WorkflowServiceApi->workflow_service_list_workflows:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowServiceApi->workflow_service_list_workflows: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**V1ListWorkflowsResponse**](V1ListWorkflowsResponse.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)
+
+# **workflow_service_update_workflow**
+> V1UpdateWorkflowResponse workflow_service_update_workflow(workflow_name, workflow)
+
+UpdateWorkflow updates a Workflow. The update_mask is used to specify the fields to be updated.
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.required_the_updated_workflow import RequiredTheUpdatedWorkflow
+from eval_studio_client.api.models.v1_update_workflow_response import V1UpdateWorkflowResponse
+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.WorkflowServiceApi(api_client)
+    workflow_name = 'workflow_name_example' # str | Output only. Immutable. Resource name of the Workflow in format of `workflows/{workflow_id}`.
+    workflow = eval_studio_client.api.RequiredTheUpdatedWorkflow() # RequiredTheUpdatedWorkflow | Required. The updated Workflow.
+
+    try:
+        # UpdateWorkflow updates a Workflow. The update_mask is used to specify the fields to be updated.
+        api_response = api_instance.workflow_service_update_workflow(workflow_name, workflow)
+        print("The response of WorkflowServiceApi->workflow_service_update_workflow:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowServiceApi->workflow_service_update_workflow: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **workflow_name** | **str**| Output only. Immutable. Resource name of the Workflow in format of `workflows/{workflow_id}`. | 
+ **workflow** | [**RequiredTheUpdatedWorkflow**](RequiredTheUpdatedWorkflow.md)| Required. The updated Workflow. | 
+
+### Return type
+
+[**V1UpdateWorkflowResponse**](V1UpdateWorkflowResponse.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)
+

eval_studio_client/api/docs/WorkflowServiceCloneWorkflowRequest.md

@@ -0,0 +1,33 @@
+# WorkflowServiceCloneWorkflowRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name_override** | **str** | Optional. The display name of the cloned Workflow. If not specified, the display name from the original Workflow is used with \" Clone\" suffix added. | [optional] 
+**description_override** | **str** | Optional. The description of the cloned Workflow. If not specified, the description from the original Workflow is used. | [optional] 
+**model_override** | **str** | Optional. The name of the model to use in the cloned Workflow. If not specified, the model from the original Workflow is used. | [optional] 
+**llm_model_override** | **str** | Optional. The name of the base LLM model to use in the cloned workflow. If not specified, the base LLM model from the original Workflow is used. Required if model_override is set. | [optional] 
+**model_parameters_override** | **str** | Optional. Model specific parameters in JSON format. If not specified, the parameters from the original Workflow are used. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.workflow_service_clone_workflow_request import WorkflowServiceCloneWorkflowRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of WorkflowServiceCloneWorkflowRequest from a JSON string
+workflow_service_clone_workflow_request_instance = WorkflowServiceCloneWorkflowRequest.from_json(json)
+# print the JSON string representation of the object
+print(WorkflowServiceCloneWorkflowRequest.to_json())
+
+# convert the object into a dict
+workflow_service_clone_workflow_request_dict = workflow_service_clone_workflow_request_instance.to_dict()
+# create an instance of WorkflowServiceCloneWorkflowRequest from a dict
+workflow_service_clone_workflow_request_from_dict = WorkflowServiceCloneWorkflowRequest.from_dict(workflow_service_clone_workflow_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/exceptions.py

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    ai/h2o/eval_studio/v1/collection.proto
+    ai/h2o/eval_studio/v1/insight.proto
 
     No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)