Merge branch 'main' into dev

Author: GiovanniGiacometti

docs/api/python/client/index.html

@@ -55,10 +55,11 @@
 </span><span id=__span-15-2><a id=__codelineno-15-2 name=__codelineno-15-2 href=#__codelineno-15-2></a>------------------------  -------  --------------  --------   -----------------
 </span><span id=__span-15-3><a id=__codelineno-15-3 name=__codelineno-15-3 href=#__codelineno-15-3></a>6476040d583201813ab4539a  my task  classification  OK         03-02-2023 10:14:06
 </span></code></pre></div></p> <h3 id=create_model>.create_model<a class=headerlink href=#create_model title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-16-1><a id=__codelineno-16-1 name=__codelineno-16-1 href=#__codelineno-16-1></a><span class=o>.</span><span class=n>create_model</span><span class=p>(</span>
-</span><span id=__span-16-2><a id=__codelineno-16-2 name=__codelineno-16-2 href=#__codelineno-16-2></a>   <span class=n>task_id</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>name</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>version</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>metric_name</span><span class=p>:</span> <span class=p>(</span><span class=n>ModelMetricName</span><span class=o>|</span><span class=kc>None</span><span class=p>),</span>
-</span><span id=__span-16-3><a id=__codelineno-16-3 name=__codelineno-16-3 href=#__codelineno-16-3></a>   <span class=n>preferred_suggestion_type</span><span class=p>:</span> <span class=p>(</span><span class=n>SuggestionType</span><span class=o>|</span><span class=kc>None</span><span class=p>)</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
-</span><span id=__span-16-4><a id=__codelineno-16-4 name=__codelineno-16-4 href=#__codelineno-16-4></a>   <span class=n>retraining_cost</span><span class=p>:</span> <span class=nb>float</span> <span class=o>=</span> <span class=mf>0.0</span><span class=p>,</span> <span class=n>resampled_dataset_size</span><span class=p>:</span> <span class=p>(</span><span class=nb>int</span><span class=o>|</span><span class=kc>None</span><span class=p>)</span> <span class=o>=</span> <span class=kc>None</span>
-</span><span id=__span-16-5><a id=__codelineno-16-5 name=__codelineno-16-5 href=#__codelineno-16-5></a><span class=p>)</span>
+</span><span id=__span-16-2><a id=__codelineno-16-2 name=__codelineno-16-2 href=#__codelineno-16-2></a>   <span class=n>task_id</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>name</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>version</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>with_probabilistic_output</span><span class=p>:</span> <span class=nb>bool</span><span class=p>,</span>
+</span><span id=__span-16-3><a id=__codelineno-16-3 name=__codelineno-16-3 href=#__codelineno-16-3></a>   <span class=n>metric_name</span><span class=p>:</span> <span class=p>(</span><span class=n>ModelMetricName</span><span class=o>|</span><span class=kc>None</span><span class=p>),</span>
+</span><span id=__span-16-4><a id=__codelineno-16-4 name=__codelineno-16-4 href=#__codelineno-16-4></a>   <span class=n>preferred_suggestion_type</span><span class=p>:</span> <span class=p>(</span><span class=n>SuggestionType</span><span class=o>|</span><span class=kc>None</span><span class=p>)</span> <span class=o>=</span> <span class=kc>None</span><span class=p>,</span>
+</span><span id=__span-16-5><a id=__codelineno-16-5 name=__codelineno-16-5 href=#__codelineno-16-5></a>   <span class=n>retraining_cost</span><span class=p>:</span> <span class=nb>float</span> <span class=o>=</span> <span class=mf>0.0</span><span class=p>,</span> <span class=n>resampled_dataset_size</span><span class=p>:</span> <span class=p>(</span><span class=nb>int</span><span class=o>|</span><span class=kc>None</span><span class=p>)</span> <span class=o>=</span> <span class=kc>None</span>
+</span><span id=__span-16-6><a id=__codelineno-16-6 name=__codelineno-16-6 href=#__codelineno-16-6></a><span class=p>)</span>
 </span></code></pre></div> <hr> <p>Create a model inside the task.</p> <p><strong>Allowed Roles:</strong></p> <ul> <li>At least <code>PROJECT_EDIT</code> for that project</li> <li><code>COMPANY_OWNER</code></li> <li><code>COMPANY_ADMIN</code></li> </ul> <p><strong>Args</strong></p> <ul> <li><strong>task_id</strong> : the identifier of the task</li> <li><strong>name</strong> : the name of the model</li> <li><strong>version</strong> : the current version of the model</li> <li><strong>metric_name</strong> : performance or error metric associated with the model</li> <li><strong>retraining_cost</strong> : estimated costs in the Task currency to retrain the model. This information is used by the retraining tool to show gain-cost information. Default value is 0.0 meaning that the cost is negligible</li> <li><strong>preferred_suggestion_type</strong> : preferred type of suggestion that will be computed to retrain the model</li> <li><strong>resampled_dataset_size</strong> : size of the resampled dataset that will be proposed to retrain the model note: this parameter is required if <code>preferred_suggestion_type</code> is <code>SuggestionType.RESAMPLED_DATASET</code></li> </ul> <p><strong>Returns</strong></p> <ul> <li><strong>model_id</strong> : <code>str</code> identifier of the created model</li> </ul> <p><strong>Raises</strong></p> <p><code>CreateModelException</code></p> <h3 id=get_models>.get_models<a class=headerlink href=#get_models title="Permanent link">&para;</a></h3> <div class="language-python highlight"><pre><span></span><code><span id=__span-17-1><a id=__codelineno-17-1 name=__codelineno-17-1 href=#__codelineno-17-1></a><span class=o>.</span><span class=n>get_models</span><span class=p>(</span>
 </span><span id=__span-17-2><a id=__codelineno-17-2 name=__codelineno-17-2 href=#__codelineno-17-2></a>   <span class=n>task_id</span><span class=p>:</span> <span class=nb>str</span>
 </span><span id=__span-17-3><a id=__codelineno-17-3 name=__codelineno-17-3 href=#__codelineno-17-3></a><span class=p>)</span>

docs/api/python/enums/index.html

@@ -14,7 +14,7 @@
 </span></code></pre></div> <hr> <p>Currency of to use for the Task</p> <hr> <h2 id=datastructure>DataStructure<a class=headerlink href=#datastructure title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-4-1><a id=__codelineno-4-1 name=__codelineno-4-1 href=#__codelineno-4-1></a><span class=n>DataStructure</span><span class=p>()</span>
 </span></code></pre></div> <hr> <p>Represents the typology of the data to send</p> <p><strong>Fields:</strong></p> <ul> <li>TABULAR</li> <li>IMAGE</li> <li>TEXT</li> <li>EMBEDDING</li> </ul> <hr> <h2 id=datatype>DataType<a class=headerlink href=#datatype title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-5-1><a id=__codelineno-5-1 name=__codelineno-5-1 href=#__codelineno-5-1></a><span class=n>DataType</span><span class=p>()</span>
 </span></code></pre></div> <hr> <p>Data type enum Describe data type of an input</p> <hr> <h2 id=detectioneventactiontype>DetectionEventActionType<a class=headerlink href=#detectioneventactiontype title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-6-1><a id=__codelineno-6-1 name=__codelineno-6-1 href=#__codelineno-6-1></a><span class=n>DetectionEventActionType</span><span class=p>()</span>
-</span></code></pre></div> <hr> <p><strong>Fields:</strong></p> <ul> <li>DISCORD_NOTIFICATION</li> <li>SLACK_NOTIFICATION</li> </ul> <hr> <h2 id=detectioneventseverity>DetectionEventSeverity<a class=headerlink href=#detectioneventseverity title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-7-1><a id=__codelineno-7-1 name=__codelineno-7-1 href=#__codelineno-7-1></a><span class=n>DetectionEventSeverity</span><span class=p>()</span>
+</span></code></pre></div> <hr> <p><strong>Fields:</strong></p> <ul> <li>DISCORD_NOTIFICATION</li> <li>SLACK_NOTIFICATION</li> <li>EMAIL_NOTIFICATION</li> <li>TEAMS_NOTIFICATION</li> <li>MQTT_NOTIFICATION</li> <li>RETRAIN</li> </ul> <hr> <h2 id=detectioneventseverity>DetectionEventSeverity<a class=headerlink href=#detectioneventseverity title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-7-1><a id=__codelineno-7-1 name=__codelineno-7-1 href=#__codelineno-7-1></a><span class=n>DetectionEventSeverity</span><span class=p>()</span>
 </span></code></pre></div> <hr> <p><strong>Fields:</strong></p> <ul> <li>LOW</li> <li>MEDIUM</li> <li>HIGH</li> </ul> <hr> <h2 id=detectioneventtype>DetectionEventType<a class=headerlink href=#detectioneventtype title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-8-1><a id=__codelineno-8-1 name=__codelineno-8-1 href=#__codelineno-8-1></a><span class=n>DetectionEventType</span><span class=p>()</span>
 </span></code></pre></div> <hr> <p><strong>Fields:</strong></p> <ul> <li>DRIFT</li> </ul> <hr> <h2 id=externalintegration>ExternalIntegration<a class=headerlink href=#externalintegration title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-9-1><a id=__codelineno-9-1 name=__codelineno-9-1 href=#__codelineno-9-1></a><span class=n>ExternalIntegration</span><span class=p>()</span>
 </span></code></pre></div> <hr> <p>An integration with a 3<sup>rd</sup> party service provider</p> <p><strong>Fields:</strong> - AWS - GCP - AZURE</p> <hr> <h2 id=filetype>FileType<a class=headerlink href=#filetype title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-10-1><a id=__codelineno-10-1 name=__codelineno-10-1 href=#__codelineno-10-1></a><span class=n>FileType</span><span class=p>()</span>
@@ -23,9 +23,9 @@
 </span></code></pre></div> <hr> <p><strong>Fields:</strong></p> <ul> <li>IDLE</li> <li>STARTING</li> <li>RUNNING</li> <li>COMPLETED</li> <li>ERROR</li> </ul> <hr> <h2 id=kpistatus>KPIStatus<a class=headerlink href=#kpistatus title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-13-1><a id=__codelineno-13-1 name=__codelineno-13-1 href=#__codelineno-13-1></a><span class=n>KPIStatus</span><span class=p>()</span>
 </span></code></pre></div> <hr> <p><strong>Fields:</strong></p> <ul> <li>NOT_INITIALIZED</li> <li>OK</li> <li>WARNING</li> <li>DRIFT</li> </ul> <hr> <h2 id=modelmetricname>ModelMetricName<a class=headerlink href=#modelmetricname title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-14-1><a id=__codelineno-14-1 name=__codelineno-14-1 href=#__codelineno-14-1></a><span class=n>ModelMetricName</span><span class=p>()</span>
 </span></code></pre></div> <hr> <p>Name of the model metrics that is associated with the model</p> <p><strong>Fields:</strong> - RMSE - RSQUARE</p> <hr> <h2 id=monitoringmetric>MonitoringMetric<a class=headerlink href=#monitoringmetric title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-15-1><a id=__codelineno-15-1 name=__codelineno-15-1 href=#__codelineno-15-1></a><span class=n>MonitoringMetric</span><span class=p>()</span>
-</span></code></pre></div> <hr> <p><strong>Fields:</strong></p> <ul> <li>FEATURE</li> <li>TEXT_TOXICITY</li> <li>TEXT_EMOTION</li> <li>TEXT_SENTIMENT</li> </ul> <hr> <h2 id=monitoringstatus>MonitoringStatus<a class=headerlink href=#monitoringstatus title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-16-1><a id=__codelineno-16-1 name=__codelineno-16-1 href=#__codelineno-16-1></a><span class=n>MonitoringStatus</span><span class=p>()</span>
+</span></code></pre></div> <hr> <p><strong>Fields:</strong></p> <ul> <li>FEATURE</li> <li>TEXT_TOXICITY</li> <li>TEXT_EMOTION</li> <li>TEXT_SENTIMENT</li> <li>MODEL_PERPLEXITY</li> </ul> <hr> <h2 id=monitoringstatus>MonitoringStatus<a class=headerlink href=#monitoringstatus title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-16-1><a id=__codelineno-16-1 name=__codelineno-16-1 href=#__codelineno-16-1></a><span class=n>MonitoringStatus</span><span class=p>()</span>
 </span></code></pre></div> <hr> <p><strong>Fields:</strong></p> <ul> <li>OK</li> <li>WARNING</li> <li>DRIFT</li> </ul> <hr> <h2 id=monitoringtarget>MonitoringTarget<a class=headerlink href=#monitoringtarget title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-17-1><a id=__codelineno-17-1 name=__codelineno-17-1 href=#__codelineno-17-1></a><span class=n>MonitoringTarget</span><span class=p>()</span>
-</span></code></pre></div> <hr> <p><strong>Fields:</strong></p> <ul> <li>ERROR</li> <li>INPUT</li> <li>CONCEPT</li> <li>PREDICTION</li> <li>USER_INPUT</li> <li>USER_INPUT_RETRIEVED_CONTEXT</li> <li>USER_INPUT_MODEL_OUTPUT</li> <li>MODEL_OUTPUT_RETRIEVED_CONTEXT</li> </ul> <hr> <h2 id=retraintriggertype>RetrainTriggerType<a class=headerlink href=#retraintriggertype title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-18-1><a id=__codelineno-18-1 name=__codelineno-18-1 href=#__codelineno-18-1></a><span class=n>RetrainTriggerType</span><span class=p>()</span>
+</span></code></pre></div> <hr> <p><strong>Fields:</strong></p> <ul> <li>ERROR</li> <li>INPUT</li> <li>CONCEPT</li> <li>PREDICTION</li> <li>USER_INPUT</li> <li>USER_INPUT_RETRIEVED_CONTEXT</li> <li>RETRIEVED_CONTEXT</li> <li>USER_INPUT_MODEL_OUTPUT</li> <li>MODEL_OUTPUT_RETRIEVED_CONTEXT</li> </ul> <hr> <h2 id=retraintriggertype>RetrainTriggerType<a class=headerlink href=#retraintriggertype title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-18-1><a id=__codelineno-18-1 name=__codelineno-18-1 href=#__codelineno-18-1></a><span class=n>RetrainTriggerType</span><span class=p>()</span>
 </span></code></pre></div> <hr> <p>Enumeration of the possible retrain triggers</p> <hr> <h2 id=storagepolicy>StoragePolicy<a class=headerlink href=#storagepolicy title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-19-1><a id=__codelineno-19-1 name=__codelineno-19-1 href=#__codelineno-19-1></a><span class=n>StoragePolicy</span><span class=p>()</span>
 </span></code></pre></div> <hr> <p>Enumeration that specifies the storage policy for the data sent to ML cube Platform</p> <p><strong>Fields:</strong> cloud it needs to read data</p> <hr> <h2 id=storingdatatype>StoringDataType<a class=headerlink href=#storingdatatype title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-20-1><a id=__codelineno-20-1 name=__codelineno-20-1 href=#__codelineno-20-1></a><span class=n>StoringDataType</span><span class=p>()</span>
 </span></code></pre></div> <hr> <p><strong>Fields:</strong></p> <ul> <li>HISTORICAL</li> <li>REFERENCE</li> <li>PRODUCTION</li> </ul> <hr> <h2 id=suggestiontype>SuggestionType<a class=headerlink href=#suggestiontype title="Permanent link">&para;</a></h2> <div class="language-python highlight"><pre><span></span><code><span id=__span-21-1><a id=__codelineno-21-1 name=__codelineno-21-1 href=#__codelineno-21-1></a><span class=n>SuggestionType</span><span class=p>()</span>