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

eval_studio_client/api/docs/V1TestCase.md

@@ -17,6 +17,7 @@ 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] 
 
 ## Example
 

eval_studio_client/api/docs/V1TestSuiteEvaluates.md

@@ -0,0 +1,11 @@
+# V1TestSuiteEvaluates
+
+
+## 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/V1UpdateWorkflowNodeResponse.md

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

@@ -0,0 +1,29 @@
+# V1UpdateWorkflowResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**workflow** | [**V1Workflow**](V1Workflow.md) |  | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_update_workflow_response import V1UpdateWorkflowResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1UpdateWorkflowResponse from a JSON string
+v1_update_workflow_response_instance = V1UpdateWorkflowResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1UpdateWorkflowResponse.to_json())
+
+# convert the object into a dict
+v1_update_workflow_response_dict = v1_update_workflow_response_instance.to_dict()
+# create an instance of V1UpdateWorkflowResponse from a dict
+v1_update_workflow_response_from_dict = V1UpdateWorkflowResponse.from_dict(v1_update_workflow_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/V1Workflow.md

@@ -0,0 +1,46 @@
+# V1Workflow
+
+Workflow represents a workflow in Eval Studio. It consists of WorkflowNodes and WorkflowEdges.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Output only. Immutable. Resource name of the Workflow in format of `workflows/{workflow_id}`. | [optional] [readonly] 
+**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] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_workflow import V1Workflow
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1Workflow from a JSON string
+v1_workflow_instance = V1Workflow.from_json(json)
+# print the JSON string representation of the object
+print(V1Workflow.to_json())
+
+# convert the object into a dict
+v1_workflow_dict = v1_workflow_instance.to_dict()
+# create an instance of V1Workflow from a dict
+v1_workflow_from_dict = V1Workflow.from_dict(v1_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/V1WorkflowEdge.md

@@ -0,0 +1,40 @@
+# V1WorkflowEdge
+
+WorkflowEdge represents an oriented edge between two WorkflowNodes in an Eval Studio Workflow.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Resource name of the Workflow in format of `workflow/{workflow_id}/edges/{edge_id}`. | [optional] 
+**parent** | **str** | Output only. Immutable. Resource name of the parent Workflow in format of `workflow/{workflow_id}`. | [optional] [readonly] 
+**create_time** | **datetime** | Output only. Immutable. Creation time of the WorkflowEdge. | [optional] [readonly] 
+**creator** | **str** | Output only. Immutable. Name of the user or service that requested creation of the WorkflowEdge. | [optional] [readonly] 
+**update_time** | **datetime** | Output only. Optional. Last update time of the WorkflowEdge. | [optional] [readonly] 
+**updater** | **str** | Output only. Name of the user or service that requested update of the WorkflowEdge. | [optional] [readonly] 
+**delete_time** | **datetime** | Output only. Optional. Deletion time of the WorkflowEdge. | [optional] [readonly] 
+**deleter** | **str** | Output only. Name of the user or service that requested deletion of the WorkflowEdge. | [optional] [readonly] 
+**type** | [**V1WorkflowEdgeType**](V1WorkflowEdgeType.md) |  | [optional] 
+**var_from** | **str** | Resource name of the source WorkflowNode in format of `workflow/{workflow_id}/nodes/{node_id}`. | [optional] 
+**to** | **str** | Resource name of the target WorkflowNode in format of `workflow/{workflow_id}/nodes/{node_id}`. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_workflow_edge import V1WorkflowEdge
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1WorkflowEdge from a JSON string
+v1_workflow_edge_instance = V1WorkflowEdge.from_json(json)
+# print the JSON string representation of the object
+print(V1WorkflowEdge.to_json())
+
+# convert the object into a dict
+v1_workflow_edge_dict = v1_workflow_edge_instance.to_dict()
+# create an instance of V1WorkflowEdge from a dict
+v1_workflow_edge_from_dict = V1WorkflowEdge.from_dict(v1_workflow_edge_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/V1WorkflowEdgeType.md

@@ -0,0 +1,12 @@
+# V1WorkflowEdgeType
+
+WorkflowEdgeType represents the type of a WorkflowEdge.   - WORKFLOW_EDGE_TYPE_UNSPECIFIED: Unspecified type.  - WORKFLOW_EDGE_TYPE_SIMPLE: Simple edge without any conditions.
+
+## 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/V1WorkflowNode.md

@@ -0,0 +1,46 @@
+# V1WorkflowNode
+
+WorkflowNode represents a node in an Eval Studio Workflow.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Output only. Immutable. Resource name of the Workflow in format of `workflows/{workflow_id}/nodes/{node_id}`. | [optional] [readonly] 
+**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.v1_workflow_node import V1WorkflowNode
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1WorkflowNode from a JSON string
+v1_workflow_node_instance = V1WorkflowNode.from_json(json)
+# print the JSON string representation of the object
+print(V1WorkflowNode.to_json())
+
+# convert the object into a dict
+v1_workflow_node_dict = v1_workflow_node_instance.to_dict()
+# create an instance of V1WorkflowNode from a dict
+v1_workflow_node_from_dict = V1WorkflowNode.from_dict(v1_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/V1WorkflowNodeArtifact.md

@@ -0,0 +1,40 @@
+# V1WorkflowNodeArtifact
+
+WorkflowNodeArtifact represents an artifact produced/consumed by a WorkflowNode.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Resource name of the Workflow in format of `workflows/{workflow_id}/nodes/{node_id}/artifacts/{artifact_id}`. | [optional] 
+**parent** | **str** | Output only. Immutable. Resource name of the parent WorkflowNode in format of `workflows/{workflow_id}/nodes/{node_id}`. | [optional] [readonly] 
+**display_name** | **str** | Human-readable name of the WorkflowNodeArtifact. | [optional] 
+**description** | **str** | Optional description of the WorkflowNodeArtifact. | [optional] 
+**create_time** | **datetime** | Output only. Immutable. Creation time of the WorkflowNodeArtifact. | [optional] [readonly] 
+**creator** | **str** | Output only. Immutable. Name of the user or service that requested creation of the WorkflowNodeArtifact. | [optional] [readonly] 
+**update_time** | **datetime** | Output only. Optional. Last update time of the WorkflowNodeArtifact. | [optional] [readonly] 
+**updater** | **str** | Output only. Name of the user or service that requested update of the WorkflowNodeArtifact. | [optional] [readonly] 
+**delete_time** | **datetime** | Output only. Optional. Deletion time of the WorkflowNodeArtifact. | [optional] [readonly] 
+**deleter** | **str** | Output only. Name of the user or service that requested deletion of the WorkflowNodeArtifact. | [optional] [readonly] 
+**mime_type** | **str** | Optional MIME type of the WorkflowNodeArtifact. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_workflow_node_artifact import V1WorkflowNodeArtifact
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1WorkflowNodeArtifact from a JSON string
+v1_workflow_node_artifact_instance = V1WorkflowNodeArtifact.from_json(json)
+# print the JSON string representation of the object
+print(V1WorkflowNodeArtifact.to_json())
+
+# convert the object into a dict
+v1_workflow_node_artifact_dict = v1_workflow_node_artifact_instance.to_dict()
+# create an instance of V1WorkflowNodeArtifact from a dict
+v1_workflow_node_artifact_from_dict = V1WorkflowNodeArtifact.from_dict(v1_workflow_node_artifact_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/V1WorkflowNodeArtifacts.md

@@ -0,0 +1,29 @@
+# V1WorkflowNodeArtifacts
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**artifacts** | [**List[V1WorkflowNodeArtifact]**](V1WorkflowNodeArtifact.md) | Output only. List of the WorkflowNodeArtifacts produced by the WorkflowNode. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_workflow_node_artifacts import V1WorkflowNodeArtifacts
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1WorkflowNodeArtifacts from a JSON string
+v1_workflow_node_artifacts_instance = V1WorkflowNodeArtifacts.from_json(json)
+# print the JSON string representation of the object
+print(V1WorkflowNodeArtifacts.to_json())
+
+# convert the object into a dict
+v1_workflow_node_artifacts_dict = v1_workflow_node_artifacts_instance.to_dict()
+# create an instance of V1WorkflowNodeArtifacts from a dict
+v1_workflow_node_artifacts_from_dict = V1WorkflowNodeArtifacts.from_dict(v1_workflow_node_artifacts_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/V1WorkflowNodeAttributes.md

@@ -0,0 +1,30 @@
+# V1WorkflowNodeAttributes
+
+WorkflowNodeAttributes represents additional attributes of a WorkflowNode.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**can_delete** | **bool** | Whether the WorkflowNode can be deleted. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_workflow_node_attributes import V1WorkflowNodeAttributes
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1WorkflowNodeAttributes from a JSON string
+v1_workflow_node_attributes_instance = V1WorkflowNodeAttributes.from_json(json)
+# print the JSON string representation of the object
+print(V1WorkflowNodeAttributes.to_json())
+
+# convert the object into a dict
+v1_workflow_node_attributes_dict = v1_workflow_node_attributes_instance.to_dict()
+# create an instance of V1WorkflowNodeAttributes from a dict
+v1_workflow_node_attributes_from_dict = V1WorkflowNodeAttributes.from_dict(v1_workflow_node_attributes_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/V1WorkflowNodeStatus.md

@@ -0,0 +1,12 @@
+# V1WorkflowNodeStatus
+
+WorkflowNodeStatus represents the status of a WorkflowNode.   - WORKFLOW_NODE_STATUS_UNSPECIFIED: Unspecified status.  - WORKFLOW_NODE_STATUS_PENDING: WorkflowNode is pending.  - WORKFLOW_NODE_STATUS_RUNNING: WorkflowNode is running.  - WORKFLOW_NODE_STATUS_COMPLETED: WorkflowNode is completed successfully.  - WORKFLOW_NODE_STATUS_FAILED: WorkflowNode failed.
+
+## 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/V1WorkflowNodeType.md

@@ -0,0 +1,12 @@
+# V1WorkflowNodeType
+
+WorkflowNodeType represents the type of a WorkflowNode.
+
+## 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/V1WorkflowNodeView.md

@@ -0,0 +1,12 @@
+# V1WorkflowNodeView
+
+WorkflowNodeView specifies 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.
+
+## 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/V1WorkflowType.md

@@ -0,0 +1,12 @@
+# V1WorkflowType
+
+WorkflowType represents the type of a Workflow.
+
+## 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/WorkflowEdgeServiceApi.md

@@ -0,0 +1,76 @@
+# eval_studio_client.api.WorkflowEdgeServiceApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**workflow_edge_service_batch_get_workflow_edges**](WorkflowEdgeServiceApi.md#workflow_edge_service_batch_get_workflow_edges) | **GET** /v1/workflows/*/edges:batchGet | Retrieves all WorkflowEdges with the specified resource names. If any of the WorkflowEdges do not exist an error is returned. The order of resource names in the request and the returned WorkflowEdges might differ.
+
+
+# **workflow_edge_service_batch_get_workflow_edges**
+> V1BatchGetWorkflowEdgesResponse workflow_edge_service_batch_get_workflow_edges(names=names)
+
+Retrieves all WorkflowEdges with the specified resource names. If any of the WorkflowEdges do not exist an error is returned. The order of resource names in the request and the returned WorkflowEdges might differ.
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_batch_get_workflow_edges_response import V1BatchGetWorkflowEdgesResponse
+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.WorkflowEdgeServiceApi(api_client)
+    names = ['names_example'] # List[str] | Required. The resource names of the WorkflowEdges to retrieve. Maximum 1000 items. (optional)
+
+    try:
+        # Retrieves all WorkflowEdges with the specified resource names. If any of the WorkflowEdges do not exist an error is returned. The order of resource names in the request and the returned WorkflowEdges might differ.
+        api_response = api_instance.workflow_edge_service_batch_get_workflow_edges(names=names)
+        print("The response of WorkflowEdgeServiceApi->workflow_edge_service_batch_get_workflow_edges:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowEdgeServiceApi->workflow_edge_service_batch_get_workflow_edges: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **names** | [**List[str]**](str.md)| Required. The resource names of the WorkflowEdges to retrieve. Maximum 1000 items. | [optional] 
+
+### Return type
+
+[**V1BatchGetWorkflowEdgesResponse**](V1BatchGetWorkflowEdgesResponse.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)
+