Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lyie28 committed Sep 23, 2024
1 parent bc60f4e commit c896f08
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 14 deletions.
16 changes: 8 additions & 8 deletions docs/docs/get-started/quick-tour.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ pip install lavague

## Automation

Let's see how we can use LaVague Web Agent's to automate filling in the following [sample job application form](https://form.jotform.com/241472287797370).

[⌛ GIF GOES HERE]

Let's see how we can use LaVague Web Agent's to automate filling in the following [sample job application form](https://form.jotform.com/241472287797370).

```python
from lavague.core.agents import WebAgent

Expand Down Expand Up @@ -60,15 +60,15 @@ We can then go to the visual web interface, or `Agent Studio`, by clicking on th

## QA

We can use LaVague agent's to create tests for websites.

If you prefer a quick no-code solution, you can use our [QA web interface](https://qa.lavague.ai).
[⌛ GIF GOES HERE]

If you prefer to work directly with the code behind our web interface, read on!
We can use LaVague agent's to create tests for websites.

Let's look at an example where we use LaVague to generate a `pytest` script checking the `add to cart` functionality of the `Amazon` website.

[⌛ GIF GOES HERE]
!!! note "QA web interface"

If you would prefer to use a quick no-code solution, you can use our [QA web interface](https://qa.lavague.ai).

First of all, we need to get our `trajectory`, or series of actions, corresponding to the actions we want to test.

Expand All @@ -91,7 +91,7 @@ obj = "Test the following scenario + {scenario}"
ret = agent.run(url=url, objective=obj)
```

Again, a link will be output to review the trajectory generation in our `Agent Studio`.
As seen in the previous example, a link will then be outputted to review the trajectory generation in our `Agent Studio`.

Once we are happy with our trajectory, we can now use our `PyTestExporter` to convert the `trajectory` object returned from our WebAgent into a PyTest file that can be used for web testing.

Expand Down
46 changes: 40 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,18 @@ description: "An AI Web Agent API for automating web tasks"

## What is LaVague?

LaVague is an AI Web Agent framework for automating web tasks.
LaVague is an AI Web Agent framework that revolutionizes web automation. Our mission is to empower developers to build intelligent, efficient, and reliable web automation solutions with ease.

It can be used for web tasks such as:
**Key features:**

- ✅ Testing websites for QA engineers
- ✅ Automating information retrieval
- ✅ Filling complex forms
- Powerful AI-driven **Web Agents** for effective automation.
- An **Agent Studio** web interface to view and replay automated tasks.
- **Exporters** to turn agent outpute into the desired replayable code format for your use cases.

**Perfect for:**

- 💻 **Builders**: Automatate repetitive tasks and improve workflow efficiency
- 🕵️ **QA Engineers**: Streamline website testing and quality assurance

Explore the sections below to get started with LaVague:

Expand Down Expand Up @@ -70,9 +74,39 @@ print(ret.response)
```bash
$ mattshumer/Reflection-Llama-3.1-70B, black-forest-labs/FLUX.1-dev, openbmb/MiniCPM3-4B, deepseek-ai/DeepSeek-V2.5, Qwen/Qwen2-VL-7B-Instruct
```

For more information on how to use LaVague, see our [quick-tour](https://docs.lavague.ai/en/latest/docs/get-started/quick-tour/).

## Capabilities

LaVague Agents takes the following inputs:

- Text `objective`
- A `user_data` key-value object

They will:

- Leverage AI to generate and execute a series of actions to complete the `objective` provided.

They output:

- A link to the Agent Studio web interface where you can view and replay the actions performed by LaVague
- Text in the case of information retrieval
- A trajectory object containing a list of actions that can be converted to various code formats with `exporters`

## Limitations

- **Bot protection**: Some websites may flag LaVague agents as bots and prevent LaVague form perfoming automated actions
- **AI-generated code:** LaVague actions are generated with AI - while we limit the scope of actions for security purposes, the actions should be verified and may need to be modified or re-generated for accuracy
- **Web only**: We currently only support automating actions on websites. Automated actions for desktop or specific APIs are planned further along our roadmap.
- **Integrations**: There are a vast number of potential use cases for LaVague and we cannot provide integrations for all potential exports of trajectories. You may need to build your own integrations for specific use cases.

!!! info "Community"

We encourage our community to contribute their integrations to our open-source repo.

For more information on contributions, see our guide [here].


## Roadmap

The next features we are working on include:
Expand Down

0 comments on commit c896f08

Please sign in to comment.