Feat/release aiml updates #95

Mohith93 · 2024-08-30T20:00:02Z

Documentation Updates

Updated release documentation until May 2024

AI ML Sources documentation

Mohith93 · 2024-09-02T14:09:25Z

Mohith93 · 2024-09-02T14:20:31Z

macintushar · 2024-09-02T15:28:21Z

NIT: should be AI/ML and not AI & ML IMO

guides/ai-ml-integration/Sources.mdx

release-notes/June_2024.mdx

guides/ai-ml-integration/Sources.mdx

sumitd94 · 2024-09-02T17:32:15Z

guides/ai-ml-integration/Sources.mdx

+    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>


This needs to be updated.

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

sumitd94 · 2024-09-02T17:33:07Z

guides/ai-ml-integration/Sources.mdx

+
+  <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.


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

guides/ai-ml-integration/Sources.mdx

sumitd94 · 2024-09-02T17:35:22Z

guides/ai-ml-integration/Sources.mdx

+---
+**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.


This is wrong.
There will no tag.

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

Co-authored-by: Sumit Dhanania <[email protected]>

subintp · 2024-09-17T11:46:36Z

/add_docs

subintp · 2024-09-17T11:46:39Z

/improve

codiumai-pr-agent-pro · 2024-09-17T11:46:43Z

The docstring command only supports the following languages: python, java, cpp, javascript, typescript, jsx, tsx, csharp

codiumai-pr-agent-pro · 2024-09-17T11:46:46Z

PR Code Suggestions ✨

Category	Suggestion	Score
Accessibility	Improve image accessibility by providing a more descriptive alt text Consider adding a more descriptive alt text for the image. Instead of "Hero Light", use a description that explains what the image represents in the context of Data Apps. guides/ai-ml-integration/Data_Apps.mdx [7-11] <img className="block" src="https://res.cloudinary.com/dspflukeu/image/upload/f_auto,q_auto/v1/DevRel/dataapps" - alt="Hero Light" + alt="Data Apps integration illustration" /> Apply this suggestion Suggestion importance[1-10]: 8 Why: The suggestion improves accessibility by providing a more descriptive alt text, which is important for users relying on screen readers to understand the content of images.	8
Enhancement	Add a brief introduction before the step-by-step guide Consider adding a brief introduction or summary before the Steps component to provide context for the process of connecting AI/ML sources. guides/ai-ml-integration/Sources.mdx [9-16] <img className="block" src="https://res.cloudinary.com/dspflukeu/image/upload/f_auto,q_auto/v1/DevRel/sources" alt="Source Image" /> +To connect your AI/ML sources to the AI Squared application, follow these steps: + <Steps> Apply this suggestion Suggestion importance[1-10]: 7 Why: Adding an introduction provides context and enhances the readability of the document, making it easier for users to understand the purpose of the steps.	7
Enhancement	Add version numbers to features and improvements for better change tracking Consider adding version numbers for each feature and improvement to provide more context and make it easier for users to track changes. release-notes/June_2024.mdx [8-17] # 🚀 Features -- Iterable Destination Connector +- Iterable Destination Connector (v0.12.0) Integrate with Iterable, allowing seamless data flow to this popular marketing automation platform. -- Workspace Settings and useQueryWrapper +- Workspace Settings and useQueryWrapper (v0.12.1) New enhancements to workspace settings and the introduction of `useQueryWrapper` for improved data handling. -- Amazon S3 Source Connector +- Amazon S3 Source Connector (v0.13.0) Added support for Amazon S3 as a source connector, enabling data ingestion directly from your S3 buckets. Apply this suggestion Suggestion importance[1-10]: 6 Why: Including version numbers helps users track changes more effectively, although it is not crucial for understanding the release notes.	6
Maintainability	Reorganize features into logical groups for improved readability Consider grouping related features and improvements together to make the release notes more organized and easier to read. release-notes/May_2024.mdx [8-27] # 🚀 Features +## Connectors and Integrations +- 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. +- HTTP Destination Connector + Introduced the HTTP Destination Connector, allowing data to be sent to any HTTP endpoint. + +## Platform Enhancements - 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. - Apply this suggestion Suggestion importance[1-10]: 5 Why: Grouping related features enhances the organization and readability of the release notes, though it is not essential for understanding the content.	5

subintp · 2024-09-17T11:46:58Z

/review

codiumai-pr-agent-pro · 2024-09-17T11:47:18Z

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
🧪 No relevant tests
🔒 Security concerns Sensitive information exposure: The PR includes placeholders for authentication headers and secret keys in the 'guides/ai-ml-integration/Sources.mdx' file. While these are likely just placeholders, it's important to ensure that no actual sensitive information is accidentally committed. It's recommended to use environment variables or secure secret management systems for handling such sensitive data in production.
⚡ Key issues to review Sensitive Information Exposure The code includes placeholders for sensitive information such as authentication headers and secret keys. Ensure these are not accidentally committed with real values.

Mohith93 added 2 commits August 29, 2024 13:20

feat: updated release notes and ai/ml integrations

ce933a5

feat: updated release and ai/ml integrations docs

847075f

Mohith93 requested review from subintp and sumitd94 August 30, 2024 20:00

Mohith93 added 2 commits August 31, 2024 01:42

Merge branch 'main' into feat/release-aiml-updates

03e64da

Update Sources.mdx

3c50e8a

feat: updated with images docs

a17dce9

macintushar requested changes Sep 2, 2024

View reviewed changes

guides/ai-ml-integration/Sources.mdx Outdated Show resolved Hide resolved

guides/ai-ml-integration/Sources.mdx Outdated Show resolved Hide resolved

release-notes/June_2024.mdx Outdated Show resolved Hide resolved

Mohith93 added 2 commits September 2, 2024 21:13

feat: updated with changes per comments

7ddf53f

feat: updated with changes per comments

aa2413c

sumitd94 reviewed Sep 2, 2024

View reviewed changes

guides/ai-ml-integration/Sources.mdx Outdated Show resolved Hide resolved

sumitd94 reviewed Sep 2, 2024

View reviewed changes

guides/ai-ml-integration/Sources.mdx Outdated Show resolved Hide resolved

sumitd94 reviewed Sep 2, 2024

View reviewed changes

guides/ai-ml-integration/Sources.mdx Outdated Show resolved Hide resolved

sumitd94 reviewed Sep 2, 2024

View reviewed changes

Mohith93 and others added 3 commits September 2, 2024 23:32

Update guides/ai-ml-integration/Sources.mdx

e7791ad

Co-authored-by: Sumit Dhanania <[email protected]>

Update guides/ai-ml-integration/Sources.mdx

f247eaa

Co-authored-by: Sumit Dhanania <[email protected]>

Update guides/ai-ml-integration/Sources.mdx

3f97597

Co-authored-by: Sumit Dhanania <[email protected]>

codiumai-pr-agent-pro bot added the Review effort [1-5]: 3 label Sep 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/release aiml updates #95

Feat/release aiml updates #95

Mohith93 commented Aug 30, 2024

Mohith93 commented Sep 2, 2024

Mohith93 commented Sep 2, 2024

macintushar commented Sep 2, 2024

sumitd94 Sep 2, 2024

sumitd94 Sep 2, 2024

sumitd94 Sep 2, 2024

subintp commented Sep 17, 2024

subintp commented Sep 17, 2024

codiumai-pr-agent-pro bot commented Sep 17, 2024 •

edited

Loading

codiumai-pr-agent-pro bot commented Sep 17, 2024 •

edited

Loading

subintp commented Sep 17, 2024

codiumai-pr-agent-pro bot commented Sep 17, 2024


		<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.

Feat/release aiml updates #95

Are you sure you want to change the base?

Feat/release aiml updates #95

Conversation

Mohith93 commented Aug 30, 2024

Mohith93 commented Sep 2, 2024

Mohith93 commented Sep 2, 2024

macintushar commented Sep 2, 2024

sumitd94 Sep 2, 2024

Choose a reason for hiding this comment

sumitd94 Sep 2, 2024

Choose a reason for hiding this comment

sumitd94 Sep 2, 2024

Choose a reason for hiding this comment

subintp commented Sep 17, 2024

subintp commented Sep 17, 2024

codiumai-pr-agent-pro bot commented Sep 17, 2024 • edited Loading

codiumai-pr-agent-pro bot commented Sep 17, 2024 • edited Loading

PR Code Suggestions ✨

subintp commented Sep 17, 2024

codiumai-pr-agent-pro bot commented Sep 17, 2024

PR Reviewer Guide 🔍

codiumai-pr-agent-pro bot commented Sep 17, 2024 •

edited

Loading

codiumai-pr-agent-pro bot commented Sep 17, 2024 •

edited

Loading