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

eval_studio_client/api/docs/WorkflowServiceApi.md

@@ -1,417 +0,0 @@
-# eval_studio_client.api.WorkflowServiceApi
-
-All URIs are relative to *http://localhost*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**workflow_service_batch_delete_workflows**](WorkflowServiceApi.md#workflow_service_batch_delete_workflows) | **POST** /v1/workflows:batchDelete | BatchDeleteWorkflows deletes Workflows by names. If any of the Workflows do not exist an error is returned.
-[**workflow_service_create_workflow**](WorkflowServiceApi.md#workflow_service_create_workflow) | **POST** /v1/workflows | CreateWorkflow creates a Workflow.
-[**workflow_service_delete_workflow**](WorkflowServiceApi.md#workflow_service_delete_workflow) | **DELETE** /v1/{name_8} | DeleteWorkflow deletes a Workflow by name. If the Workflow does not exist an error is returned.
-[**workflow_service_get_workflow**](WorkflowServiceApi.md#workflow_service_get_workflow) | **GET** /v1/{name_11} | GetWorkflow retrieves a Workflow by name. Deleted Workflow is returned without error, it has a delete_time and deleter fields set.
-[**workflow_service_list_workflows**](WorkflowServiceApi.md#workflow_service_list_workflows) | **GET** /v1/workflows | ListWorkflows lists Workflows.
-[**workflow_service_update_workflow**](WorkflowServiceApi.md#workflow_service_update_workflow) | **PATCH** /v1/{workflow.name} | UpdateWorkflow updates a Workflow. The update_mask is used to specify the fields to be updated.
-
-
-# **workflow_service_batch_delete_workflows**
-> V1BatchDeleteWorkflowsResponse workflow_service_batch_delete_workflows(body)
-
-BatchDeleteWorkflows deletes Workflows by names. If any of the Workflows do not exist an error is returned.
-
-### Example
-
-
-```python
-import eval_studio_client.api
-from eval_studio_client.api.models.v1_batch_delete_workflows_request import V1BatchDeleteWorkflowsRequest
-from eval_studio_client.api.models.v1_batch_delete_workflows_response import V1BatchDeleteWorkflowsResponse
-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.WorkflowServiceApi(api_client)
-    body = eval_studio_client.api.V1BatchDeleteWorkflowsRequest() # V1BatchDeleteWorkflowsRequest | 
-
-    try:
-        # BatchDeleteWorkflows deletes Workflows by names. If any of the Workflows do not exist an error is returned.
-        api_response = api_instance.workflow_service_batch_delete_workflows(body)
-        print("The response of WorkflowServiceApi->workflow_service_batch_delete_workflows:\n")
-        pprint(api_response)
-    except Exception as e:
-        print("Exception when calling WorkflowServiceApi->workflow_service_batch_delete_workflows: %s\n" % e)
-```
-
-
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **body** | [**V1BatchDeleteWorkflowsRequest**](V1BatchDeleteWorkflowsRequest.md)|  | 
-
-### Return type
-
-[**V1BatchDeleteWorkflowsResponse**](V1BatchDeleteWorkflowsResponse.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)
-
-# **workflow_service_create_workflow**
-> V1CreateWorkflowResponse workflow_service_create_workflow(workflow)
-
-CreateWorkflow creates a Workflow.
-
-### Example
-
-
-```python
-import eval_studio_client.api
-from eval_studio_client.api.models.v1_create_workflow_response import V1CreateWorkflowResponse
-from eval_studio_client.api.models.v1_workflow import V1Workflow
-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.WorkflowServiceApi(api_client)
-    workflow = eval_studio_client.api.V1Workflow() # V1Workflow | Required. The Workflow to create.
-
-    try:
-        # CreateWorkflow creates a Workflow.
-        api_response = api_instance.workflow_service_create_workflow(workflow)
-        print("The response of WorkflowServiceApi->workflow_service_create_workflow:\n")
-        pprint(api_response)
-    except Exception as e:
-        print("Exception when calling WorkflowServiceApi->workflow_service_create_workflow: %s\n" % e)
-```
-
-
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **workflow** | [**V1Workflow**](V1Workflow.md)| Required. The Workflow to create. | 
-
-### Return type
-
-[**V1CreateWorkflowResponse**](V1CreateWorkflowResponse.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)
-
-# **workflow_service_delete_workflow**
-> V1DeleteWorkflowResponse workflow_service_delete_workflow(name_8)
-
-DeleteWorkflow deletes a Workflow by name. If the Workflow does not exist an error is returned.
-
-### Example
-
-
-```python
-import eval_studio_client.api
-from eval_studio_client.api.models.v1_delete_workflow_response import V1DeleteWorkflowResponse
-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.WorkflowServiceApi(api_client)
-    name_8 = 'name_8_example' # str | Required. The name of the Workflow to delete.
-
-    try:
-        # DeleteWorkflow deletes a Workflow by name. If the Workflow does not exist an error is returned.
-        api_response = api_instance.workflow_service_delete_workflow(name_8)
-        print("The response of WorkflowServiceApi->workflow_service_delete_workflow:\n")
-        pprint(api_response)
-    except Exception as e:
-        print("Exception when calling WorkflowServiceApi->workflow_service_delete_workflow: %s\n" % e)
-```
-
-
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **name_8** | **str**| Required. The name of the Workflow to delete. | 
-
-### Return type
-
-[**V1DeleteWorkflowResponse**](V1DeleteWorkflowResponse.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_service_get_workflow**
-> V1GetWorkflowResponse workflow_service_get_workflow(name_11)
-
-GetWorkflow retrieves a Workflow by name. Deleted Workflow is returned without error, it has a delete_time and deleter fields set.
-
-### Example
-
-
-```python
-import eval_studio_client.api
-from eval_studio_client.api.models.v1_get_workflow_response import V1GetWorkflowResponse
-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.WorkflowServiceApi(api_client)
-    name_11 = 'name_11_example' # str | Required. The name of the Workflow to retrieve.
-
-    try:
-        # GetWorkflow retrieves a Workflow by name. Deleted Workflow is returned without error, it has a delete_time and deleter fields set.
-        api_response = api_instance.workflow_service_get_workflow(name_11)
-        print("The response of WorkflowServiceApi->workflow_service_get_workflow:\n")
-        pprint(api_response)
-    except Exception as e:
-        print("Exception when calling WorkflowServiceApi->workflow_service_get_workflow: %s\n" % e)
-```
-
-
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **name_11** | **str**| Required. The name of the Workflow to retrieve. | 
-
-### Return type
-
-[**V1GetWorkflowResponse**](V1GetWorkflowResponse.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_service_list_workflows**
-> V1ListWorkflowsResponse workflow_service_list_workflows()
-
-ListWorkflows lists Workflows.
-
-### Example
-
-
-```python
-import eval_studio_client.api
-from eval_studio_client.api.models.v1_list_workflows_response import V1ListWorkflowsResponse
-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.WorkflowServiceApi(api_client)
-
-    try:
-        # ListWorkflows lists Workflows.
-        api_response = api_instance.workflow_service_list_workflows()
-        print("The response of WorkflowServiceApi->workflow_service_list_workflows:\n")
-        pprint(api_response)
-    except Exception as e:
-        print("Exception when calling WorkflowServiceApi->workflow_service_list_workflows: %s\n" % e)
-```
-
-
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-[**V1ListWorkflowsResponse**](V1ListWorkflowsResponse.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_service_update_workflow**
-> V1UpdateWorkflowResponse workflow_service_update_workflow(workflow_name, workflow)
-
-UpdateWorkflow updates a Workflow. The update_mask is used to specify the fields to be updated.
-
-### Example
-
-
-```python
-import eval_studio_client.api
-from eval_studio_client.api.models.required_the_updated_workflow import RequiredTheUpdatedWorkflow
-from eval_studio_client.api.models.v1_update_workflow_response import V1UpdateWorkflowResponse
-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.WorkflowServiceApi(api_client)
-    workflow_name = 'workflow_name_example' # str | Output only. Immutable. Resource name of the Workflow in format of `workflows/{workflow_id}`.
-    workflow = eval_studio_client.api.RequiredTheUpdatedWorkflow() # RequiredTheUpdatedWorkflow | Required. The updated Workflow.
-
-    try:
-        # UpdateWorkflow updates a Workflow. The update_mask is used to specify the fields to be updated.
-        api_response = api_instance.workflow_service_update_workflow(workflow_name, workflow)
-        print("The response of WorkflowServiceApi->workflow_service_update_workflow:\n")
-        pprint(api_response)
-    except Exception as e:
-        print("Exception when calling WorkflowServiceApi->workflow_service_update_workflow: %s\n" % e)
-```
-
-
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **workflow_name** | **str**| Output only. Immutable. Resource name of the Workflow in format of `workflows/{workflow_id}`. | 
- **workflow** | [**RequiredTheUpdatedWorkflow**](RequiredTheUpdatedWorkflow.md)| Required. The updated Workflow. | 
-
-### Return type
-
-[**V1UpdateWorkflowResponse**](V1UpdateWorkflowResponse.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/models/protobuf_null_value.py

@@ -1,36 +0,0 @@
-# coding: utf-8
-
-"""
-    ai/h2o/eval_studio/v1/collection.proto
-
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
-
-    The version of the OpenAPI document: version not set
-    Generated by OpenAPI Generator (https://openapi-generator.tech)
-
-    Do not edit the class manually.
-"""  # noqa: E501
-
-
-from __future__ import annotations
-import json
-from enum import Enum
-from typing_extensions import Self
-
-
-class ProtobufNullValue(str, Enum):
-    """
-    `NullValue` is a singleton enumeration to represent the null value for the `Value` type union.  The JSON representation for `NullValue` is JSON `null`.   - NULL_VALUE: Null value.
-    """
-
-    """
-    allowed enum values
-    """
-    NULL_VALUE = 'NULL_VALUE'
-
-    @classmethod
-    def from_json(cls, json_str: str) -> Self:
-        """Create an instance of ProtobufNullValue from a JSON string"""
-        return cls(json.loads(json_str))
-
-

eval_studio_client/api/models/required_the_updated_workflow.py

@@ -1,152 +0,0 @@
-# coding: utf-8
-
-"""
-    ai/h2o/eval_studio/v1/collection.proto
-
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
-
-    The version of the OpenAPI document: version not set
-    Generated by OpenAPI Generator (https://openapi-generator.tech)
-
-    Do not edit the class manually.
-"""  # noqa: E501
-
-
-from __future__ import annotations
-import pprint
-import re  # noqa: F401
-import json
-
-from datetime import datetime
-from pydantic import BaseModel, ConfigDict, Field, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional
-from eval_studio_client.api.models.v1_workflow_node_artifacts import V1WorkflowNodeArtifacts
-from eval_studio_client.api.models.v1_workflow_type import V1WorkflowType
-from typing import Optional, Set
-from typing_extensions import Self
-
-class RequiredTheUpdatedWorkflow(BaseModel):
-    """
-    RequiredTheUpdatedWorkflow
-    """ # noqa: E501
-    display_name: Optional[StrictStr] = Field(default=None, description="Human-readable name of the Workflow.", alias="displayName")
-    description: Optional[StrictStr] = Field(default=None, description="Optional description of the Workflow.")
-    create_time: Optional[datetime] = Field(default=None, description="Output only. Immutable. Creation time of the Workflow.", alias="createTime")
-    creator: Optional[StrictStr] = Field(default=None, description="Output only. Immutable. Name of the user or service that requested creation of the Workflow.")
-    update_time: Optional[datetime] = Field(default=None, description="Output only. Optional. Last update time of the Workflow.", alias="updateTime")
-    updater: Optional[StrictStr] = Field(default=None, description="Output only. Name of the user or service that requested update of the Workflow.")
-    delete_time: Optional[datetime] = Field(default=None, description="Output only. Optional. Deletion time of the Workflow.", alias="deleteTime")
-    deleter: Optional[StrictStr] = Field(default=None, description="Output only. Name of the user or service that requested deletion of the Workflow.")
-    type: Optional[V1WorkflowType] = None
-    model: Optional[StrictStr] = Field(default=None, description="Immutable. Resource name of the Model associated with this Workflow.")
-    nodes: Optional[List[StrictStr]] = Field(default=None, description="Output only. List of the WorkflowNodes in the Workflow.")
-    edges: Optional[List[StrictStr]] = Field(default=None, description="Output only. List of the WorkflowEdges in the Workflow.")
-    outputs: Optional[Dict[str, Dict[str, Any]]] = Field(default=None, description="Output only. Optional. Computed outputs of all the WorkflowNodes in the Workflow.")
-    output_artifacts: Optional[Dict[str, V1WorkflowNodeArtifacts]] = Field(default=None, description="Output only. Optional. List of the WorkflowNodeArtifacts produces by all the WorkflowNodes in the Workflow.", alias="outputArtifacts")
-    llm_model: Optional[StrictStr] = Field(default=None, description="Immutable. LLM Model to use.", alias="llmModel")
-    model_parameters: Optional[StrictStr] = Field(default=None, description="Optional. Immutable. Model parameter overrides in JSON format.", alias="modelParameters")
-    __properties: ClassVar[List[str]] = ["displayName", "description", "createTime", "creator", "updateTime", "updater", "deleteTime", "deleter", "type", "model", "nodes", "edges", "outputs", "outputArtifacts", "llmModel", "modelParameters"]
-
-    model_config = ConfigDict(
-        populate_by_name=True,
-        validate_assignment=True,
-        protected_namespaces=(),
-    )
-
-
-    def to_str(self) -> str:
-        """Returns the string representation of the model using alias"""
-        return pprint.pformat(self.model_dump(by_alias=True))
-
-    def to_json(self) -> str:
-        """Returns the JSON representation of the model using alias"""
-        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
-        return json.dumps(self.to_dict())
-
-    @classmethod
-    def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of RequiredTheUpdatedWorkflow from a JSON string"""
-        return cls.from_dict(json.loads(json_str))
-
-    def to_dict(self) -> Dict[str, Any]:
-        """Return the dictionary representation of the model using alias.
-
-        This has the following differences from calling pydantic's
-        `self.model_dump(by_alias=True)`:
-
-        * `None` is only added to the output dict for nullable fields that
-          were set at model initialization. Other fields with value `None`
-          are ignored.
-        * OpenAPI `readOnly` fields are excluded.
-        * OpenAPI `readOnly` fields are excluded.
-        * OpenAPI `readOnly` fields are excluded.
-        * OpenAPI `readOnly` fields are excluded.
-        * OpenAPI `readOnly` fields are excluded.
-        * OpenAPI `readOnly` fields are excluded.
-        * OpenAPI `readOnly` fields are excluded.
-        * OpenAPI `readOnly` fields are excluded.
-        * OpenAPI `readOnly` fields are excluded.
-        * OpenAPI `readOnly` fields are excluded.
-        """
-        excluded_fields: Set[str] = set([
-            "create_time",
-            "creator",
-            "update_time",
-            "updater",
-            "delete_time",
-            "deleter",
-            "nodes",
-            "edges",
-            "outputs",
-            "output_artifacts",
-        ])
-
-        _dict = self.model_dump(
-            by_alias=True,
-            exclude=excluded_fields,
-            exclude_none=True,
-        )
-        # override the default output from pydantic by calling `to_dict()` of each value in output_artifacts (dict)
-        _field_dict = {}
-        if self.output_artifacts:
-            for _key in self.output_artifacts:
-                if self.output_artifacts[_key]:
-                    _field_dict[_key] = self.output_artifacts[_key].to_dict()
-            _dict['outputArtifacts'] = _field_dict
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of RequiredTheUpdatedWorkflow from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "displayName": obj.get("displayName"),
-            "description": obj.get("description"),
-            "createTime": obj.get("createTime"),
-            "creator": obj.get("creator"),
-            "updateTime": obj.get("updateTime"),
-            "updater": obj.get("updater"),
-            "deleteTime": obj.get("deleteTime"),
-            "deleter": obj.get("deleter"),
-            "type": obj.get("type"),
-            "model": obj.get("model"),
-            "nodes": obj.get("nodes"),
-            "edges": obj.get("edges"),
-            "outputs": obj.get("outputs"),
-            "outputArtifacts": dict(
-                (_k, V1WorkflowNodeArtifacts.from_dict(_v))
-                for _k, _v in obj["outputArtifacts"].items()
-            )
-            if obj.get("outputArtifacts") is not None
-            else None,
-            "llmModel": obj.get("llmModel"),
-            "modelParameters": obj.get("modelParameters")
-        })
-        return _obj
-
-