From 28f96811e024036679a4f5d9ed0993a4c89fad6d Mon Sep 17 00:00:00 2001 From: Massimiliano Pippi Date: Thu, 17 Oct 2024 10:21:43 +0200 Subject: [PATCH] docs --- README.md | 4 ++-- docs/prompt.md | 6 ++++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e1e2cb0..50324a8 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 diff --git a/docs/prompt.md b/docs/prompt.md index 22d5d94..a628693 100644 --- a/docs/prompt.md +++ b/docs/prompt.md @@ -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: