opik 1.8.39__py3-none-any.whl → 1.9.71__py3-none-any.whl

opik/rest_api/optimizations/client.py

@@ -5,9 +5,11 @@ import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
-from ..types.json_node_write import JsonNodeWrite
+from ..types.json_list_string_write import JsonListStringWrite
 from ..types.optimization_page_public import OptimizationPagePublic
 from ..types.optimization_public import OptimizationPublic
+from ..types.optimization_studio_config_write import OptimizationStudioConfigWrite
+from ..types.optimization_studio_log import OptimizationStudioLog
 from ..types.optimization_write_status import OptimizationWriteStatus
 from .raw_client import AsyncRawOptimizationsClient, RawOptimizationsClient
 from .types.optimization_update_status import OptimizationUpdateStatus
@@ -31,6 +33,30 @@ class OptimizationsClient:
         """
         return self._raw_client
 
+    def cancel_studio_optimizations(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Cancel Studio optimizations by id
+
+        Parameters
+        ----------
+        id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from Opik import OpikApi
+        client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", )
+        client.optimizations.cancel_studio_optimizations(id='id', )
+        """
+        _response = self._raw_client.cancel_studio_optimizations(id, request_options=request_options)
+        return _response.data
+
     def find_optimizations(
         self,
         *,
@@ -39,6 +65,7 @@ class OptimizationsClient:
         dataset_id: typing.Optional[str] = None,
         name: typing.Optional[str] = None,
         dataset_deleted: typing.Optional[bool] = None,
+        filters: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> OptimizationPagePublic:
         """
@@ -56,6 +83,8 @@ class OptimizationsClient:
 
         dataset_deleted : typing.Optional[bool]
 
+        filters : typing.Optional[str]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -76,6 +105,7 @@ class OptimizationsClient:
             dataset_id=dataset_id,
             name=name,
             dataset_deleted=dataset_deleted,
+            filters=filters,
             request_options=request_options,
         )
         return _response.data
@@ -88,7 +118,8 @@ class OptimizationsClient:
         status: OptimizationWriteStatus,
         id: typing.Optional[str] = OMIT,
         name: typing.Optional[str] = OMIT,
-        metadata: typing.Optional[JsonNodeWrite] = OMIT,
+        metadata: typing.Optional[JsonListStringWrite] = OMIT,
+        studio_config: typing.Optional[OptimizationStudioConfigWrite] = OMIT,
         last_updated_at: typing.Optional[dt.datetime] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
@@ -107,7 +138,9 @@ class OptimizationsClient:
 
         name : typing.Optional[str]
 
-        metadata : typing.Optional[JsonNodeWrite]
+        metadata : typing.Optional[JsonListStringWrite]
+
+        studio_config : typing.Optional[OptimizationStudioConfigWrite]
 
         last_updated_at : typing.Optional[dt.datetime]
 
@@ -131,6 +164,7 @@ class OptimizationsClient:
             id=id,
             name=name,
             metadata=metadata,
+            studio_config=studio_config,
             last_updated_at=last_updated_at,
             request_options=request_options,
         )
@@ -144,7 +178,8 @@ class OptimizationsClient:
         status: OptimizationWriteStatus,
         id: typing.Optional[str] = OMIT,
         name: typing.Optional[str] = OMIT,
-        metadata: typing.Optional[JsonNodeWrite] = OMIT,
+        metadata: typing.Optional[JsonListStringWrite] = OMIT,
+        studio_config: typing.Optional[OptimizationStudioConfigWrite] = OMIT,
         last_updated_at: typing.Optional[dt.datetime] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
@@ -163,7 +198,9 @@ class OptimizationsClient:
 
         name : typing.Optional[str]
 
-        metadata : typing.Optional[JsonNodeWrite]
+        metadata : typing.Optional[JsonListStringWrite]
+
+        studio_config : typing.Optional[OptimizationStudioConfigWrite]
 
         last_updated_at : typing.Optional[dt.datetime]
 
@@ -187,6 +224,7 @@ class OptimizationsClient:
             id=id,
             name=name,
             metadata=metadata,
+            studio_config=studio_config,
             last_updated_at=last_updated_at,
             request_options=request_options,
         )
@@ -282,6 +320,33 @@ class OptimizationsClient:
         )
         return _response.data
 
+    def get_studio_optimization_logs(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> OptimizationStudioLog:
+        """
+        Get presigned S3 URL for downloading optimization logs
+
+        Parameters
+        ----------
+        id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OptimizationStudioLog
+            Logs response
+
+        Examples
+        --------
+        from Opik import OpikApi
+        client = OpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", )
+        client.optimizations.get_studio_optimization_logs(id='id', )
+        """
+        _response = self._raw_client.get_studio_optimization_logs(id, request_options=request_options)
+        return _response.data
+
 
 class AsyncOptimizationsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -298,6 +363,35 @@ class AsyncOptimizationsClient:
         """
         return self._raw_client
 
+    async def cancel_studio_optimizations(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Cancel Studio optimizations by id
+
+        Parameters
+        ----------
+        id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from Opik import AsyncOpikApi
+        import asyncio
+        client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", )
+        async def main() -> None:
+            await client.optimizations.cancel_studio_optimizations(id='id', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.cancel_studio_optimizations(id, request_options=request_options)
+        return _response.data
+
     async def find_optimizations(
         self,
         *,
@@ -306,6 +400,7 @@ class AsyncOptimizationsClient:
         dataset_id: typing.Optional[str] = None,
         name: typing.Optional[str] = None,
         dataset_deleted: typing.Optional[bool] = None,
+        filters: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> OptimizationPagePublic:
         """
@@ -323,6 +418,8 @@ class AsyncOptimizationsClient:
 
         dataset_deleted : typing.Optional[bool]
 
+        filters : typing.Optional[str]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -346,6 +443,7 @@ class AsyncOptimizationsClient:
             dataset_id=dataset_id,
             name=name,
             dataset_deleted=dataset_deleted,
+            filters=filters,
             request_options=request_options,
         )
         return _response.data
@@ -358,7 +456,8 @@ class AsyncOptimizationsClient:
         status: OptimizationWriteStatus,
         id: typing.Optional[str] = OMIT,
         name: typing.Optional[str] = OMIT,
-        metadata: typing.Optional[JsonNodeWrite] = OMIT,
+        metadata: typing.Optional[JsonListStringWrite] = OMIT,
+        studio_config: typing.Optional[OptimizationStudioConfigWrite] = OMIT,
         last_updated_at: typing.Optional[dt.datetime] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
@@ -377,7 +476,9 @@ class AsyncOptimizationsClient:
 
         name : typing.Optional[str]
 
-        metadata : typing.Optional[JsonNodeWrite]
+        metadata : typing.Optional[JsonListStringWrite]
+
+        studio_config : typing.Optional[OptimizationStudioConfigWrite]
 
         last_updated_at : typing.Optional[dt.datetime]
 
@@ -404,6 +505,7 @@ class AsyncOptimizationsClient:
             id=id,
             name=name,
             metadata=metadata,
+            studio_config=studio_config,
             last_updated_at=last_updated_at,
             request_options=request_options,
         )
@@ -417,7 +519,8 @@ class AsyncOptimizationsClient:
         status: OptimizationWriteStatus,
         id: typing.Optional[str] = OMIT,
         name: typing.Optional[str] = OMIT,
-        metadata: typing.Optional[JsonNodeWrite] = OMIT,
+        metadata: typing.Optional[JsonListStringWrite] = OMIT,
+        studio_config: typing.Optional[OptimizationStudioConfigWrite] = OMIT,
         last_updated_at: typing.Optional[dt.datetime] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
@@ -436,7 +539,9 @@ class AsyncOptimizationsClient:
 
         name : typing.Optional[str]
 
-        metadata : typing.Optional[JsonNodeWrite]
+        metadata : typing.Optional[JsonListStringWrite]
+
+        studio_config : typing.Optional[OptimizationStudioConfigWrite]
 
         last_updated_at : typing.Optional[dt.datetime]
 
@@ -463,6 +568,7 @@ class AsyncOptimizationsClient:
             id=id,
             name=name,
             metadata=metadata,
+            studio_config=studio_config,
             last_updated_at=last_updated_at,
             request_options=request_options,
         )
@@ -566,3 +672,33 @@ class AsyncOptimizationsClient:
             id, name=name, status=status, request_options=request_options
         )
         return _response.data
+
+    async def get_studio_optimization_logs(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> OptimizationStudioLog:
+        """
+        Get presigned S3 URL for downloading optimization logs
+
+        Parameters
+        ----------
+        id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OptimizationStudioLog
+            Logs response
+
+        Examples
+        --------
+        from Opik import AsyncOpikApi
+        import asyncio
+        client = AsyncOpikApi(api_key="YOUR_API_KEY", workspace_name="YOUR_WORKSPACE_NAME", )
+        async def main() -> None:
+            await client.optimizations.get_studio_optimization_logs(id='id', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_studio_optimization_logs(id, request_options=request_options)
+        return _response.data