FS-101 Add report director

[mic-smith]

Description

Create Report Director to handle file uploads

Changelog

• Move file_upload_service to file_utils
• Add report director which uses fle_utils and returns hardcode report string

[stevenhillcox-sl]

I am wondering if the director should be responsible for storing the report in the scratchpad, or if the agent should be doing it.

[mic-smith]

Probably the director, though I don't think we have any reason to be using the scratch pad, so it's tempting to just remove completely for now.

[IMladjenovic]

In terms of director vs Report Agent adding results to the scratchpad, I would lean towards the director doing this as aligns closer with the approach taken by the Chat Director and Chat Supervisor. The Chat Supervisor calls out to various agents to perform tasks and then analyses how good there responses are before accepting them and putting them on the scratch pad. This makes sense on the "Chat Flow" side because we are verifying Infer's abililty to respond to a question. On the "Report Flow" side of things, this doesn't really matter as much because there isn't any ambiguity in what we are doing, we have a clear intention to complete for the user with an orchestrated flow.

But, with the Chat Flow in mind, I'd be keen for the Report Director to work in a similar way and update the scratch pad itself. We don't currently plan to have a Report Supervisor because the flow is so straightforward, but if we begin to have more variables in this report creation process we may require a Report Supervisor to manage the preparation of data needed by the Report Agent to create the Report.

I don't mind whether we put the file on the scratch pad or not at the moment, but I would keep it in for now as we should hopefully be aiming towards introducing a "Sustainability Materiality Matrix" to the report creation. This will focus the report agent on the most important sustainability areas for that company that the report agent should focus on.
(The materiality matrix will look something like this: https://sasb.ifrs.org/wp-content/uploads/2021/11/MMap-2021.png but not SASB until we can establish a license to use it)

If we add this Matrix Agent then the flow will look like:

1. Report Director puts the the file on the scratch pad
2. Report Director calls the Materiality Agent to align the company to a industry and sector within that industry and then add the relevant materiality matrix onto the scratch pad
3. Report Director calls the Report Agent. Report Agent knows that all the info it needs to create a report on the scratch pad.
4. Report Agent creates report and returns to director who sends the report to the UI

Late note:
As the scratchpad gets cleared after each call, I think we will add the Report as part of the intent agent prompt along with the chat history.

[IMladjenovic]

What do we think about moving this into a src/directors/ folder and also add the current director.py renamed to chat_director.py as part of this ticket?

[IMladjenovic]

and if we rename the director, could be worth renaming the current supervisor to chat_supervisor.py

[mic-smith]

Done, and renamed prompt file too to match. (director -> chat_director)

[IMladjenovic]

In terms of director vs Report Agent adding results to the scratchpad, I would lean towards the director doing this as aligns closer with the approach taken by the Chat Director and Chat Supervisor. The Chat Supervisor calls out to various agents to perform tasks and then analyses how good there responses are before accepting them and putting them on the scratch pad. This makes sense on the "Chat Flow" side because we are verifying Infer's abililty to respond to a question. On the "Report Flow" side of things, this doesn't really matter as much because there isn't any ambiguity in what we are doing, we have a clear intention to complete for the user with an orchestrated flow.

But, with the Chat Flow in mind, I'd be keen for the Report Director to work in a similar way and update the scratch pad itself. We don't currently plan to have a Report Supervisor because the flow is so straightforward, but if we begin to have more variables in this report creation process we may require a Report Supervisor to manage the preparation of data needed by the Report Agent to create the Report.

I don't mind whether we put the file on the scratch pad or not at the moment, but I would keep it in for now as we should hopefully be aiming towards introducing a "Sustainability Materiality Matrix" to the report creation. This will focus the report agent on the most important sustainability areas for that company that the report agent should focus on.
(The materiality matrix will look something like this: https://sasb.ifrs.org/wp-content/uploads/2021/11/MMap-2021.png but not SASB until we can establish a license to use it)

If we add this Matrix Agent then the flow will look like:

1. Report Director puts the the file on the scratch pad
2. Report Director calls the Materiality Agent to align the company to a industry and sector within that industry and then add the relevant materiality matrix onto the scratch pad
3. Report Director calls the Report Agent. Report Agent knows that all the info it needs to create a report on the scratch pad.
4. Report Agent creates report and returns to director who sends the report to the UI

Late note:
As the scratchpad gets cleared after each call, I think we will add the Report as part of the intent agent prompt along with the chat history.

[evpearce]

are we supposed to have this bit of commented out code?
and i this report just a placeholder or something? what is it used for

[stevenhillcox-sl]

I believe this is the part where we will plug in the report agent once it's complete. For now, it just returns some placeholder markdown

[mic-smith]

Yes, this is just a sample response and to show where the report agent will be integrated. The placeholder report isn't used by anything yet.