label-studio-sdk 1.0.20__py3-none-any.whl → 2.0.0__py3-none-any.whl

label_studio_sdk/ml/client.py

@@ -4,15 +4,14 @@ import typing
 from ..core.client_wrapper import SyncClientWrapper
 from ..core.request_options import RequestOptions
 from ..types.ml_backend import MlBackend
-from ..core.pydantic_utilities import parse_obj_as
+from ..core.unchecked_base_model import construct_type
 from json.decoder import JSONDecodeError
 from ..core.api_error import ApiError
 from .types.ml_create_request_auth_method import MlCreateRequestAuthMethod
-from .types.ml_create_response import MlCreateResponse
 from ..core.jsonable_encoder import jsonable_encoder
 from .types.ml_update_request_auth_method import MlUpdateRequestAuthMethod
-from .types.ml_update_response import MlUpdateResponse
 from ..errors.internal_server_error import InternalServerError
+from .types.ml_list_model_versions_response import MlListModelVersionsResponse
 from ..core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
@@ -28,11 +27,12 @@ class MlClient:
     ) -> typing.List[MlBackend]:
         """
 
-        List all configured Machine Learning (ML) backends for a specific project by ID. For more information about ML backends, see [Machine learning integration](https://labelstud.io/guide/ml).
+            List all configured ML backends for a specific project by ID.
+            Use the following cURL command:
+            ```bash
+            curl http://localhost:8000/api/ml?project={project_id} -H 'Authorization: Token abc123'
 
 
-        You will need to provide the project ID. This can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../projects/list).
-
         Parameters
         ----------
         project : typing.Optional[int]
@@ -67,7 +67,7 @@ class MlClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     typing.List[MlBackend],
-                    parse_obj_as(
+                    construct_type(
                         type_=typing.List[MlBackend],  # type: ignore
                         object_=_response.json(),
                     ),
@@ -91,59 +91,60 @@ class MlClient:
         extra_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         timeout: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> MlCreateResponse:
+    ) -> MlBackend:
         """
-
-        Add an ML backend to a project. For more information about what you need to configure when adding an ML backend, see [Connect the model to Label studio](https://labelstud.io/guide/ml#Connect-the-model-to-Label-Studio).
-
-        <Note>If you are using Docker Compose, you may need to adjust your ML backend URL. See [localhost and Docker containers](https://labelstud.io/guide/ml#localhost-and-Docker-containers).</Note>
-
-        <Note>If you are using files that are located in the cloud, local storage, or uploaded to Label Studio, you must configure your environment variables to allow the ML backend to interact with those files. See [Allow the ML backend to access Label Studio](https://labelstud.io/guide/ml#Allow-the-ML-backend-to-access-Label-Studio-data).</Note>
-
+        
+            Add an ML backend to a project using the Label Studio UI or by sending a POST request using the following cURL 
+            command:
+            ```bash
+            curl -X POST -H 'Content-type: application/json' http://localhost:8000/api/ml -H 'Authorization: Token abc123'\
+            --data '{"url": "http://localhost:9090", "project": {project_id}}' 
+            
+        
         Parameters
         ----------
         url : typing.Optional[str]
             ML backend URL
-
+        
         project : typing.Optional[int]
             Project ID
-
+        
         is_interactive : typing.Optional[bool]
             Is interactive
-
+        
         title : typing.Optional[str]
             Title
-
+        
         description : typing.Optional[str]
             Description
-
+        
         auth_method : typing.Optional[MlCreateRequestAuthMethod]
             Auth method
-
+        
         basic_auth_user : typing.Optional[str]
             Basic auth user
-
+        
         basic_auth_pass : typing.Optional[str]
             Basic auth password
-
+        
         extra_params : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
             Extra parameters
-
+        
         timeout : typing.Optional[int]
             Response model timeout
-
+        
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
-
+        
         Returns
         -------
-        MlCreateResponse
-
-
+        MlBackend
+            
+        
         Examples
         --------
         from label_studio_sdk import LabelStudio
-
+        
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
@@ -173,9 +174,9 @@ class MlClient:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    MlCreateResponse,
-                    parse_obj_as(
-                        type_=MlCreateResponse,  # type: ignore
+                    MlBackend,
+                    construct_type(
+                        type_=MlBackend,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -187,14 +188,15 @@ class MlClient:
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> MlBackend:
         """
 
-        Get details about a specific ML backend. You will need to specify an ID for the backend connection. You can find this using [List ML backends](list).
+            Get details about a specific ML backend connection by ID. For example, make a GET request using the
+            following cURL command:
+            ```bash
+            curl http://localhost:8000/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'
 
-        For more information, see [Machine learning integration](https://labelstud.io/guide/ml).
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this ml backend.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -224,7 +226,7 @@ class MlClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     MlBackend,
-                    parse_obj_as(
+                    construct_type(
                         type_=MlBackend,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -237,14 +239,15 @@ class MlClient:
     def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
 
-        Remove an existing ML backend connection. You will need to specify an ID for the backend connection. You can find this using [List ML backends](list).
+            Remove an existing ML backend connection by ID. For example, use the
+            following cURL command:
+            ```bash
+            curl -X DELETE http://localhost:8000/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'
 
-        For more information, see [Machine learning integration](https://labelstud.io/guide/ml).
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this ml backend.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -292,60 +295,61 @@ class MlClient:
         extra_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         timeout: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> MlUpdateResponse:
+    ) -> MlBackend:
         """
-
-        Update the ML backend parameters. You will need to specify an ID for the backend connection. You can find this using [List ML backends](list).
-
-        For more information, see [Machine learning integration](https://labelstud.io/guide/ml).
-
+        
+            Update ML backend parameters using the Label Studio UI or by sending a PATCH request using the following cURL command:
+            ```bash
+            curl -X PATCH -H 'Content-type: application/json' http://localhost:8000/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'\
+            --data '{"url": "http://localhost:9091"}' 
+            
+        
         Parameters
         ----------
         id : int
-            A unique integer value identifying this ml backend.
-
+        
         url : typing.Optional[str]
             ML backend URL
-
+        
         project : typing.Optional[int]
             Project ID
-
+        
         is_interactive : typing.Optional[bool]
             Is interactive
-
+        
         title : typing.Optional[str]
             Title
-
+        
         description : typing.Optional[str]
             Description
-
+        
         auth_method : typing.Optional[MlUpdateRequestAuthMethod]
             Auth method
-
+        
         basic_auth_user : typing.Optional[str]
             Basic auth user
-
+        
         basic_auth_pass : typing.Optional[str]
             Basic auth password
-
+        
         extra_params : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
             Extra parameters
-
+        
         timeout : typing.Optional[int]
             Response model timeout
-
+        
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
-
+        
         Returns
         -------
-        MlUpdateResponse
-
-
+        MlBackend
+            
+        
         Examples
         --------
         from label_studio_sdk import LabelStudio
-
+        
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
@@ -377,9 +381,9 @@ class MlClient:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    MlUpdateResponse,
-                    parse_obj_as(
-                        type_=MlUpdateResponse,  # type: ignore
+                    MlBackend,
+                    construct_type(
+                        type_=MlBackend,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -393,18 +397,15 @@ class MlClient:
         id: int,
         *,
         task: int,
-        context: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        context: typing.Optional[typing.Optional[typing.Any]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
 
-        Enable interactive pre-annotations for a specific task.
-
-        ML-assisted labeling with interactive pre-annotations works with image segmentation and object detection tasks using rectangles, ellipses, polygons, brush masks, and keypoints, as well as with HTML and text named entity recognition tasks. Your ML backend must support the type of labeling that you’re performing, recognize the input that you create, and be able to respond with the relevant output for a prediction. For more information, see [Interactive pre-annotations](https://labelstud.io/guide/ml.html#Interactive-pre-annotations).
-
-        Before you can use interactive annotations, it must be enabled for you ML backend connection (`"is_interactive": true`).
+                Send a request to the machine learning backend set up to be used for interactive preannotations to retrieve a
+                predicted region based on annotator input.
+                See [set up machine learning](https://labelstud.io/guide/ml.html#Get-interactive-preannotations) for more.
 
-        You will need the task ID and the ML backend connection ID. The task ID is available from the Label Studio URL when viewing the task, or you can retrieve it programmatically with [Get task list](../tasks/list). The ML backend connection ID is available via [List ML backends](list).
 
         Parameters
         ----------
@@ -414,8 +415,7 @@ class MlClient:
         task : int
             ID of task to annotate
 
-        context : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
-            Context for ML model
+        context : typing.Optional[typing.Optional[typing.Any]]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -466,11 +466,11 @@ class MlClient:
     ) -> None:
         """
 
-        After you connect a model to Label Studio as a machine learning backend and annotate at least one task, you can start training the model. Training logs appear in stdout and the console.
+                After you add an ML backend, call this API with the ML backend ID to start training with
+                already-labeled tasks.
 
-        For more information, see [Model training](https://labelstud.io/guide/ml.html#Model-training).
+                Get the ML backend ID by [listing the ML backends for a project](https://labelstud.io/api/#operation/api_ml_list).
 
-        You will need to specify an ID for the backend connection. You can find this using [List ML backends](list).
 
         Parameters
         ----------
@@ -517,7 +517,7 @@ class MlClient:
                 raise InternalServerError(
                     typing.cast(
                         str,
-                        parse_obj_as(
+                        construct_type(
                             type_=str,  # type: ignore
                             object_=_response.json(),
                         ),
@@ -528,21 +528,23 @@ class MlClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def list_model_versions(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+    def list_model_versions(
+        self, id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> MlListModelVersionsResponse:
         """
-
-        Get available versions of the model. You will need to specify an ID for the backend connection. You can find this using [List ML backends](list).
+        Get available versions of the model.
 
         Parameters
         ----------
-        id : str
+        id : int
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        None
+        MlListModelVersionsResponse
+            List of available versions.
 
         Examples
         --------
@@ -552,7 +554,7 @@ class MlClient:
             api_key="YOUR_API_KEY",
         )
         client.ml.list_model_versions(
-            id="id",
+            id=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -562,7 +564,13 @@ class MlClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return
+                return typing.cast(
+                    MlListModelVersionsResponse,
+                    construct_type(
+                        type_=MlListModelVersionsResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -578,11 +586,12 @@ class AsyncMlClient:
     ) -> typing.List[MlBackend]:
         """
 
-        List all configured Machine Learning (ML) backends for a specific project by ID. For more information about ML backends, see [Machine learning integration](https://labelstud.io/guide/ml).
+            List all configured ML backends for a specific project by ID.
+            Use the following cURL command:
+            ```bash
+            curl http://localhost:8000/api/ml?project={project_id} -H 'Authorization: Token abc123'
 
 
-        You will need to provide the project ID. This can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../projects/list).
-
         Parameters
         ----------
         project : typing.Optional[int]
@@ -625,7 +634,7 @@ class AsyncMlClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     typing.List[MlBackend],
-                    parse_obj_as(
+                    construct_type(
                         type_=typing.List[MlBackend],  # type: ignore
                         object_=_response.json(),
                     ),
@@ -649,70 +658,71 @@ class AsyncMlClient:
         extra_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         timeout: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> MlCreateResponse:
+    ) -> MlBackend:
         """
-
-        Add an ML backend to a project. For more information about what you need to configure when adding an ML backend, see [Connect the model to Label studio](https://labelstud.io/guide/ml#Connect-the-model-to-Label-Studio).
-
-        <Note>If you are using Docker Compose, you may need to adjust your ML backend URL. See [localhost and Docker containers](https://labelstud.io/guide/ml#localhost-and-Docker-containers).</Note>
-
-        <Note>If you are using files that are located in the cloud, local storage, or uploaded to Label Studio, you must configure your environment variables to allow the ML backend to interact with those files. See [Allow the ML backend to access Label Studio](https://labelstud.io/guide/ml#Allow-the-ML-backend-to-access-Label-Studio-data).</Note>
-
+        
+            Add an ML backend to a project using the Label Studio UI or by sending a POST request using the following cURL 
+            command:
+            ```bash
+            curl -X POST -H 'Content-type: application/json' http://localhost:8000/api/ml -H 'Authorization: Token abc123'\
+            --data '{"url": "http://localhost:9090", "project": {project_id}}' 
+            
+        
         Parameters
         ----------
         url : typing.Optional[str]
             ML backend URL
-
+        
         project : typing.Optional[int]
             Project ID
-
+        
         is_interactive : typing.Optional[bool]
             Is interactive
-
+        
         title : typing.Optional[str]
             Title
-
+        
         description : typing.Optional[str]
             Description
-
+        
         auth_method : typing.Optional[MlCreateRequestAuthMethod]
             Auth method
-
+        
         basic_auth_user : typing.Optional[str]
             Basic auth user
-
+        
         basic_auth_pass : typing.Optional[str]
             Basic auth password
-
+        
         extra_params : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
             Extra parameters
-
+        
         timeout : typing.Optional[int]
             Response model timeout
-
+        
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
-
+        
         Returns
         -------
-        MlCreateResponse
-
-
+        MlBackend
+            
+        
         Examples
         --------
         import asyncio
-
+        
         from label_studio_sdk import AsyncLabelStudio
-
+        
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-
-
+        
+        
         async def main() -> None:
             await client.ml.create()
-
-
+        
+        
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -739,9 +749,9 @@ class AsyncMlClient:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    MlCreateResponse,
-                    parse_obj_as(
-                        type_=MlCreateResponse,  # type: ignore
+                    MlBackend,
+                    construct_type(
+                        type_=MlBackend,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -753,14 +763,15 @@ class AsyncMlClient:
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> MlBackend:
         """
 
-        Get details about a specific ML backend. You will need to specify an ID for the backend connection. You can find this using [List ML backends](list).
+            Get details about a specific ML backend connection by ID. For example, make a GET request using the
+            following cURL command:
+            ```bash
+            curl http://localhost:8000/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'
 
-        For more information, see [Machine learning integration](https://labelstud.io/guide/ml).
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this ml backend.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -798,7 +809,7 @@ class AsyncMlClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     MlBackend,
-                    parse_obj_as(
+                    construct_type(
                         type_=MlBackend,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -811,14 +822,15 @@ class AsyncMlClient:
     async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
 
-        Remove an existing ML backend connection. You will need to specify an ID for the backend connection. You can find this using [List ML backends](list).
+            Remove an existing ML backend connection by ID. For example, use the
+            following cURL command:
+            ```bash
+            curl -X DELETE http://localhost:8000/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'
 
-        For more information, see [Machine learning integration](https://labelstud.io/guide/ml).
 
         Parameters
         ----------
         id : int
-            A unique integer value identifying this ml backend.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -874,73 +886,74 @@ class AsyncMlClient:
         extra_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         timeout: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> MlUpdateResponse:
+    ) -> MlBackend:
         """
-
-        Update the ML backend parameters. You will need to specify an ID for the backend connection. You can find this using [List ML backends](list).
-
-        For more information, see [Machine learning integration](https://labelstud.io/guide/ml).
-
+        
+            Update ML backend parameters using the Label Studio UI or by sending a PATCH request using the following cURL command:
+            ```bash
+            curl -X PATCH -H 'Content-type: application/json' http://localhost:8000/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'\
+            --data '{"url": "http://localhost:9091"}' 
+            
+        
         Parameters
         ----------
         id : int
-            A unique integer value identifying this ml backend.
-
+        
         url : typing.Optional[str]
             ML backend URL
-
+        
         project : typing.Optional[int]
             Project ID
-
+        
         is_interactive : typing.Optional[bool]
             Is interactive
-
+        
         title : typing.Optional[str]
             Title
-
+        
         description : typing.Optional[str]
             Description
-
+        
         auth_method : typing.Optional[MlUpdateRequestAuthMethod]
             Auth method
-
+        
         basic_auth_user : typing.Optional[str]
             Basic auth user
-
+        
         basic_auth_pass : typing.Optional[str]
             Basic auth password
-
+        
         extra_params : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
             Extra parameters
-
+        
         timeout : typing.Optional[int]
             Response model timeout
-
+        
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
-
+        
         Returns
         -------
-        MlUpdateResponse
-
-
+        MlBackend
+            
+        
         Examples
         --------
         import asyncio
-
+        
         from label_studio_sdk import AsyncLabelStudio
-
+        
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-
-
+        
+        
         async def main() -> None:
             await client.ml.update(
                 id=1,
             )
-
-
+        
+        
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -967,9 +980,9 @@ class AsyncMlClient:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    MlUpdateResponse,
-                    parse_obj_as(
-                        type_=MlUpdateResponse,  # type: ignore
+                    MlBackend,
+                    construct_type(
+                        type_=MlBackend,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -983,18 +996,15 @@ class AsyncMlClient:
         id: int,
         *,
         task: int,
-        context: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        context: typing.Optional[typing.Optional[typing.Any]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
 
-        Enable interactive pre-annotations for a specific task.
-
-        ML-assisted labeling with interactive pre-annotations works with image segmentation and object detection tasks using rectangles, ellipses, polygons, brush masks, and keypoints, as well as with HTML and text named entity recognition tasks. Your ML backend must support the type of labeling that you’re performing, recognize the input that you create, and be able to respond with the relevant output for a prediction. For more information, see [Interactive pre-annotations](https://labelstud.io/guide/ml.html#Interactive-pre-annotations).
+                Send a request to the machine learning backend set up to be used for interactive preannotations to retrieve a
+                predicted region based on annotator input.
+                See [set up machine learning](https://labelstud.io/guide/ml.html#Get-interactive-preannotations) for more.
 
-        Before you can use interactive annotations, it must be enabled for you ML backend connection (`"is_interactive": true`).
-
-        You will need the task ID and the ML backend connection ID. The task ID is available from the Label Studio URL when viewing the task, or you can retrieve it programmatically with [Get task list](../tasks/list). The ML backend connection ID is available via [List ML backends](list).
 
         Parameters
         ----------
@@ -1004,8 +1014,7 @@ class AsyncMlClient:
         task : int
             ID of task to annotate
 
-        context : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
-            Context for ML model
+        context : typing.Optional[typing.Optional[typing.Any]]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1064,11 +1073,11 @@ class AsyncMlClient:
     ) -> None:
         """
 
-        After you connect a model to Label Studio as a machine learning backend and annotate at least one task, you can start training the model. Training logs appear in stdout and the console.
+                After you add an ML backend, call this API with the ML backend ID to start training with
+                already-labeled tasks.
 
-        For more information, see [Model training](https://labelstud.io/guide/ml.html#Model-training).
+                Get the ML backend ID by [listing the ML backends for a project](https://labelstud.io/api/#operation/api_ml_list).
 
-        You will need to specify an ID for the backend connection. You can find this using [List ML backends](list).
 
         Parameters
         ----------
@@ -1123,7 +1132,7 @@ class AsyncMlClient:
                 raise InternalServerError(
                     typing.cast(
                         str,
-                        parse_obj_as(
+                        construct_type(
                             type_=str,  # type: ignore
                             object_=_response.json(),
                         ),
@@ -1134,21 +1143,23 @@ class AsyncMlClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def list_model_versions(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+    async def list_model_versions(
+        self, id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> MlListModelVersionsResponse:
         """
-
-        Get available versions of the model. You will need to specify an ID for the backend connection. You can find this using [List ML backends](list).
+        Get available versions of the model.
 
         Parameters
         ----------
-        id : str
+        id : int
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        None
+        MlListModelVersionsResponse
+            List of available versions.
 
         Examples
         --------
@@ -1163,7 +1174,7 @@ class AsyncMlClient:
 
         async def main() -> None:
             await client.ml.list_model_versions(
-                id="id",
+                id=1,
             )
 
 
@@ -1176,7 +1187,13 @@ class AsyncMlClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return
+                return typing.cast(
+                    MlListModelVersionsResponse,
+                    construct_type(
+                        type_=MlListModelVersionsResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)