mirror of
https://github.com/icereed/paperless-gpt.git
synced 2025-03-12 21:08:00 -05:00
6410136f89
- **Custom Prompt Templates**: Introduced support for user-modifiable prompt templates using Go's `text/template`.
- Added default prompt templates for title and tag generation.
- Templates are stored in the `prompts` directory and are loaded at startup.
- If the template files do not exist, they are created with default content.
- Users can modify the templates by editing the files in the `prompts` directory.
- **API Endpoints for Prompts**:
- Added `GET /api/prompts` endpoint to retrieve the current prompt templates.
- Added `POST /api/prompts` endpoint to update the prompt templates.
- These endpoints prepare for future UI support for modifying prompts.
- **Thread Safety**:
- Implemented a `sync.RWMutex` to ensure thread-safe access to the templates.
- **Updated Backend Logic**:
- Modified `getSuggestedTitle` and `getSuggestedTags` functions to use the loaded templates.
- Templates utilize variables like `{{.Language}}`, `{{.Content}}`, `{{.AvailableTags}}`, and `{{.Title}}`.
- **Docker and Documentation**:
- Updated the `loadTemplates` function to ensure the `prompts` directory exists and to save default templates if missing.
- Updated the README with instructions on how to mount the `prompts` directory in Docker and Docker Compose.
- Provided guidance on modifying the prompt templates via file edits.
61 lines
2.5 KiB
Go
61 lines
2.5 KiB
Go
package main
|
|
|
|
import (
|
|
"time"
|
|
)
|
|
|
|
type GetDocumentsApiResponse struct {
|
|
Count int `json:"count"`
|
|
Next interface{} `json:"next"`
|
|
Previous interface{} `json:"previous"`
|
|
All []int `json:"all"`
|
|
Results []struct {
|
|
ID int `json:"id"`
|
|
Correspondent interface{} `json:"correspondent"`
|
|
DocumentType interface{} `json:"document_type"`
|
|
StoragePath interface{} `json:"storage_path"`
|
|
Title string `json:"title"`
|
|
Content string `json:"content"`
|
|
Tags []int `json:"tags"`
|
|
Created time.Time `json:"created"`
|
|
CreatedDate string `json:"created_date"`
|
|
Modified time.Time `json:"modified"`
|
|
Added time.Time `json:"added"`
|
|
ArchiveSerialNumber interface{} `json:"archive_serial_number"`
|
|
OriginalFileName string `json:"original_file_name"`
|
|
ArchivedFileName string `json:"archived_file_name"`
|
|
Owner int `json:"owner"`
|
|
UserCanChange bool `json:"user_can_change"`
|
|
Notes []interface{} `json:"notes"`
|
|
SearchHit struct {
|
|
Score float64 `json:"score"`
|
|
Highlights string `json:"highlights"`
|
|
NoteHighlights string `json:"note_highlights"`
|
|
Rank int `json:"rank"`
|
|
} `json:"__search_hit__"`
|
|
} `json:"results"`
|
|
}
|
|
|
|
// Document is a stripped down version of the document object from paperless-ngx.
|
|
// Response payload for /documents endpoint and part of request payload for /generate-suggestions endpoint
|
|
type Document struct {
|
|
ID int `json:"id"`
|
|
Title string `json:"title"`
|
|
Content string `json:"content"`
|
|
Tags []string `json:"tags"`
|
|
}
|
|
|
|
// GenerateSuggestionsRequest is the request payload for generating suggestions for /generate-suggestions endpoint
|
|
type GenerateSuggestionsRequest struct {
|
|
Documents []Document `json:"documents"`
|
|
GenerateTitles bool `json:"generate_titles,omitempty"`
|
|
GenerateTags bool `json:"generate_tags,omitempty"`
|
|
}
|
|
|
|
// DocumentSuggestion is the response payload for /generate-suggestions endpoint and the request payload for /update-documents endpoint (as an array)
|
|
type DocumentSuggestion struct {
|
|
ID int `json:"id"`
|
|
OriginalDocument Document `json:"original_document"`
|
|
SuggestedTitle string `json:"suggested_title,omitempty"`
|
|
SuggestedTags []string `json:"suggested_tags,omitempty"`
|
|
}
|