-
Notifications
You must be signed in to change notification settings - Fork 12
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
AI assistant draft docs #570
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry Ayo, a few important changes here.
Outside of the details, I think we should question WHY we need a page of documentation on the assistant? To whose benefit is it? What message do we want to convey?
It's a pretty intuitive and discoverable tool I think. If we're going to spend time creating and maintaining docs, we should make sure they're valuable.
docs/jobs/ai-assistant.md
Outdated
@@ -0,0 +1,60 @@ | |||
--- | |||
title: Using OpenFn with AI Assistant |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
docs/jobs/ai-assistant.md
Outdated
|
||
:::warning | ||
|
||
AI makes mistakes. Always review the AI's response carefully and make sure to |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
static/img/ai-assistant-intro.png
Outdated
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm if this feature is going to change a lot, how about a quick video @christad92 explaining the basics instead of screenshots? Videos can quicker to replace compared with screenshots, and this could also generally be good content to create some buzz about this feature
docs/jobs/ai-assistant.md
Outdated
:::warning | ||
|
||
AI makes mistakes. Always review the AI's response carefully and make sure to | ||
verify the output. You can help us improve the AI Assistant by providing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How will they provide feedback?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@christad92 how about starting a dedicated "AI" category in the Community where users could share feedback... and where we could announce the feature and related updates.
docs/jobs/ai-assistant.md
Outdated
The AI Assistant is built on the Claude 3.5 Sonnet model from Anthropic and is | ||
trained with OpenFn documentation and example job code. The goal of the | ||
assistant is to help you with your jobs and diagnosing issues with your jobs and | ||
error logs. It is important to note that the assistant is not a replacement for |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
docs/jobs/ai-assistant.md
Outdated
|
||
The AI Assistant is built on the Claude 3.5 Sonnet model from Anthropic and is | ||
trained with OpenFn documentation and example job code. The goal of the | ||
assistant is to help you with your jobs and diagnosing issues with your jobs and |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
docs/jobs/ai-assistant.md
Outdated
|
||
:::caution | ||
|
||
Before you start, we recommend that you take a moment to read our more about the |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
docs/jobs/ai-assistant.md
Outdated
|
||
## How to access the AI Assistant | ||
|
||
The AI Assistant is located in the IDE/Inspector as a new tab in the Input |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
docs/jobs/ai-assistant.md
Outdated
|
||
The AI Assistant is located in the IDE/Inspector as a new tab in the Input | ||
panel. To use the Assistant, click on the `AI Assistant` tab. If it is your | ||
first time, this will open an introductory screen with a button that says |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
docs/jobs/ai-assistant.md
Outdated
sessions listed in cards names with the first prompt of the session. | ||
![Previous Sessions](/img/ai-assistant-sessions.png) | ||
|
||
To ask any question, you can type your question in the text area and click on |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
I will take a swing at this next week (ran out of time this week) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left some comments but I mostly defer to you and Joe on the docs here
docs/jobs/ai-assistant.md
Outdated
|
||
## How to access the AI Assistant | ||
|
||
The AI Assistant is located in the IDE/Inspector as a new tab in the Input |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
static/img/ai-assistant-intro.png
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm if this feature is going to change a lot, how about a quick video @christad92 explaining the basics instead of screenshots? Videos can quicker to replace compared with screenshots, and this could also generally be good content to create some buzz about this feature
docs/jobs/ai-assistant.md
Outdated
:::warning | ||
|
||
AI makes mistakes. Always review the AI's response carefully and make sure to | ||
verify the output. You can help us improve the AI Assistant by providing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@christad92 how about starting a dedicated "AI" category in the Community where users could share feedback... and where we could announce the feature and related updates.
Hey @christad92 (CC @aleksa-krolls), I've taken a swing at this. I have:
|
docs/build/ai-assistant.md
Outdated
|
||
:::caution Assistant Unavailable? | ||
|
||
The AI Assistant must be configured before it can be used. If it's not available on your deployment, contact your system administrator. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not at all sure about the language here (especially the second line). Can anyone give me a hand?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
expanded this language a bit, and linked to our pricing page
updating help text
fix broken links
No description provided.