prompttrail.agent package

Subpackages

• prompttrail.agent.session_transformers package
  • Module contents
    • CodeBlock
      • CodeBlock.__init__()
      • CodeBlock.code
      • CodeBlock.lang
    • DangerouslyEvaluatePythonCode
      • DangerouslyEvaluatePythonCode.__init__()
      • DangerouslyEvaluatePythonCode.process_metadata()
    • Debugger
      • Debugger.__init__()
      • Debugger.process_metadata()
    • ExtractMarkdownCodeBlock
      • ExtractMarkdownCodeBlock.__init__()
      • ExtractMarkdownCodeBlock.process_metadata()
    • LambdaSessionTransformer
      • LambdaSessionTransformer.__init__()
      • LambdaSessionTransformer.process()
    • MetadataTransformer
      • MetadataTransformer.__init__()
      • MetadataTransformer.process()
      • MetadataTransformer.process_metadata()
    • ResetMetadata
      • ResetMetadata.__init__()
      • ResetMetadata.process_metadata()
    • SessionTransformer
      • SessionTransformer.__init__()
      • SessionTransformer.process()
    • UpdateMetadata
      • UpdateMetadata.__init__()
      • UpdateMetadata.process_metadata()
• prompttrail.agent.subroutine package
  • Submodules
  • prompttrail.agent.subroutine.session_init_strategy module
    • CleanSessionStrategy
      • CleanSessionStrategy.initialize()
    • FilteredInheritStrategy
      • FilteredInheritStrategy.__init__()
      • FilteredInheritStrategy.initialize()
    • InheritSystemStrategy
      • InheritSystemStrategy.initialize()
    • LastNMessagesStrategy
      • LastNMessagesStrategy.__init__()
      • LastNMessagesStrategy.initialize()
    • SessionInitStrategy
      • SessionInitStrategy.initialize()
  • prompttrail.agent.subroutine.squash_strategy module
    • FilterByRoleStrategy
      • FilterByRoleStrategy.__init__()
      • FilterByRoleStrategy.squash()
    • LLMFilteringStrategy
      • LLMFilteringStrategy.__init__()
      • LLMFilteringStrategy.squash()
    • LLMSummarizingStrategy
      • LLMSummarizingStrategy.__init__()
      • LLMSummarizingStrategy.squash()
    • LastMessageStrategy
      • LastMessageStrategy.squash()
    • SquashStrategy
      • SquashStrategy.initialize()
      • SquashStrategy.squash()
  • Module contents
    • CleanSessionStrategy
      • CleanSessionStrategy.initialize()
    • FilterByRoleStrategy
      • FilterByRoleStrategy.__init__()
      • FilterByRoleStrategy.squash()
    • FilteredInheritStrategy
      • FilteredInheritStrategy.__init__()
      • FilteredInheritStrategy.initialize()
    • InheritSystemStrategy
      • InheritSystemStrategy.initialize()
    • LLMFilteringStrategy
      • LLMFilteringStrategy.__init__()
      • LLMFilteringStrategy.squash()
    • LLMSummarizingStrategy
      • LLMSummarizingStrategy.__init__()
      • LLMSummarizingStrategy.squash()
    • LastMessageStrategy
      • LastMessageStrategy.squash()
    • SessionInitStrategy
      • SessionInitStrategy.initialize()
    • SquashStrategy
      • SquashStrategy.initialize()
      • SquashStrategy.squash()
    • SubroutineTemplate
      • SubroutineTemplate.__init__()
      • SubroutineTemplate.create_stack()
• prompttrail.agent.templates package
  • Module contents
    • AnthropicToolingTemplate
      • AnthropicToolingTemplate.__init__()
      • AnthropicToolingTemplate.format_tool_call()
      • AnthropicToolingTemplate.format_tool_result()
    • AssistantTemplate
      • AssistantTemplate.__init__()
    • BreakTemplate
      • BreakTemplate.__init__()
      • BreakTemplate.create_stack()
      • BreakTemplate.walk()
    • ControlTemplate
      • ControlTemplate.__init__()
      • ControlTemplate.create_stack()
      • ControlTemplate.walk()
    • EndTemplate
      • EndTemplate.__init__()
      • EndTemplate.before_transform
      • EndTemplate.create_stack()
      • EndTemplate.template_id
    • Event
      • Event.event_type
      • Event.payload
      • Event.__init__()
      • Event.event_type
      • Event.payload
    • ExecuteToolTemplate
      • ExecuteToolTemplate.__init__()
    • GenerateTemplate
      • GenerateTemplate.__init__()
    • IfTemplate
      • IfTemplate.__init__()
      • IfTemplate.create_stack()
      • IfTemplate.walk()
    • LinearTemplate
      • LinearTemplate.__init__()
      • LinearTemplate.create_stack()
      • LinearTemplate.walk()
    • LoopTemplate
      • LoopTemplate.__init__()
      • LoopTemplate.create_stack()
      • LoopTemplate.walk()
    • MessageTemplate
      • MessageTemplate.__init__()
      • MessageTemplate.create_stack()
    • OpenAIToolingTemplate
      • OpenAIToolingTemplate.__init__()
      • OpenAIToolingTemplate.check_tool_arguments()
      • OpenAIToolingTemplate.format_tool_call()
      • OpenAIToolingTemplate.format_tool_result()
    • Stack
      • Stack.template_id
    • SystemTemplate
      • SystemTemplate.__init__()
    • Template
      • Template.__init__()
      • Template.create_stack()
      • Template.render()
      • Template.walk()
    • ToolingTemplate
      • ToolingTemplate.__init__()
    • ToolingTemplateBase
      • ToolingTemplateBase.__init__()
      • ToolingTemplateBase.get_tool()
      • ToolingTemplateBase.tools
    • UserTemplate
      • UserTemplate.__init__()
• prompttrail.agent.tools package
  • Submodules
  • prompttrail.agent.tools.builtin module
    • CreateOrOverwriteFile
      • CreateOrOverwriteFile.arguments
      • CreateOrOverwriteFile.description
      • CreateOrOverwriteFile.name
    • EditFile
      • EditFile.arguments
      • EditFile.description
      • EditFile.name
      • EditFile.block_anchor_fallback_match()
      • EditFile.construct_new_file_content()
      • EditFile.line_trimmed_fallback_match()
    • EndConversationTool
      • EndConversationTool.arguments
      • EndConversationTool.description
      • EndConversationTool.name
    • ExecuteCommand
      • ExecuteCommand.arguments
      • ExecuteCommand.description
      • ExecuteCommand.name
    • ReadFile
      • ReadFile.arguments
      • ReadFile.description
      • ReadFile.name
    • TreeDirectory
      • TreeDirectory.arguments
      • TreeDirectory.description
      • TreeDirectory.name
      • TreeDirectory.run_command()
  • Module contents
    • SubroutineTool
      • SubroutineTool.subroutine
      • SubroutineTool.__init__()
    • Tool
      • Tool.arguments
      • Tool.description
      • Tool.enable_logging
      • Tool.logger
      • Tool.name
      • Tool.execute()
      • Tool.model_post_init()
      • Tool.to_schema()
      • Tool.validate_arguments()
    • ToolArgument
      • ToolArgument.description
      • ToolArgument.name
      • ToolArgument.required
      • ToolArgument.value_type
      • ToolArgument.validate_value()
    • ToolResult
      • ToolResult.content
      • ToolResult.metadata

Submodules

prompttrail.agent.runners module

class prompttrail.agent.runners.APIRunner(model: Model, template: Template, user_interface: UserInterface, host: str = '127.0.0.1', port: int = 8000)

Bases: Runner

__init__(model: Model, template: Template, user_interface: UserInterface, host: str = '127.0.0.1', port: int = 8000)

Abstract class for runner. Runner is a class to run the templates. It is responsible for rendering templates and handling user interactions.

run(session: Session | None = None, max_messages: int | None = 100, debug_mode: bool = False) → Session

Run method implementation for APIRunner.

This method is mainly for compatibility with the Runner interface. The actual processing is done through the API endpoints.

start_server()

class prompttrail.agent.runners.CommandLineRunner(model: Model, template: Template, user_interface: UserInterface)

Bases: Runner

run(session: Session | None = None, max_messages: int | None = 100, debug_mode: bool = False) → Session

Command line runner. This runner is for debugging purpose. It prints out the messages to the console.

Parameters:

• session (Optional[Session], optional) – If set, use the session given. Otherwise, create a new session. Defaults to None.

• max_messages (Optional[int], optional) – Maximum number of messages to yield. If number of messages exceeds this number, the conversation is forced to stop. Defaults to 100.

• debug_mode (bool, optional) – If set, print out debug messages. Defaults to False.

Returns:

Final session of the conversation.

Return type:

Session

class prompttrail.agent.runners.Runner(model: Model, template: Template, user_interface: UserInterface)

Bases: Debuggable

__init__(model: Model, template: Template, user_interface: UserInterface)

Abstract class for runner. Runner is a class to run the templates. It is responsible for rendering templates and handling user interactions.

abstract run(session: Session | None = None, max_messages: int | None = None, debug_mode: bool = False) → Session

All runners should implement this method. This method should run the templates and return the final session.

search_template(template_like: str) → Template

Search template by template id. If template id is not found, raise ValueError.

class prompttrail.agent.runners.SessionState(session: prompttrail.core._core.Session, current_event: prompttrail.agent.templates._core.UserInteractionEvent | None = None, is_running: bool = False, websocket: starlette.websockets.WebSocket | None = None)

Bases: object

__init__(session: Session, current_event: UserInteractionEvent | None = None, is_running: bool = False, websocket: WebSocket | None = None) → None

current_event: UserInteractionEvent | None = None

is_running: bool = False

session: Session

websocket: WebSocket | None = None

prompttrail.agent.runners.cutify_role(role: Literal['system', 'user', 'assistant', 'tool_result', 'control']) → str

Cutify role name based on OpenAI’s naming convention.

prompttrail.agent.runners.pretty_print_metadata(metadata: Dict[str, Any]) → str

prompttrail.agent.user_interface module

class prompttrail.agent.user_interface.CLIInterface

Bases: UserInterface

ask(session: Session, description: str | None = 'Input> ', default: str | None = None) → str

Ask the user for input via the command line interface.

Parameters:

• session – The current session of the conversation.

• description – The description of the input prompt.

• default – The default value for the input prompt.

Returns:

The user’s input as a string.

class prompttrail.agent.user_interface.DefaultOrEchoMockInterface

Bases: MockInterface

ask(session: Session, description: str | None = None, default: str | None = None) → str

Base mock provider that returns an empty string.

Parameters:

• session – The current session of the conversation.

• description – The description of the input prompt.

• default – The default value for the input prompt.

Returns:

An empty string.

class prompttrail.agent.user_interface.EchoMockInterface

Bases: MockInterface

ask(session: Session, description: str | None = None, default: str | None = None) → str

Mock the user interaction by echoing the last message.

Parameters:

• session – The current session of the conversation.

• description – The description of the input prompt.

• default – The default value for the input prompt.

Returns:

The last message as the user’s input.

class prompttrail.agent.user_interface.MockInterface

Bases: UserInterface

ask(session: Session, description: str | None = None, default: str | None = None) → str

Base mock provider that returns an empty string.

Parameters:

• session – The current session of the conversation.

• description – The description of the input prompt.

• default – The default value for the input prompt.

Returns:

An empty string.

class prompttrail.agent.user_interface.SingleTurnResponseMockInterface(conversation_table: Dict[str, str])

Bases: MockInterface

__init__(conversation_table: Dict[str, str])

Initialize logging for the class.

ask(session: Session, description: str | None = None, default: str | None = None) → str

Mock the user interaction by providing pre-defined responses based on the conversation history.

Parameters:

• session – The current session of the conversation.

• description – The description of the input prompt.

• default – The default value for the input prompt.

Returns:

The pre-defined response based on the conversation history.

class prompttrail.agent.user_interface.UserInterface

Bases: Debuggable

abstract ask(session: Session, instruction: str | None, default: str | None = None) → str

Ask the user for input.

Parameters:

• session – The current session of the conversation.

• description – The description of the input prompt.

• default – The default value for the input prompt.

Returns:

The user’s input as a string.

Module contents

Agent module for PromptTrail.