Merge pull request #49 from Promptly-Technologies-LLC/34-enhance-the-readme

Add explanation and screenshots to the README

Author: chriscarrollsmith

README.md

@@ -27,4 +27,22 @@ uv run uvicorn main:app --host 0.0.0.0 --port 8000 --reload
 
 ### 5. Set your OpenAI API key and create an assistant in the GUI
 
-If your OPENAI_API_KEY or ASSISTANT_ID are not set, you will be redirected to the setup page where you can set them. (The values will be saved in a .env file in the root of the project.) Once set, you will be redirected to the home page and can begin a chat session.
+## Usage
+
+Navigate to the `/setup` page at any time to configure your assistant:
+
+![Setup Page](./docs/setup.png)
+
+Navigate to the `/chat` page to begin a chat session:
+
+![Chat Page](./docs/chat.png)
+
+If your OPENAI_API_KEY or ASSISTANT_ID are not set, you will be redirected to `/setup` where you can set them. (The values will be saved in a `.env` file in the root of the project.)
+
+The assistant is capable of multi-step workflows involving multiple chained tool calls, including file searches, code execution, and calling custom functions. Tool calls will be displayed in the chat as they are processed.
+
+## Defining Your Own Custom Functions
+
+Define custom functions in the `utils/custom_functions.py` file. An example `get_weather` function is provided. You will need to import your function in `routers/chat.py` and add your execution logic to the `event_generator` function (search for `get_weather` in that file to see a function execution example). See also `templates/components/weather-widget.html` for an example widget for displaying the function call results.
+
+Ultimately I plan to support a more intuitive workflow for defining custom functions, and perhaps I'll even add MCP support. Please contribute a PR if you'd like to help!

docs/chat.png

@@ -86,7 +86,7 @@ def get_function_tool_param() -> FunctionToolParam:
     )
 
 
-def get_weather(location, dates: Sequence[str | datetime] = [datetime.today()]):
+def get_weather(location, dates: Sequence[str | datetime] = [datetime.today()]) -> list[dict[str, Any]]:
     """
     Generate random weather reports for a given location over a date range.