sdk docs

Author: alelavml3

md-docs/api/python/client.md

@@ -1471,6 +1471,101 @@ Export a RAG evaluation report to a file.
 
 None
 
+### .compute_topic_modeling_report
+```python
+.compute_topic_modeling_report(
+   task_id: str, report_name: str, from_timestamp: float, to_timestamp: float
+)
+```
+
+---
+Compute the topic modeling report for a given task. This
+functionality is available only for tasks based on text data.
+The data on which the report is computed is determined
+by the timestamps.
+
+This request starts an operation pipeline that is
+executed by ML cube Platform.
+Thus, the method returns the identifier of the job that you can
+monitor to know its status and proceed with the other work
+using the method `wait_job_completion(job_id)`
+
+**Allowed Roles:**
+- At least `PROJECT_EDIT` for that project
+- `COMPANY_OWNER`
+- `COMPANY_ADMIN`
+
+
+**Args**
+
+* **task_id**  : the identifier of the task
+* **report_name**  : the name of the report
+* **from_timestamp**  : start timestamp of the samples to evaluate
+* **to_timestamp**  : end timestamp of the samples to evaluate
+
+
+**Returns**
+
+* **job_id**  : `str` identifier of the submitted job
+
+
+**Raises**
+
+ComputeTopicModelingReportException
+
+### .get_topic_modeling_reports
+```python
+.get_topic_modeling_reports(
+   task_id: str
+)
+```
+
+---
+For a given task id, get the computed topic modeling reports.
+
+**Allowed Roles:**
+- At least `PROJECT_VIEW` for that project
+- `COMPANY_OWNER`
+- `COMPANY_ADMIN`
+
+
+**Args**
+
+* **task_id**  : the identifier of the task
+
+
+**Returns**
+
+* **topic_modeling_reports**  : list[TaskTopicModelingReportItem]
+
+
+### .get_topic_modeling_report
+```python
+.get_topic_modeling_report(
+   report_id: str
+)
+```
+
+---
+For a given task id, get the computed topic modeling report
+for a specific report id.
+
+**Allowed Roles:**
+- At least `PROJECT_VIEW` for that project
+- `COMPANY_OWNER`
+- `COMPANY_ADMIN`
+
+
+**Args**
+
+* **report_id**  : the identifier of the report
+
+
+**Returns**
+
+* **topic_modeling_report_detail**  : TaskTopicModelingReportDetails
+
+
 ### .get_monitoring_status
 ```python
 .get_monitoring_status(
@@ -2505,6 +2600,46 @@ your trust policy.
 * **credentials**  : `SecretAWSCredentials`
 
 
+**Raises**
+
+`SDKClientException`
+
+### .create_aws_compatible_integration_credentials
+```python
+.create_aws_compatible_integration_credentials(
+   name: str, default: bool, project_id: str, access_key_id: str,
+   secret_access_key: str, endpoint_url: (str|None) = None
+)
+```
+
+---
+Create credentials to integrate with AWS-compatible services.
+
+**Allowed Roles:**
+
+- At least `UPDATE_PROJECT_INFORMATION` for the project
+- `COMPANY_OWNER`
+- `COMPANY_ADMIN`
+
+
+**Args**
+
+* **name**  : a simple name to identify this set of credentials
+* **default**  : whether to use these credentials by default when
+    using an AWS integration
+* **project_id**  : the project in which these credentials will
+    be configured
+* **access_key_id**  : the access key id
+* **secret_access_key**  : the secret access key
+* **endpoint_url**  : the endpoint url of the service. If None,
+    AWS itself is used
+
+
+**Returns**
+
+* **credentials**  : `AWSCompatibleCredentials`
+
+
 **Raises**
 
 `SDKClientException`

md-docs/api/python/enums.md

@@ -19,6 +19,18 @@ ApiKeyExpirationTime()
 ----
 
 
+## BaseML3Enum
+```python 
+BaseML3Enum()
+```
+
+
+---
+Base class for all enums in the ML3 Platform SDK
+
+----
+
+
 ## ColumnRole
 ```python 
 ColumnRole()
@@ -84,7 +96,7 @@ DataType()
 
 ---
 Data type enum
-Describe data type of an input
+Describe data type of input
 
 ----
 
@@ -151,6 +163,7 @@ An integration with a 3rd party service provider
 - AWS
 - GCP
 - AZURE
+- AWS_COMPATIBLE
 
 ----
 
@@ -188,6 +201,24 @@ Type of folder
 ----
 
 
+## ImageMode
+```python 
+ImageMode()
+```
+
+
+---
+Image mode enumeration
+
+Fields
+------
+RGB: Red, Green, Blue
+RGBA: Red, Green, Blue, Alpha
+GRAYSCALE: Grayscale
+
+----
+
+
 ## JobStatus
 ```python 
 JobStatus()

md-docs/api/python/exceptions.md

@@ -85,6 +85,18 @@ ComputeRetrainingReportException
 ----
 
 
+## ComputeTopicModelingReportException
+```python 
+ComputeTopicModelingReportException()
+```
+
+
+---
+ComputeTopicModelingReportException
+
+----
+
+
 ## CreateCompanyException
 ```python 
 CreateCompanyException()
@@ -181,6 +193,18 @@ GetRetrainingReportException
 ----
 
 
+## GetTopicModelingReportException
+```python 
+GetTopicModelingReportException()
+```
+
+
+---
+GetTopicModelingReportException
+
+----
+
+
 ## InvalidActionList
 ```python 
 InvalidActionList()

md-docs/api/python/models.md

@@ -1,6 +1,29 @@
 #
 
 
+## AWSCompatibleCredentials
+```python 
+AWSCompatibleCredentials()
+```
+
+
+---
+AWS-compatible integration credentials.
+
+
+**Attributes**
+
+* **credentials_id**  : str
+* **name**  : str
+* **default**  : bool
+* **type**  : ExternalIntegration
+* **access_key_id**  : The access key id
+* **endpoint_url**  : The endpoint url (if any)
+
+
+----
+
+
 ## AWSCredentials
 ```python 
 AWSCredentials()
@@ -170,6 +193,9 @@ Column base model
     Indicates the subrole of the column. It's used in
     RAG tasks to define the role of the input columns
     (e.g. user input or retrieved context)
+* **image_mode**  : Optional[ImageMode] = None
+    Indicates the mode of the image. It must be provided
+    when the data type is an image
 
 
 ----
@@ -1052,6 +1078,43 @@ TaskRagEvalReportItem()
 ```
 
 
+---
+base model for Rag Evaluation Report
+
+
+**Attributes**
+
+* **id**  : str
+* **creation_datetime**  : datetime
+* **name**  : str
+* **status**  : JobStatus
+* **from_datetime**  : datetime
+* **to_datetime**  : datetime
+
+
+----
+
+
+## TaskTopicModelingReportDetails
+```python 
+TaskTopicModelingReportDetails()
+```
+
+
+---
+Task Topic Modeling Report Details base model
+
+----
+
+
+## TaskTopicModelingReportItem
+```python 
+TaskTopicModelingReportItem()
+```
+
+
+---
+Task Topic Modeling Report Item base model
 
 ----