eval-studio-client 0.7.0__py3-none-any.whl

eval_studio_client/api/docs/OperationProgressServiceApi.md

@@ -0,0 +1,75 @@
+# eval_studio_client.api.OperationProgressServiceApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**operation_progress_service_get_operation_progress_by_parent**](OperationProgressServiceApi.md#operation_progress_service_get_operation_progress_by_parent) | **GET** /v1alpha/{parent}/progresses:getByParent | 
+
+
+# **operation_progress_service_get_operation_progress_by_parent**
+> V1alphaGetOperationProgressByParentResponse operation_progress_service_get_operation_progress_by_parent(parent)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1alpha_get_operation_progress_by_parent_response import V1alphaGetOperationProgressByParentResponse
+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.OperationProgressServiceApi(api_client)
+    parent = 'parent_example' # str | Required. The name of the parent Operation.
+
+    try:
+        api_response = api_instance.operation_progress_service_get_operation_progress_by_parent(parent)
+        print("The response of OperationProgressServiceApi->operation_progress_service_get_operation_progress_by_parent:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling OperationProgressServiceApi->operation_progress_service_get_operation_progress_by_parent: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **parent** | **str**| Required. The name of the parent Operation. | 
+
+### Return type
+
+[**V1alphaGetOperationProgressByParentResponse**](V1alphaGetOperationProgressByParentResponse.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/OperationServiceApi.md

@@ -0,0 +1,345 @@
+# eval_studio_client.api.OperationServiceApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**operation_service_batch_get_operations**](OperationServiceApi.md#operation_service_batch_get_operations) | **GET** /v1alpha/operations:batchGet | 
+[**operation_service_finalize_operation**](OperationServiceApi.md#operation_service_finalize_operation) | **PATCH** /v1alpha/{operation.name}:finalize | 
+[**operation_service_get_operation**](OperationServiceApi.md#operation_service_get_operation) | **GET** /v1alpha/{name_5} | 
+[**operation_service_list_operations**](OperationServiceApi.md#operation_service_list_operations) | **GET** /v1alpha/operations | 
+[**operation_service_update_operation**](OperationServiceApi.md#operation_service_update_operation) | **PATCH** /v1alpha/{operation.name} | 
+
+
+# **operation_service_batch_get_operations**
+> V1alphaBatchGetOperationsResponse operation_service_batch_get_operations(names=names)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1alpha_batch_get_operations_response import V1alphaBatchGetOperationsResponse
+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.OperationServiceApi(api_client)
+    names = ['names_example'] # List[str] | The names of the Operations to retrieve. A maximum of 1000 can be specified. (optional)
+
+    try:
+        api_response = api_instance.operation_service_batch_get_operations(names=names)
+        print("The response of OperationServiceApi->operation_service_batch_get_operations:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling OperationServiceApi->operation_service_batch_get_operations: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **names** | [**List[str]**](str.md)| The names of the Operations to retrieve. A maximum of 1000 can be specified. | [optional] 
+
+### Return type
+
+[**V1alphaBatchGetOperationsResponse**](V1alphaBatchGetOperationsResponse.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)
+
+# **operation_service_finalize_operation**
+> V1alphaFinalizeOperationResponse operation_service_finalize_operation(operation_name, operation)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.required_the_operation_to_finalize import RequiredTheOperationToFinalize
+from eval_studio_client.api.models.v1alpha_finalize_operation_response import V1alphaFinalizeOperationResponse
+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.OperationServiceApi(api_client)
+    operation_name = 'operation_name_example' # str | Output only. Name of the Operation resource. e.g.: \"operations/<UUID>\"
+    operation = eval_studio_client.api.RequiredTheOperationToFinalize() # RequiredTheOperationToFinalize | Required. The Operation to finalize.  The Operation's `name` field is used to identify the Operation to finalize. Format: operations/{operation}
+
+    try:
+        api_response = api_instance.operation_service_finalize_operation(operation_name, operation)
+        print("The response of OperationServiceApi->operation_service_finalize_operation:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling OperationServiceApi->operation_service_finalize_operation: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **operation_name** | **str**| Output only. Name of the Operation resource. e.g.: \&quot;operations/&lt;UUID&gt;\&quot; | 
+ **operation** | [**RequiredTheOperationToFinalize**](RequiredTheOperationToFinalize.md)| Required. The Operation to finalize.  The Operation&#39;s &#x60;name&#x60; field is used to identify the Operation to finalize. Format: operations/{operation} | 
+
+### Return type
+
+[**V1alphaFinalizeOperationResponse**](V1alphaFinalizeOperationResponse.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)
+
+# **operation_service_get_operation**
+> V1alphaGetOperationResponse operation_service_get_operation(name_5)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1alpha_get_operation_response import V1alphaGetOperationResponse
+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.OperationServiceApi(api_client)
+    name_5 = 'name_5_example' # str | Required. The name of the Operation to retrieve.
+
+    try:
+        api_response = api_instance.operation_service_get_operation(name_5)
+        print("The response of OperationServiceApi->operation_service_get_operation:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling OperationServiceApi->operation_service_get_operation: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name_5** | **str**| Required. The name of the Operation to retrieve. | 
+
+### Return type
+
+[**V1alphaGetOperationResponse**](V1alphaGetOperationResponse.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)
+
+# **operation_service_list_operations**
+> V1alphaListOperationsResponse operation_service_list_operations()
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1alpha_list_operations_response import V1alphaListOperationsResponse
+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.OperationServiceApi(api_client)
+
+    try:
+        api_response = api_instance.operation_service_list_operations()
+        print("The response of OperationServiceApi->operation_service_list_operations:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling OperationServiceApi->operation_service_list_operations: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**V1alphaListOperationsResponse**](V1alphaListOperationsResponse.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)
+
+# **operation_service_update_operation**
+> V1alphaUpdateOperationResponse operation_service_update_operation(operation_name, operation)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.required_the_operation_to_update import RequiredTheOperationToUpdate
+from eval_studio_client.api.models.v1alpha_update_operation_response import V1alphaUpdateOperationResponse
+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.OperationServiceApi(api_client)
+    operation_name = 'operation_name_example' # str | Output only. Name of the Operation resource. e.g.: \"operations/<UUID>\"
+    operation = eval_studio_client.api.RequiredTheOperationToUpdate() # RequiredTheOperationToUpdate | Required. The Operation to update.  The Operation's `name` field is used to identify the Operation to update. Format: operations/{operation}
+
+    try:
+        api_response = api_instance.operation_service_update_operation(operation_name, operation)
+        print("The response of OperationServiceApi->operation_service_update_operation:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling OperationServiceApi->operation_service_update_operation: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **operation_name** | **str**| Output only. Name of the Operation resource. e.g.: \&quot;operations/&lt;UUID&gt;\&quot; | 
+ **operation** | [**RequiredTheOperationToUpdate**](RequiredTheOperationToUpdate.md)| Required. The Operation to update.  The Operation&#39;s &#x60;name&#x60; field is used to identify the Operation to update. Format: operations/{operation} | 
+
+### Return type
+
+[**V1alphaUpdateOperationResponse**](V1alphaUpdateOperationResponse.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/PerturbationServiceApi.md

@@ -0,0 +1,78 @@
+# eval_studio_client.api.PerturbationServiceApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**perturbation_service_create_perturbation**](PerturbationServiceApi.md#perturbation_service_create_perturbation) | **POST** /v1alpha/{parent}/perturbations | 
+
+
+# **perturbation_service_create_perturbation**
+> V1alphaCreatePerturbationResponse perturbation_service_create_perturbation(parent, body)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.perturbation_service_create_perturbation_request import PerturbationServiceCreatePerturbationRequest
+from eval_studio_client.api.models.v1alpha_create_perturbation_response import V1alphaCreatePerturbationResponse
+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.PerturbationServiceApi(api_client)
+    parent = 'parent_example' # str | Required. The Test being perturbed.
+    body = eval_studio_client.api.PerturbationServiceCreatePerturbationRequest() # PerturbationServiceCreatePerturbationRequest | 
+
+    try:
+        api_response = api_instance.perturbation_service_create_perturbation(parent, body)
+        print("The response of PerturbationServiceApi->perturbation_service_create_perturbation:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling PerturbationServiceApi->perturbation_service_create_perturbation: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **parent** | **str**| Required. The Test being perturbed. | 
+ **body** | [**PerturbationServiceCreatePerturbationRequest**](PerturbationServiceCreatePerturbationRequest.md)|  | 
+
+### Return type
+
+[**V1alphaCreatePerturbationResponse**](V1alphaCreatePerturbationResponse.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/PerturbationServiceCreatePerturbationRequest.md

@@ -0,0 +1,31 @@
+# PerturbationServiceCreatePerturbationRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**perturbator_configurations** | [**List[V1alphaPerturbatorConfiguration]**](V1alphaPerturbatorConfiguration.md) | Required. PerturbatorConfiguration to apply to the parent Test. | [optional] 
+**test_cases** | [**List[V1alphaTestCase]**](V1alphaTestCase.md) | Required. List of test cases to perturbate. These are the test cases from the parent test.  TODO: breaks https://google.aip.dev/144 | [optional] 
+**test_case_relationships** | [**List[V1alphaTestCaseRelationship]**](V1alphaTestCaseRelationship.md) | Optional. List of relationships between test cases. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.perturbation_service_create_perturbation_request import PerturbationServiceCreatePerturbationRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PerturbationServiceCreatePerturbationRequest from a JSON string
+perturbation_service_create_perturbation_request_instance = PerturbationServiceCreatePerturbationRequest.from_json(json)
+# print the JSON string representation of the object
+print(PerturbationServiceCreatePerturbationRequest.to_json())
+
+# convert the object into a dict
+perturbation_service_create_perturbation_request_dict = perturbation_service_create_perturbation_request_instance.to_dict()
+# create an instance of PerturbationServiceCreatePerturbationRequest from a dict
+perturbation_service_create_perturbation_request_from_dict = PerturbationServiceCreatePerturbationRequest.from_dict(perturbation_service_create_perturbation_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/docs/PerturbatorServiceApi.md

@@ -0,0 +1,138 @@
+# eval_studio_client.api.PerturbatorServiceApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**perturbator_service_get_perturbator**](PerturbatorServiceApi.md#perturbator_service_get_perturbator) | **GET** /v1alpha/{name_6} | 
+[**perturbator_service_list_perturbators**](PerturbatorServiceApi.md#perturbator_service_list_perturbators) | **GET** /v1alpha/perturbators | 
+
+
+# **perturbator_service_get_perturbator**
+> V1alphaGetPerturbatorResponse perturbator_service_get_perturbator(name_6)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1alpha_get_perturbator_response import V1alphaGetPerturbatorResponse
+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.PerturbatorServiceApi(api_client)
+    name_6 = 'name_6_example' # str | Required. The name of the Perturbator to retrieve.
+
+    try:
+        api_response = api_instance.perturbator_service_get_perturbator(name_6)
+        print("The response of PerturbatorServiceApi->perturbator_service_get_perturbator:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling PerturbatorServiceApi->perturbator_service_get_perturbator: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name_6** | **str**| Required. The name of the Perturbator to retrieve. | 
+
+### Return type
+
+[**V1alphaGetPerturbatorResponse**](V1alphaGetPerturbatorResponse.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)
+
+# **perturbator_service_list_perturbators**
+> V1alphaListPerturbatorsResponse perturbator_service_list_perturbators()
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1alpha_list_perturbators_response import V1alphaListPerturbatorsResponse
+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.PerturbatorServiceApi(api_client)
+
+    try:
+        api_response = api_instance.perturbator_service_list_perturbators()
+        print("The response of PerturbatorServiceApi->perturbator_service_list_perturbators:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling PerturbatorServiceApi->perturbator_service_list_perturbators: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**V1alphaListPerturbatorsResponse**](V1alphaListPerturbatorsResponse.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)
+