Table of Contents

• Structure of CodeWriterFlow
• run_codewriter
• CodeWriterCtrlFlow
  • CodeWriterCtrlFlow
• CodeWriterAskUserFlow
  • CodeWriterAskUserFlow
    • run
• CodeWriterFlow
  • CodeWriterFlow
    • detect_finish_or_continue
    • run
• __init__

Structure of CodeWriterFlow

               goal
                |
                v
        +---------------+
        |  Controller   | --------<<<<-----------+
        +---------------+                        |
                |                                |
                | (command, command args)        |
                |                                |
                v                                |
        +------------------+                     |
        |   Executor       |  Each branch is an  |
        | (Tree Structure) |  executor           |
        +------------------+                     |
                |                                ^
                | (summary)                      |
                |                                |
                v                                |             
                |                                |
                +-> goes back to the Controller>-+

         +-------------------+
         |   Branching       |
         |    Executor       |
         +-------------------+
        /          |         \
       /           |          \
      /            |           \
     /             |            \
write_code      ask_user       test

• ask_user: Ask user for info / confirmation, etc.
• write_code: Generates code (user edit is allowed) and fetches user feedback.
• test: Test the code, user can provide test suites, if nothing is provided, syntax of the code is checked.

run_codewriter

CodeWriterCtrlFlow

CodeWriterCtrlFlow Objects

• goal

• goal
• code
• feedback

• command
• command_args

• backend: the backend used to call the LLM.
• commands: a list of commands that the controller can use.
• system_message_prompt_template: the template of the system message prompt.
• init_human_message_prompt_template: the template of the init human (user) message prompt.
• human_message_prompt_template: the template of the human (user) message prompt.
• previous_messages: the sliding window of previous messages.

CodeWriterAskUserFlow

CodeWriterAskUserFlow Objects

• question: The question asked by the controller

• The question is displayed, and the user gives feedback by inputing string.

• feedback: The input of the user.
• code: No code was written.

• query_message_prompt_template: The template of the message that is displayed to the user.
• request_multi_line_input: Whether the user should be able to input multiple lines. Default: False.
• end_of_input_string: The string that the user can input to indicate that he/she is done with the input. Default: EOI

run

• input_data: The input data.

CodeWriterFlow

CodeWriterFlow Objects

• goal

• code
• result
• summary
• status

• name: Name of the flow
• description: Description of the flow
• _target_: The instantiation target of the flow
• input_interface: The input to the flow. Inherited from ContentWriterFlow, in this case, it is goal.
• output_interface: The output of the flow.
• subflows_config: Configurations of subflows
• early_exit_keys: The keys that will trigger an early exit of the flow
• topology: Configures the topology of the subflows, please have a special look at the I/O interfaces of the subflows.

detect_finish_or_continue

• output_payload: The output payload of the subflow
• src_flow: The subflow that generated the output payload

run

• input_data: The input data of the flow

__init__