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

eval_studio_client/api/models/v1alpha_get_test_response.py

@@ -0,0 +1,91 @@
+# coding: utf-8
+
+"""
+    ai/h2o/eval_studio/v1alpha/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 pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List, Optional
+from eval_studio_client.api.models.v1alpha_test import V1alphaTest
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V1alphaGetTestResponse(BaseModel):
+    """
+    V1alphaGetTestResponse
+    """ # noqa: E501
+    test: Optional[V1alphaTest] = None
+    __properties: ClassVar[List[str]] = ["test"]
+
+    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 V1alphaGetTestResponse 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of test
+        if self.test:
+            _dict['test'] = self.test.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1alphaGetTestResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "test": V1alphaTest.from_dict(obj["test"]) if obj.get("test") is not None else None
+        })
+        return _obj
+
+

eval_studio_client/api/models/v1alpha_import_evaluation_request.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    ai/h2o/eval_studio/v1alpha/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 pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from eval_studio_client.api.models.v1alpha_model import V1alphaModel
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V1alphaImportEvaluationRequest(BaseModel):
+    """
+    V1alphaImportEvaluationRequest
+    """ # noqa: E501
+    evaluator_identifiers: Optional[List[StrictStr]] = Field(default=None, description="Required. Evaluator identifiers to use, not the resource names.", alias="evaluatorIdentifiers")
+    model: Optional[V1alphaModel] = None
+    test_lab: Optional[StrictStr] = Field(default=None, description="Required. The JSON representation of the pre-built test-lab.", alias="testLab")
+    operation: Optional[StrictStr] = Field(default=None, description="Required. Resource name of the long-running operation.")
+    evaluators_parameters: Optional[Dict[str, StrictStr]] = Field(default=None, description="Optional. Additional evaluators configuration, for all the evaluators used in the evaluation. Key is the evaluator identifier, and the value is a JSON string containing the configuration dictionary.", alias="evaluatorsParameters")
+    __properties: ClassVar[List[str]] = ["evaluatorIdentifiers", "model", "testLab", "operation", "evaluatorsParameters"]
+
+    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 V1alphaImportEvaluationRequest 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of model
+        if self.model:
+            _dict['model'] = self.model.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1alphaImportEvaluationRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "evaluatorIdentifiers": obj.get("evaluatorIdentifiers"),
+            "model": V1alphaModel.from_dict(obj["model"]) if obj.get("model") is not None else None,
+            "testLab": obj.get("testLab"),
+            "operation": obj.get("operation"),
+            "evaluatorsParameters": obj.get("evaluatorsParameters")
+        })
+        return _obj
+
+

eval_studio_client/api/models/v1alpha_import_leaderboard_request.py

@@ -0,0 +1,104 @@
+# coding: utf-8
+
+"""
+    ai/h2o/eval_studio/v1alpha/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 pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from eval_studio_client.api.models.v1alpha_leaderboard_type import V1alphaLeaderboardType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V1alphaImportLeaderboardRequest(BaseModel):
+    """
+    V1alphaImportLeaderboardRequest
+    """ # noqa: E501
+    test_lab_json: Optional[StrictStr] = Field(default=None, description="Test Lab in JSON format.", alias="testLabJson")
+    url: Optional[StrictStr] = Field(default=None, description="URL pointing to a Test Lab in JSON format to import.")
+    evaluator: Optional[StrictStr] = Field(default=None, description="Required. Resource name of the Evaluator used in this Leaderboard.")
+    model: Optional[StrictStr] = Field(default=None, description="Required. Resource name of the Model used in this Leaderboard.")
+    test_display_name: Optional[StrictStr] = Field(default=None, description="Required. Display name of the newly created Test.", alias="testDisplayName")
+    test_description: Optional[StrictStr] = Field(default=None, description="Optional. Description of the newly created Test.", alias="testDescription")
+    leaderboard_display_name: Optional[StrictStr] = Field(default=None, description="Required. Display name of the newly created Leaderboard.", alias="leaderboardDisplayName")
+    leaderboard_description: Optional[StrictStr] = Field(default=None, description="Optional. Description of the newly created Leaderboard.", alias="leaderboardDescription")
+    leaderboard_type: Optional[V1alphaLeaderboardType] = Field(default=None, alias="leaderboardType")
+    __properties: ClassVar[List[str]] = ["testLabJson", "url", "evaluator", "model", "testDisplayName", "testDescription", "leaderboardDisplayName", "leaderboardDescription", "leaderboardType"]
+
+    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 V1alphaImportLeaderboardRequest 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1alphaImportLeaderboardRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "testLabJson": obj.get("testLabJson"),
+            "url": obj.get("url"),
+            "evaluator": obj.get("evaluator"),
+            "model": obj.get("model"),
+            "testDisplayName": obj.get("testDisplayName"),
+            "testDescription": obj.get("testDescription"),
+            "leaderboardDisplayName": obj.get("leaderboardDisplayName"),
+            "leaderboardDescription": obj.get("leaderboardDescription"),
+            "leaderboardType": obj.get("leaderboardType")
+        })
+        return _obj
+
+

eval_studio_client/api/models/v1alpha_import_leaderboard_response.py

@@ -0,0 +1,91 @@
+# coding: utf-8
+
+"""
+    ai/h2o/eval_studio/v1alpha/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 pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List, Optional
+from eval_studio_client.api.models.v1alpha_operation import V1alphaOperation
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V1alphaImportLeaderboardResponse(BaseModel):
+    """
+    V1alphaImportLeaderboardResponse
+    """ # noqa: E501
+    operation: Optional[V1alphaOperation] = None
+    __properties: ClassVar[List[str]] = ["operation"]
+
+    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 V1alphaImportLeaderboardResponse 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of operation
+        if self.operation:
+            _dict['operation'] = self.operation.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1alphaImportLeaderboardResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "operation": V1alphaOperation.from_dict(obj["operation"]) if obj.get("operation") is not None else None
+        })
+        return _obj
+
+

eval_studio_client/api/models/v1alpha_info.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    ai/h2o/eval_studio/v1alpha/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 pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V1alphaInfo(BaseModel):
+    """
+    V1alphaInfo
+    """ # noqa: E501
+    base_url: Optional[StrictStr] = Field(default=None, description="The base absolute URL of the Eval Studio instance.", alias="baseUrl")
+    version: Optional[StrictStr] = Field(default=None, description="The version of the Eval Studio instance.")
+    oauth2_login_url: Optional[StrictStr] = Field(default=None, description="The URL for initiating the OAuth2 flow.", alias="oauth2LoginUrl")
+    oauth2_logout_url: Optional[StrictStr] = Field(default=None, description="The URL for logging out.", alias="oauth2LogoutUrl")
+    h2o_gpte_allowlist: Optional[List[StrictStr]] = Field(default=None, description="Allowlist of H2OGPTe models for UI that can be used in Eval Studio. E.g. gpt-35-turbo-1106, h2oai/h2ogpt-4096-llama2-13b-chat, h2oai/h2ogpt-4096-llama2-70b-chat-4bit, HuggingFaceH4/zephyr-7b-beta, h2oai/h2ogpt-gm-7b-mistral-chat-sft-dpo-v1, h2oai/h2ogpt-gm-experimental.", alias="h2oGpteAllowlist")
+    h2o_gpte_client_version: Optional[StrictStr] = Field(default=None, description="The version of h2oGPTe client used by the workers.", alias="h2oGpteClientVersion")
+    h2o_sonar_version: Optional[StrictStr] = Field(default=None, description="The version of H2O Sonar used by the workers.", alias="h2oSonarVersion")
+    __properties: ClassVar[List[str]] = ["baseUrl", "version", "oauth2LoginUrl", "oauth2LogoutUrl", "h2oGpteAllowlist", "h2oGpteClientVersion", "h2oSonarVersion"]
+
+    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 V1alphaInfo 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1alphaInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "baseUrl": obj.get("baseUrl"),
+            "version": obj.get("version"),
+            "oauth2LoginUrl": obj.get("oauth2LoginUrl"),
+            "oauth2LogoutUrl": obj.get("oauth2LogoutUrl"),
+            "h2oGpteAllowlist": obj.get("h2oGpteAllowlist"),
+            "h2oGpteClientVersion": obj.get("h2oGpteClientVersion"),
+            "h2oSonarVersion": obj.get("h2oSonarVersion")
+        })
+        return _obj
+
+

eval_studio_client/api/models/v1alpha_insight.py

@@ -0,0 +1,107 @@
+# coding: utf-8
+
+"""
+    ai/h2o/eval_studio/v1alpha/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 pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V1alphaInsight(BaseModel):
+    """
+    Insight represents additional information about the evaluation.
+    """ # noqa: E501
+    description: Optional[StrictStr] = Field(default=None, description="Description of the insight.")
+    actions_description: Optional[StrictStr] = Field(default=None, description="Description of the actions that can be taken based on the insight.", alias="actionsDescription")
+    actions_codes: Optional[List[StrictStr]] = Field(default=None, description="List of codes that can be used to take actions based on the insight.", alias="actionsCodes")
+    evaluator_id: Optional[StrictStr] = Field(default=None, alias="evaluatorId")
+    evaluator_display_name: Optional[StrictStr] = Field(default=None, description="Human readable name of the evaluator that generated the insight, e.g. Tokens presence.", alias="evaluatorDisplayName")
+    explanation_type: Optional[StrictStr] = Field(default=None, description="Type of the explanation.", alias="explanationType")
+    explanation_name: Optional[StrictStr] = Field(default=None, description="Name of the explanation.", alias="explanationName")
+    explanation_mime: Optional[StrictStr] = Field(default=None, description="MIME type of the explanation.", alias="explanationMime")
+    resources: Optional[List[StrictStr]] = Field(default=None, description="List of resources that can be used to take actions based on the insight.")
+    insight_type: Optional[StrictStr] = Field(default=None, description="Type of the insight.", alias="insightType")
+    insight_attrs: Optional[Dict[str, StrictStr]] = Field(default=None, description="Attributes of the insight.", alias="insightAttrs")
+    __properties: ClassVar[List[str]] = ["description", "actionsDescription", "actionsCodes", "evaluatorId", "evaluatorDisplayName", "explanationType", "explanationName", "explanationMime", "resources", "insightType", "insightAttrs"]
+
+    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 V1alphaInsight 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1alphaInsight from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "description": obj.get("description"),
+            "actionsDescription": obj.get("actionsDescription"),
+            "actionsCodes": obj.get("actionsCodes"),
+            "evaluatorId": obj.get("evaluatorId"),
+            "evaluatorDisplayName": obj.get("evaluatorDisplayName"),
+            "explanationType": obj.get("explanationType"),
+            "explanationName": obj.get("explanationName"),
+            "explanationMime": obj.get("explanationMime"),
+            "resources": obj.get("resources"),
+            "insightType": obj.get("insightType"),
+            "insightAttrs": obj.get("insightAttrs")
+        })
+        return _obj
+
+