promttrail
Contents:
Quickstart
Quick Navigation
Table of Contents
Preparation
Install
models
: Unified Interface to LLM API
Make an API Call
Core Concepts
Try different API
Try local LLMs
Stream Output
agents
: Agent as Code
Introduction
Subroutines
Hooks
Rendering
Session
Control Flow
Tool (Function Calling)
core
: Developer Tools for LLMs
Metadata
Cache
Mock
Debug and Logging
Project Structure
promttrail
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
_
__init__() (prompttrail.agent.runners.APIRunner method)
(prompttrail.agent.runners.Runner method)
(prompttrail.agent.runners.SessionState method)
(prompttrail.agent.session_transformers.CodeBlock method)
(prompttrail.agent.session_transformers.DangerouslyEvaluatePythonCode method)
(prompttrail.agent.session_transformers.Debugger method)
(prompttrail.agent.session_transformers.ExtractMarkdownCodeBlock method)
(prompttrail.agent.session_transformers.LambdaSessionTransformer method)
(prompttrail.agent.session_transformers.MetadataTransformer method)
(prompttrail.agent.session_transformers.ResetMetadata method)
(prompttrail.agent.session_transformers.SessionTransformer method)
(prompttrail.agent.session_transformers.UpdateMetadata method)
(prompttrail.agent.subroutine.FilterByRoleStrategy method)
(prompttrail.agent.subroutine.FilteredInheritStrategy method)
(prompttrail.agent.subroutine.LLMFilteringStrategy method)
(prompttrail.agent.subroutine.LLMSummarizingStrategy method)
(prompttrail.agent.subroutine.session_init_strategy.FilteredInheritStrategy method)
(prompttrail.agent.subroutine.session_init_strategy.LastNMessagesStrategy method)
(prompttrail.agent.subroutine.squash_strategy.FilterByRoleStrategy method)
(prompttrail.agent.subroutine.squash_strategy.LLMFilteringStrategy method)
(prompttrail.agent.subroutine.squash_strategy.LLMSummarizingStrategy method)
(prompttrail.agent.subroutine.SubroutineTemplate method)
(prompttrail.agent.templates.AnthropicToolingTemplate method)
(prompttrail.agent.templates.AssistantTemplate method)
(prompttrail.agent.templates.BreakTemplate method)
(prompttrail.agent.templates.ControlTemplate method)
(prompttrail.agent.templates.EndTemplate method)
(prompttrail.agent.templates.Event method)
(prompttrail.agent.templates.ExecuteToolTemplate method)
(prompttrail.agent.templates.GenerateTemplate method)
(prompttrail.agent.templates.IfTemplate method)
(prompttrail.agent.templates.LinearTemplate method)
(prompttrail.agent.templates.LoopTemplate method)
(prompttrail.agent.templates.MessageTemplate method)
(prompttrail.agent.templates.OpenAIToolingTemplate method)
(prompttrail.agent.templates.SystemTemplate method)
(prompttrail.agent.templates.Template method)
(prompttrail.agent.templates.ToolingTemplate method)
(prompttrail.agent.templates.ToolingTemplateBase method)
(prompttrail.agent.templates.UserTemplate method)
(prompttrail.agent.tools.SubroutineTool method)
(prompttrail.agent.user_interface.SingleTurnResponseMockInterface method)
(prompttrail.core.cache.LRUCacheProvider method)
(prompttrail.core.const.ReachedEndTemplateException method)
(prompttrail.core.errors.ProviderResponseError method)
(prompttrail.core.Message method)
(prompttrail.core.Metadata method)
(prompttrail.core.mocks.EchoMockProvider method)
(prompttrail.core.mocks.FunctionalMockProvider method)
(prompttrail.core.mocks.OneTurnConversationMockProvider method)
(prompttrail.core.Session method)
(prompttrail.core.utils.Debuggable method)
(prompttrail.models.transformers.TransformersModel method)
A
add() (prompttrail.core.cache.CacheProvider method)
(prompttrail.core.cache.LRUCacheProvider method)
after_send() (prompttrail.core.Model method)
AnthropicMessageDict (class in prompttrail.models.anthropic)
AnthropicToolingTemplate (class in prompttrail.agent.templates)
api_base (prompttrail.models.openai.OpenAIConfig attribute)
api_key (prompttrail.models.anthropic.AnthropicConfig attribute)
(prompttrail.models.google.GoogleConfig attribute)
(prompttrail.models.openai.OpenAIConfig attribute)
api_version (prompttrail.models.openai.OpenAIConfig attribute)
APIRunner (class in prompttrail.agent.runners)
append() (prompttrail.core.Session method)
arguments (prompttrail.agent.tools.builtin.CreateOrOverwriteFile attribute)
(prompttrail.agent.tools.builtin.EditFile attribute)
(prompttrail.agent.tools.builtin.EndConversationTool attribute)
(prompttrail.agent.tools.builtin.ExecuteCommand attribute)
(prompttrail.agent.tools.builtin.ReadFile attribute)
(prompttrail.agent.tools.builtin.TreeDirectory attribute)
(prompttrail.agent.tools.Tool attribute)
ask() (prompttrail.agent.user_interface.CLIInterface method)
(prompttrail.agent.user_interface.DefaultOrEchoMockInterface method)
(prompttrail.agent.user_interface.EchoMockInterface method)
(prompttrail.agent.user_interface.MockInterface method)
(prompttrail.agent.user_interface.SingleTurnResponseMockInterface method)
(prompttrail.agent.user_interface.UserInterface method)
AssistantTemplate (class in prompttrail.agent.templates)
B
before_send() (prompttrail.models.transformers.TransformersModel method)
before_transform (prompttrail.agent.templates.EndTemplate attribute)
block_anchor_fallback_match() (prompttrail.agent.tools.builtin.EditFile method)
BreakException
BreakTemplate (class in prompttrail.agent.templates)
C
cache_provider (prompttrail.core.Config attribute)
CacheProvider (class in prompttrail.core.cache)
call() (prompttrail.core.mocks.FunctionalMockProvider method)
(prompttrail.core.mocks.MockProvider method)
(prompttrail.core.mocks.OneTurnConversationMockProvider method)
candidate_count (prompttrail.models.google.GoogleConfig attribute)
check_tool_arguments() (prompttrail.agent.templates.OpenAIToolingTemplate method)
CleanSessionStrategy (class in prompttrail.agent.subroutine)
(class in prompttrail.agent.subroutine.session_init_strategy)
client (prompttrail.models.anthropic.AnthropicModel attribute)
CLIInterface (class in prompttrail.agent.user_interface)
code (prompttrail.agent.session_transformers.CodeBlock attribute)
CodeBlock (class in prompttrail.agent.session_transformers)
CommandLineRunner (class in prompttrail.agent.runners)
configuration (prompttrail.core.Model attribute)
(prompttrail.models.anthropic.AnthropicModel attribute)
(prompttrail.models.google.GoogleModel attribute)
(prompttrail.models.openai.OpenAIModel attribute)
ConfigurationValidationError
construct_new_file_content() (prompttrail.agent.tools.builtin.EditFile method)
content (prompttrail.agent.tools.ToolResult attribute)
(prompttrail.core.Message attribute)
(prompttrail.models.anthropic.AnthropicMessageDict attribute)
context (prompttrail.models.google.GoogleConfig attribute)
ControlTemplate (class in prompttrail.agent.templates)
copy() (prompttrail.core.Metadata method)
count_tokens() (in module prompttrail.core.utils)
create_stack() (prompttrail.agent.subroutine.SubroutineTemplate method)
(prompttrail.agent.templates.BreakTemplate method)
(prompttrail.agent.templates.ControlTemplate method)
(prompttrail.agent.templates.EndTemplate method)
(prompttrail.agent.templates.IfTemplate method)
(prompttrail.agent.templates.LinearTemplate method)
(prompttrail.agent.templates.LoopTemplate method)
(prompttrail.agent.templates.MessageTemplate method)
(prompttrail.agent.templates.Template method)
critical() (prompttrail.core.utils.Debuggable method)
current_event (prompttrail.agent.runners.SessionState attribute)
cutify_role() (in module prompttrail.agent.runners)
D
DangerouslyEvaluatePythonCode (class in prompttrail.agent.session_transformers)
debug() (prompttrail.core.utils.Debuggable method)
debug_mode (prompttrail.core.Session attribute)
Debuggable (class in prompttrail.core.utils)
Debugger (class in prompttrail.agent.session_transformers)
DefaultOrEchoMockInterface (class in prompttrail.agent.user_interface)
description (prompttrail.agent.tools.builtin.CreateOrOverwriteFile attribute)
(prompttrail.agent.tools.builtin.EditFile attribute)
(prompttrail.agent.tools.builtin.EndConversationTool attribute)
(prompttrail.agent.tools.builtin.ExecuteCommand attribute)
(prompttrail.agent.tools.builtin.ReadFile attribute)
(prompttrail.agent.tools.builtin.TreeDirectory attribute)
(prompttrail.agent.tools.Tool attribute)
(prompttrail.agent.tools.ToolArgument attribute)
device (prompttrail.models.transformers.TransformersConfig attribute)
dict() (prompttrail.core.Metadata method)
disable_log() (prompttrail.core.utils.Debuggable method)
E
EchoMockInterface (class in prompttrail.agent.user_interface)
EchoMockProvider (class in prompttrail.core.mocks)
enable_log() (prompttrail.core.utils.Debuggable method)
enable_logging (prompttrail.agent.tools.Tool attribute)
(prompttrail.core.Model attribute)
EndTemplate (class in prompttrail.agent.templates)
error() (prompttrail.core.utils.Debuggable method)
Event (class in prompttrail.agent.templates)
event_type (prompttrail.agent.templates.Event attribute)
,
[1]
examples (prompttrail.models.google.GoogleConfig attribute)
execute() (prompttrail.agent.tools.Tool method)
ExecuteToolTemplate (class in prompttrail.agent.templates)
ExtractMarkdownCodeBlock (class in prompttrail.agent.session_transformers)
F
FilterByRoleStrategy (class in prompttrail.agent.subroutine)
(class in prompttrail.agent.subroutine.squash_strategy)
FilteredInheritStrategy (class in prompttrail.agent.subroutine)
(class in prompttrail.agent.subroutine.session_init_strategy)
format_tool() (prompttrail.core.Model method)
(prompttrail.models.anthropic.AnthropicModel method)
(prompttrail.models.openai.OpenAIModel method)
format_tool_call() (prompttrail.agent.templates.AnthropicToolingTemplate method)
(prompttrail.agent.templates.OpenAIToolingTemplate method)
format_tool_result() (prompttrail.agent.templates.AnthropicToolingTemplate method)
(prompttrail.agent.templates.OpenAIToolingTemplate static method)
(prompttrail.core.Model method)
(prompttrail.models.anthropic.AnthropicModel method)
from_dict() (prompttrail.core.Session class method)
FunctionalMockProvider (class in prompttrail.core.mocks)
G
GenerateTemplate (class in prompttrail.agent.templates)
get_current_template_id() (prompttrail.core.Session method)
get_jump() (prompttrail.core.Session method)
get_last() (prompttrail.core.Session method)
get_last_message() (prompttrail.core.Session method)
get_tool() (prompttrail.agent.templates.ToolingTemplateBase method)
H
head_stack() (prompttrail.core.Session method)
HookError
I
IfTemplate (class in prompttrail.agent.templates)
info() (prompttrail.core.utils.Debuggable method)
InheritSystemStrategy (class in prompttrail.agent.subroutine)
(class in prompttrail.agent.subroutine.session_init_strategy)
initialize() (prompttrail.agent.subroutine.CleanSessionStrategy method)
(prompttrail.agent.subroutine.FilteredInheritStrategy method)
(prompttrail.agent.subroutine.InheritSystemStrategy method)
(prompttrail.agent.subroutine.session_init_strategy.CleanSessionStrategy method)
(prompttrail.agent.subroutine.session_init_strategy.FilteredInheritStrategy method)
(prompttrail.agent.subroutine.session_init_strategy.InheritSystemStrategy method)
(prompttrail.agent.subroutine.session_init_strategy.LastNMessagesStrategy method)
(prompttrail.agent.subroutine.session_init_strategy.SessionInitStrategy method)
(prompttrail.agent.subroutine.SessionInitStrategy method)
(prompttrail.agent.subroutine.squash_strategy.SquashStrategy method)
(prompttrail.agent.subroutine.SquashStrategy method)
is_cached() (prompttrail.core.Model method)
is_in_test_env() (in module prompttrail.core.utils)
is_mocked() (prompttrail.core.Model method)
is_running (prompttrail.agent.runners.SessionState attribute)
J
jump_to_id (prompttrail.core.Session attribute)
L
LambdaSessionTransformer (class in prompttrail.agent.session_transformers)
lang (prompttrail.agent.session_transformers.CodeBlock attribute)
LastMessageStrategy (class in prompttrail.agent.subroutine)
(class in prompttrail.agent.subroutine.squash_strategy)
LastNMessagesStrategy (class in prompttrail.agent.subroutine.session_init_strategy)
line_trimmed_fallback_match() (prompttrail.agent.tools.builtin.EditFile method)
LinearTemplate (class in prompttrail.agent.templates)
list_models() (prompttrail.core.Model method)
(prompttrail.models.anthropic.AnthropicModel method)
(prompttrail.models.google.GoogleModel method)
(prompttrail.models.openai.OpenAIModel method)
LLMFilteringStrategy (class in prompttrail.agent.subroutine)
(class in prompttrail.agent.subroutine.squash_strategy)
LLMSummarizingStrategy (class in prompttrail.agent.subroutine)
(class in prompttrail.agent.subroutine.squash_strategy)
log() (prompttrail.core.utils.Debuggable method)
logger (prompttrail.agent.tools.Tool attribute)
(prompttrail.core.Model attribute)
LoopTemplate (class in prompttrail.agent.templates)
LRUCacheProvider (class in prompttrail.core.cache)
M
max_tokens (prompttrail.core.Config attribute)
(prompttrail.models.anthropic.AnthropicConfig attribute)
(prompttrail.models.google.GoogleConfig attribute)
(prompttrail.models.openai.OpenAIConfig attribute)
(prompttrail.models.transformers.TransformersConfig attribute)
messages (prompttrail.core.Session attribute)
MessageTemplate (class in prompttrail.agent.templates)
Metadata (class in prompttrail.core)
metadata (prompttrail.agent.tools.ToolResult attribute)
(prompttrail.core.Message attribute)
(prompttrail.core.Session attribute)
MetadataTransformer (class in prompttrail.agent.session_transformers)
mock_provider (prompttrail.core.Config attribute)
MockInterface (class in prompttrail.agent.user_interface)
MockProvider (class in prompttrail.core.mocks)
model (prompttrail.models.transformers.TransformersModel attribute)
model_copy() (prompttrail.core.Metadata method)
model_name (prompttrail.core.Config attribute)
(prompttrail.models.anthropic.AnthropicConfig attribute)
(prompttrail.models.google.GoogleConfig attribute)
(prompttrail.models.openai.OpenAIConfig attribute)
(prompttrail.models.transformers.TransformersConfig attribute)
model_post_init() (prompttrail.agent.tools.Tool method)
(prompttrail.core.Model method)
module
prompttrail
prompttrail.agent
prompttrail.agent.runners
prompttrail.agent.session_transformers
prompttrail.agent.subroutine
prompttrail.agent.subroutine.session_init_strategy
prompttrail.agent.subroutine.squash_strategy
prompttrail.agent.templates
prompttrail.agent.tools
prompttrail.agent.tools.builtin
prompttrail.agent.user_interface
prompttrail.core
prompttrail.core.cache
prompttrail.core.const
prompttrail.core.errors
prompttrail.core.mocks
prompttrail.core.utils
prompttrail.models
prompttrail.models.anthropic
prompttrail.models.google
prompttrail.models.openai
prompttrail.models.transformers
N
name (prompttrail.agent.tools.builtin.CreateOrOverwriteFile attribute)
(prompttrail.agent.tools.builtin.EditFile attribute)
(prompttrail.agent.tools.builtin.EndConversationTool attribute)
(prompttrail.agent.tools.builtin.ExecuteCommand attribute)
(prompttrail.agent.tools.builtin.ReadFile attribute)
(prompttrail.agent.tools.builtin.TreeDirectory attribute)
(prompttrail.agent.tools.Tool attribute)
(prompttrail.agent.tools.ToolArgument attribute)
O
OneTurnConversationMockProvider (class in prompttrail.core.mocks)
OpenAIToolingTemplate (class in prompttrail.agent.templates)
organization_id (prompttrail.models.openai.OpenAIConfig attribute)
P
ParameterValidationError
payload (prompttrail.agent.templates.Event attribute)
,
[1]
pop_stack() (prompttrail.core.Session method)
prepare() (prompttrail.core.Model method)
pretty_print_metadata() (in module prompttrail.agent.runners)
process() (prompttrail.agent.session_transformers.LambdaSessionTransformer method)
(prompttrail.agent.session_transformers.MetadataTransformer method)
(prompttrail.agent.session_transformers.SessionTransformer method)
process_metadata() (prompttrail.agent.session_transformers.DangerouslyEvaluatePythonCode method)
(prompttrail.agent.session_transformers.Debugger method)
(prompttrail.agent.session_transformers.ExtractMarkdownCodeBlock method)
(prompttrail.agent.session_transformers.MetadataTransformer method)
(prompttrail.agent.session_transformers.ResetMetadata method)
(prompttrail.agent.session_transformers.UpdateMetadata method)
prompt (prompttrail.models.google.GoogleChatExample attribute)
prompttrail
module
prompttrail.agent
module
prompttrail.agent.runners
module
prompttrail.agent.session_transformers
module
prompttrail.agent.subroutine
module
prompttrail.agent.subroutine.session_init_strategy
module
prompttrail.agent.subroutine.squash_strategy
module
prompttrail.agent.templates
module
prompttrail.agent.tools
module
prompttrail.agent.tools.builtin
module
prompttrail.agent.user_interface
module
prompttrail.core
module
prompttrail.core.cache
module
prompttrail.core.const
module
prompttrail.core.errors
module
prompttrail.core.mocks
module
prompttrail.core.utils
module
prompttrail.models
module
prompttrail.models.anthropic
module
prompttrail.models.google
module
prompttrail.models.openai
module
prompttrail.models.transformers
module
ProviderResponseError
push_stack() (prompttrail.core.Session method)
R
ReachedEndTemplateException
render() (prompttrail.agent.templates.Template method)
RenderingError
repetition_penalty (prompttrail.core.Config attribute)
(prompttrail.models.transformers.TransformersConfig attribute)
required (prompttrail.agent.tools.ToolArgument attribute)
ResetMetadata (class in prompttrail.agent.session_transformers)
response (prompttrail.models.google.GoogleChatExample attribute)
role (prompttrail.core.Message attribute)
(prompttrail.models.anthropic.AnthropicMessageDict attribute)
run() (prompttrail.agent.runners.APIRunner method)
(prompttrail.agent.runners.CommandLineRunner method)
(prompttrail.agent.runners.Runner method)
run_command() (prompttrail.agent.tools.builtin.TreeDirectory method)
Runner (class in prompttrail.agent.runners)
runner (prompttrail.core.Session attribute)
S
search() (prompttrail.core.cache.CacheProvider method)
(prompttrail.core.cache.LRUCacheProvider method)
search_template() (prompttrail.agent.runners.Runner method)
send() (prompttrail.core.Model method)
send_async() (prompttrail.core.Model method)
session (prompttrail.agent.runners.SessionState attribute)
SessionInitStrategy (class in prompttrail.agent.subroutine)
(class in prompttrail.agent.subroutine.session_init_strategy)
SessionState (class in prompttrail.agent.runners)
SessionTransformer (class in prompttrail.agent.session_transformers)
set_jump() (prompttrail.core.Session method)
setup_logger_for_pydantic() (prompttrail.core.utils.Debuggable method)
SingleTurnResponseMockInterface (class in prompttrail.agent.user_interface)
squash() (prompttrail.agent.subroutine.FilterByRoleStrategy method)
(prompttrail.agent.subroutine.LastMessageStrategy method)
(prompttrail.agent.subroutine.LLMFilteringStrategy method)
(prompttrail.agent.subroutine.LLMSummarizingStrategy method)
(prompttrail.agent.subroutine.squash_strategy.FilterByRoleStrategy method)
(prompttrail.agent.subroutine.squash_strategy.LastMessageStrategy method)
(prompttrail.agent.subroutine.squash_strategy.LLMFilteringStrategy method)
(prompttrail.agent.subroutine.squash_strategy.LLMSummarizingStrategy method)
(prompttrail.agent.subroutine.squash_strategy.SquashStrategy method)
(prompttrail.agent.subroutine.SquashStrategy method)
SquashStrategy (class in prompttrail.agent.subroutine)
(class in prompttrail.agent.subroutine.squash_strategy)
stack (prompttrail.core.Session attribute)
start_server() (prompttrail.agent.runners.APIRunner method)
subroutine (prompttrail.agent.tools.SubroutineTool attribute)
SubroutineTemplate (class in prompttrail.agent.subroutine)
SystemTemplate (class in prompttrail.agent.templates)
T
temperature (prompttrail.core.Config attribute)
(prompttrail.models.anthropic.AnthropicConfig attribute)
(prompttrail.models.google.GoogleConfig attribute)
(prompttrail.models.openai.OpenAIConfig attribute)
(prompttrail.models.transformers.TransformersConfig attribute)
Template (class in prompttrail.agent.templates)
template_id (prompttrail.agent.templates.EndTemplate attribute)
(prompttrail.agent.templates.Stack attribute)
TemplateNotFoundError
to_dict() (prompttrail.core.Session method)
to_schema() (prompttrail.agent.tools.Tool method)
tokenizer (prompttrail.models.transformers.TransformersModel attribute)
tool_use (prompttrail.core.Message attribute)
ToolingTemplate (class in prompttrail.agent.templates)
ToolingTemplateBase (class in prompttrail.agent.templates)
tools (prompttrail.agent.templates.ToolingTemplateBase attribute)
(prompttrail.core.Config attribute)
top_k (prompttrail.core.Config attribute)
(prompttrail.models.anthropic.AnthropicConfig attribute)
(prompttrail.models.google.GoogleConfig attribute)
(prompttrail.models.transformers.TransformersConfig attribute)
top_p (prompttrail.core.Config attribute)
(prompttrail.models.anthropic.AnthropicConfig attribute)
(prompttrail.models.google.GoogleConfig attribute)
(prompttrail.models.transformers.TransformersConfig attribute)
U
UpdateMetadata (class in prompttrail.agent.session_transformers)
UserInterface (class in prompttrail.agent.user_interface)
UserTemplate (class in prompttrail.agent.templates)
V
validate_all() (prompttrail.core.Config method)
validate_arguments() (prompttrail.agent.tools.Tool method)
validate_providers() (prompttrail.core.Config method)
validate_session() (prompttrail.core.Config method)
(prompttrail.core.Model method)
(prompttrail.models.google.GoogleModel method)
(prompttrail.models.transformers.TransformersModel method)
validate_tools() (prompttrail.models.anthropic.AnthropicModel method)
validate_value() (prompttrail.agent.tools.ToolArgument method)
value_type (prompttrail.agent.tools.ToolArgument attribute)
W
walk() (prompttrail.agent.templates.BreakTemplate method)
(prompttrail.agent.templates.ControlTemplate method)
(prompttrail.agent.templates.IfTemplate method)
(prompttrail.agent.templates.LinearTemplate method)
(prompttrail.agent.templates.LoopTemplate method)
(prompttrail.agent.templates.Template method)
warning() (prompttrail.core.utils.Debuggable method)
websocket (prompttrail.agent.runners.SessionState attribute)