Merge branch 'main' into dev

Author: GiovanniGiacometti

docs/api/python/client/index.html

@@ -2,112 +2,112 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/api/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/api/examples/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/api/python/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/api/python/client/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/api/python/enums/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/api/python/exceptions/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/api/python/models/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/api/rest/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/data_schema/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/detection_event_rules/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/glossary/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/rbac/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/integrations/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/integrations/data_sources/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/integrations/retrain_triggers/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/business/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/labeling/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/monitoring/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ml-cube.github.io/ml3-platform-docs/user_guide/modules/retraining/</loc>
-         <lastmod>2024-07-24</lastmod>
+         <lastmod>2024-08-06</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>

docs/search/search_index.json

@@ -4,15 +4,16 @@
 ## ML3PlatformClient
 ```python 
 ML3PlatformClient(
-   url: str, api_key: str
+   url: str, api_key: str, timeout: int = 60
 )
 ```
 
 
 ---
 Client class is the single point of interaction with ML cube
 Platform APIs, it is initialized providing the `url` and the User
-`api_key`.
+`api_key`. Optionally, you can specify the `timeout` for the
+operations.
 Every operation is performed verifying the API Key and the
 permissions associated to the User that own that key.
 
@@ -741,6 +742,43 @@ using the method `wait_job_completion(job_id)`
 * **job_id**  : `str` job identifier of the pipeline in execution
 
 
+**Raises**
+
+`UpdateModelVersionException`
+
+### .update_model_version
+```python
+.update_model_version(
+   model_id: str, new_model_version: str
+)
+```
+
+---
+Update model version with empty reference data.
+It is similar to create model but it does not actually create
+a different Model but a new version of the existent one.
+After this request, it is possible to upload data with
+add_historical_data. To start monitoring is required to set the
+reference of this new model with set_reference request.
+
+**Allowed Roles:**
+
+- At least `PROJECT_EDIT` for that project
+- `COMPANY_OWNER`
+- `COMPANY_ADMIN`
+
+
+**Args**
+
+* **model_id**  : the identifier of the model
+* **new_model_version**  : the new version of the model
+
+
+**Returns**
+
+* **model_id**  : `str` job identifier of new model id
+
+
 **Raises**
 
 `UpdateModelVersionException`
@@ -887,7 +925,8 @@ Show data schema of associated with a task
 ### .add_historical_data
 ```python
 .add_historical_data(
-   task_id: str, inputs: Data, target: (Data|None) = None
+   task_id: str, inputs: Data, target: (Data|None) = None,
+   predictions: (list[tuple[str, Data]]|None) = None
 )
 ```
 
@@ -914,6 +953,11 @@ using the method `wait_job_completion(job_id)`
     It can be None if you upload other kinds of data
 * **target**  : data object that contains target data.
     It can be None if you upload other kinds of data
+* **predictions**  : list of data objects that contain prediction data.
+    Each element is a tuple with model_id and data object.
+    It can be None if you upload other kinds of data.
+    Predictions are mandatory for RAG tasks while not
+    permitted for the other TaskType.
 
 
 **Returns**