simplify docs for tasks (#2487)
This commit is contained in:
@@ -5,8 +5,7 @@ slug: running-tasks/visualizing-results
|
||||
---
|
||||
|
||||
|
||||
# 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.
|
||||
Skyvern comes bundled with a Visualizer to help you understand what's going on with your tasks. To get started, navigate to the history page and click on any agent run.
|
||||
|
||||
<img src="../images/visualizing_results/navigate_to_task.png" />
|
||||
|
||||
@@ -29,30 +28,4 @@ The task parameters are the inputs that you provided to Skyvern. This includes t
|
||||
## 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
|
||||
```
|
||||
|
||||
## Artifacts configurations
|
||||
By default, Skyvern stores artifacts, including video recording, screenshots, llm requests and responses, html and skyvern parsed html elements locally in the `/artifacts` folder under the skyvern repository.
|
||||
You can also have skyvern to upload atrifacts to your s3 buckets. To do this, first set up these environment variables:
|
||||
- `AWS_DEFAULT_REGION`: `us-east-1`, `us-west-1`, ...
|
||||
- `AWS_ACCESS_KEY_ID`
|
||||
- `AWS_SECRET_ACCESS_KEY`
|
||||
- `SKYVERN_STORAGE_TYPE`: set it to be `s3`. The default is `local`
|
||||
|
||||
Make sure these s3 buckets are created: `skyvern-artifacts`, `skyvern-screenshots`. These are the default bucket names skyvern uses. To customize the bucket names, change these two env variables: `AWS_S3_BUCKET_ARTIFACTS` and `AWS_S3_BUCKET_SCREENSHOTS`
|
||||
<img src="../images/visualizing_results/view_diagnostics.png" />
|
||||
Reference in New Issue
Block a user