Skip to content

Commit

Permalink
fix: docs links
Browse files Browse the repository at this point in the history
  • Loading branch information
micpst committed Jun 14, 2024
1 parent eae24da commit f5ffb6a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/concepts/freeform_views.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Unlike structured views, which define a response format and a set of operations
]
```

To learn more about implementing freeform views, refer to the [How to: Create text-to-SQL Freeform View](../how-to/custom_freeform_views.md) guide.
To learn more about implementing freeform views, refer to the [How to: Create text-to-SQL Freeform View](../how-to/views/text-to-sql.md) guide.

!!! warning
When using freeform views, the LLM typically gets raw access to the data source and can execute arbitrary operations on it using the query language of the data source (e.g., SQL). This can be powerful but also necessitates that the developer be extremely cautious about securing the data source outside of db-ally. For instance, in the case of Relational Databases, the developer should ensure that the database user used by db-ally has read-only access to the database, and that the database does not contain any sensitive data that shouldn't be exposed to the LLM.
2 changes: 1 addition & 1 deletion docs/how-to/views/custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ There are two main ways to create custom structured views:
If you're not sure which method to choose, we recommend starting with the `MethodsBaseView`. It's simpler and easier to use, and you can switch to the `BaseStructuredView` later if you find you need more control over filter management. For this guide, we'll focus on the `MethodsBaseView`.

!!! note
Both are methods of creating [structured views](../../concepts/structured_views.md). If you're looking to create a [freeform view](../../concepts/freeform_views.md), refer to the [Freeform Views](custom_freeform_views.md) guide instead.
Both are methods of creating [structured views](../../concepts/structured_views.md). If you're looking to create a [freeform view](../../concepts/freeform_views.md), refer to the [Freeform Views](text-to-sql.md) guide instead.

## Example
Throughout the guide, we'll use an example of creating a custom base view called `FilteredIterableBaseView`. To keep things simple, the "data source" it uses is a list defined in Python. The goal is to demonstrate how to create a custom view and define filters for it. In most real-world scenarios, data would usually come from an external source, like a REST API or a database.
Expand Down

0 comments on commit f5ffb6a

Please sign in to comment.