eval-studio-client 1.1.6a5__py3-none-any.whl → 1.2.0__py3-none-any.whl

eval_studio_client/api/docs/V1ListWorkflowAccessResponse.md

@@ -0,0 +1,29 @@
+# V1ListWorkflowAccessResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role_bindings** | [**List[V1RoleBinding]**](V1RoleBinding.md) | The RoleBindings for the Workflow requested. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_list_workflow_access_response import V1ListWorkflowAccessResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ListWorkflowAccessResponse from a JSON string
+v1_list_workflow_access_response_instance = V1ListWorkflowAccessResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1ListWorkflowAccessResponse.to_json())
+
+# convert the object into a dict
+v1_list_workflow_access_response_dict = v1_list_workflow_access_response_instance.to_dict()
+# create an instance of V1ListWorkflowAccessResponse from a dict
+v1_list_workflow_access_response_from_dict = V1ListWorkflowAccessResponse.from_dict(v1_list_workflow_access_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/V1ListWorkflowsSharedWithMeResponse.md

@@ -0,0 +1,29 @@
+# V1ListWorkflowsSharedWithMeResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**workflows** | [**List[V1Workflow]**](V1Workflow.md) | The Workflows that match the request. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_list_workflows_shared_with_me_response import V1ListWorkflowsSharedWithMeResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ListWorkflowsSharedWithMeResponse from a JSON string
+v1_list_workflows_shared_with_me_response_instance = V1ListWorkflowsSharedWithMeResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1ListWorkflowsSharedWithMeResponse.to_json())
+
+# convert the object into a dict
+v1_list_workflows_shared_with_me_response_dict = v1_list_workflows_shared_with_me_response_instance.to_dict()
+# create an instance of V1ListWorkflowsSharedWithMeResponse from a dict
+v1_list_workflows_shared_with_me_response_from_dict = V1ListWorkflowsSharedWithMeResponse.from_dict(v1_list_workflows_shared_with_me_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/V1Role.md

@@ -0,0 +1,12 @@
+# V1Role
+
+Roles are used to define the access level of a user to a specific resource.   - ROLE_UNSPECIFIED: Unspecified role. This is used when the role is not set or not applicable.  - ROLE_READER: Reader role. This role allows read-only access to the resource.  - ROLE_WRITER: Writer role. This role allows read and write access to the resource. This does not allow to manage access to the resource or to delete it.
+
+## 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/V1RoleBinding.md

@@ -0,0 +1,32 @@
+# V1RoleBinding
+
+RoleBinding is used to bind a user to a specific role for a specific resource.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subject** | **str** | The subject to which the role is assigned. | [optional] 
+**role** | [**V1Role**](V1Role.md) |  | [optional] 
+**resource** | **str** | The resource to which the role is assigned. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_role_binding import V1RoleBinding
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1RoleBinding from a JSON string
+v1_role_binding_instance = V1RoleBinding.from_json(json)
+# print the JSON string representation of the object
+print(V1RoleBinding.to_json())
+
+# convert the object into a dict
+v1_role_binding_dict = v1_role_binding_instance.to_dict()
+# create an instance of V1RoleBinding from a dict
+v1_role_binding_from_dict = V1RoleBinding.from_dict(v1_role_binding_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/V1Stats.md

@@ -0,0 +1,32 @@
+# V1Stats
+
+Stats represents statistics about the Eval Studio instance, jobs and utilization.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**topic_modeling_pending_jobs** | **str** | Number of pending jobs in the topic modeling queue. It's marked as optional to always be part of the response, even when the value is zero. | [optional] 
+**test_validation_pending_jobs** | **str** | Number of pending jobs in the test validation queue. It's marked as optional to always be part of the response, even when the value is zero. | [optional] 
+**failure_clustering_pending_jobs** | **str** | Number of pending jobs in the failure clustering queue. It's marked as optional to always be part of the response, even when the value is zero. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1_stats import V1Stats
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1Stats from a JSON string
+v1_stats_instance = V1Stats.from_json(json)
+# print the JSON string representation of the object
+print(V1Stats.to_json())
+
+# convert the object into a dict
+v1_stats_dict = v1_stats_instance.to_dict()
+# create an instance of V1Stats from a dict
+v1_stats_from_dict = V1Stats.from_dict(v1_stats_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/V1WorkflowNode.md

@@ -23,6 +23,8 @@ Name | Type | Description | Notes
 **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] 
+**result_status** | [**V1WorkflowNodeResultStatus**](V1WorkflowNodeResultStatus.md) |  | [optional] 
+**stale** | **bool** | Output only. The stale field marks whether the internal result is outdated and need to be checked for validity. | [optional] [readonly] 
 
 ## Example
 

eval_studio_client/api/docs/V1WorkflowNodeResultStatus.md

@@ -0,0 +1,12 @@
+# V1WorkflowNodeResultStatus
+
+WorkflowNodeResultStatus represents the result status of the finished computation of the node.   - WORKFLOW_NODE_RESULT_STATUS_UNSPECIFIED: Unspecified status.  - WORKFLOW_NODE_RESULT_STATUS_NONE: The process has a no result yet (no computation was done).  - WORKFLOW_NODE_RESULT_STATUS_SUCCESS: The process succeeded with a valid computation.  - WORKFLOW_NODE_RESULT_STATUS_WARNING: The process ends up with a result and warning.  - WORKFLOW_NODE_RESULT_STATUS_ERROR: The process failed and no result was produced.
+
+## 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/V1WorkflowResultArtifactType.md

@@ -0,0 +1,12 @@
+# V1WorkflowResultArtifactType
+
+WorkflowResultArtifactType enum representing the types of artifacts that can be produced by a Workflow result.
+
+## 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/V1WorkflowResultReportFormat.md

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

@@ -0,0 +1,282 @@
+# eval_studio_client.api.WorkflowResultServiceApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**workflow_result_service_get_workflow_result_corpus_patch**](WorkflowResultServiceApi.md#workflow_result_service_get_workflow_result_corpus_patch) | **GET** /v1/{name}:getResultsCorpusPatch | GetWorkflowResultCorpusPatch retrieves the corpus patch of a Workflow result. The corpus patch is a HTML document that contains questions and answers identified as problematic in HEC and RT IV workflow steps.
+[**workflow_result_service_get_workflow_result_report**](WorkflowResultServiceApi.md#workflow_result_service_get_workflow_result_report) | **GET** /v1/{name}:getResultsReport | GetWorkflowResultReport retrieves the report of a Workflow result. The report is a detailed HTML document summarizing the Workflow's execution and findings.
+[**workflow_result_service_get_workflow_result_summary**](WorkflowResultServiceApi.md#workflow_result_service_get_workflow_result_summary) | **GET** /v1/{name}:getResultsSummary | GetWorkflowResultSummary retrieves the 3x3x3 summary of a Workflow result. The summary includes 3 summary sentences, 3 bullets with most serious highlights, and 3 recommended actions sentences.
+[**workflow_result_service_get_workflow_result_system_prompt_patch**](WorkflowResultServiceApi.md#workflow_result_service_get_workflow_result_system_prompt_patch) | **GET** /v1/{name}:getResultsSystemPromptPatch | GetWorkflowResultSystemPromptPatch retrieves the system prompt patch of a Workflow result.
+
+
+# **workflow_result_service_get_workflow_result_corpus_patch**
+> V1GetWorkflowResultCorpusPatchResponse workflow_result_service_get_workflow_result_corpus_patch(name)
+
+GetWorkflowResultCorpusPatch retrieves the corpus patch of a Workflow result. The corpus patch is a HTML document that contains questions and answers identified as problematic in HEC and RT IV workflow steps.
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_get_workflow_result_corpus_patch_response import V1GetWorkflowResultCorpusPatchResponse
+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.WorkflowResultServiceApi(api_client)
+    name = 'name_example' # str | Required. The resource name of the workflow for which to generate the corpus patch.
+
+    try:
+        # GetWorkflowResultCorpusPatch retrieves the corpus patch of a Workflow result. The corpus patch is a HTML document that contains questions and answers identified as problematic in HEC and RT IV workflow steps.
+        api_response = api_instance.workflow_result_service_get_workflow_result_corpus_patch(name)
+        print("The response of WorkflowResultServiceApi->workflow_result_service_get_workflow_result_corpus_patch:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowResultServiceApi->workflow_result_service_get_workflow_result_corpus_patch: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| Required. The resource name of the workflow for which to generate the corpus patch. | 
+
+### Return type
+
+[**V1GetWorkflowResultCorpusPatchResponse**](V1GetWorkflowResultCorpusPatchResponse.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_result_service_get_workflow_result_report**
+> V1GetWorkflowResultReportResponse workflow_result_service_get_workflow_result_report(name, format=format)
+
+GetWorkflowResultReport retrieves the report of a Workflow result. The report is a detailed HTML document summarizing the Workflow's execution and findings.
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_get_workflow_result_report_response import V1GetWorkflowResultReportResponse
+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.WorkflowResultServiceApi(api_client)
+    name = 'name_example' # str | Required. The resource name of the workflow for which to retrieve the report.
+    format = 'WORKFLOW_RESULT_REPORT_FORMAT_UNSPECIFIED' # str | Required. The format of the report to retrieve. (optional) (default to 'WORKFLOW_RESULT_REPORT_FORMAT_UNSPECIFIED')
+
+    try:
+        # GetWorkflowResultReport retrieves the report of a Workflow result. The report is a detailed HTML document summarizing the Workflow's execution and findings.
+        api_response = api_instance.workflow_result_service_get_workflow_result_report(name, format=format)
+        print("The response of WorkflowResultServiceApi->workflow_result_service_get_workflow_result_report:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowResultServiceApi->workflow_result_service_get_workflow_result_report: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| Required. The resource name of the workflow for which to retrieve the report. | 
+ **format** | **str**| Required. The format of the report to retrieve. | [optional] [default to 'WORKFLOW_RESULT_REPORT_FORMAT_UNSPECIFIED']
+
+### Return type
+
+[**V1GetWorkflowResultReportResponse**](V1GetWorkflowResultReportResponse.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_result_service_get_workflow_result_summary**
+> V1GetWorkflowResultSummaryResponse workflow_result_service_get_workflow_result_summary(name)
+
+GetWorkflowResultSummary retrieves the 3x3x3 summary of a Workflow result. The summary includes 3 summary sentences, 3 bullets with most serious highlights, and 3 recommended actions sentences.
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_get_workflow_result_summary_response import V1GetWorkflowResultSummaryResponse
+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.WorkflowResultServiceApi(api_client)
+    name = 'name_example' # str | Required. The name of the Workflow for which to retrieve the 3x3x3 summary.
+
+    try:
+        # GetWorkflowResultSummary retrieves the 3x3x3 summary of a Workflow result. The summary includes 3 summary sentences, 3 bullets with most serious highlights, and 3 recommended actions sentences.
+        api_response = api_instance.workflow_result_service_get_workflow_result_summary(name)
+        print("The response of WorkflowResultServiceApi->workflow_result_service_get_workflow_result_summary:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowResultServiceApi->workflow_result_service_get_workflow_result_summary: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| Required. The name of the Workflow for which to retrieve the 3x3x3 summary. | 
+
+### Return type
+
+[**V1GetWorkflowResultSummaryResponse**](V1GetWorkflowResultSummaryResponse.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_result_service_get_workflow_result_system_prompt_patch**
+> V1GetWorkflowResultSystemPromptPatchResponse workflow_result_service_get_workflow_result_system_prompt_patch(name)
+
+GetWorkflowResultSystemPromptPatch retrieves the system prompt patch of a Workflow result.
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1_get_workflow_result_system_prompt_patch_response import V1GetWorkflowResultSystemPromptPatchResponse
+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.WorkflowResultServiceApi(api_client)
+    name = 'name_example' # str | Required. The resource name of the workflow for which to generate the system prompt patch.
+
+    try:
+        # GetWorkflowResultSystemPromptPatch retrieves the system prompt patch of a Workflow result.
+        api_response = api_instance.workflow_result_service_get_workflow_result_system_prompt_patch(name)
+        print("The response of WorkflowResultServiceApi->workflow_result_service_get_workflow_result_system_prompt_patch:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WorkflowResultServiceApi->workflow_result_service_get_workflow_result_system_prompt_patch: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| Required. The resource name of the workflow for which to generate the system prompt patch. | 
+
+### Return type
+
+[**V1GetWorkflowResultSystemPromptPatchResponse**](V1GetWorkflowResultSystemPromptPatchResponse.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)
+