Skip to content

prompt

Hooks to modify the prompts.

Here is a collection of methods to hook the prompts components that instruct the Agent.

agent_prompt_instructions(instructions, cat)

Hook the instruction prompt.

Allows to edit the instructions that the Cat feeds to the Agent to select tools and forms.

Parameters:

Name Type Description Default
instructions str

Instructions prompt to select tool or form.

 required
cat StrayCat

StrayCat instance.

 required

Returns:

Name Type Description
instructions str

Instructions prompt to select tool or form
Notes

This prompt explains the Agent how to select a tool or form.

Source code in cat/mad_hatter/core_plugin/hooks/prompt.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
@hook(priority=0)
def agent_prompt_instructions(instructions: str, cat) -> str:
    """Hook the instruction prompt.

    Allows to edit the instructions that the Cat feeds to the *Agent* to select tools and forms.

    Parameters
    ----------
    instructions : str
        Instructions prompt to select tool or form.
    cat : StrayCat
        StrayCat instance.

    Returns
    -------
    instructions : str
        Instructions prompt to select tool or form

    Notes
    -----
    This prompt explains the *Agent* how to select a tool or form.

    """

    return instructions

agent_prompt_prefix(prefix, cat)

Hook the main prompt prefix.

Allows to edit the prefix of the Main Prompt that the Cat feeds to the Agent. It describes the personality of your assistant and its general task.

The prefix is then completed with the agent_prompt_suffix.

Parameters:

Name Type Description Default
prefix str

Main / System prompt with personality and general task to be accomplished.

 required
cat StrayCat

StrayCat instance.

 required

Returns:

Name Type Description
prefix str

Main / System prompt.
Notes

The default prefix describe who the AI is and how it is expected to answer the Human.

Source code in cat/mad_hatter/core_plugin/hooks/prompt.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
@hook(priority=0)
def agent_prompt_prefix(prefix, cat) -> str:
    """Hook the main prompt prefix.

    Allows to edit the prefix of the *Main Prompt* that the Cat feeds to the *Agent*.
    It describes the personality of your assistant and its general task.

    The prefix is then completed with the `agent_prompt_suffix`.

    Parameters
    ----------
    prefix : str
        Main / System prompt with personality and general task to be accomplished.
    cat : StrayCat
        StrayCat instance.

    Returns
    -------
    prefix : str
        Main / System prompt.

    Notes
    -----
    The default prefix describe who the AI is and how it is expected to answer the Human.
    """

    return prefix

agent_prompt_suffix(prompt_suffix, cat)

Hook the main prompt suffix.

Allows to edit the suffix of the Main Prompt that the Cat feeds to the Agent.

The suffix is concatenated to agent_prompt_prefix when RAG context is used.

Parameters:

Name Type Description Default
cat StrayCat

StrayCat instance.

 required

Returns:

Name Type Description
prompt_suffix str

The suffix string to be concatenated to the Main Prompt (prefix).
Notes

The default suffix has a few placeholders: - {episodic_memory} provides memories retrieved from episodic memory (past conversations) - {declarative_memory} provides memories retrieved from declarative memory (uploaded documents) - {chat_history} provides the Agent the recent conversation history - {input} provides the last user's input - {agent_scratchpad} is where the Agent can concatenate tools use and multiple calls to the LLM.

Source code in cat/mad_hatter/core_plugin/hooks/prompt.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
@hook(priority=0)
def agent_prompt_suffix(prompt_suffix: str, cat) -> str:
    """Hook the main prompt suffix.

    Allows to edit the suffix of the *Main Prompt* that the Cat feeds to the *Agent*.

    The suffix is concatenated to `agent_prompt_prefix` when RAG context is used.

    Parameters
    ----------
    cat : StrayCat
        StrayCat instance.

    Returns
    -------
    prompt_suffix : str
        The suffix string to be concatenated to the *Main Prompt* (prefix).

    Notes
    -----
    The default suffix has a few placeholders:
    - {episodic_memory} provides memories retrieved from *episodic* memory (past conversations)
    - {declarative_memory} provides memories retrieved from *declarative* memory (uploaded documents)
    - {chat_history} provides the *Agent* the recent conversation history
    - {input} provides the last user's input
    - {agent_scratchpad} is where the *Agent* can concatenate tools use and multiple calls to the LLM.

    """

    return prompt_suffix