Skip to content

Commit e7d6e20

Browse files
authored
Merge pull request #83 from UiPath/docs/improvements
chore: quick start docs improvements
2 parents 3221698 + dc1e5ab commit e7d6e20

1 file changed

Lines changed: 29 additions & 4 deletions

File tree

docs/quick_start.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -228,12 +228,27 @@ uipath run agent '{\"topic\":\"uipath\"}'
228228
229229
///
230230
231-
/// info
231+
/// attention
232232
233-
Run command also accepts a _.json_ file as input:
234-
>uipath run agent -f <path_to_input_json_file>
233+
For a shell agnostic option, please refer to the next section.
235234
236-
///
235+
///
236+
237+
### (Optional) Run The Agent with a json File as Input
238+
239+
The `run` command can also take a .json file as an input. You can create a file named `input.json` having the following content:
240+
241+
```json
242+
{
243+
"topic": "UiPath"
244+
}
245+
```
246+
247+
Use this file as agent input:
248+
249+
```shell
250+
> uipath run agent --file input.json
251+
```
237252
238253
## Deploy The Agent On UiPath Cloud Platform
239254
@@ -312,6 +327,16 @@ Use the provided link to monitor your job and view detailed traces.
312327
/>
313328
</picture>
314329
330+
### (Optional) Invoke The Agent with a json File as Input
331+
332+
The `invoke` command operates similarly to the `run` command, allowing you to use the same .json file defined
333+
in the [(Optional) Run the agent with a .json file as input](#optional-run-the-agent-with-a-json-file-as-input)
334+
section, as agent input:
335+
336+
```shell
337+
> uipath invoke agent --file input.json
338+
```
339+
315340
## Next Steps
316341
317342
Congratulations! You have successfully set up, created, published, and run a UiPath LangChain Agent. 🚀

0 commit comments

Comments
 (0)