scope-client 1.4.703__tar.gz → 1.4.704__tar.gz

{scope_client-1.4.703 → scope_client-1.4.704}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: scope_client
-Version: 1.4.703
+Version: 1.4.704
 Summary: Arthur Python API Client Library
 Author-email: Arthur <info@arthur.ai>
 License: MIT

{scope_client-1.4.703 → scope_client-1.4.704}/scope_client/scope_client/api_bindings/__init__.py

@@ -120,6 +120,7 @@ from scope_client.api_bindings.models.delete_group_membership import DeleteGroup
 from scope_client.api_bindings.models.dimension import Dimension
 from scope_client.api_bindings.models.extended_role import ExtendedRole
 from scope_client.api_bindings.models.fetch_data_job_spec import FetchDataJobSpec
+from scope_client.api_bindings.models.generate_metrics_spec_request import GenerateMetricsSpecRequest
 from scope_client.api_bindings.models.group import Group
 from scope_client.api_bindings.models.group_membership import GroupMembership
 from scope_client.api_bindings.models.group_sort import GroupSort

{scope_client-1.4.703 → scope_client-1.4.704}/scope_client/scope_client/api_bindings/api/models_v1_api.py

@@ -19,6 +19,7 @@ from typing_extensions import Annotated
 from pydantic import Field, StrictStr
 from typing import Optional
 from typing_extensions import Annotated
+from scope_client.api_bindings.models.generate_metrics_spec_request import GenerateMetricsSpecRequest
 from scope_client.api_bindings.models.model import Model
 from scope_client.api_bindings.models.models_sort import ModelsSort
 from scope_client.api_bindings.models.patch_model import PatchModel
@@ -586,6 +587,304 @@ class ModelsV1Api:
 
 
 
+    @validate_call
+    def generate_metrics_spec(
+        self,
+        project_id: StrictStr,
+        generate_metrics_spec_request: GenerateMetricsSpecRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> PutModelMetricSpec:
+        """Generates A Metrics Spec.
+
+        Generates a metric spec for a model based on one or several datasets. Requires project_generate_metrics_spec permission.
+
+        :param project_id: (required)
+        :type project_id: str
+        :param generate_metrics_spec_request: (required)
+        :type generate_metrics_spec_request: GenerateMetricsSpecRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._generate_metrics_spec_serialize(
+            project_id=project_id,
+            generate_metrics_spec_request=generate_metrics_spec_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PutModelMetricSpec",
+            '500': "InternalServerError",
+            '404': "NotFoundError",
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def generate_metrics_spec_with_http_info(
+        self,
+        project_id: StrictStr,
+        generate_metrics_spec_request: GenerateMetricsSpecRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[PutModelMetricSpec]:
+        """Generates A Metrics Spec.
+
+        Generates a metric spec for a model based on one or several datasets. Requires project_generate_metrics_spec permission.
+
+        :param project_id: (required)
+        :type project_id: str
+        :param generate_metrics_spec_request: (required)
+        :type generate_metrics_spec_request: GenerateMetricsSpecRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._generate_metrics_spec_serialize(
+            project_id=project_id,
+            generate_metrics_spec_request=generate_metrics_spec_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PutModelMetricSpec",
+            '500': "InternalServerError",
+            '404': "NotFoundError",
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def generate_metrics_spec_without_preload_content(
+        self,
+        project_id: StrictStr,
+        generate_metrics_spec_request: GenerateMetricsSpecRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Generates A Metrics Spec.
+
+        Generates a metric spec for a model based on one or several datasets. Requires project_generate_metrics_spec permission.
+
+        :param project_id: (required)
+        :type project_id: str
+        :param generate_metrics_spec_request: (required)
+        :type generate_metrics_spec_request: GenerateMetricsSpecRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._generate_metrics_spec_serialize(
+            project_id=project_id,
+            generate_metrics_spec_request=generate_metrics_spec_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PutModelMetricSpec",
+            '500': "InternalServerError",
+            '404': "NotFoundError",
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _generate_metrics_spec_serialize(
+        self,
+        project_id,
+        generate_metrics_spec_request,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if project_id is not None:
+            _path_params['project_id'] = project_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if generate_metrics_spec_request is not None:
+            _body_params = generate_metrics_spec_request
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'OAuth2AuthorizationCode'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/api/v1/projects/{project_id}/generate_metrics_spec',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
     @validate_call
     def get_model(
         self,

{scope_client-1.4.703 → scope_client-1.4.704}/scope_client/scope_client/api_bindings/models/__init__.py

@@ -81,6 +81,7 @@ from scope_client.api_bindings.models.delete_group_membership import DeleteGroup
 from scope_client.api_bindings.models.dimension import Dimension
 from scope_client.api_bindings.models.extended_role import ExtendedRole
 from scope_client.api_bindings.models.fetch_data_job_spec import FetchDataJobSpec
+from scope_client.api_bindings.models.generate_metrics_spec_request import GenerateMetricsSpecRequest
 from scope_client.api_bindings.models.group import Group
 from scope_client.api_bindings.models.group_membership import GroupMembership
 from scope_client.api_bindings.models.group_sort import GroupSort

scope_client-1.4.704/scope_client/scope_client/api_bindings/models/generate_metrics_spec_request.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    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
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GenerateMetricsSpecRequest(BaseModel):
+    """
+    GenerateMetricsSpecRequest
+    """ # noqa: E501
+    dataset_ids: List[StrictStr] = Field(description="List of dataset IDs for which to generate a model metrics spec. Datasets must be in the project in the path.")
+    __properties: ClassVar[List[str]] = ["dataset_ids"]
+
+    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 GenerateMetricsSpecRequest 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 GenerateMetricsSpecRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "dataset_ids": obj.get("dataset_ids")
+        })
+        return _obj
+
+

{scope_client-1.4.703 → scope_client-1.4.704}/scope_client/scope_client/api_bindings/models/permission_name.py

@@ -81,6 +81,7 @@ class PermissionName(str, Enum):
     PROJECT_ROLE_BINDING_DELETE = 'project_role_binding_delete'
     PROJECT_CREATE_ROLE_BINDING = 'project_create_role_binding'
     PROJECT_LIST_ROLE_BINDINGS = 'project_list_role_bindings'
+    PROJECT_GENERATE_METRICS_SPEC = 'project_generate_metrics_spec'
     MODEL_READ = 'model_read'
     MODEL_UPDATE = 'model_update'
     MODEL_DELETE = 'model_delete'

{scope_client-1.4.703 → scope_client-1.4.704}/scope_client/scope_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: scope_client
-Version: 1.4.703
+Version: 1.4.704
 Summary: Arthur Python API Client Library
 Author-email: Arthur <info@arthur.ai>
 License: MIT

{scope_client-1.4.703 → scope_client-1.4.704}/scope_client/scope_client.egg-info/SOURCES.txt

@@ -105,6 +105,7 @@ scope_client/scope_client/api_bindings/models/delete_group_membership.py
 scope_client/scope_client/api_bindings/models/dimension.py
 scope_client/scope_client/api_bindings/models/extended_role.py
 scope_client/scope_client/api_bindings/models/fetch_data_job_spec.py
+scope_client/scope_client/api_bindings/models/generate_metrics_spec_request.py
 scope_client/scope_client/api_bindings/models/group.py
 scope_client/scope_client/api_bindings/models/group_membership.py
 scope_client/scope_client/api_bindings/models/group_sort.py