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

eval_studio_client/api/models/v1alpha_collection_info.py

@@ -0,0 +1,93 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V1alphaCollectionInfo(BaseModel):
+    """
+    CollectionInfo represents the information about a collection in the H2OGPTE.
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="Required. Collection ID.")
+    display_name: Optional[StrictStr] = Field(default=None, description="Required. Collection display name.", alias="displayName")
+    description: Optional[StrictStr] = Field(default=None, description="Required. Collection description.")
+    document_count: Optional[StrictInt] = Field(default=None, description="Required.The number of documents in the collection.", alias="documentCount")
+    __properties: ClassVar[List[str]] = ["id", "displayName", "description", "documentCount"]
+
+    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 V1alphaCollectionInfo 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 V1alphaCollectionInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "displayName": obj.get("displayName"),
+            "description": obj.get("description"),
+            "documentCount": obj.get("documentCount")
+        })
+        return _obj
+
+

eval_studio_client/api/models/v1alpha_create_dashboard_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_dashboard import V1alphaDashboard
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V1alphaCreateDashboardResponse(BaseModel):
+    """
+    V1alphaCreateDashboardResponse
+    """ # noqa: E501
+    dashboard: Optional[V1alphaDashboard] = None
+    __properties: ClassVar[List[str]] = ["dashboard"]
+
+    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 V1alphaCreateDashboardResponse 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 dashboard
+        if self.dashboard:
+            _dict['dashboard'] = self.dashboard.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1alphaCreateDashboardResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "dashboard": V1alphaDashboard.from_dict(obj["dashboard"]) if obj.get("dashboard") is not None else None
+        })
+        return _obj
+
+

eval_studio_client/api/models/v1alpha_create_document_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_document import V1alphaDocument
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V1alphaCreateDocumentResponse(BaseModel):
+    """
+    V1alphaCreateDocumentResponse
+    """ # noqa: E501
+    document: Optional[V1alphaDocument] = None
+    __properties: ClassVar[List[str]] = ["document"]
+
+    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 V1alphaCreateDocumentResponse 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 document
+        if self.document:
+            _dict['document'] = self.document.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1alphaCreateDocumentResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "document": V1alphaDocument.from_dict(obj["document"]) if obj.get("document") is not None else None
+        })
+        return _obj
+
+

eval_studio_client/api/models/v1alpha_create_evaluation_request.py

@@ -0,0 +1,115 @@
+# 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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from eval_studio_client.api.models.v1alpha_evaluation_test import V1alphaEvaluationTest
+from eval_studio_client.api.models.v1alpha_model import V1alphaModel
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V1alphaCreateEvaluationRequest(BaseModel):
+    """
+    V1alphaCreateEvaluationRequest
+    """ # 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
+    evaluation_tests: Optional[List[V1alphaEvaluationTest]] = Field(default=None, description="TODO: breaks https://google.aip.dev/144 Required. Defines the evaluation configuration.", alias="evaluationTests")
+    operation: Optional[StrictStr] = Field(default=None, description="Required. Resource name of the long-running operation.")
+    llm_models: Optional[List[StrictStr]] = Field(default=None, description="Optional. If specified, the evaluation will be run on the specified LLM models. If empty, the evaluation will be run on all available LLM models.", alias="llmModels")
+    use_cache: Optional[StrictBool] = Field(default=None, description="Optional. If true, the evaluation will use the TestLab cache, if available, to speedup the evaluation.", alias="useCache")
+    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")
+    model_parameters: Optional[StrictStr] = Field(default=None, description="Optional. Parameters overrides in JSON format.", alias="modelParameters")
+    h2ogpte_collection: Optional[StrictStr] = Field(default=None, description="The existing collection name in H2OGPTe.", alias="h2ogpteCollection")
+    __properties: ClassVar[List[str]] = ["evaluatorIdentifiers", "model", "evaluationTests", "operation", "llmModels", "useCache", "evaluatorsParameters", "modelParameters", "h2ogpteCollection"]
+
+    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 V1alphaCreateEvaluationRequest 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()
+        # override the default output from pydantic by calling `to_dict()` of each item in evaluation_tests (list)
+        _items = []
+        if self.evaluation_tests:
+            for _item in self.evaluation_tests:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['evaluationTests'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1alphaCreateEvaluationRequest 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,
+            "evaluationTests": [V1alphaEvaluationTest.from_dict(_item) for _item in obj["evaluationTests"]] if obj.get("evaluationTests") is not None else None,
+            "operation": obj.get("operation"),
+            "llmModels": obj.get("llmModels"),
+            "useCache": obj.get("useCache"),
+            "evaluatorsParameters": obj.get("evaluatorsParameters"),
+            "modelParameters": obj.get("modelParameters"),
+            "h2ogpteCollection": obj.get("h2ogpteCollection")
+        })
+        return _obj
+
+

eval_studio_client/api/models/v1alpha_create_evaluator_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_evaluator import V1alphaEvaluator
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V1alphaCreateEvaluatorResponse(BaseModel):
+    """
+    V1alphaCreateEvaluatorResponse
+    """ # noqa: E501
+    evaluator: Optional[V1alphaEvaluator] = None
+    __properties: ClassVar[List[str]] = ["evaluator"]
+
+    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 V1alphaCreateEvaluatorResponse 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 evaluator
+        if self.evaluator:
+            _dict['evaluator'] = self.evaluator.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1alphaCreateEvaluatorResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "evaluator": V1alphaEvaluator.from_dict(obj["evaluator"]) if obj.get("evaluator") is not None else None
+        })
+        return _obj
+
+

eval_studio_client/api/models/v1alpha_create_leaderboard_request.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_leaderboard import V1alphaLeaderboard
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V1alphaCreateLeaderboardRequest(BaseModel):
+    """
+    V1alphaCreateLeaderboardRequest
+    """ # noqa: E501
+    leaderboard: Optional[V1alphaLeaderboard] = None
+    __properties: ClassVar[List[str]] = ["leaderboard"]
+
+    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 V1alphaCreateLeaderboardRequest 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 leaderboard
+        if self.leaderboard:
+            _dict['leaderboard'] = self.leaderboard.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1alphaCreateLeaderboardRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "leaderboard": V1alphaLeaderboard.from_dict(obj["leaderboard"]) if obj.get("leaderboard") is not None else None
+        })
+        return _obj
+
+

eval_studio_client/api/models/v1alpha_create_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 V1alphaCreateLeaderboardResponse(BaseModel):
+    """
+    V1alphaCreateLeaderboardResponse
+    """ # 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 V1alphaCreateLeaderboardResponse 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 V1alphaCreateLeaderboardResponse 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
+
+