systemprompt-files 0.26.0

File storage, metadata, and access control for systemprompt.io AI governance infrastructure. Governed file operations for the MCP governance pipeline.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

<div align="center">

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://systemprompt.io/files/images/logo.svg">
  <source media="(prefers-color-scheme: light)" srcset="https://systemprompt.io/files/images/logo-dark.svg">
  <img src="https://systemprompt.io/files/images/logo.svg" alt="systemprompt.io" width="180">
</picture>

### Production infrastructure for AI agents

[**Website**](https://systemprompt.io) · [**Documentation**](https://systemprompt.io/documentation/) · [**Guides**](https://systemprompt.io/guides) · [**Core**](https://github.com/systempromptio/systemprompt-core) · [**Template**](https://github.com/systempromptio/systemprompt-template) · [**Discord**](https://discord.gg/wkAbSuPWpr)

</div>

---

# systemprompt-files

<div align="center">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/systempromptio/systemprompt-core/main/assets/readme/terminals/dark/domain-files.svg">
    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/systempromptio/systemprompt-core/main/assets/readme/terminals/light/domain-files.svg">
    <img alt="systemprompt-files terminal demo" src="https://raw.githubusercontent.com/systempromptio/systemprompt-core/main/assets/readme/terminals/dark/domain-files.svg" width="100%">
  </picture>
</div>

[![Crates.io](https://img.shields.io/crates/v/systemprompt-files.svg?style=flat-square)](https://crates.io/crates/systemprompt-files)
[![Docs.rs](https://img.shields.io/docsrs/systemprompt-files?style=flat-square)](https://docs.rs/systemprompt-files)
[![License: BSL-1.1](https://img.shields.io/badge/license-BSL--1.1-2b6cb0?style=flat-square)](https://github.com/systempromptio/systemprompt-core/blob/main/LICENSE)
[![codecov](https://img.shields.io/codecov/c/github/systempromptio/systemprompt-core/main?style=flat-square&logo=codecov)](https://codecov.io/gh/systempromptio/systemprompt-core)

Files that stay on your infrastructure, with a record of every one. Governed uploads with MIME validation, AI-generated image tracking, and content associations, stored where you control them and audited like every other operation.

**Layer**: Domain — business-logic modules that implement systemprompt.io features. Part of the [systemprompt-core](https://github.com/systempromptio/systemprompt-core) workspace.

## Overview

**Infrastructure** · [Self-Hosted Deployment](https://systemprompt.io/features/self-hosted-ai-platform)

This crate provides file storage, metadata management, and content-file linking capabilities. It handles file uploads with validation, AI-generated image tracking, and content associations.

## Usage

```toml
[dependencies]
systemprompt-files = "0.21"
```

Configured via `files.yaml`:

```yaml
files:
  urlPrefix: "/files"
  upload:
    enabled: true
    maxFileSizeBytes: 52428800
    persistenceMode: context_scoped
    allowedTypes:
      images: true
      documents: true
      audio: true
      video: false
```

## Module Layout

| Module | Purpose |
|--------|---------|
| `models/` | `File` entity, `content_file` junction with `FileRole`, and file/image metadata types. |
| `repository/` | Compile-time-verified persistence for files, content linking, and AI-image queries. |
| `services/` | `FileUploadService` (validation, storage, persistence) and the AI-persistence provider. |
| `config/` | `FilesConfig` YAML loading, upload limits, allowed types, and profile-driven validation. |
| `jobs/` | `FileIngestionJob` scanning storage for images. |

## Modules

| Module | Purpose |
|--------|---------|
| `config` | Profile-driven configuration loading, validation, and persistence modes |
| `error` | `FilesError` and `FilesResult` shared across the crate |
| `extension` | `FilesExtension` registering schemas and jobs via the extension framework |
| `jobs` | Background file ingestion with inventory registration |
| `models` | Data structures: `File`, `ContentFile`, `FileRole`, metadata variants |
| `repository` | Database access layer using compile-time verified `sqlx` macros |
| `services` | Upload, validation, and AI-persistence service wrappers |

## Public Types

| Type | Description |
|------|-------------|
| `File` | File entity with path, URL, metadata, and typed identifiers |
| `ContentFile` | Links a file to content with role and display order |
| `FileRole` | Featured, Attachment, Inline, OgImage, Thumbnail |
| `FileMetadata` | Container for checksums and type-specific metadata |
| `TypeSpecificMetadata` | Enum variant carrying image, audio, document, or video metadata |
| `ImageMetadata` / `ImageGenerationInfo` | Image dimensions, alt text, and AI generation provenance |
| `AudioMetadata` / `DocumentMetadata` / `VideoMetadata` | Type-specific metadata records |
| `FileChecksums` | SHA-256 / content checksum container |
| `FileUploadRequest` / `FileUploadRequestBuilder` | Builder for upload operations |
| `UploadedFile` | Result returned by `FileUploadService` |
| `FileCategory` / `FileValidator` | Upload validation surface |
| `FilesConfig` / `FilesConfigYaml` / `FilesConfigValidator` | Configuration types and validation |
| `FileUploadConfig` / `AllowedFileTypes` / `FilePersistenceMode` | Upload policy configuration |
| `InsertFileRequest` / `FileRepository` / `FileStats` | Repository surface |
| `FilesAiPersistenceProvider` | Provider implementation for AI-generated image persistence |
| `FilesExtension` | Extension entry point registered via `inventory` |
| `FileIngestionJob` | Scheduled job that reconciles storage with database rows |
| `FilesError` / `FilesResult` | Crate-level error type and result alias |

## Jobs

| Job | Description |
|-----|-------------|
| `FileIngestionJob` | Scans the configured storage root and reconciles on-disk image files with database rows |

## Schemas

| File | Purpose |
|------|---------|
| `schema/files.sql` | Core `files` table definition |
| `schema/content_files.sql` | Junction table linking files to content |
| `schema/ai_image_analytics.sql` | View/table for AI-generated image analytics |

## Dependencies

| Crate | Purpose |
|-------|---------|
| `systemprompt-database` | `DbPool` and `sqlx` query macros |
| `systemprompt-identifiers` | `FileId`, `UserId`, `ContentId`, `SessionId`, `TraceId`, `ContextId` |
| `systemprompt-traits` | `Job` trait for background jobs |
| `systemprompt-models` | `AppPaths`, `ProfileBootstrap`, shared models |
| `systemprompt-cloud` | Storage path constants and cloud integration |
| `systemprompt-config` | Profile and YAML configuration loading |
| `systemprompt-extension` | Extension trait and registration macros |
| `systemprompt-provider-contracts` | Provider trait contracts implemented by this crate |
| `systemprompt-logging` | Structured `tracing` integration |

## License

BSL-1.1 (Business Source License). Source-available for evaluation, testing, and non-production use. Production use requires a commercial license. Each version converts to Apache 2.0 four years after publication. See [LICENSE](https://github.com/systempromptio/systemprompt-core/blob/main/LICENSE).

---

<div align="center">

**[systemprompt.io](https://systemprompt.io)** · **[Documentation](https://systemprompt.io/documentation/)** · **[Guides](https://systemprompt.io/guides)** · **[Live Demo](https://systemprompt.io/features/demo)** · **[Template](https://github.com/systempromptio/systemprompt-template)** · **[crates.io](https://crates.io/crates/systemprompt-files)** · **[docs.rs](https://docs.rs/systemprompt-files)** · **[Discord](https://discord.gg/wkAbSuPWpr)**

<sub>Domain layer · Own how your organization uses AI.</sub>

</div>