Add docs for advanced features + visualizing results (#581)
This commit is contained in:
BIN
docs/images/visualizing_results/navigate_to_task.png
Normal file
BIN
docs/images/visualizing_results/navigate_to_task.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 167 KiB |
BIN
docs/images/visualizing_results/view_actions.png
Normal file
BIN
docs/images/visualizing_results/view_actions.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 242 KiB |
BIN
docs/images/visualizing_results/view_diagnostics.png
Normal file
BIN
docs/images/visualizing_results/view_diagnostics.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 102 KiB |
BIN
docs/images/visualizing_results/view_parameters.png
Normal file
BIN
docs/images/visualizing_results/view_parameters.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 86 KiB |
BIN
docs/images/visualizing_results/view_recording.png
Normal file
BIN
docs/images/visualizing_results/view_recording.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 55 KiB |
@@ -1,2 +1,22 @@
|
||||
---
|
||||
title: Advanced Settings for tasks
|
||||
description: 'How to use advanced settings for tasks'
|
||||
---
|
||||
|
||||
<img src="https://thumbs.dreamstime.com/b/pug-dog-holding-pliers-screwdriver-behind-old-wooden-sign-text-under-construction-white-background-constructor-92836854.jpg" />
|
||||
# Advanced Settings for tasks
|
||||
|
||||
## Overriding the max_steps paramter in the task
|
||||
If you want the task to execute for a specific number of steps, you can use the `x-max-steps-override` header in the request. This will override the default `max_steps` parameter set in the task.
|
||||
|
||||
```json
|
||||
POST https://api.skyvern.com/api/v1/tasks
|
||||
|
||||
Headers:
|
||||
{
|
||||
"x-api-key": "YOUR_API_KEY",
|
||||
"x-max-steps-override": 10
|
||||
}
|
||||
|
||||
Body:
|
||||
.. usual task body ..
|
||||
```
|
||||
|
||||
@@ -1,2 +1,46 @@
|
||||
---
|
||||
title: Visualizing Results
|
||||
description: 'How to understand the information shown by Skyvern'
|
||||
---
|
||||
|
||||
<img src="https://thumbs.dreamstime.com/b/pug-dog-holding-pliers-screwdriver-behind-old-wooden-sign-text-under-construction-white-background-constructor-92836854.jpg" />
|
||||
# Visualizing Results
|
||||
Skyvern comes bundled with a Visualizer to help you understand what's going on with your tasks. To get started, navigate to the task history page and click on any task.
|
||||
|
||||
<img src="/images/visualizing_results/navigate_to_task.png" />
|
||||
|
||||
|
||||
## Actions
|
||||
Each action that Skyvern takes can be viewed in the Action viewer. It's accompanied with a screenshot of the screen state *after* the action has executed
|
||||
|
||||
<img src="/images/visualizing_results/view_actions.png" />
|
||||
|
||||
## Recording
|
||||
Each Skyvern task comes with a recording of the entire operation (end to end). To view the recording, click on the recording tab.
|
||||
|
||||
<img src="/images/visualizing_results/view_recording.png" />
|
||||
|
||||
## Task Parameters
|
||||
The task parameters are the inputs that you provided to Skyvern. This includes the URL, the extraction rules, and any other information that you provided to Skyvern.
|
||||
|
||||
<img src="/images/visualizing_results/view_parameters.png" />
|
||||
|
||||
## Diagnostic Logs
|
||||
The diagnostics tab contains information used by Skyvern to do its processing. It includes information such as the annotated screenshots, action screenshots, element tree, prompt, action list, page HTML, and the raw LLM Request.
|
||||
|
||||
<img src="/images/visualizing_results/view_diagnostics.png" />
|
||||
|
||||
## Accessing results via API
|
||||
|
||||
You can also access the results of a task via the API.
|
||||
|
||||
The following endpoint can be used to get the results of a task:
|
||||
```
|
||||
GET https://api.skyvern.com/api/v1/tasks/{task_id}/steps?page=1&page_size=15
|
||||
```
|
||||
|
||||
The response will contain a list of steps, alongside their actions and other relevant information
|
||||
|
||||
The following endpoint can be used to retrieve artifacts for a specific step:
|
||||
```
|
||||
GET https://api.skyvern.com/api/v1/tasks/{task_id}/steps/{step_id}/artifacts
|
||||
```
|
||||
|
||||
@@ -28,9 +28,3 @@ SKYVERN_API_KEY: this is the [api key](/running-tasks/introduction) specific to
|
||||
| Parameter | Type | Required? | Sample Value | Description |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| webhook_callback_url | String | yes | … | |
|
||||
|
||||
# Required Headers
|
||||
|
||||
| Parameter | Type | Required? | Sample Value | Description |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| x-api-key | String | yes | eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e<br/>yJleHAiOjQ4MjU0MjI5NzUsInN1YiI6<br/>Im9fMTA2MTUxNzEyNjQ5ODUxMzQ2In0 | Bearer token that gives your backend access to the Skyvern API. This will be manually provided by us |
|
||||
|
||||
Reference in New Issue
Block a user