cheshire-cat-ai / docs

Documentation for the Cheshire Cat AI
https://cheshire-cat-ai.github.io/docs/
33 stars 28 forks source link

Ordering and/or enumerating hooks according to the execution pipeline #95

Open nicola-corbellini opened 8 months ago

nicola-corbellini commented 8 months ago

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!

kodaline commented 8 months ago

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

nicola-corbellini commented 8 months ago

@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:

kodaline commented 8 months ago

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 😱

nicola-corbellini commented 8 months ago

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