cheshire-cat-ai/docs

Ordering and/or enumerating hooks according to the execution pipeline

Opened this issue · 4 comments

In this table, the hooks should be ordered according the their execution.
Since the ordering requires to jump from one tab to another, we may think to order those in the same tab and add enumeration to explain the ordering across all hook typology (i.e. agent, rabbit hole, ecc.).

Example

Name Description
1. Before agent starts Intervene before the agent starts
2. Agent fast reply Shorten the pipeline and returns an answer right after the agent execution

Smarter or more sophisticated ways are welcome!

@nicola-corbellini what about doing a section in the file about hooks execution pipeline? Maybe then, linking each hook to the table?

@kodaline yes, this could be a solution, but if we could keep the info all in the same place I think it could be better for the user.
Other solutions could be:

  • numbered list, like mentioned above
  • adding previous hook and following hook in the panel appearing with +
  • adding the numbering hovering the hook name

I am not sure I understood well this improvement 😄 , but, adding a tab in the table called Pipeline ? Where, you just have all the hooks as in the pipeline... it might not be short though 😱

Yep indeed, also there are the diagrams already where the execution flow with hooks. Maybe just ordering and numbering the entry in the hook table is the cleanest solution