AI assistant draft docs #570

christad92 · 2024-09-10T21:57:17Z

No description provided.

josephjclark

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

@@ -0,0 +1,60 @@
+---
+title: Using OpenFn with AI Assistant


docs/jobs/ai-assistant.md

+
+:::warning
+
+AI makes mistakes. Always review the AI's response carefully and make sure to


aleksa-krolls · 2024-09-14T19:53:46Z

static/img/ai-assistant-intro.png

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

josephjclark · 2024-09-11T06:38:39Z

docs/jobs/ai-assistant.md

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


How will they provide feedback?

@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

+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


docs/jobs/ai-assistant.md

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


docs/jobs/ai-assistant.md

+
+:::caution
+
+Before you start, we recommend that you take a moment to read our more about the


docs/jobs/ai-assistant.md

+
+## How to access the AI Assistant
+
+The AI Assistant is located in the IDE/Inspector as a new tab in the Input


docs/jobs/ai-assistant.md

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


docs/jobs/ai-assistant.md

+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


josephjclark · 2024-09-13T16:21:52Z

I will take a swing at this next week (ran out of time this week)

aleksa-krolls

Left some comments but I mostly defer to you and Joe on the docs here

docs/jobs/ai-assistant.md

+
+## How to access the AI Assistant
+
+The AI Assistant is located in the IDE/Inspector as a new tab in the Input


aleksa-krolls · 2024-09-14T19:53:46Z

static/img/ai-assistant-intro.png

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

aleksa-krolls · 2024-09-14T19:54:56Z

docs/jobs/ai-assistant.md

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


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

josephjclark · 2024-09-27T15:37:30Z

Hey @christad92 (CC @aleksa-krolls), I've taken a swing at this. I have:

Moved the AI Assistant page into Platform/Build & Manage workflows, add added a link to it in the Job Writing Guide. That's because the AI Assistant is a Lightning feature. Admittedly it's a little buried there, but I'm OK with that
Removed the unnecessarily scary language. We can advice caution and encourage critical thinking without giving the impression that our product is totally broken.
Reduced the number of screenshots to just 1. This will need updating one day because it looks horribly broken, but there's not a lot we can do right now until the actual feature is fixed (BTW can I remind you that we have a lot of outstanding and very important issues open for the Assistant?)
Simplified and clarified some of the usage instructions to what I think is a more helpful level
Added a note about what to do if the assistant is disabled. I'd appreciate some help with the language on this one!

josephjclark · 2024-09-27T15:38:10Z

docs/build/ai-assistant.md

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


I'm not at all sure about the language here (especially the second line). Can anyone give me a hand?

expanded this language a bit, and linked to our pricing page

updating help text

fix broken links

christad92 added 2 commits September 10, 2024 22:23

Draft AI Assistant Docs

ec0841a

Updated draft of AI Assistant

d312ba0

christad92 requested review from josephjclark and aleksa-krolls September 10, 2024 21:57

added prettier

bef96d6

josephjclark requested changes Sep 11, 2024

View reviewed changes

aleksa-krolls reviewed Sep 14, 2024

View reviewed changes

josephjclark added 4 commits September 27, 2024 15:59

Move ai-assistant page under platform

1b2c735

Redraft ai assistant docs

6992c56

update ai assistant images

f1261af

Add note about the assistant being unavailable

d868a50

josephjclark reviewed Sep 27, 2024

View reviewed changes

josephjclark requested a review from aleksa-krolls September 27, 2024 15:38

christad92 and others added 2 commits October 17, 2024 11:17

Updated availability statement

605acc0

Update ai-assistant.md

6141b10

updating help text

aleksa-krolls approved these changes Oct 18, 2024

View reviewed changes

Update ai-assistant.md

4632951

fix broken links

aleksa-krolls merged commit 23ddc4d into main Oct 18, 2024
1 check passed

aleksa-krolls deleted the ai-assistant branch October 18, 2024 17:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AI assistant draft docs #570

AI assistant draft docs #570

christad92 commented Sep 10, 2024

josephjclark left a comment

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

aleksa-krolls Sep 14, 2024

josephjclark Sep 11, 2024

aleksa-krolls Sep 14, 2024

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

josephjclark commented Sep 13, 2024

aleksa-krolls left a comment

This comment was marked as outdated.

aleksa-krolls Sep 14, 2024

aleksa-krolls Sep 14, 2024

josephjclark commented Sep 27, 2024

josephjclark Sep 27, 2024

aleksa-krolls Oct 18, 2024


		:::warning

		AI makes mistakes. Always review the AI's response carefully and make sure to


		:::caution

		Before you start, we recommend that you take a moment to read our more about the


		## How to access the AI Assistant

		The AI Assistant is located in the IDE/Inspector as a new tab in the Input


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

AI assistant draft docs #570

AI assistant draft docs #570

Conversation

christad92 commented Sep 10, 2024

josephjclark left a comment

Choose a reason for hiding this comment

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

aleksa-krolls Sep 14, 2024

Choose a reason for hiding this comment

josephjclark Sep 11, 2024

Choose a reason for hiding this comment

aleksa-krolls Sep 14, 2024

Choose a reason for hiding this comment

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

josephjclark commented Sep 13, 2024

aleksa-krolls left a comment

Choose a reason for hiding this comment

This comment was marked as outdated.

aleksa-krolls Sep 14, 2024

Choose a reason for hiding this comment

aleksa-krolls Sep 14, 2024

Choose a reason for hiding this comment

josephjclark commented Sep 27, 2024

josephjclark Sep 27, 2024

Choose a reason for hiding this comment

aleksa-krolls Oct 18, 2024

Choose a reason for hiding this comment