eval-studio-client 1.0.0a1__py3-none-any.whl → 1.0.1__py3-none-any.whl

eval_studio_client/api/docs/WorkflowNodeServiceApi.md

@@ -0,0 +1,423 @@
+# eval_studio_client.api.WorkflowNodeServiceApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**workflow_node_service_batch_get_workflow_nodes**](WorkflowNodeServiceApi.md#workflow_node_service_batch_get_workflow_nodes) | **GET** /v1/workflows/*/nodes:batchGet | BatchGetWorkflowNodes retrieves all WorkflowNodes with the specified resource names. If any of the WorkflowNodes do not exist an error is returned. Deleted WorkflowNodes are returned without error. The order of resource names in the request and the returned WorkflowNodes might differ.
+[**workflow_node_service_delete_workflow_node**](WorkflowNodeServiceApi.md#workflow_node_service_delete_workflow_node) | **DELETE** /v1/{name_7} | DeleteWorkflowNode deletes a WorkflowNode by name. If the WorkflowNode does not exist an error is returned.
+[**workflow_node_service_get_workflow_node**](WorkflowNodeServiceApi.md#workflow_node_service_get_workflow_node) | **GET** /v1/{name_10} | GetWorkflowNode retrieves a WorkflowNode by name. Deleted WorkflowNode is returned without error, it has a delete_time and deleter fields set.
+[**workflow_node_service_get_workflow_node_prerequisites**](WorkflowNodeServiceApi.md#workflow_node_service_get_workflow_node_prerequisites) | **GET** /v1/{name}:getPrerequisites | GetWorkflowNodePrerequisites retrieves the WorkflowNodes and WorkflowEdges that are the prerequisites of the specified WorkflowNode. The list might be empty. Large data might be stored in storage and not returned in the response. It is client's responsibility to retrieve the data from storage using the content handlers. It is intended to be used by the Eval Studio Workers.
+[**workflow_node_service_process_workflow_node**](WorkflowNodeServiceApi.md#workflow_node_service_process_workflow_node) | **POST** /v1/{name}:process | ProcessWorkflowNode processes a WorkflowNode.
+[**workflow_node_service_update_workflow_node**](WorkflowNodeServiceApi.md#workflow_node_service_update_workflow_node) | **PATCH** /v1/{node.name} | UpdateWorkflowNode updates a WorkflowNode. The update_mask is used to specify the fields to be updated.
+
+
+# **workflow_node_service_batch_get_workflow_nodes**
+> V1BatchGetWorkflowNodesResponse workflow_node_service_batch_get_workflow_nodes(names=names, view=view)
+
+BatchGetWorkflowNodes retrieves all WorkflowNodes with the specified resource names. If any of the WorkflowNodes do not exist an error is returned. Deleted WorkflowNodes are returned without error. The order of resource names in the request and the returned WorkflowNodes might differ.
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_batch_get_workflow_nodes_response import V1BatchGetWorkflowNodesResponse
+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.WorkflowNodeServiceApi(api_client)
+    names = ['names_example'] # List[str] | Required. The resource names of the WorkflowNodes to retrieve. Maximum 1000 items. (optional)
+    view = 'WORKFLOW_NODE_VIEW_UNSPECIFIED' # str | Optional. The level of detail to include in the response.   - WORKFLOW_NODE_VIEW_UNSPECIFIED: Unspecified view.  - WORKFLOW_NODE_VIEW_BASIC: Basic view. Lacks large data fields. TODO: describe what fields are omitted.  - WORKFLOW_NODE_VIEW_FULL: Full view. Contains all fields. (optional) (default to 'WORKFLOW_NODE_VIEW_UNSPECIFIED')
+
+    try:
+        # BatchGetWorkflowNodes retrieves all WorkflowNodes with the specified resource names. If any of the WorkflowNodes do not exist an error is returned. Deleted WorkflowNodes are returned without error. The order of resource names in the request and the returned WorkflowNodes might differ.
+        api_response = api_instance.workflow_node_service_batch_get_workflow_nodes(names=names, view=view)
+        print("The response of WorkflowNodeServiceApi->workflow_node_service_batch_get_workflow_nodes:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowNodeServiceApi->workflow_node_service_batch_get_workflow_nodes: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **names** | [**List[str]**](str.md)| Required. The resource names of the WorkflowNodes to retrieve. Maximum 1000 items. | [optional] 
+ **view** | **str**| Optional. The level of detail to include in the response.   - WORKFLOW_NODE_VIEW_UNSPECIFIED: Unspecified view.  - WORKFLOW_NODE_VIEW_BASIC: Basic view. Lacks large data fields. TODO: describe what fields are omitted.  - WORKFLOW_NODE_VIEW_FULL: Full view. Contains all fields. | [optional] [default to 'WORKFLOW_NODE_VIEW_UNSPECIFIED']
+
+### Return type
+
+[**V1BatchGetWorkflowNodesResponse**](V1BatchGetWorkflowNodesResponse.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_node_service_delete_workflow_node**
+> V1DeleteWorkflowNodeResponse workflow_node_service_delete_workflow_node(name_7)
+
+DeleteWorkflowNode deletes a WorkflowNode by name. If the WorkflowNode does not exist an error is returned.
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_delete_workflow_node_response import V1DeleteWorkflowNodeResponse
+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.WorkflowNodeServiceApi(api_client)
+    name_7 = 'name_7_example' # str | Required. The name of the WorkflowNode to delete.
+
+    try:
+        # DeleteWorkflowNode deletes a WorkflowNode by name. If the WorkflowNode does not exist an error is returned.
+        api_response = api_instance.workflow_node_service_delete_workflow_node(name_7)
+        print("The response of WorkflowNodeServiceApi->workflow_node_service_delete_workflow_node:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowNodeServiceApi->workflow_node_service_delete_workflow_node: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name_7** | **str**| Required. The name of the WorkflowNode to delete. | 
+
+### Return type
+
+[**V1DeleteWorkflowNodeResponse**](V1DeleteWorkflowNodeResponse.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_node_service_get_workflow_node**
+> V1GetWorkflowNodeResponse workflow_node_service_get_workflow_node(name_10, view=view)
+
+GetWorkflowNode retrieves a WorkflowNode by name. Deleted WorkflowNode 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_node_response import V1GetWorkflowNodeResponse
+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.WorkflowNodeServiceApi(api_client)
+    name_10 = 'name_10_example' # str | Required. The name of the WorkflowNode to retrieve.
+    view = 'WORKFLOW_NODE_VIEW_UNSPECIFIED' # str | Optional. The level of detail to include in the response.   - WORKFLOW_NODE_VIEW_UNSPECIFIED: Unspecified view.  - WORKFLOW_NODE_VIEW_BASIC: Basic view. Lacks large data fields. TODO: describe what fields are omitted.  - WORKFLOW_NODE_VIEW_FULL: Full view. Contains all fields. (optional) (default to 'WORKFLOW_NODE_VIEW_UNSPECIFIED')
+
+    try:
+        # GetWorkflowNode retrieves a WorkflowNode by name. Deleted WorkflowNode is returned without error, it has a delete_time and deleter fields set.
+        api_response = api_instance.workflow_node_service_get_workflow_node(name_10, view=view)
+        print("The response of WorkflowNodeServiceApi->workflow_node_service_get_workflow_node:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowNodeServiceApi->workflow_node_service_get_workflow_node: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name_10** | **str**| Required. The name of the WorkflowNode to retrieve. | 
+ **view** | **str**| Optional. The level of detail to include in the response.   - WORKFLOW_NODE_VIEW_UNSPECIFIED: Unspecified view.  - WORKFLOW_NODE_VIEW_BASIC: Basic view. Lacks large data fields. TODO: describe what fields are omitted.  - WORKFLOW_NODE_VIEW_FULL: Full view. Contains all fields. | [optional] [default to 'WORKFLOW_NODE_VIEW_UNSPECIFIED']
+
+### Return type
+
+[**V1GetWorkflowNodeResponse**](V1GetWorkflowNodeResponse.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_node_service_get_workflow_node_prerequisites**
+> V1GetWorkflowNodePrerequisitesResponse workflow_node_service_get_workflow_node_prerequisites(name)
+
+GetWorkflowNodePrerequisites retrieves the WorkflowNodes and WorkflowEdges that are the prerequisites of the specified WorkflowNode. The list might be empty. Large data might be stored in storage and not returned in the response. It is client's responsibility to retrieve the data from storage using the content handlers. It is intended to be used by the Eval Studio Workers.
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_get_workflow_node_prerequisites_response import V1GetWorkflowNodePrerequisitesResponse
+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.WorkflowNodeServiceApi(api_client)
+    name = 'name_example' # str | Required. The name of the WorkflowNode to retrieve the prerequisites for.
+
+    try:
+        # GetWorkflowNodePrerequisites retrieves the WorkflowNodes and WorkflowEdges that are the prerequisites of the specified WorkflowNode. The list might be empty. Large data might be stored in storage and not returned in the response. It is client's responsibility to retrieve the data from storage using the content handlers. It is intended to be used by the Eval Studio Workers.
+        api_response = api_instance.workflow_node_service_get_workflow_node_prerequisites(name)
+        print("The response of WorkflowNodeServiceApi->workflow_node_service_get_workflow_node_prerequisites:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowNodeServiceApi->workflow_node_service_get_workflow_node_prerequisites: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| Required. The name of the WorkflowNode to retrieve the prerequisites for. | 
+
+### Return type
+
+[**V1GetWorkflowNodePrerequisitesResponse**](V1GetWorkflowNodePrerequisitesResponse.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_node_service_process_workflow_node**
+> V1ProcessWorkflowNodeResponse workflow_node_service_process_workflow_node(name)
+
+ProcessWorkflowNode processes a WorkflowNode.
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_process_workflow_node_response import V1ProcessWorkflowNodeResponse
+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.WorkflowNodeServiceApi(api_client)
+    name = 'name_example' # str | Required. The name of the WorkflowNode to process.
+
+    try:
+        # ProcessWorkflowNode processes a WorkflowNode.
+        api_response = api_instance.workflow_node_service_process_workflow_node(name)
+        print("The response of WorkflowNodeServiceApi->workflow_node_service_process_workflow_node:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowNodeServiceApi->workflow_node_service_process_workflow_node: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| Required. The name of the WorkflowNode to process. | 
+
+### Return type
+
+[**V1ProcessWorkflowNodeResponse**](V1ProcessWorkflowNodeResponse.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_node_service_update_workflow_node**
+> V1UpdateWorkflowNodeResponse workflow_node_service_update_workflow_node(node_name, node)
+
+UpdateWorkflowNode updates a WorkflowNode. 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_node import RequiredTheUpdatedWorkflowNode
+from eval_studio_client.api.models.v1_update_workflow_node_response import V1UpdateWorkflowNodeResponse
+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.WorkflowNodeServiceApi(api_client)
+    node_name = 'node_name_example' # str | Output only. Immutable. Resource name of the Workflow in format of `workflows/{workflow_id}/nodes/{node_id}`.
+    node = eval_studio_client.api.RequiredTheUpdatedWorkflowNode() # RequiredTheUpdatedWorkflowNode | Required. The updated WorkflowNode.
+
+    try:
+        # UpdateWorkflowNode updates a WorkflowNode. The update_mask is used to specify the fields to be updated.
+        api_response = api_instance.workflow_node_service_update_workflow_node(node_name, node)
+        print("The response of WorkflowNodeServiceApi->workflow_node_service_update_workflow_node:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowNodeServiceApi->workflow_node_service_update_workflow_node: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **node_name** | **str**| Output only. Immutable. Resource name of the Workflow in format of `workflows/{workflow_id}/nodes/{node_id}`. | 
+ **node** | [**RequiredTheUpdatedWorkflowNode**](RequiredTheUpdatedWorkflowNode.md)| Required. The updated WorkflowNode. | 
+
+### Return type
+
+[**V1UpdateWorkflowNodeResponse**](V1UpdateWorkflowNodeResponse.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)
+