update guide

This commit is contained in:
zachary62 2025-03-13 23:54:22 -04:00
parent 0a420b3513
commit b3420359be
2 changed files with 6 additions and 8 deletions

View File

@ -32,13 +32,12 @@ These system designs should be a collaboration between humans and AI assistants:
2. **Flow Design**: Outline at a high level, describe how your AI system orchestrates nodes. 2. **Flow Design**: Outline at a high level, describe how your AI system orchestrates nodes.
- Identify applicable design patterns (e.g., [Map Reduce](./design_pattern/mapreduce.md), [Agent](./design_pattern/agent.md), [RAG](./design_pattern/rag.md)). - Identify applicable design patterns (e.g., [Map Reduce](./design_pattern/mapreduce.md), [Agent](./design_pattern/agent.md), [RAG](./design_pattern/rag.md)).
- Draw the Flow in a mermaid diagram. For example: - Outline the flow and draw it in a mermaid diagram. For example:
```mermaid ```mermaid
flowchart LR flowchart LR
firstNode[First Node] --> secondNode[Second Node] firstNode[First Node] --> secondNode[Second Node]
secondNode --> thirdNode[Third Node] secondNode --> thirdNode[Third Node]
``` ```
- For each node in the flow, provide a high-level purpose description.
3. **Utilities**: Based on the Flow Design, identify and implement necessary utility functions. 3. **Utilities**: Based on the Flow Design, identify and implement necessary utility functions.
- Think of your AI system as the brain. It needs a body—these *external utility functions*—to interact with the real world: - Think of your AI system as the brain. It needs a body—these *external utility functions*—to interact with the real world:
@ -47,9 +46,8 @@ These system designs should be a collaboration between humans and AI assistants:
- Reading inputs (e.g., retrieving Slack messages, reading emails) - Reading inputs (e.g., retrieving Slack messages, reading emails)
- Writing outputs (e.g., generating reports, sending emails) - Writing outputs (e.g., generating reports, sending emails)
- Using external tools (e.g., calling LLMs, searching the web) - Using external tools (e.g., calling LLMs, searching the web)
- **NOTE**: *LLM-based tasks* (e.g., summarizing text, analyzing sentiment) are **NOT** utility functions; rather, they are *core functions* internal in the AI system.
- NOTE: *LLM-based tasks* (e.g., summarizing text, analyzing sentiment) are **NOT** utility functions; rather, they are *core functions* internal in the AI system. - For each utility function, implement it and write a simple test.
- For each utility function, implement it and write a simple test (e.g., under `if __name__ == "__main__":` ).
- Document their input/output, as well as why they are necessary. For example: - Document their input/output, as well as why they are necessary. For example:
- *Name*: Embedding (`utils/get_embedding.py`) - *Name*: Embedding (`utils/get_embedding.py`)
- *Input*: `str` - *Input*: `str`
@ -61,9 +59,8 @@ These system designs should be a collaboration between humans and AI assistants:
- Start with the shared data design - Start with the shared data design
- For simple systems, use an in-memory dictionary. - For simple systems, use an in-memory dictionary.
- For more complex systems or when persistence is required, use a database. - For more complex systems or when persistence is required, use a database.
- **Remove Data Redundancy**: Dont store the same data. Use in-memory references or foreign keys. - **Don't Repeat Yourself"**: Use in-memory references or foreign keys.
- For each node, specify its type, how it reads and writes data, and which utility function it uses. - For each node, describe its type, how it reads and writes data, and which utility function it uses. Keep it specific but high-level without codes. For example:
- Keep it specific but high-level without codes. For example:
- `type`: Regular (or Batch, or Async) - `type`: Regular (or Batch, or Async)
- `prep`: Read "text" from the shared store - `prep`: Read "text" from the shared store
- `exec`: Call the embedding utility function - `exec`: Call the embedding utility function

View File

@ -25,6 +25,7 @@ Here, we provide some minimal example implementations:
call_llm("How are you?") call_llm("How are you?")
``` ```
> Store the API key in an environment variable like OPENAI_API_KEY for security. > Store the API key in an environment variable like OPENAI_API_KEY for security.
{: .best-practice }
2. Claude (Anthropic) 2. Claude (Anthropic)
```python ```python