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

eval_studio_client/api/docs/EvaluationServiceApi.md

@@ -0,0 +1,332 @@
+# eval_studio_client.api.EvaluationServiceApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**evaluation_service_create_evaluation**](EvaluationServiceApi.md#evaluation_service_create_evaluation) | **POST** /v1alpha/evaluations | 
+[**evaluation_service_import_evaluation**](EvaluationServiceApi.md#evaluation_service_import_evaluation) | **POST** /v1alpha/evaluations:import | 
+[**evaluation_service_list_llm_models**](EvaluationServiceApi.md#evaluation_service_list_llm_models) | **GET** /v1alpha/evaluations:llm_models | 
+[**evaluation_service_list_rag_collections**](EvaluationServiceApi.md#evaluation_service_list_rag_collections) | **GET** /v1alpha/evaluations:rag_collections | 
+
+
+# **evaluation_service_create_evaluation**
+> V1alphaOperation evaluation_service_create_evaluation(body)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1alpha_create_evaluation_request import V1alphaCreateEvaluationRequest
+from eval_studio_client.api.models.v1alpha_operation import V1alphaOperation
+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.EvaluationServiceApi(api_client)
+    body = eval_studio_client.api.V1alphaCreateEvaluationRequest() # V1alphaCreateEvaluationRequest | 
+
+    try:
+        api_response = api_instance.evaluation_service_create_evaluation(body)
+        print("The response of EvaluationServiceApi->evaluation_service_create_evaluation:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EvaluationServiceApi->evaluation_service_create_evaluation: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1alphaCreateEvaluationRequest**](V1alphaCreateEvaluationRequest.md)|  | 
+
+### Return type
+
+[**V1alphaOperation**](V1alphaOperation.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)
+
+# **evaluation_service_import_evaluation**
+> V1alphaOperation evaluation_service_import_evaluation(body)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1alpha_import_evaluation_request import V1alphaImportEvaluationRequest
+from eval_studio_client.api.models.v1alpha_operation import V1alphaOperation
+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.EvaluationServiceApi(api_client)
+    body = eval_studio_client.api.V1alphaImportEvaluationRequest() # V1alphaImportEvaluationRequest | 
+
+    try:
+        api_response = api_instance.evaluation_service_import_evaluation(body)
+        print("The response of EvaluationServiceApi->evaluation_service_import_evaluation:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EvaluationServiceApi->evaluation_service_import_evaluation: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1alphaImportEvaluationRequest**](V1alphaImportEvaluationRequest.md)|  | 
+
+### Return type
+
+[**V1alphaOperation**](V1alphaOperation.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)
+
+# **evaluation_service_list_llm_models**
+> V1alphaListLLMModelsResponse evaluation_service_list_llm_models(model_name=model_name, model_create_time=model_create_time, model_creator=model_creator, model_update_time=model_update_time, model_updater=model_updater, model_delete_time=model_delete_time, model_deleter=model_deleter, model_display_name=model_display_name, model_description=model_description, model_url=model_url, model_api_key=model_api_key, model_type=model_type, model_parameters=model_parameters, model_demo=model_demo, retries=retries)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1alpha_list_llm_models_response import V1alphaListLLMModelsResponse
+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.EvaluationServiceApi(api_client)
+    model_name = 'model_name_example' # str | Output only. Name of the Model resource. e.g.: \"models/<UUID>\" (optional)
+    model_create_time = '2013-10-20T19:20:30+01:00' # datetime | Output only. Timestamp when the Model was created. (optional)
+    model_creator = 'model_creator_example' # str | Output only. Name of the user or service that requested creation of the Model. (optional)
+    model_update_time = '2013-10-20T19:20:30+01:00' # datetime | Output only. Optional. Timestamp when the Model was last updated. (optional)
+    model_updater = 'model_updater_example' # str | Output only. Optional. Name of the user or service that requested update of the Model. (optional)
+    model_delete_time = '2013-10-20T19:20:30+01:00' # datetime | Output only. Optional. Set when the Model is deleted. When set Model should be considered as deleted. (optional)
+    model_deleter = 'model_deleter_example' # str | Output only. Optional. Name of the user or service that requested deletion of the Model. (optional)
+    model_display_name = 'model_display_name_example' # str | Human readable name of the Model. (optional)
+    model_description = 'model_description_example' # str | Optional. Arbitrary description of the Model. (optional)
+    model_url = 'model_url_example' # str | Optional. Immutable. Absolute URL to the Model. (optional)
+    model_api_key = 'model_api_key_example' # str | Optional. API key used to access the Model. Not set for read calls (i.e. get, list) by public clients (front-end). Set only for internal (server-to-worker) communication. (optional)
+    model_type = 'MODEL_TYPE_UNSPECIFIED' # str | Immutable. Type of this Model.   - MODEL_TYPE_UNSPECIFIED: Unspecified type.  - MODEL_TYPE_H2OGPTE_RAG: h2oGPTe RAG.  - MODEL_TYPE_OPENAI_RAG: OpenAI Assistant RAG.  - MODEL_TYPE_H2OGPTE_LLM: h2oGPTe LLM.  - MODEL_TYPE_H2OGPT_LLM: h2oGPT LLM.  - MODEL_TYPE_OPENAI_CHAT: OpenAI chat.  - MODEL_TYPE_AZURE_OPENAI_CHAT: Microsoft Azure hosted OpenAI Chat.  - MODEL_TYPE_OPENAI_API_CHAT: OpenAI API chat.  - MODEL_TYPE_H2OLLMOPS: H2O LLMOps.  - MODEL_TYPE_OLLAMA: Ollama.  - MODEL_TYPE_AMAZON_BEDROCK: Amazon Bedrock. (optional) (default to 'MODEL_TYPE_UNSPECIFIED')
+    model_parameters = 'model_parameters_example' # str | Optional. Model specific parameters in JSON format. (optional)
+    model_demo = True # bool | Output only. Whether the Model is a demo resource or not. Demo resources are read only. (optional)
+    retries = 56 # int | Optional. The number of retries to attempt when querying the model for available LLM models. Defaults to 5. (optional)
+
+    try:
+        api_response = api_instance.evaluation_service_list_llm_models(model_name=model_name, model_create_time=model_create_time, model_creator=model_creator, model_update_time=model_update_time, model_updater=model_updater, model_delete_time=model_delete_time, model_deleter=model_deleter, model_display_name=model_display_name, model_description=model_description, model_url=model_url, model_api_key=model_api_key, model_type=model_type, model_parameters=model_parameters, model_demo=model_demo, retries=retries)
+        print("The response of EvaluationServiceApi->evaluation_service_list_llm_models:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EvaluationServiceApi->evaluation_service_list_llm_models: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **model_name** | **str**| Output only. Name of the Model resource. e.g.: \&quot;models/&lt;UUID&gt;\&quot; | [optional] 
+ **model_create_time** | **datetime**| Output only. Timestamp when the Model was created. | [optional] 
+ **model_creator** | **str**| Output only. Name of the user or service that requested creation of the Model. | [optional] 
+ **model_update_time** | **datetime**| Output only. Optional. Timestamp when the Model was last updated. | [optional] 
+ **model_updater** | **str**| Output only. Optional. Name of the user or service that requested update of the Model. | [optional] 
+ **model_delete_time** | **datetime**| Output only. Optional. Set when the Model is deleted. When set Model should be considered as deleted. | [optional] 
+ **model_deleter** | **str**| Output only. Optional. Name of the user or service that requested deletion of the Model. | [optional] 
+ **model_display_name** | **str**| Human readable name of the Model. | [optional] 
+ **model_description** | **str**| Optional. Arbitrary description of the Model. | [optional] 
+ **model_url** | **str**| Optional. Immutable. Absolute URL to the Model. | [optional] 
+ **model_api_key** | **str**| Optional. API key used to access the Model. Not set for read calls (i.e. get, list) by public clients (front-end). Set only for internal (server-to-worker) communication. | [optional] 
+ **model_type** | **str**| Immutable. Type of this Model.   - MODEL_TYPE_UNSPECIFIED: Unspecified type.  - MODEL_TYPE_H2OGPTE_RAG: h2oGPTe RAG.  - MODEL_TYPE_OPENAI_RAG: OpenAI Assistant RAG.  - MODEL_TYPE_H2OGPTE_LLM: h2oGPTe LLM.  - MODEL_TYPE_H2OGPT_LLM: h2oGPT LLM.  - MODEL_TYPE_OPENAI_CHAT: OpenAI chat.  - MODEL_TYPE_AZURE_OPENAI_CHAT: Microsoft Azure hosted OpenAI Chat.  - MODEL_TYPE_OPENAI_API_CHAT: OpenAI API chat.  - MODEL_TYPE_H2OLLMOPS: H2O LLMOps.  - MODEL_TYPE_OLLAMA: Ollama.  - MODEL_TYPE_AMAZON_BEDROCK: Amazon Bedrock. | [optional] [default to &#39;MODEL_TYPE_UNSPECIFIED&#39;]
+ **model_parameters** | **str**| Optional. Model specific parameters in JSON format. | [optional] 
+ **model_demo** | **bool**| Output only. Whether the Model is a demo resource or not. Demo resources are read only. | [optional] 
+ **retries** | **int**| Optional. The number of retries to attempt when querying the model for available LLM models. Defaults to 5. | [optional] 
+
+### Return type
+
+[**V1alphaListLLMModelsResponse**](V1alphaListLLMModelsResponse.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)
+
+# **evaluation_service_list_rag_collections**
+> V1alphaListRAGCollectionsResponse evaluation_service_list_rag_collections(model_name=model_name, model_create_time=model_create_time, model_creator=model_creator, model_update_time=model_update_time, model_updater=model_updater, model_delete_time=model_delete_time, model_deleter=model_deleter, model_display_name=model_display_name, model_description=model_description, model_url=model_url, model_api_key=model_api_key, model_type=model_type, model_parameters=model_parameters, model_demo=model_demo)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1alpha_list_rag_collections_response import V1alphaListRAGCollectionsResponse
+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.EvaluationServiceApi(api_client)
+    model_name = 'model_name_example' # str | Output only. Name of the Model resource. e.g.: \"models/<UUID>\" (optional)
+    model_create_time = '2013-10-20T19:20:30+01:00' # datetime | Output only. Timestamp when the Model was created. (optional)
+    model_creator = 'model_creator_example' # str | Output only. Name of the user or service that requested creation of the Model. (optional)
+    model_update_time = '2013-10-20T19:20:30+01:00' # datetime | Output only. Optional. Timestamp when the Model was last updated. (optional)
+    model_updater = 'model_updater_example' # str | Output only. Optional. Name of the user or service that requested update of the Model. (optional)
+    model_delete_time = '2013-10-20T19:20:30+01:00' # datetime | Output only. Optional. Set when the Model is deleted. When set Model should be considered as deleted. (optional)
+    model_deleter = 'model_deleter_example' # str | Output only. Optional. Name of the user or service that requested deletion of the Model. (optional)
+    model_display_name = 'model_display_name_example' # str | Human readable name of the Model. (optional)
+    model_description = 'model_description_example' # str | Optional. Arbitrary description of the Model. (optional)
+    model_url = 'model_url_example' # str | Optional. Immutable. Absolute URL to the Model. (optional)
+    model_api_key = 'model_api_key_example' # str | Optional. API key used to access the Model. Not set for read calls (i.e. get, list) by public clients (front-end). Set only for internal (server-to-worker) communication. (optional)
+    model_type = 'MODEL_TYPE_UNSPECIFIED' # str | Immutable. Type of this Model.   - MODEL_TYPE_UNSPECIFIED: Unspecified type.  - MODEL_TYPE_H2OGPTE_RAG: h2oGPTe RAG.  - MODEL_TYPE_OPENAI_RAG: OpenAI Assistant RAG.  - MODEL_TYPE_H2OGPTE_LLM: h2oGPTe LLM.  - MODEL_TYPE_H2OGPT_LLM: h2oGPT LLM.  - MODEL_TYPE_OPENAI_CHAT: OpenAI chat.  - MODEL_TYPE_AZURE_OPENAI_CHAT: Microsoft Azure hosted OpenAI Chat.  - MODEL_TYPE_OPENAI_API_CHAT: OpenAI API chat.  - MODEL_TYPE_H2OLLMOPS: H2O LLMOps.  - MODEL_TYPE_OLLAMA: Ollama.  - MODEL_TYPE_AMAZON_BEDROCK: Amazon Bedrock. (optional) (default to 'MODEL_TYPE_UNSPECIFIED')
+    model_parameters = 'model_parameters_example' # str | Optional. Model specific parameters in JSON format. (optional)
+    model_demo = True # bool | Output only. Whether the Model is a demo resource or not. Demo resources are read only. (optional)
+
+    try:
+        api_response = api_instance.evaluation_service_list_rag_collections(model_name=model_name, model_create_time=model_create_time, model_creator=model_creator, model_update_time=model_update_time, model_updater=model_updater, model_delete_time=model_delete_time, model_deleter=model_deleter, model_display_name=model_display_name, model_description=model_description, model_url=model_url, model_api_key=model_api_key, model_type=model_type, model_parameters=model_parameters, model_demo=model_demo)
+        print("The response of EvaluationServiceApi->evaluation_service_list_rag_collections:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EvaluationServiceApi->evaluation_service_list_rag_collections: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **model_name** | **str**| Output only. Name of the Model resource. e.g.: \&quot;models/&lt;UUID&gt;\&quot; | [optional] 
+ **model_create_time** | **datetime**| Output only. Timestamp when the Model was created. | [optional] 
+ **model_creator** | **str**| Output only. Name of the user or service that requested creation of the Model. | [optional] 
+ **model_update_time** | **datetime**| Output only. Optional. Timestamp when the Model was last updated. | [optional] 
+ **model_updater** | **str**| Output only. Optional. Name of the user or service that requested update of the Model. | [optional] 
+ **model_delete_time** | **datetime**| Output only. Optional. Set when the Model is deleted. When set Model should be considered as deleted. | [optional] 
+ **model_deleter** | **str**| Output only. Optional. Name of the user or service that requested deletion of the Model. | [optional] 
+ **model_display_name** | **str**| Human readable name of the Model. | [optional] 
+ **model_description** | **str**| Optional. Arbitrary description of the Model. | [optional] 
+ **model_url** | **str**| Optional. Immutable. Absolute URL to the Model. | [optional] 
+ **model_api_key** | **str**| Optional. API key used to access the Model. Not set for read calls (i.e. get, list) by public clients (front-end). Set only for internal (server-to-worker) communication. | [optional] 
+ **model_type** | **str**| Immutable. Type of this Model.   - MODEL_TYPE_UNSPECIFIED: Unspecified type.  - MODEL_TYPE_H2OGPTE_RAG: h2oGPTe RAG.  - MODEL_TYPE_OPENAI_RAG: OpenAI Assistant RAG.  - MODEL_TYPE_H2OGPTE_LLM: h2oGPTe LLM.  - MODEL_TYPE_H2OGPT_LLM: h2oGPT LLM.  - MODEL_TYPE_OPENAI_CHAT: OpenAI chat.  - MODEL_TYPE_AZURE_OPENAI_CHAT: Microsoft Azure hosted OpenAI Chat.  - MODEL_TYPE_OPENAI_API_CHAT: OpenAI API chat.  - MODEL_TYPE_H2OLLMOPS: H2O LLMOps.  - MODEL_TYPE_OLLAMA: Ollama.  - MODEL_TYPE_AMAZON_BEDROCK: Amazon Bedrock. | [optional] [default to &#39;MODEL_TYPE_UNSPECIFIED&#39;]
+ **model_parameters** | **str**| Optional. Model specific parameters in JSON format. | [optional] 
+ **model_demo** | **bool**| Output only. Whether the Model is a demo resource or not. Demo resources are read only. | [optional] 
+
+### Return type
+
+[**V1alphaListRAGCollectionsResponse**](V1alphaListRAGCollectionsResponse.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/EvaluatorServiceApi.md

@@ -0,0 +1,345 @@
+# eval_studio_client.api.EvaluatorServiceApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**evaluator_service_batch_delete_evaluators**](EvaluatorServiceApi.md#evaluator_service_batch_delete_evaluators) | **POST** /v1alpha/evaluators:batchDelete | 
+[**evaluator_service_create_evaluator**](EvaluatorServiceApi.md#evaluator_service_create_evaluator) | **POST** /v1alpha/evaluators | 
+[**evaluator_service_delete_evaluator**](EvaluatorServiceApi.md#evaluator_service_delete_evaluator) | **DELETE** /v1alpha/{name_2} | 
+[**evaluator_service_get_evaluator**](EvaluatorServiceApi.md#evaluator_service_get_evaluator) | **GET** /v1alpha/{name_2} | 
+[**evaluator_service_list_evaluators**](EvaluatorServiceApi.md#evaluator_service_list_evaluators) | **GET** /v1alpha/evaluators | 
+
+
+# **evaluator_service_batch_delete_evaluators**
+> V1alphaBatchDeleteEvaluatorsResponse evaluator_service_batch_delete_evaluators(body)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1alpha_batch_delete_evaluators_request import V1alphaBatchDeleteEvaluatorsRequest
+from eval_studio_client.api.models.v1alpha_batch_delete_evaluators_response import V1alphaBatchDeleteEvaluatorsResponse
+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.EvaluatorServiceApi(api_client)
+    body = eval_studio_client.api.V1alphaBatchDeleteEvaluatorsRequest() # V1alphaBatchDeleteEvaluatorsRequest | 
+
+    try:
+        api_response = api_instance.evaluator_service_batch_delete_evaluators(body)
+        print("The response of EvaluatorServiceApi->evaluator_service_batch_delete_evaluators:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EvaluatorServiceApi->evaluator_service_batch_delete_evaluators: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1alphaBatchDeleteEvaluatorsRequest**](V1alphaBatchDeleteEvaluatorsRequest.md)|  | 
+
+### Return type
+
+[**V1alphaBatchDeleteEvaluatorsResponse**](V1alphaBatchDeleteEvaluatorsResponse.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)
+
+# **evaluator_service_create_evaluator**
+> V1alphaCreateEvaluatorResponse evaluator_service_create_evaluator(evaluator)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1alpha_create_evaluator_response import V1alphaCreateEvaluatorResponse
+from eval_studio_client.api.models.v1alpha_evaluator import V1alphaEvaluator
+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.EvaluatorServiceApi(api_client)
+    evaluator = eval_studio_client.api.V1alphaEvaluator() # V1alphaEvaluator | Required. The Evaluator to create.
+
+    try:
+        api_response = api_instance.evaluator_service_create_evaluator(evaluator)
+        print("The response of EvaluatorServiceApi->evaluator_service_create_evaluator:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EvaluatorServiceApi->evaluator_service_create_evaluator: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **evaluator** | [**V1alphaEvaluator**](V1alphaEvaluator.md)| Required. The Evaluator to create. | 
+
+### Return type
+
+[**V1alphaCreateEvaluatorResponse**](V1alphaCreateEvaluatorResponse.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)
+
+# **evaluator_service_delete_evaluator**
+> V1alphaDeleteEvaluatorResponse evaluator_service_delete_evaluator(name_2)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1alpha_delete_evaluator_response import V1alphaDeleteEvaluatorResponse
+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.EvaluatorServiceApi(api_client)
+    name_2 = 'name_2_example' # str | Required. The name of the Evaluator to delete.
+
+    try:
+        api_response = api_instance.evaluator_service_delete_evaluator(name_2)
+        print("The response of EvaluatorServiceApi->evaluator_service_delete_evaluator:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EvaluatorServiceApi->evaluator_service_delete_evaluator: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name_2** | **str**| Required. The name of the Evaluator to delete. | 
+
+### Return type
+
+[**V1alphaDeleteEvaluatorResponse**](V1alphaDeleteEvaluatorResponse.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)
+
+# **evaluator_service_get_evaluator**
+> V1alphaGetEvaluatorResponse evaluator_service_get_evaluator(name_2)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1alpha_get_evaluator_response import V1alphaGetEvaluatorResponse
+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.EvaluatorServiceApi(api_client)
+    name_2 = 'name_2_example' # str | Required. The name of the Evaluator to retrieve.
+
+    try:
+        api_response = api_instance.evaluator_service_get_evaluator(name_2)
+        print("The response of EvaluatorServiceApi->evaluator_service_get_evaluator:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EvaluatorServiceApi->evaluator_service_get_evaluator: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name_2** | **str**| Required. The name of the Evaluator to retrieve. | 
+
+### Return type
+
+[**V1alphaGetEvaluatorResponse**](V1alphaGetEvaluatorResponse.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)
+
+# **evaluator_service_list_evaluators**
+> V1alphaListEvaluatorsResponse evaluator_service_list_evaluators(view=view)
+
+
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1alpha_list_evaluators_response import V1alphaListEvaluatorsResponse
+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.EvaluatorServiceApi(api_client)
+    view = 'EVALUATOR_VIEW_UNSPECIFIED' # str | Optional. View specifies the amount of information included in the Evaluator's description. Brief view includes only short descriptions, which can significantly decrease the amount of data transferred.   - EVALUATOR_VIEW_UNSPECIFIED: The default / unset value. The API will default to the EVALUATOR_VIEW_BRIEF.  - EVALUATOR_VIEW_BRIEF: Brief view of the Evaluator, which doesn't include the long description, only the brief one.  - EVALUATOR_VIEW_FULL: Full view of the evaluator, including brief and full description. (optional) (default to 'EVALUATOR_VIEW_UNSPECIFIED')
+
+    try:
+        api_response = api_instance.evaluator_service_list_evaluators(view=view)
+        print("The response of EvaluatorServiceApi->evaluator_service_list_evaluators:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EvaluatorServiceApi->evaluator_service_list_evaluators: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **view** | **str**| Optional. View specifies the amount of information included in the Evaluator's description. Brief view includes only short descriptions, which can significantly decrease the amount of data transferred.   - EVALUATOR_VIEW_UNSPECIFIED: The default / unset value. The API will default to the EVALUATOR_VIEW_BRIEF.  - EVALUATOR_VIEW_BRIEF: Brief view of the Evaluator, which doesn't include the long description, only the brief one.  - EVALUATOR_VIEW_FULL: Full view of the evaluator, including brief and full description. | [optional] [default to 'EVALUATOR_VIEW_UNSPECIFIED']
+
+### Return type
+
+[**V1alphaListEvaluatorsResponse**](V1alphaListEvaluatorsResponse.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)
+