Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/release aiml updates #95

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Binary file added guides/.DS_Store
Binary file not shown.
5 changes: 3 additions & 2 deletions guides/ai-ml-integration/Data_Apps.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
title: 'Data Apps'
description: " "
icon: ''
---

<img
className="block"
src=""
alt=""
src="https://res.cloudinary.com/dspflukeu/image/upload/f_auto,q_auto/v1/DevRel/dataapps"
alt="Hero Light"
/>

<Note>Watch out for this space, **Data Apps** coming soon!</Note>
14 changes: 10 additions & 4 deletions guides/ai-ml-integration/Models.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
---
title: 'Models'
description: " "
description: |
The AI/ML Model creation process involves defining how to harvest the necessary values for the input variables that were specified during the creation of an AI/ML Source Connector. This step is crucial for ensuring that the data from your source is properly mapped to the corresponding input variables in your model.

By accurately defining the data extraction and processing methods, you ensure that the AI/ML model receives the relevant and correctly formatted data needed for making predictions or decisions. This process sets the foundation for the model's overall performance and accuracy.
icon: 'table'

---

<img
className="block"
src=""
alt=""
src="https://res.cloudinary.com/dspflukeu/image/upload/f_auto,q_auto/v1/DevRel/models"
alt="Hero Light"
/>

<Note>Watch out for this space, **Models** coming soon!</Note>
<Note>Watch out for this space, **Models** coming soon!</Note>

100 changes: 96 additions & 4 deletions guides/ai-ml-integration/Sources.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,104 @@
---
title: 'Sources'
description: " "

description: "AI/ML sources refer to datasets or repositories of information that serve as inputs for Artificial Intelligence (AI) and Machine Learning (ML) models. These sources provide the data needed to train, validate, and test AI/ML models, enabling them to make accurate predictions and informed decisions. Connect your AI/ML sources to the AI Squared application by following the steps outlined below."
icon: 'database'

---

<img
className="block"
src=""
alt=""
src="https://res.cloudinary.com/dspflukeu/image/upload/f_auto,q_auto/v1/DevRel/sources"
alt="Source Image"
/>

<Note>Watch out for this space, **Sources** coming soon!</Note>

<Steps>

<Step title="Step 1">
Navigate to the <strong>Sources</strong> section in the AISquared application. Click on the <strong>Add Source</strong> button located in the top right corner of the screen to begin adding a new data source.
Mohith93 marked this conversation as resolved.
Show resolved Hide resolved
Mohith93 marked this conversation as resolved.
Show resolved Hide resolved
<img
className="block"
src="https://res.cloudinary.com/dspflukeu/image/upload/f_auto,q_auto/v1/DevRel/Source%20-%20AIML/step1"
alt="Step 1"
/>
</Step>

<Step title="Step 2">
From the list of available connectors, select the <strong>AI/ML Source</strong> connector that you wish to connect to. This allows you to integrate with various AI/ML data sources.
Mohith93 marked this conversation as resolved.
Show resolved Hide resolved
<img
className="block"
src="https://res.cloudinary.com/dspflukeu/image/upload/f_auto,q_auto/v1/DevRel/Source%20-%20AIML/step2"
alt="Step 2"
/>
</Step>

<Step title="Step 3">
To establish a connection to your chosen endpoint, fill in the following details:
<ul>
<li><strong>Endpoint Name:</strong> A unique name to identify this endpoint.</li>
<li><strong>URL:</strong> The endpoint's URL where the data can be accessed.</li>
<li><strong>Authentication:</strong> Select the type of authentication required for accessing the endpoint.</li>
<li><strong>Auth Header:</strong> Provide the authentication header if needed.</li>
<li><strong>Secret Key:</strong> Enter the secret key for secure access.</li>
</ul>
Additionally, provide a sample <strong>Request Format</strong> and <strong>Response Format</strong> to define how data will be sent to and received from the endpoint.
<img
className="block"
src="https://res.cloudinary.com/dspflukeu/image/upload/f_auto,q_auto/v1/DevRel/Source%20-%20AIML/step3"
alt="Step 3"
/>
</Step>
Comment on lines +36 to +51
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be updated.

Go to production and see the config screen for Databricks AI Model.
The designs are different


<Step title="Step 4">
After entering the necessary details, test the connection by clicking on the <strong>Test Connection</strong> button. Ensure that you receive a "Connection Successful" response, indicating that the endpoint is correctly configured.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no Test Connection button. The image you attached and text you have written does not align well.
On this screen, it automatically starts testing the config and updates you

<img
className="block"
src="https://res.cloudinary.com/dspflukeu/image/upload/f_auto,q_auto/v1/DevRel/Source%20-%20AIML/step4"
alt="Step 4"
/>
</Step>

<Step title="Step 5">
Provide a name for your new source, and add a brief description that explains its purpose or any relevant details. This will help in identifying the source later.
<img
className="block"
src="https://res.cloudinary.com/dspflukeu/image/upload/f_auto,q_auto/v1/DevRel/Source%20-%20AIML/step5"
alt="Step 5"
/>
</Step>

<Step title="Step 6">
Define the input schema for the data by specifying the following:
Mohith93 marked this conversation as resolved.
Show resolved Hide resolved
<ul>
<li><strong>Name:</strong> The name of each key in the payload (as defined in the request format).</li>
<li><strong>Type:</strong> The data type for each key (e.g., String, Integer, Float, Boolean).</li>
<li><strong>Value:</strong> Indicate whether the value is dynamic (changes over time) or static (remains constant).</li>
</ul>
This schema will structure the data that is input into your AI/ML models.
<img
className="block"
src="https://res.cloudinary.com/dspflukeu/image/upload/f_auto,q_auto/v1/DevRel/Source%20-%20AIML/step6"
alt="Step 6"
/>
</Step>

<Step title="Step 7">
Similarly, define the output schema by specifying the following:
<ul>
<li><strong>Field Name:</strong> The name of each key in the output payload (as defined in the response format).</li>
<li><strong>Type:</strong> The data type for each key (e.g., String, Integer, Float, Boolean).</li>
</ul>
This schema will structure the data that your AI/ML model will output.
<img
className="block"
src="https://res.cloudinary.com/dspflukeu/image/upload/f_auto,q_auto/v1/DevRel/Source%20-%20AIML/step7"
alt="Step 7"
/>
</Step>

</Steps>

---
**Conclusion:**
Once the source is created, it will be displayed in the **Sources** list with a tag labeled **AI/ML** to easily differentiate it from other types of sources.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is wrong.
There will no tag.

Sources screen has AIML Sources and Data Sources which helps in differentiating the Sources.
Please update this

4 changes: 3 additions & 1 deletion mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,9 @@
"pages": [
"release-notes/2024",
"release-notes/July_2024",
"release-notes/August_2024"
"release-notes/August_2024",
"release-notes/May_2024",
"release-notes/June_2024"
]
},
{
Expand Down
12 changes: 12 additions & 0 deletions release-notes/2024.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,16 @@ description: ''
href='/release-notes/July_2024' >
Version: v0.14.0 to v0.19.0
</Card>
<Card
title='June 2024'
icon='book-open'
href='/release-notes/June_2024' >
Version: v0.12.0 to v0.13.0
</Card>
<Card
title='May 2024'
icon='book-open'
href='/release-notes/May_2024' >
Version: v0.5.0 to v0.8.0
</Card>
</CardGroup>
70 changes: 70 additions & 0 deletions release-notes/June_2024.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: June 2024 releases
description: ' Multiwoven Release updates for the month of June'

---


# 🚀 Features

- **Iterable Destination Connector**
Integrate with Iterable, allowing seamless data flow to this popular marketing automation platform.

- **Workspace Settings and useQueryWrapper**
New enhancements to workspace settings and the introduction of `useQueryWrapper` for improved data handling.

- **Amazon S3 Source Connector**
Added support for Amazon S3 as a source connector, enabling data ingestion directly from your S3 buckets.



# 🛠️ Improvements



- **GitHub URL Issues**
Addressed inconsistencies with GitHub URLs in the application.

- **Change GitHub PAT to SSH Private Key**
Updated authentication method from GitHub PAT to SSH Private Key for enhanced security.

- **UI Maintainability and Workspace ID on Page Refresh**
Improved UI maintainability and ensured that the workspace ID persists after page refresh.

- **CE Sync Commit for Multiple Commits**
Fixed the issue where CE sync commits were not functioning correctly for multiple commits.

- **Add Role in User Info API Response**
Enhanced the user info API to include role details in the response.

- **Sync Write Update Action for Destination**
Synchronized the write update action across various destinations for consistency.

- **Fix Sync Name Validation Error**
Resolved validation errors in sync names due to contract issues.

- **Update Commit Message Regex**
Updated the regular expression for commit messages to follow git conventions.

- **Update Insert and Update Actions**
Renamed `insert` and `update` actions to `destination_insert` and `destination_update` for clarity.

- **Comment Contract Valid Rule in Update Sync Action**
Adjusted the contract validation rule in the update sync action to prevent failures.

- **Fix for Primary Key in `destination_update`**
Resolved the issue where `destination_update` was not correctly picking up the primary key.

- **Add Limit and Offset Query Validator**
Introduced validation for limit and offset queries to improve API reliability.

- **Ignore RBAC for Get Workspaces API**
Modified the API to bypass Role-Based Access Control (RBAC) for fetching workspaces.

- **Heartbeat Timeout Update for Loader**
Updated the heartbeat timeout for the loader to ensure smoother operations.

- **Add Strong Migration Gem**
Integrated the Strong Migration gem to help with safe database migrations.

<Note>Stay tuned for more exciting updates in the upcoming releases!</Note>
110 changes: 110 additions & 0 deletions release-notes/May_2024.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
---
title: May 2024 releases
description: ' Multiwoven Release updates for the month of May'

---


# 🚀 Features

- **Role and Resource Migration**
Introduced migration capabilities for roles and resources, enhancing data management and security.

- **Zendesk Destination Connector**
Added support for Zendesk as a destination connector, enabling seamless integration with Zendesk for data flow.

- **Athena Connector**
Integrated the Athena Connector, allowing users to connect to and query Athena directly from the platform.

- **Support for Temporal Cloud**
Enabled support for Temporal Cloud, facilitating advanced workflow orchestration in the cloud.

- **Workspace APIs for CE**
Added Workspace APIs for the Community Edition, expanding workspace management capabilities.

- **HTTP Destination Connector**
Introduced the HTTP Destination Connector, allowing data to be sent to any HTTP endpoint.

- **Separate Routes for Main Application**
Organized and separated routes for the main application, improving modularity and maintainability.

- **Compression Support for SFTP**
Added compression support for SFTP, enabling faster and more efficient data transfers.

- **Password Field Toggle**
Introduced a toggle to view or hide password field values, enhancing user experience and security.

- **Dynamic UI Schema Generation**
Added dynamic generation of UI schemas, streamlining the user interface customization process.

- **Health Check Endpoint for Worker**
Added a health check endpoint for worker services, ensuring better monitoring and reliability.

- **Skip Rows in Sync Runs Table**
Implemented functionality to skip rows in the sync runs table, providing more control over data synchronization.

- **Cron Expression as Schedule Type**
Added support for using cron expressions as a schedule type, offering more flexibility in task scheduling.

- **SQL Autocomplete**
Introduced SQL autocomplete functionality, improving query writing efficiency.



# 🛠️ Improvements

- **Text Update in Finalize Source Form**
Changed and improved the text in the Finalize Source Form for clarity.

- **Rate Limiter Spec Failure**
Fixed a failure issue in the rate limiter specifications, ensuring better performance and stability.

- **Check for Null Record Data**
Added a condition to check if record data is null, preventing errors during data processing.

- **Cursor Field Mandatory Check**
Ensured that the cursor field is mandatory, improving data integrity during synchronization.

- **Docker Build for ARM64 Release**
Fixed the Docker build process for ARM64 releases, ensuring compatibility across architectures.

- **UI Auto Deploy**
Improved the UI auto-deployment process for more efficient updates.

- **Cursor Query for SOQL**
Added support for cursor queries in SOQL, enhancing Salesforce data operations.

- **Skip Cursor Query for Empty Cursor Field**
Implemented a check to skip cursor queries when the cursor field is empty, avoiding unnecessary processing.

- **Updated Integration Gem Version**
Updated the integration gem to version 0.1.67, including support for Athena source, Zendesk, and HTTP destinations.

- **Removed Stale User Management APIs**
Deleted outdated user management APIs and made changes to role ID handling for better security.

- **Color and Logo Theme Update**
Changed colors and logos to align with the new theme, providing a refreshed UI appearance.

- **Refactored Modeling Method Screen**
Refactored the modeling method screen for better usability and code maintainability.

- **Removed Hardcoded UI Schema**
Removed hardcoded UI schema elements, making the UI more dynamic and adaptable.

- **Heartbeat Timeout for Loader**
Updated the heartbeat timeout for the loader, improving the reliability of the loading process.

- **Integration Gem to 1.63**
Bumped the integration gem version to 1.63, including various improvements and bug fixes.

- **Core Chakra Config Update**
Updated the core Chakra UI configuration to support new branding requirements.

- **Branding Support in Config**
Modified the configuration to support custom branding, allowing for more personalized user experiences.

- **Strong Migration Gem Addition**
Integrated the Strong Migration gem to ensure safer and more efficient database migrations.

<Note>Stay tuned for more exciting updates in future releases!</Note>