Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
masci committed Oct 17, 2024
1 parent ec125ab commit 28f9681
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Docs are available [here](https://masci.github.io/banks/).
- [Examples](#examples)
- [:point\_right: Render a prompt template as chat messages](#point_right-render-a-prompt-template-as-chat-messages)
- [:point\_right: Use a LLM to generate a text while rendering a prompt](#point_right-use-a-llm-to-generate-a-text-while-rendering-a-prompt)
- [:point\_right: Call functions directly from the prompt](#point_right-call-functions-directly-from-the-prompt)
- [:point\_right: Function calling directly from the prompt](#point_right-function-calling-directly-from-the-prompt)
- [:point\_right: Use prompt caching from Anthropic](#point_right-use-prompt-caching-from-anthropic)
- [Reuse templates from registries](#reuse-templates-from-registries)
- [Async support](#async-support)
Expand Down Expand Up @@ -137,7 +137,7 @@ Examples:
> Banks uses a cache to avoid generating text again for the same template with the same context. By default
> the cache is in-memory but it can be customized.
### :point_right: Call functions directly from the prompt
### :point_right: Function calling directly from the prompt

Banks provides a filter `tool` that can be used to convert a callable passed to a prompt into an LLM function call.
Docstrings are used to describe the tool and its arguments, and during prompt rendering Banks will perform all the LLM
Expand Down
6 changes: 6 additions & 0 deletions docs/prompt.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ p.text() ## outputs 'HELLO'
In addition to all the [builtin filters](https://jinja.palletsprojects.com/en/3.1.x/templates/#list-of-builtin-filters)
provided by Jinja, Banks supports the following ones, specific for prompt engineering.

::: banks.filters.tool.tool
options:
show_root_full_path: false
show_symbol_type_heading: false
show_signature_annotations: false
heading_level: 3

::: banks.filters.cache_control.cache_control
options:
Expand Down

0 comments on commit 28f9681

Please sign in to comment.