vodorod/Dorod-Sky
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update workflow-blocks.mdx (#950)

Browse Source
This commit is contained in:
kati3-design
2024-10-11 18:26:36 -04:00
committed by GitHub
parent d43b0b5d91
commit 7012ee0f2b
1 changed files with 56 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
docs/workflows/workflow-blocks.mdx
View File

@@ -4,7 +4,7 @@ description: 'Individual Blocks within Skyvern'
---
### TaskBlock
## TaskBlock
The magic block. Skyvern navigates through the websites to take actions and/or extract information.
@@ -25,9 +25,28 @@ Example block:
stuck_with_popups: terminate and return this error if you can't close popups after several tries and can't take the necessary actions on the website because there is a blocking popup on the page
failed_to_login: terminate and return this error if you fail logging in to the page
```
Inputs:
### ForLoopBlock
Iterate over something such as a CSV or the output of a previous block. The blocks nedted under `loop_blocks` are the blocks that will be repeated for each entry in the
1. **URL *(often required):*** Skyvern Agent’s starting point. Ideally the website you’d like to automate.
- In the workflows interface, if this input is left blank it will continue where the previous node left off. The idea of a navigation goal is to set or reset where the agent starts off.
- If you’re logging in to a site using the first task block, you would want to leave URL blank for the second block so that it can continue after logging in
2. **Navigation Goal *(often required):*** details where Skyvern is going and what Skyvern is doing. Clear Navigation Goals will be a single goal, broken down into steps. Avoid supplying multiple goals. You need to specify when the goal is complete, using “COMPLETE”, or when to abandon that goal, using “TERMINATE”
- The navigation goal is not used to load the URL. Asking Skyvern to “go to website A” in this field will not have the intended effect
- Terminations result in Skyvern explaining why it stopped navigating
- This field can be omitted if you only want Skyvern to extract data without navigating anywhere else
3. **Data Extraction Goal *(optional):*** aside from where Skyvern is going and what Skyvern is doing, is there anything that Skyvern is extracting and returning back? A good data extraction goal is specific about what Skyvern is returning to the user
- Note that data extractions only happen after Skyvern is finished navigating
4. **Extracted Information Schema *(optional):*** if you have a data extraction goal, some users need it formatted in a certain way for internal purposes. Navigation payload accepts JSON formatted specifications for how the data should be returned
5. **Max Steps Override *(optional):*** some users want to cap cost through the number of steps the task can take
6. **Max Retries *(optional):*** the number of times a step can be retried if it fails
7. **Complete on Download *(optional):*** Allows Skyvern to complete the task after a file has been downloaded
8. **File Suffix *(optional):*** an identifier attached to the downloaded file
9. **TOTP URL and TOTP Identifier *(optional):*** if you have an internal system where you can store the 2FA TOTP code, this URL calls on this storage space. The identifier allows you to link the code to the task, this is critical if you are running multiple tasks concurrently. [Contact us](https://meetings.hubspot.com/skyvern/demo?uuid=7c83865f-1a92-4c44-9e52-1ba0dbc04f7a) if you would like to set up 2FA retreival in your workflows.
10. **Parameters *(optional):*** parameters are self-defined placeholders that are specified run-to-run. They can either be workflow parameters, passed in via an API call, or output parameters, extracted from a previous task block. If specified, they are used by Skyvern to assist in the navigation, to fill out forms or further influence what actions to take on a website.
## ForLoopBlock
Iterate over something such as a CSV or the output of a previous block. The blocks nested under `loop_blocks` are the blocks that will be repeated for each entry in the
```
- block_type: for_loop
@@ -55,8 +74,14 @@ Iterate over something such as a CSV or the output of a previous block. The bloc
not_possible_to_download_invoice: return this error if the website doesn't allow downloading/viewing invoices
cant_solve_captcha: return this error if captcha isn't solved after multiple retries
```
Inputs:
### CodeBlock
1. **Loop Value *(required):*** This is the value that the loop will iterate over. For instance, if you have for every invoice ID, do X, invoice ID would be the value for this input.
* Please [contact us](https://meetings.hubspot.com/skyvern/demo?uuid=7c83865f-1a92-4c44-9e52-1ba0dbc04f7a) if you would like to add a loop block. Since we’re in beta, the loop value needs to be parameterized from the backend.
2. **Another block nested within the loop (required)**
## CodeBlock
This block executes user-defined Python code within our execution environment. It’s able to take parameters as input and transform them based on a certain specification.
In addition to running simple code snippets, CodeBlock allows you to:
@@ -94,9 +119,12 @@ In addition to running simple code snippets, CodeBlock allows you to:
print("Now I want to see a cat")
await skyvern_page.goto("https://cataas.com/cat")
```
Inputs:
1. **Code *(required):*** Insert your custom Python code so that you can define your own custom block.
### TextPromptBlock
## TextPromptBlock
Do a custom OpenAI query as a part of your workflow
@@ -116,8 +144,12 @@ Do a custom OpenAI query as a part of your workflow
output_parameter_key: new_title
```
### DownloadToS3Block
### UploadToS3Block
Inputs:
1. **Prompt *(required):*** Write a natural language prompt to be sent to the LLM to generate a text response
2. **JSON Schema *(optional):*** Craft a JSON input that structures the LLM output for use in another programming task
## DownloadToS3Block / UploadToS3Block
Persists files inside S3
@@ -127,7 +159,10 @@ Persists files inside S3
path: SKYVERN_DOWNLOAD_DIRECTORY
```
### SendEmailBlock
* Since we’re in beta, this feature is unavailable right now, [contact us](https://meetings.hubspot.com/skyvern/demo?uuid=7c83865f-1a92-4c44-9e52-1ba0dbc04f7a) if you would like to use it.
## SendEmailBlock
Sends an email with some data
@@ -147,11 +182,17 @@ Sends an email with some data
- SKYVERN_DOWNLOAD_DIRECTORY
```
### FileParserBlock
Inputs:
1. **Recipients *(required):*** a list of people who will receive the email separated by commas
2. **Subject/Body *(optional):*** the header and body of an email
3. **File attachments *(optional):*** since we’re still in beta, you will need to [contact us](https://meetings.hubspot.com/skyvern/demo?uuid=7c83865f-1a92-4c44-9e52-1ba0dbc04f7a) to upload attachments to the email
## FileParserBlock
Downloads and parses a file to be used within other workflow blocks.
**Supported types:** csv
**Supported types:** CSV
```
- block_type: file_url_parser
@@ -159,3 +200,8 @@ Downloads and parses a file to be used within other workflow blocks.
file_type: csv
file_url: <csv_file_url>
```
Inputs:
1. **File URL *(required):*** This block allows you to use a CSV within your workflow.
* Since we’re still in beta, you will need to [contact us](https://meetings.hubspot.com/skyvern/demo?uuid=7c83865f-1a92-4c44-9e52-1ba0dbc04f7a) to load a value into this block