Skip to content

Commit 98b78b5

Browse files
authored
Update NLA API section in docs (#41)
1 parent 344258d commit 98b78b5

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

apps/docs/docs/quick-start/set-up-runner.mdx

+5-4
Original file line numberDiff line numberDiff line change
@@ -89,25 +89,26 @@ You should receive a successful response with the list of installed connectors a
8989
By default, the [connery-io/connery-runner-administration](https://github.com/connery-io/connery-runner-administration) connector is preinstalled on the runner.
9090
:::
9191

92-
### Run action using natural language
92+
### Identify action using natural language
9393

94-
Here is an example of using Natural Language Actions API to run the `RefreshConnectorsCache` action from the `connery-io/connery-runner-administration` connector.
94+
Here is an example of using Natural Language Actions API to identify action based on the natural language request.
9595

9696
:::info
9797
The `OPENAI_API_KEY` is required for the Natural Language Actions feature to work.
9898
If you configure it just now, you must restart the runner to apply the changes.
9999
:::
100100

101101
```
102-
curl '<PUBLIC_RUNNER_URL>actions/run' \
102+
curl '<PUBLIC_RUNNER_URL>actions/identify' \
103103
-H 'Content-Type: application/json' \
104104
-H 'x-api-key: <CONNERY_RUNNER_API_KEY>' \
105105
-d '{
106106
"prompt": "Please clean connectors cache on the runner."
107107
}' | jq .
108108
```
109109

110-
You should receive a natural language response from the runner.
110+
You should receive a response from the runner with the identified action, its connector, and the list of input parameters.
111+
Once the action is identified, you can run it using the API call from the next step.
111112

112113
### Run action using API
113114

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Subproject commit 38a5a36fab074d2d81ea2e7b1d85c94d63553212

0 commit comments

Comments
 (0)