eval-studio-client 1.2.5__py3-none-any.whl → 1.3.0__py3-none-any.whl

eval_studio_client/api/api/leaderboard_report_service_api.py

@@ -16,8 +16,11 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
-from pydantic import Field, field_validator
+from pydantic import Field, StrictStr, field_validator
+from typing import Optional
 from typing_extensions import Annotated
+from eval_studio_client.api.models.v1_cmp_leaderboard_reports_request import V1CmpLeaderboardReportsRequest
+from eval_studio_client.api.models.v1_cmp_leaderboard_reports_response import V1CmpLeaderboardReportsResponse
 from eval_studio_client.api.models.v1_get_leaderboard_report_response import V1GetLeaderboardReportResponse
 
 from eval_studio_client.api.api_client import ApiClient, RequestSerialized
@@ -38,10 +41,278 @@ class LeaderboardReportServiceApi:
         self.api_client = api_client
 
 
+    @validate_call
+    def leaderboard_report_service_cmp_leaderboard_reports(
+        self,
+        body: V1CmpLeaderboardReportsRequest,
+        _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,
+    ) -> V1CmpLeaderboardReportsResponse:
+        """leaderboard_report_service_cmp_leaderboard_reports
+
+
+        :param body: (required)
+        :type body: V1CmpLeaderboardReportsRequest
+        :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._leaderboard_report_service_cmp_leaderboard_reports_serialize(
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "V1CmpLeaderboardReportsResponse",
+        }
+        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 leaderboard_report_service_cmp_leaderboard_reports_with_http_info(
+        self,
+        body: V1CmpLeaderboardReportsRequest,
+        _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[V1CmpLeaderboardReportsResponse]:
+        """leaderboard_report_service_cmp_leaderboard_reports
+
+
+        :param body: (required)
+        :type body: V1CmpLeaderboardReportsRequest
+        :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._leaderboard_report_service_cmp_leaderboard_reports_serialize(
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "V1CmpLeaderboardReportsResponse",
+        }
+        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 leaderboard_report_service_cmp_leaderboard_reports_without_preload_content(
+        self,
+        body: V1CmpLeaderboardReportsRequest,
+        _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:
+        """leaderboard_report_service_cmp_leaderboard_reports
+
+
+        :param body: (required)
+        :type body: V1CmpLeaderboardReportsRequest
+        :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._leaderboard_report_service_cmp_leaderboard_reports_serialize(
+            body=body,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "V1CmpLeaderboardReportsResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _leaderboard_report_service_cmp_leaderboard_reports_serialize(
+        self,
+        body,
+        _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]] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if body is not None:
+            _body_params = body
+
+
+        # set the HTTP header `Accept`
+        _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] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/v1/leaderboardReports:compare',
+            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 leaderboard_report_service_get_leaderboard_report(
         self,
-        name_3: Annotated[str, Field(strict=True, description="Required. The name of the Leaderboard to retrieve.")],
+        name_4: Annotated[str, Field(strict=True, description="Required. The name of the Leaderboard to retrieve.")],
+        view: Annotated[Optional[StrictStr], Field(description="Optional. The view of the leaderboard report results to return. Defaults to LEADERBOARD_REPORT_RESULT_VIEW_FULL.   - LEADERBOARD_REPORT_RESULT_VIEW_UNSPECIFIED: Default value. The basic view with essential fields.  - LEADERBOARD_REPORT_RESULT_VIEW_FULL: Full view with all fields populated.  - LEADERBOARD_REPORT_RESULT_VIEW_SUMMARY: Summary view with only key fields.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -58,8 +329,10 @@ class LeaderboardReportServiceApi:
         """leaderboard_report_service_get_leaderboard_report
 
 
-        :param name_3: Required. The name of the Leaderboard to retrieve. (required)
-        :type name_3: str
+        :param name_4: Required. The name of the Leaderboard to retrieve. (required)
+        :type name_4: str
+        :param view: Optional. The view of the leaderboard report results to return. Defaults to LEADERBOARD_REPORT_RESULT_VIEW_FULL.   - LEADERBOARD_REPORT_RESULT_VIEW_UNSPECIFIED: Default value. The basic view with essential fields.  - LEADERBOARD_REPORT_RESULT_VIEW_FULL: Full view with all fields populated.  - LEADERBOARD_REPORT_RESULT_VIEW_SUMMARY: Summary view with only key fields.
+        :type view: str
         :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
@@ -83,7 +356,8 @@ class LeaderboardReportServiceApi:
         """ # noqa: E501
 
         _param = self._leaderboard_report_service_get_leaderboard_report_serialize(
-            name_3=name_3,
+            name_4=name_4,
+            view=view,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -107,7 +381,8 @@ class LeaderboardReportServiceApi:
     @validate_call
     def leaderboard_report_service_get_leaderboard_report_with_http_info(
         self,
-        name_3: Annotated[str, Field(strict=True, description="Required. The name of the Leaderboard to retrieve.")],
+        name_4: Annotated[str, Field(strict=True, description="Required. The name of the Leaderboard to retrieve.")],
+        view: Annotated[Optional[StrictStr], Field(description="Optional. The view of the leaderboard report results to return. Defaults to LEADERBOARD_REPORT_RESULT_VIEW_FULL.   - LEADERBOARD_REPORT_RESULT_VIEW_UNSPECIFIED: Default value. The basic view with essential fields.  - LEADERBOARD_REPORT_RESULT_VIEW_FULL: Full view with all fields populated.  - LEADERBOARD_REPORT_RESULT_VIEW_SUMMARY: Summary view with only key fields.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -124,8 +399,10 @@ class LeaderboardReportServiceApi:
         """leaderboard_report_service_get_leaderboard_report
 
 
-        :param name_3: Required. The name of the Leaderboard to retrieve. (required)
-        :type name_3: str
+        :param name_4: Required. The name of the Leaderboard to retrieve. (required)
+        :type name_4: str
+        :param view: Optional. The view of the leaderboard report results to return. Defaults to LEADERBOARD_REPORT_RESULT_VIEW_FULL.   - LEADERBOARD_REPORT_RESULT_VIEW_UNSPECIFIED: Default value. The basic view with essential fields.  - LEADERBOARD_REPORT_RESULT_VIEW_FULL: Full view with all fields populated.  - LEADERBOARD_REPORT_RESULT_VIEW_SUMMARY: Summary view with only key fields.
+        :type view: str
         :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
@@ -149,7 +426,8 @@ class LeaderboardReportServiceApi:
         """ # noqa: E501
 
         _param = self._leaderboard_report_service_get_leaderboard_report_serialize(
-            name_3=name_3,
+            name_4=name_4,
+            view=view,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -173,7 +451,8 @@ class LeaderboardReportServiceApi:
     @validate_call
     def leaderboard_report_service_get_leaderboard_report_without_preload_content(
         self,
-        name_3: Annotated[str, Field(strict=True, description="Required. The name of the Leaderboard to retrieve.")],
+        name_4: Annotated[str, Field(strict=True, description="Required. The name of the Leaderboard to retrieve.")],
+        view: Annotated[Optional[StrictStr], Field(description="Optional. The view of the leaderboard report results to return. Defaults to LEADERBOARD_REPORT_RESULT_VIEW_FULL.   - LEADERBOARD_REPORT_RESULT_VIEW_UNSPECIFIED: Default value. The basic view with essential fields.  - LEADERBOARD_REPORT_RESULT_VIEW_FULL: Full view with all fields populated.  - LEADERBOARD_REPORT_RESULT_VIEW_SUMMARY: Summary view with only key fields.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -190,8 +469,10 @@ class LeaderboardReportServiceApi:
         """leaderboard_report_service_get_leaderboard_report
 
 
-        :param name_3: Required. The name of the Leaderboard to retrieve. (required)
-        :type name_3: str
+        :param name_4: Required. The name of the Leaderboard to retrieve. (required)
+        :type name_4: str
+        :param view: Optional. The view of the leaderboard report results to return. Defaults to LEADERBOARD_REPORT_RESULT_VIEW_FULL.   - LEADERBOARD_REPORT_RESULT_VIEW_UNSPECIFIED: Default value. The basic view with essential fields.  - LEADERBOARD_REPORT_RESULT_VIEW_FULL: Full view with all fields populated.  - LEADERBOARD_REPORT_RESULT_VIEW_SUMMARY: Summary view with only key fields.
+        :type view: str
         :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
@@ -215,7 +496,8 @@ class LeaderboardReportServiceApi:
         """ # noqa: E501
 
         _param = self._leaderboard_report_service_get_leaderboard_report_serialize(
-            name_3=name_3,
+            name_4=name_4,
+            view=view,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -234,7 +516,8 @@ class LeaderboardReportServiceApi:
 
     def _leaderboard_report_service_get_leaderboard_report_serialize(
         self,
-        name_3,
+        name_4,
+        view,
         _request_auth,
         _content_type,
         _headers,
@@ -254,9 +537,13 @@ class LeaderboardReportServiceApi:
         _body_params: Optional[bytes] = None
 
         # process the path parameters
-        if name_3 is not None:
-            _path_params['name_3'] = name_3
+        if name_4 is not None:
+            _path_params['name_4'] = name_4
         # process the query parameters
+        if view is not None:
+            
+            _query_params.append(('view', view))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -276,7 +563,7 @@ class LeaderboardReportServiceApi:
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/v1/{name_3}',
+            resource_path='/v1/{name_4}',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,