"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" # @generated-id: 937cb03f8130 from .basesdk import BaseSDK from datetime import datetime from mistralai.client import errors, models, utils from mistralai.client._hooks import HookContext from mistralai.client.types import OptionalNullable, UNSET from mistralai.client.utils import get_security_from_env from mistralai.client.utils.unmarshal_json_response import unmarshal_json_response from typing import Any, Mapping, Optional class Metrics(BaseSDK): def get_workflow_metrics( self, *, workflow_name: str, start_time: OptionalNullable[datetime] = UNSET, end_time: OptionalNullable[datetime] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, ) -> models.WorkflowMetrics: r"""Get Workflow Metrics Get comprehensive metrics for a specific workflow. Args: workflow_name: The name of the workflow type to get metrics for start_time: Optional start time filter (ISO 8601 format) end_time: Optional end time filter (ISO 8601 format) Returns: WorkflowMetrics: Dictionary containing metrics: - execution_count: Total number of executions - success_count: Number of successful executions - error_count: Number of failed/terminated executions - average_latency_ms: Average execution duration in milliseconds - retry_rate: Proportion of workflows with retries - latency_over_time: Time-series data of execution durations Example: GET /v1/workflows/MyWorkflow/metrics GET /v1/workflows/MyWorkflow/metrics?start_time=2025-01-01T00:00:00Z GET /v1/workflows/MyWorkflow/metrics?start_time=2025-01-01T00:00:00Z&end_time=2025-12-31T23:59:59Z :param workflow_name: :param start_time: Filter workflows started after this time (ISO 8601) :param end_time: Filter workflows started before this time (ISO 8601) :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds :param http_headers: Additional headers to set or replace on requests. """ base_url = None url_variables = None if timeout_ms is None: timeout_ms = self.sdk_configuration.timeout_ms if timeout_ms is None: timeout_ms = 30000 if server_url is not None: base_url = server_url else: base_url = self._get_url(base_url, url_variables) request = models.GetWorkflowMetricsV1WorkflowsWorkflowNameMetricsGetRequest( workflow_name=workflow_name, start_time=start_time, end_time=end_time, ) req = self._build_request( method="GET", path="/v1/workflows/{workflow_name}/metrics", base_url=base_url, url_variables=url_variables, request=request, request_body_required=False, request_has_path_params=True, request_has_query_params=True, user_agent_header="user-agent", accept_header_value="application/json", http_headers=http_headers, security=self.sdk_configuration.security, allow_empty_value=None, timeout_ms=timeout_ms, ) if retries == UNSET: if self.sdk_configuration.retry_config is not UNSET: retries = self.sdk_configuration.retry_config retry_config = None if isinstance(retries, utils.RetryConfig): retry_config = (retries, ["429", "500", "502", "503", "504"]) http_res = self.do_request( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", operation_id="get_workflow_metrics_v1_workflows__workflow_name__metrics_get", oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), ), request=req, error_status_codes=["422", "4XX", "5XX"], retry_config=retry_config, ) response_data: Any = None if utils.match_response(http_res, "200", "application/json"): return unmarshal_json_response(models.WorkflowMetrics, http_res) if utils.match_response(http_res, "422", "application/json"): response_data = unmarshal_json_response( errors.HTTPValidationErrorData, http_res ) raise errors.HTTPValidationError(response_data, http_res) if utils.match_response(http_res, "4XX", "*"): http_res_text = utils.stream_to_text(http_res) raise errors.SDKError("API error occurred", http_res, http_res_text) if utils.match_response(http_res, "5XX", "*"): http_res_text = utils.stream_to_text(http_res) raise errors.SDKError("API error occurred", http_res, http_res_text) raise errors.SDKError("Unexpected response received", http_res) async def get_workflow_metrics_async( self, *, workflow_name: str, start_time: OptionalNullable[datetime] = UNSET, end_time: OptionalNullable[datetime] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, http_headers: Optional[Mapping[str, str]] = None, ) -> models.WorkflowMetrics: r"""Get Workflow Metrics Get comprehensive metrics for a specific workflow. Args: workflow_name: The name of the workflow type to get metrics for start_time: Optional start time filter (ISO 8601 format) end_time: Optional end time filter (ISO 8601 format) Returns: WorkflowMetrics: Dictionary containing metrics: - execution_count: Total number of executions - success_count: Number of successful executions - error_count: Number of failed/terminated executions - average_latency_ms: Average execution duration in milliseconds - retry_rate: Proportion of workflows with retries - latency_over_time: Time-series data of execution durations Example: GET /v1/workflows/MyWorkflow/metrics GET /v1/workflows/MyWorkflow/metrics?start_time=2025-01-01T00:00:00Z GET /v1/workflows/MyWorkflow/metrics?start_time=2025-01-01T00:00:00Z&end_time=2025-12-31T23:59:59Z :param workflow_name: :param start_time: Filter workflows started after this time (ISO 8601) :param end_time: Filter workflows started before this time (ISO 8601) :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds :param http_headers: Additional headers to set or replace on requests. """ base_url = None url_variables = None if timeout_ms is None: timeout_ms = self.sdk_configuration.timeout_ms if timeout_ms is None: timeout_ms = 30000 if server_url is not None: base_url = server_url else: base_url = self._get_url(base_url, url_variables) request = models.GetWorkflowMetricsV1WorkflowsWorkflowNameMetricsGetRequest( workflow_name=workflow_name, start_time=start_time, end_time=end_time, ) req = self._build_request_async( method="GET", path="/v1/workflows/{workflow_name}/metrics", base_url=base_url, url_variables=url_variables, request=request, request_body_required=False, request_has_path_params=True, request_has_query_params=True, user_agent_header="user-agent", accept_header_value="application/json", http_headers=http_headers, security=self.sdk_configuration.security, allow_empty_value=None, timeout_ms=timeout_ms, ) if retries == UNSET: if self.sdk_configuration.retry_config is not UNSET: retries = self.sdk_configuration.retry_config retry_config = None if isinstance(retries, utils.RetryConfig): retry_config = (retries, ["429", "500", "502", "503", "504"]) http_res = await self.do_request_async( hook_ctx=HookContext( config=self.sdk_configuration, base_url=base_url or "", operation_id="get_workflow_metrics_v1_workflows__workflow_name__metrics_get", oauth2_scopes=None, security_source=get_security_from_env( self.sdk_configuration.security, models.Security ), ), request=req, error_status_codes=["422", "4XX", "5XX"], retry_config=retry_config, ) response_data: Any = None if utils.match_response(http_res, "200", "application/json"): return unmarshal_json_response(models.WorkflowMetrics, http_res) if utils.match_response(http_res, "422", "application/json"): response_data = unmarshal_json_response( errors.HTTPValidationErrorData, http_res ) raise errors.HTTPValidationError(response_data, http_res) if utils.match_response(http_res, "4XX", "*"): http_res_text = await utils.stream_to_text_async(http_res) raise errors.SDKError("API error occurred", http_res, http_res_text) if utils.match_response(http_res, "5XX", "*"): http_res_text = await utils.stream_to_text_async(http_res) raise errors.SDKError("API error occurred", http_res, http_res_text) raise errors.SDKError("Unexpected response received", http_res)