daniel/email-classifier
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add MkDocs documentation #5

Merged
daniel merged 4 commits from docs/mkdocs into main 2026-04-09 20:57:50 +00:00
Conversation 0 Commits 4 Files Changed 9 +11 -11
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 8d1109c309 - Show all commits

22
docs/api.md
View File

@@ -82,7 +82,7 @@ You can override the global LLM settings for individual requests:
| Field | Type | Description | | Field | Type | Description |
|---|---|---| |---|---|---|
| `provider` | `openai` \| `anthropic` | Override the global LLM provider | | `provider` | `openai` | `anthropic` | Override the global LLM provider |
| `model` | `string` | Override the model name | | `model` | `string` | Override the model name |
| `base_url` | `string` | Override the API base URL | | `base_url` | `string` | Override the API base URL |
| `api_key` | `string` | Override the API key (excluded from logs) | | `api_key` | `string` | Override the API key (excluded from logs) |
@@ -130,7 +130,7 @@ You can override the global LLM settings for individual requests:
| `needs_action` | `bool` | Whether the email requires user action | | `needs_action` | `bool` | Whether the email requires user action |
| `category` | `string` | One of the 8 classification categories | | `category` | `string` | One of the 8 classification categories |
| `priority` | `string` | `high`, `medium`, or `low` | | `priority` | `string` | `high`, `medium`, or `low` |
| `task_description` | `string\|null` | Short action-oriented description | | `task_description` | `string|null` | Short action-oriented description |
| `reasoning` | `string` | One-sentence explanation of the classification | | `reasoning` | `string` | One-sentence explanation of the classification |
| `confidence` | `float` | Model confidence score (0.0–1.0) | | `confidence` | `float` | Model confidence score (0.0–1.0) |
| `details` | `object` | Structured extraction (see below) | | `details` | `object` | Structured extraction (see below) |
@@ -140,27 +140,27 @@ You can override the global LLM settings for individual requests:
| Field | Type | Description | | Field | Type | Description |
|---|---|---| |---|---|---|
| `summary` | `string\|null` | Brief human-readable summary | | `summary` | `string|null` | Brief human-readable summary |
| `suggested_title` | `string\|null` | Good task/Todoist title | | `suggested_title` | `string|null` | Good task/Todoist title |
| `suggested_notes` | `string\|null` | Multiline notes for a human reviewer | | `suggested_notes` | `string|null` | Multiline notes for a human reviewer |
| `deadline` | `string\|null` | Any date/time deadline mentioned | | `deadline` | `string|null` | Any date/time deadline mentioned |
| `people` | `string[]` | People involved or referenced | | `people` | `string[]` | People involved or referenced |
| `organizations` | `string[]` | Organizations, departments, vendors, teams | | `organizations` | `string[]` | Organizations, departments, vendors, teams |
| `attachments_referenced` | `string[]` | Attachment names mentioned in the email | | `attachments_referenced` | `string[]` | Attachment names mentioned in the email |
| `next_steps` | `string[]` | Specific recommended next actions | | `next_steps` | `string[]` | Specific recommended next actions |
| `key_points` | `string[]` | Important context bullets | | `key_points` | `string[]` | Important context bullets |
| `source_signals` | `string[]` | Signals that triggered the classification | | `source_signals` | `string[]` | Signals that triggered the classification |
| `dedupe_key` | `string\|null` | Content fingerprint (SHA-256) | | `dedupe_key` | `string|null` | Content fingerprint (SHA-256) |
### `dedupe` Object ### `dedupe` Object
| Field | Type | Description | | Field | Type | Description |
|---|---|---| |---|---|---|
| `status` | `new \| duplicate \| updated` | Whether this is new, a duplicate, or updated | | `status` | `new | duplicate | updated` | Whether this is new, a duplicate, or updated |
| `seen_count` | `int` | Number of times this email thread has been seen | | `seen_count` | `int` | Number of times this email thread has been seen |
| `matched_on` | `none \| id \| conversation \| fingerprint` | Which dedupe mechanism matched | | `matched_on` | `none | id | conversation | fingerprint` | Which dedupe mechanism matched |
| `message_id` | `string\|null` | Outlook `id` field if available | | `message_id` | `string|null` | Outlook `id` field if available |
| `conversation_id` | `string\|null` | Outlook `conversationId` if available | | `conversation_id` | `string|null` | Outlook `conversationId` if available |
| `fingerprint` | `string` | SHA-256 content fingerprint | | `fingerprint` | `string` | SHA-256 content fingerprint |
--- ---