Skip to content

Commit a13592a

Browse files
Merge pull request #652 from OpenFn/adaptor-updates-mar25
Adaptor overview page updates & edits to AI Assistant links and copy
2 parents dae7c4d + cb2c0b2 commit a13592a

File tree

8 files changed

+152
-18
lines changed

8 files changed

+152
-18
lines changed

adaptors/chatgpt.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: ChatGPT AI Adaptor
3+
---
4+
5+
## About ChatGPT
6+
7+
[ChatGPT](https://chatgpt.com/) is an AI assistant built by OpenAI. It provides
8+
a family of large language models (LLMs) developed for natural language
9+
processing tasks such as text generation, summarization, and question answering.
10+
11+
ChatGPT models process text input to generate responses but do not have built-in memory or autonomous decision-making. They can be integrated with external tools
12+
or APIs to execute actions beyond text-based outputs.
13+
14+
## Use OpenFn + LLMs for AI-Driven Workflows
15+
16+
While LLMs (like Claude or ChatGPT) can generate insights, recommendations, or
17+
structured data, they often **lack direct execution capabilities**—meaning they
18+
need an automation system to act on their outputs.
19+
20+
**OpenFn workflows fill this gap by orchestrating actions based on LLM-generated responses.**
21+
22+
Remember that LLMs are imperfect. Learn more about your recommended approach to
23+
AI in our [Responsible AI Policy](https://www.openfn.org/ai).
24+
25+
## Integration Options
26+
27+
Use this adpator to integrate with the [OpenAI Platform API](https://platform.openai.com/docs/overview), to integrate ChatGPT AI models into your workflows to
28+
leverage their natural language processing (NLP) capabilities.
29+
30+
Example AI-driven workflow on OpenFn:
31+
![ai-driven-workflow](/img/ai-workflow-example.png)
32+
33+
## Authentication
34+
35+
See this adaptor's
36+
[Configuration docs](/adaptors/packages/chatgpt-configuration-schema) for
37+
technical docs on the authentication parameters required.
38+
39+
## Helpful Links
40+
41+
- About ChatGPT: https://chatgpt.com/
42+
- API docs: https://platform.openai.com/docs/overview
43+
- API Intro: https://www.chatbase.co/blog/chatgpt-api

adaptors/claude.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Claude AI Adaptor
3+
---
4+
5+
## About Claude
6+
7+
[Claude](https://claude.ai/) is an AI assistant built by Anthropic. It provides
8+
a family of large language models (LLMs) developed for natural language
9+
processing tasks such as text generation, summarization, and question answering.
10+
11+
Claude models process text input to generate responses but do not have built-in
12+
memory or autonomous decision-making. They can be integrated with external tools
13+
or APIs to execute actions beyond text-based outputs.
14+
15+
## Use OpenFn + LLMs for AI-Driven Workflows
16+
17+
While LLMs (like Claude or ChatGPT) can generate insights, recommendations, or
18+
structured data, they often **lack direct execution capabilities**—meaning they
19+
need an automation system to act on their outputs.
20+
21+
**OpenFn workflows fill this gap by orchestrating actions based on LLM-generated responses.**
22+
23+
Remember that LLMs are imperfect. Learn more about your recommended approach to
24+
AI in our [Responsible AI Policy](https://www.openfn.org/ai).
25+
26+
## Integration Options
27+
28+
Use this adpator to integrate with the [Claude API](https://www.anthropic.com/api), to integrate Claude AI models into your workflows to
29+
leverage their natural language processing (NLP) capabilities.
30+
31+
Example AI-driven workflow on OpenFn:
32+
![ai-driven-workflow](/img/ai-workflow-example.png)
33+
34+
## Authentication
35+
36+
See this adaptor's
37+
[Configuration docs](/adaptors/packages/claude-configuration-schema) for
38+
technical docs on the authentication parameters required.
39+
40+
## Helpful Links
41+
42+
- About Claude: https://claude.ai/
43+
- API docs: https://www.anthropic.com/api

adaptors/varo.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Varo Adaptor
3+
---
4+
5+
## About Varo
6+
7+
[Varo](https://www.varo-app.org/) is a simple and free smartphone app that
8+
collects and forwards useful cold chain information and temperature logs to the
9+
email inbox of your choice.
10+
11+
## Integration Options
12+
13+
This is a data transformation adaptor for converting Varo data to the WHO
14+
Equipment Monitoring System (EMS) standard.
15+
16+
To integrate with Varo data, you can use the relevant OpenFn adaptor (e.g.,
17+
Gmail) for your chosen email inbox to query the Varo emails and attachments.
18+
19+
![example-workflow](/img/sample-cce-workflow.png)
20+
21+
## Authentication
22+
23+
N/A - This adaptor is for data transformation only, and not for direct
24+
connection to the Varo app. See note in above section.
25+
26+
## Helpful Links
27+
28+
- Varo website: https://www.varo-app.org/
29+
- WHO documentation on EMS standard:
30+
https://extranet.who.int/prequal/immunization-devices/e006-temperature-monitoring-devices

docs/build/ai-assistant.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,30 @@ sidebar_label: AI Assistant
44
---
55

66
The OpenFn AI Assistant provides a chat interface with an AI Model to help you
7-
build workflows.
7+
build workflows. **Check out [this video](https://www.youtube.com/watch?v=3L_cGl9tWRc&ab_channel=OpenFn.org) for an introduction on how it works.**
88

99
You can use it to draft, proofread and debug job code, diagnose errors, and
1010
understand the capabilities of the platform.
1111

12+
:::info Build AI-Driven Workflows on OpenFn
13+
14+
Check out OpenFn [adaptors](/adaptors) to build OpenFn workflows that orchestrate interactions with LLMs (like ChatGPT and Claude) and turn AI-powered decision-making into action and automated execution.
15+
16+
:::
17+
1218
![AI Assistant](/img/ai-assistant.png)
1319

14-
:::caution Assistant Unavailable? Can't find it?
20+
:::caution Assistant Unavailable? Can't find it?
1521

16-
For local deployments of OpenFn, the instance administrator needs to configure the AI
17-
Assistant before it is available. See
22+
For local deployments of OpenFn, the instance administrator needs to configure
23+
the AI Assistant before it is available. See
1824
[deployment docs](https://github.com/OpenFn/lightning/blob/main/DEPLOYMENT.md#ai-chat)
1925
here for help or contact the super user of your instance.
2026

2127
The Assistant is available on app.openfn.org, with usage credits subject your
22-
project's plan. See [openfn.org/pricing](https://www.openfn.org/pricing) or contact [[email protected]](mailto:[email protected])
23-
for more information on paid plans for usage of OpenFn's cloud-hosted platform.
28+
project's plan. See [openfn.org/pricing](https://www.openfn.org/pricing) or
29+
contact [[email protected]](mailto:[email protected]) for more information on
30+
paid plans for usage of OpenFn's cloud-hosted platform.
2431

2532
:::
2633

@@ -36,20 +43,19 @@ versions of the assistant may be rolled out to other pages.
3643
All chat sessions are shared between all users of the project. You can start a
3744
new chat session at any time, or open an old one.
3845

39-
Input data and run-time job logs not sent to the model. But we do include
40-
your step code so that the Assistant can provide a contextually relevant answer.
46+
Input data and run-time job logs not sent to the model. But we do include your
47+
step code so that the Assistant can provide a contextually relevant answer.
4148

4249
## A Note on Responsible AI Usage
4350

4451
The AI assistant is built on emerging Large Language Model (terminology). Like
45-
other LLMS and chatbots, its capabilities are impressive, but imperfect.
52+
other LLMs and chatbots, its capabilities are impressive, but imperfect.
4653

4754
Remember that ultimately, all responses are generated by an algorithm and YOU,
4855
the human in charge, are responsible for how its output is used. You should
4956
consider all responses critically and verify the output where possible.
5057

51-
You can read more about our approach to AI in our
52-
[Responsible AI Policy](https://www.openfn.org/ai).
58+
**You can read more about our approach to AI in our [Responsible AI Policy](https://www.openfn.org/ai).**
5359

5460
## How to access the AI Assistant
5561

@@ -68,9 +74,10 @@ You can close a chat session by clicking the `(X)` button on the top right of
6874
the chat interface, which will take you back to the list of sessions for this
6975
step.
7076

71-
:::caution Feedback or Questions about the Assistant?
77+
:::caution Feedback or Questions about the Assistant?
7278

73-
We welcome your questions or feedback on [community.openfn.org](https://community.openfn.org/),
74-
or contact [[email protected]](mailto:[email protected]) with private queries.
79+
We welcome your questions or feedback on
80+
[community.openfn.org](https://community.openfn.org/), or contact
81+
[[email protected]](mailto:[email protected]) with private queries.
7582

7683
:::

docs/build/collections.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ sidebar_label: Collections
44
---
55

66
Collections provides a high-volume, high-performance storage solution built into
7-
OpenFn.
7+
OpenFn. Check out
8+
**[this video](https://www.youtube.com/watch?v=iXkkkzratzY&t=3s&ab_channel=OpenFn.org)**
9+
for an introduction.
810

911
Collections is suitable for buffering, caching and aggregating data from
1012
Webhooks, storing large mapping files, and sharing state between workflows.
@@ -65,8 +67,8 @@ You can use the Collections API with any adaptor.
6567

6668
:::
6769

68-
Data is stored as key-value pairs, where the key is a unique identifier for
69-
some data (like a UUID, or timestamp). The value is always saved as a string
70+
Data is stored as key-value pairs, where the key is a unique identifier for some
71+
data (like a UUID, or timestamp). The value is always saved as a string
7072
(although you can pass JSON-compatible objects directly, which will be
7173
automatically serialized by the Collections API).
7274

@@ -142,7 +144,9 @@ collections.each(
142144
);
143145
```
144146

145-
Values are uploaded to a collection through `collections.set`. All sets are "upserts" - meaning that new keys will be created for values that don't exist, and values will be updated for keys that _do_ exist.
147+
Values are uploaded to a collection through `collections.set`. All sets are
148+
"upserts" - meaning that new keys will be created for values that don't exist,
149+
and values will be updated for keys that _do_ exist.
146150

147151
The example below sets a single item:
148152

docs/get-started/terminology.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,13 @@ Workflows are the **"what to do"** part of automation!
4545

4646
:::
4747

48+
A workflow is a structured sequence of tasks, processes, or actions that are
49+
executed automatically based on predefined rules, triggers, and logic.
50+
51+
When working with AI, workflows provide the structured execution needed to turn
52+
LLM insights into real-world actions, while AI agents enable more dynamic
53+
decision-making within workflows.
54+
4855
A Workflow is a collection of a Trigger, Steps, Paths, and custom logic
4956
connected together to automate a specific business process or task. A Workflow
5057
is configured via the Canvas in the web app, or locally (via code).

static/img/ai-workflow-example.png

55.1 KB
Loading

static/img/sample-cce-workflow.png

230 KB
Loading

0 commit comments

Comments
 (0)