Glossary

📚 Glossary of key terms¶

Here is a glossary of the key terms used throughout the MindFlight AI Server documentation. This section helps clarify concepts, especially for developers who are new to workflow orchestration or AI systems.

API (Application Programming Interface)¶

A set of rules and protocols that allow different software components to communicate with each other. In MindFlight, APIs are the entry points for Clients to interact with the server.

Background Job¶

A task that runs asynchronously in the background, so it doesn't block other operations. For example, drafting a reply to an email can run as a background job.

Client¶

Any external system, app, or interface that sends requests to the MindFlight AI Server. Clients can be chatbots, dashboards, or automation scripts.

Event (Internal)¶

A notification that something happened inside the server, like "unipile.email.received". Events are used to trigger workflows or background jobs.

Fiber¶

A Go web framework used to build the server's HTTP API. It's known for being fast and lightweight.

Job Manager¶

The component that manages background jobs. It queues, runs, and tracks tasks that might take longer than normal API requests.

LLM (Large Language Model)¶

An AI system trained to understand and generate text, such as OpenAI's GPT models. The server can use an LLM to help draft content or process language.

Memory¶

A key-value store inside the server used to keep temporary or session data. For example, you might store a user's last message or preferences here.

Notification (External)¶

A webhook message sent to Clients when a specific event happens, like notifying a user when an email has been processed.

Provider¶

A plugin module that connects the server to external services (e.g., email, file storage, APIs). Providers handle specialized tasks and expose tools.

Pub/Sub (Publish/Subscribe)¶

A messaging pattern where components publish events, and subscribers listen for them. This allows different parts of the system to react to changes in real-time.

Tool¶

A functionality exposed by a Provider that can be called via API. For example, the Filesystem Provider has a list_files tool.

Webhook¶

A URL endpoint that receives HTTP POST messages automatically when certain events happen. Webhooks are used for both incoming (from Providers) and outgoing (to Clients) communication.

Workflow¶

A sequence of steps or tasks that need to be executed in a specific order to complete a process. For example, processing an incoming email and replying to it is a workflow.