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

eval_studio_client/api/docs/V1alphaProblemAndAction.md

@@ -0,0 +1,39 @@
+# V1alphaProblemAndAction
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **str** | Output only. Problem description. | [optional] [readonly] 
+**severity** | **str** | Output only. Problem severity. | [optional] [readonly] 
+**problem_type** | **str** | Output only. Problem type. | [optional] [readonly] 
+**problem_attrs** | **Dict[str, str]** | Output only. Problem attributes. | [optional] [readonly] 
+**actions_description** | **str** | Output only. Description of actions to mitigate the problem. | [optional] [readonly] 
+**explainer_id** | **str** | Output only. ID of the explainer which identified the problem. | [optional] [readonly] 
+**explainer_name** | **str** | Output only. Display name of the explainer which identified the problem. | [optional] [readonly] 
+**explanation_type** | **str** | Output only. Type of the explanation which can clarify the problem. | [optional] [readonly] 
+**explanation_name** | **str** | Output only. Name of the explanation which can clarify the problem. | [optional] [readonly] 
+**explanation_mime** | **str** | Output only. Media type of the explanation which can clarify the problem. | [optional] [readonly] 
+**resources** | **List[str]** | Output only. Problem resources. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1alpha_problem_and_action import V1alphaProblemAndAction
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1alphaProblemAndAction from a JSON string
+v1alpha_problem_and_action_instance = V1alphaProblemAndAction.from_json(json)
+# print the JSON string representation of the object
+print(V1alphaProblemAndAction.to_json())
+
+# convert the object into a dict
+v1alpha_problem_and_action_dict = v1alpha_problem_and_action_instance.to_dict()
+# create an instance of V1alphaProblemAndAction from a dict
+v1alpha_problem_and_action_from_dict = V1alphaProblemAndAction.from_dict(v1alpha_problem_and_action_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/V1alphaTest.md

@@ -0,0 +1,40 @@
+# V1alphaTest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | [optional] [readonly] 
+**create_time** | **datetime** | Output only. Timestamp when the Test was created. | [optional] [readonly] 
+**creator** | **str** | Output only. Name of the user or service that requested creation of the Test. | [optional] [readonly] 
+**update_time** | **datetime** | Output only. Optional. Timestamp when the Test was last updated. | [optional] [readonly] 
+**updater** | **str** | Output only. Optional. Name of the user or service that requested update of the Test. | [optional] [readonly] 
+**delete_time** | **datetime** | Output only. Optional. Set when the Test is deleted. When set, Test should be considered as deleted. | [optional] [readonly] 
+**deleter** | **str** | Output only. Optional. Name of the user or service that requested deletion of the Test. | [optional] [readonly] 
+**display_name** | **str** | Human readable name of the Test. | [optional] 
+**description** | **str** | Optional. Arbitrary description of the Test. | [optional] 
+**documents** | **List[str]** | Immutable. Resource names of Documents assigned to the Test. | [optional] 
+**tags** | **List[str]** | Tags assigned to the Test. | [optional] 
+**demo** | **bool** | Output only. Whether the Test is a demo resource or not. Demo resources are read only. | [optional] [readonly] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1alpha_test import V1alphaTest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1alphaTest from a JSON string
+v1alpha_test_instance = V1alphaTest.from_json(json)
+# print the JSON string representation of the object
+print(V1alphaTest.to_json())
+
+# convert the object into a dict
+v1alpha_test_dict = v1alpha_test_instance.to_dict()
+# create an instance of V1alphaTest from a dict
+v1alpha_test_from_dict = V1alphaTest.from_dict(v1alpha_test_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/V1alphaTestCase.md

@@ -0,0 +1,40 @@
+# V1alphaTestCase
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | [optional] [readonly] 
+**create_time** | **datetime** | Output only. Timestamp when the Test was created. | [optional] [readonly] 
+**creator** | **str** | Output only. Name of the user or service that requested creation of the TestCase. | [optional] [readonly] 
+**update_time** | **datetime** | Output only. Optional. Timestamp when the TestCase was last updated. | [optional] [readonly] 
+**updater** | **str** | Output only. Optional. Name of the user or service that requested update of the TestCase. | [optional] [readonly] 
+**delete_time** | **datetime** | Output only. Optional. Set when the TestCase is deleted. When set TestCase should be considered as deleted. | [optional] [readonly] 
+**deleter** | **str** | Output only. Optional. Name of the user or service that requested deletion of the TestCase. | [optional] [readonly] 
+**parent** | **str** | Parent Test resource name. e.g.: \"tests/<UUID>\". | [optional] 
+**prompt** | **str** | Prompt text. Model input. | [optional] 
+**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] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1alpha_test_case import V1alphaTestCase
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1alphaTestCase from a JSON string
+v1alpha_test_case_instance = V1alphaTestCase.from_json(json)
+# print the JSON string representation of the object
+print(V1alphaTestCase.to_json())
+
+# convert the object into a dict
+v1alpha_test_case_dict = v1alpha_test_case_instance.to_dict()
+# create an instance of V1alphaTestCase from a dict
+v1alpha_test_case_from_dict = V1alphaTestCase.from_dict(v1alpha_test_case_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/V1alphaTestCaseRelationship.md

@@ -0,0 +1,31 @@
+# V1alphaTestCaseRelationship
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source** | **str** | Required. Source test case. | [optional] 
+**target** | **str** | Required. Target test case. | [optional] 
+**type** | **str** | Required. Type of the relationship. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1alpha_test_case_relationship import V1alphaTestCaseRelationship
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1alphaTestCaseRelationship from a JSON string
+v1alpha_test_case_relationship_instance = V1alphaTestCaseRelationship.from_json(json)
+# print the JSON string representation of the object
+print(V1alphaTestCaseRelationship.to_json())
+
+# convert the object into a dict
+v1alpha_test_case_relationship_dict = v1alpha_test_case_relationship_instance.to_dict()
+# create an instance of V1alphaTestCaseRelationship from a dict
+v1alpha_test_case_relationship_from_dict = V1alphaTestCaseRelationship.from_dict(v1alpha_test_case_relationship_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/V1alphaTestClass.md

@@ -0,0 +1,41 @@
+# V1alphaTestClass
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | [optional] [readonly] 
+**create_time** | **datetime** | Output only. Timestamp when the TestClass was created. | [optional] [readonly] 
+**creator** | **str** | Output only. Name of the user or service that requested creation of the TestClass. | [optional] [readonly] 
+**update_time** | **datetime** | Output only. Optional. Timestamp when the TestClass was last updated. | [optional] [readonly] 
+**updater** | **str** | Output only. Optional. Name of the user or service that requested update of the TestClass. | [optional] [readonly] 
+**delete_time** | **datetime** | Output only. Optional. Set when the TestClass is deleted. When set, TestClass should be considered as deleted. | [optional] [readonly] 
+**deleter** | **str** | Output only. Optional. Name of the user or service that requested deletion of the TestClass. | [optional] [readonly] 
+**display_name** | **str** | Human readable name of the TestClass. | [optional] 
+**description** | **str** | Optional. Arbitrary description of the TestClass. | [optional] 
+**evaluators** | **List[str]** | List of evaluators that are part of the TestClass. | [optional] 
+**recommended_tests** | **List[str]** | List of recommended Tests that are part of the TestClass. | [optional] 
+**test_class_type** | [**V1alphaTestClassType**](V1alphaTestClassType.md) |  | [optional] 
+**tags** | **List[str]** | List of tags. Can contain any string, some examples are \"SR 11-7\", \"NIST\", etc. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1alpha_test_class import V1alphaTestClass
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1alphaTestClass from a JSON string
+v1alpha_test_class_instance = V1alphaTestClass.from_json(json)
+# print the JSON string representation of the object
+print(V1alphaTestClass.to_json())
+
+# convert the object into a dict
+v1alpha_test_class_dict = v1alpha_test_class_instance.to_dict()
+# create an instance of V1alphaTestClass from a dict
+v1alpha_test_class_from_dict = V1alphaTestClass.from_dict(v1alpha_test_class_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/V1alphaTestClassType.md

@@ -0,0 +1,12 @@
+# V1alphaTestClassType
+
+ - TEST_CLASS_TYPE_UNSPECIFIED: Unspecified TestClass type.  - TEST_CLASS_TYPE_STANDARD: TestClass type corresponding to a certain standard.  - TEST_CLASS_TYPE_ROLE: TestClass type corresponding to a certain role.  - TEST_CLASS_TYPE_PROBLEM: TestClass type corresponding to a certain problem.  - TEST_CLASS_TYPE_PURPOSE: TestClass type corresponding to a certain purpose.  - TEST_CLASS_TYPE_METHOD: TestClass type corresponding to a certain method.  - TEST_CLASS_TYPE_METHOD_TYPE: TestClass type corresponding to a certain method type.
+
+## 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/V1alphaTestLab.md

@@ -0,0 +1,41 @@
+# V1alphaTestLab
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | [optional] [readonly] 
+**create_time** | **datetime** | Output only. Timestamp when the Test was created. | [optional] [readonly] 
+**creator** | **str** | Output only. Name of the user or service that requested creation of the TestCase. | [optional] [readonly] 
+**update_time** | **datetime** | Output only. Optional. Timestamp when the TestCase was last updated. | [optional] [readonly] 
+**updater** | **str** | Output only. Optional. Name of the user or service that requested update of the TestCase. | [optional] [readonly] 
+**delete_time** | **datetime** | Output only. Optional. Set when the TestCase is deleted. When set TestCase should be considered as deleted. | [optional] [readonly] 
+**deleter** | **str** | Output only. Optional. Name of the user or service that requested deletion of the TestCase. | [optional] [readonly] 
+**model** | **str** | Immutable. Model used in this test lab. | [optional] 
+**test_cases** | **List[str]** | Immutable. Test cases used in this test lab. | [optional] 
+**content** | **bytearray** | Immutable. Raw content of the Test Lab. | [optional] 
+**llm_models** | **List[str]** | Immutable. List of LLM models used. | [optional] 
+**model_parameters** | **str** | Immutable. Optional. Parameters overrides in JSON format. | [optional] 
+**h2ogpte_collection** | **str** | The existing collection name in H2OGPTe. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1alpha_test_lab import V1alphaTestLab
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1alphaTestLab from a JSON string
+v1alpha_test_lab_instance = V1alphaTestLab.from_json(json)
+# print the JSON string representation of the object
+print(V1alphaTestLab.to_json())
+
+# convert the object into a dict
+v1alpha_test_lab_dict = v1alpha_test_lab_instance.to_dict()
+# create an instance of V1alphaTestLab from a dict
+v1alpha_test_lab_from_dict = V1alphaTestLab.from_dict(v1alpha_test_lab_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/V1alphaUpdateDashboardResponse.md

@@ -0,0 +1,29 @@
+# V1alphaUpdateDashboardResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dashboard** | [**V1alphaDashboard**](V1alphaDashboard.md) |  | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1alpha_update_dashboard_response import V1alphaUpdateDashboardResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1alphaUpdateDashboardResponse from a JSON string
+v1alpha_update_dashboard_response_instance = V1alphaUpdateDashboardResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1alphaUpdateDashboardResponse.to_json())
+
+# convert the object into a dict
+v1alpha_update_dashboard_response_dict = v1alpha_update_dashboard_response_instance.to_dict()
+# create an instance of V1alphaUpdateDashboardResponse from a dict
+v1alpha_update_dashboard_response_from_dict = V1alphaUpdateDashboardResponse.from_dict(v1alpha_update_dashboard_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/V1alphaUpdateDocumentResponse.md

@@ -0,0 +1,29 @@
+# V1alphaUpdateDocumentResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**document** | [**V1alphaDocument**](V1alphaDocument.md) |  | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1alpha_update_document_response import V1alphaUpdateDocumentResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1alphaUpdateDocumentResponse from a JSON string
+v1alpha_update_document_response_instance = V1alphaUpdateDocumentResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1alphaUpdateDocumentResponse.to_json())
+
+# convert the object into a dict
+v1alpha_update_document_response_dict = v1alpha_update_document_response_instance.to_dict()
+# create an instance of V1alphaUpdateDocumentResponse from a dict
+v1alpha_update_document_response_from_dict = V1alphaUpdateDocumentResponse.from_dict(v1alpha_update_document_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/V1alphaUpdateLeaderboardResponse.md

@@ -0,0 +1,29 @@
+# V1alphaUpdateLeaderboardResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**leaderboard** | [**V1alphaLeaderboard**](V1alphaLeaderboard.md) |  | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1alpha_update_leaderboard_response import V1alphaUpdateLeaderboardResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1alphaUpdateLeaderboardResponse from a JSON string
+v1alpha_update_leaderboard_response_instance = V1alphaUpdateLeaderboardResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1alphaUpdateLeaderboardResponse.to_json())
+
+# convert the object into a dict
+v1alpha_update_leaderboard_response_dict = v1alpha_update_leaderboard_response_instance.to_dict()
+# create an instance of V1alphaUpdateLeaderboardResponse from a dict
+v1alpha_update_leaderboard_response_from_dict = V1alphaUpdateLeaderboardResponse.from_dict(v1alpha_update_leaderboard_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/V1alphaUpdateModelResponse.md

@@ -0,0 +1,29 @@
+# V1alphaUpdateModelResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**model** | [**V1alphaModel**](V1alphaModel.md) |  | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1alpha_update_model_response import V1alphaUpdateModelResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1alphaUpdateModelResponse from a JSON string
+v1alpha_update_model_response_instance = V1alphaUpdateModelResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1alphaUpdateModelResponse.to_json())
+
+# convert the object into a dict
+v1alpha_update_model_response_dict = v1alpha_update_model_response_instance.to_dict()
+# create an instance of V1alphaUpdateModelResponse from a dict
+v1alpha_update_model_response_from_dict = V1alphaUpdateModelResponse.from_dict(v1alpha_update_model_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/V1alphaUpdateOperationResponse.md

@@ -0,0 +1,29 @@
+# V1alphaUpdateOperationResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**operation** | [**V1alphaOperation**](V1alphaOperation.md) |  | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1alpha_update_operation_response import V1alphaUpdateOperationResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1alphaUpdateOperationResponse from a JSON string
+v1alpha_update_operation_response_instance = V1alphaUpdateOperationResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1alphaUpdateOperationResponse.to_json())
+
+# convert the object into a dict
+v1alpha_update_operation_response_dict = v1alpha_update_operation_response_instance.to_dict()
+# create an instance of V1alphaUpdateOperationResponse from a dict
+v1alpha_update_operation_response_from_dict = V1alphaUpdateOperationResponse.from_dict(v1alpha_update_operation_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/V1alphaUpdateTestCaseResponse.md

@@ -0,0 +1,29 @@
+# V1alphaUpdateTestCaseResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**test_case** | [**V1alphaTestCase**](V1alphaTestCase.md) |  | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1alpha_update_test_case_response import V1alphaUpdateTestCaseResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1alphaUpdateTestCaseResponse from a JSON string
+v1alpha_update_test_case_response_instance = V1alphaUpdateTestCaseResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1alphaUpdateTestCaseResponse.to_json())
+
+# convert the object into a dict
+v1alpha_update_test_case_response_dict = v1alpha_update_test_case_response_instance.to_dict()
+# create an instance of V1alphaUpdateTestCaseResponse from a dict
+v1alpha_update_test_case_response_from_dict = V1alphaUpdateTestCaseResponse.from_dict(v1alpha_update_test_case_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/V1alphaUpdateTestResponse.md

@@ -0,0 +1,29 @@
+# V1alphaUpdateTestResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**test** | [**V1alphaTest**](V1alphaTest.md) |  | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1alpha_update_test_response import V1alphaUpdateTestResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1alphaUpdateTestResponse from a JSON string
+v1alpha_update_test_response_instance = V1alphaUpdateTestResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1alphaUpdateTestResponse.to_json())
+
+# convert the object into a dict
+v1alpha_update_test_response_dict = v1alpha_update_test_response_instance.to_dict()
+# create an instance of V1alphaUpdateTestResponse from a dict
+v1alpha_update_test_response_from_dict = V1alphaUpdateTestResponse.from_dict(v1alpha_update_test_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/V1alphaWhoAmIResponse.md

@@ -0,0 +1,31 @@
+# V1alphaWhoAmIResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sub** | **str** | The caller's identity. | [optional] 
+**preferred_username** | **str** | The caller's preferred username. Might be empty. | [optional] 
+**email** | **str** | The caller's email address. Might be empty. | [optional] 
+
+## Example
+
+```python
+from eval_studio_client.api.models.v1alpha_who_am_i_response import V1alphaWhoAmIResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1alphaWhoAmIResponse from a JSON string
+v1alpha_who_am_i_response_instance = V1alphaWhoAmIResponse.from_json(json)
+# print the JSON string representation of the object
+print(V1alphaWhoAmIResponse.to_json())
+
+# convert the object into a dict
+v1alpha_who_am_i_response_dict = v1alpha_who_am_i_response_instance.to_dict()
+# create an instance of V1alphaWhoAmIResponse from a dict
+v1alpha_who_am_i_response_from_dict = V1alphaWhoAmIResponse.from_dict(v1alpha_who_am_i_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/WhoAmIServiceApi.md

@@ -0,0 +1,72 @@
+# eval_studio_client.api.WhoAmIServiceApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**who_am_i_service_who_am_i**](WhoAmIServiceApi.md#who_am_i_service_who_am_i) | **GET** /v1alpha/whoAmI | WhoAmI is used to retrieve the caller's identity.
+
+
+# **who_am_i_service_who_am_i**
+> V1alphaWhoAmIResponse who_am_i_service_who_am_i()
+
+WhoAmI is used to retrieve the caller's identity.
+
+### Example
+
+
+```python
+import eval_studio_client.api
+from eval_studio_client.api.models.v1alpha_who_am_i_response import V1alphaWhoAmIResponse
+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.WhoAmIServiceApi(api_client)
+
+    try:
+        # WhoAmI is used to retrieve the caller's identity.
+        api_response = api_instance.who_am_i_service_who_am_i()
+        print("The response of WhoAmIServiceApi->who_am_i_service_who_am_i:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WhoAmIServiceApi->who_am_i_service_who_am_i: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**V1alphaWhoAmIResponse**](V1alphaWhoAmIResponse.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)
+