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

Create AI integration #684

Merged
merged 3 commits into from
Dec 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions portal/content/docs/documentation/ai-integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: AI integration
sidebar:
order: 9
---
The ODE has an AI component to help users improve column names and descriptions. To use the AI feature, please first ingest or select a file from the sidebar. Then click on the AI button located on the top right corner of the app:

![AI Integration button is located in the top panel](./assets/ai-integration/ai-integration-1.png)

The tool will then display a dialog to inform the user that by confirming the action, the app will only share column names with OpenAI. If the user accepts, the next step is to add the OpenAI key. The dialog also includes a link to check OpenAI terms and conditions:

![OpenAI key dialog](./assets/ai-integration/ai-integration-2.png)

After pasting your OpenAI key, the ODE will show you a predefined prompt:

![OpenAI Prompt dialog](./assets/ai-integration/ai-integration-3.png)

Finally, clicking on confirm will generate the response.

Note: The OpenAI integration is a pilot. The ODE team will collect feedback and improve the implementation in 2025.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Comparison to Alternatives
sidebar:
order: 11
order: 12
---

There are several alternatives available with their own pros and cons. Let's comapre them with **Open Data Editor** to have a better understanding of the Data IDE field.
Expand Down
2 changes: 1 addition & 1 deletion portal/content/docs/documentation/explore-edit-metadata.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: How to explore and edit metadata
sidebar:
order: 9
order: 10
---

To explore or edit the metadata, select a file from the menu on the left and click on the **Metadata button** located at the top left of the datagrid.
Expand Down
2 changes: 1 addition & 1 deletion portal/content/docs/documentation/publishing-data.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Publishing your data
sidebar:
order: 10
order: 11
---

You can publish a file using the **Publish** feature located at the top right of the datagrid:
Expand Down
Loading