From d868a5066c2d6588725a9010fbce505419f4a60e Mon Sep 17 00:00:00 2001 From: Joe Clark Date: Fri, 27 Sep 2024 16:36:50 +0100 Subject: [PATCH] Add note about the assistant being unavailable --- docs/build/ai-assistant.md | 9 +++++++++ docs/build/steps/step-editor.md | 6 ++++++ 2 files changed, 15 insertions(+) diff --git a/docs/build/ai-assistant.md b/docs/build/ai-assistant.md index 82fdd2e8cb56..8841881ddc3e 100644 --- a/docs/build/ai-assistant.md +++ b/docs/build/ai-assistant.md @@ -11,6 +11,15 @@ understand the capabilities of the platform. ![AI Assistant](/img/ai-assistant.png) +:::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. + +The Assistant is available on app.openfn.org, with usage credits subject your organization's plan. + +::: + + ## About the Assistant The AI Assistant is built on the Claude 3.5 Sonnet model from diff --git a/docs/build/steps/step-editor.md b/docs/build/steps/step-editor.md index ffb882249a1d..02ffa8c0220c 100644 --- a/docs/build/steps/step-editor.md +++ b/docs/build/steps/step-editor.md @@ -6,6 +6,12 @@ sidebar_label: Edit & Test Steps This page outlines how to edit and test Steps in your Workflow using the Inspector interface. +:::tip + +If you're writing jobs on the platform app (Lightning), you can use the [AI Assistant](/documentation/build/ai-assistant) to help you. You'll find it in the Inspector. + +::: + ## Edit & Test Steps via the Inspector Use the `Inspector` interface on the platform to create, edit, and test Steps.