mirror of
https://github.com/MrSleeps/jellyfin-scene-search.git
synced 2026-11-20 00:33:36 +00:00
Document web and plugin caption controls
This commit is contained in:
@@ -451,11 +451,13 @@ When `SCENE_API_KEY` is set, search and thumbnail endpoints accept either `Autho
|
|||||||
|
|
||||||
The API intentionally runs with one worker. Multiple workers would each load their own copy of the embedding model into GPU memory.
|
The API intentionally runs with one worker. Multiple workers would each load their own copy of the embedding model into GPU memory.
|
||||||
|
|
||||||
The API also exposes authenticated Jellyfin-management endpoints used by the plugin:
|
The API also exposes authenticated management endpoints used by the plugin and standalone dashboard:
|
||||||
|
|
||||||
- `GET /api/jellyfin/libraries` — list visible libraries and indexed counts.
|
- `GET /api/jellyfin/libraries` — list visible libraries and indexed counts.
|
||||||
- `POST /api/jellyfin/index` — start one background indexing job for selected library ids.
|
- `POST /api/jellyfin/index` — start one background indexing job for selected library ids.
|
||||||
- `GET /api/jellyfin/index/status` — report live library/item/frame/sync progress.
|
- `GET /api/jellyfin/index/status` — report live library/item/frame/sync progress.
|
||||||
|
- `POST /api/caption` — start or resume caption generation for selected library ids.
|
||||||
|
- `GET /api/caption/status` — report routing/caption/model/frame/sync progress.
|
||||||
|
|
||||||
Only one indexing job can run at a time. Search requests return a temporary 503 while that job owns the shared embedding model.
|
Only one indexing job can run at a time. Search requests return a temporary 503 while that job owns the shared embedding model.
|
||||||
|
|
||||||
@@ -469,6 +471,10 @@ The API serves a lightweight management/search UI at `/`. It provides:
|
|||||||
- Jellyfin library selection and indexed item/frame counts;
|
- Jellyfin library selection and indexed item/frame counts;
|
||||||
- normal or forced indexing;
|
- normal or forced indexing;
|
||||||
- overall progress plus current library/item/frame progress;
|
- overall progress plus current library/item/frame progress;
|
||||||
|
- Start / resume captioning for the selected libraries;
|
||||||
|
- live caption progress with current title, timestamp, route and model;
|
||||||
|
- optional forced recaptioning;
|
||||||
|
- automatic Meilisearch rebuild after captioning finishes;
|
||||||
- final indexed/unchanged/failed/removed totals;
|
- final indexed/unchanged/failed/removed totals;
|
||||||
- semantic scene search with cached frame thumbnails.
|
- semantic scene search with cached frame thumbnails.
|
||||||
|
|
||||||
@@ -508,6 +514,10 @@ The plugin asks the Python service for the libraries visible to the configured J
|
|||||||
|
|
||||||
Use **Index selected libraries** to start a backend indexing job. The plugin shows an overall percentage/progress bar across all selected libraries as well as the current library, item and frame progress, and polls until the job completes. When ingestion finishes, the backend automatically rebuilds Meilisearch, so newly indexed vectors are searchable without a separate `sync-meili` command.
|
Use **Index selected libraries** to start a backend indexing job. The plugin shows an overall percentage/progress bar across all selected libraries as well as the current library, item and frame progress, and polls until the job completes. When ingestion finishes, the backend automatically rebuilds Meilisearch, so newly indexed vectors are searchable without a separate `sync-meili` command.
|
||||||
|
|
||||||
|
The same page also has **Start / resume captioning**. It operates on the selected Jellyfin libraries and skips frames that already have a current caption. Every successful caption is committed immediately, so if the container/API/Ollama connection is interrupted you can press Start / resume again and continue from the uncaptained frames. **Force recaption existing frames** deliberately regenerates them.
|
||||||
|
|
||||||
|
Captioning first runs the local routing classifier, then sends frames to the configured general or specialist Ollama model. Search is blocked only while the local routing GPU is in use and while Meilisearch is rebuilt; it remains available during the long remote Ollama caption phase.
|
||||||
|
|
||||||
Plugin-triggered indexing reuses the API process's existing SigLIP instance and blocks semantic searches while the indexing job owns the model, avoiding a second GPU copy on the same machine.
|
Plugin-triggered indexing reuses the API process's existing SigLIP instance and blocks semantic searches while the indexing job owns the model, avoiding a second GPU copy on the same machine.
|
||||||
|
|
||||||
The prefix is intentional for the first rollout. Jellyfin 12 uses non-empty external-provider results instead of its built-in SQL search results. While only a test library is indexed, making Scene Search answer every query could hide ordinary Jellyfin results that have not been indexed yet.
|
The prefix is intentional for the first rollout. Jellyfin 12 uses non-empty external-provider results instead of its built-in SQL search results. While only a test library is indexed, making Scene Search answer every query could hide ordinary Jellyfin results that have not been indexed yet.
|
||||||
@@ -530,6 +540,10 @@ Once the complete libraries you care about are indexed and semantic ranking is c
|
|||||||
|
|
||||||
The first version contributes Movies, Episodes and generic Videos because those are the item types currently ingested by `jellyfin-index`.
|
The first version contributes Movies, Episodes and generic Videos because those are the item types currently ingested by `jellyfin-index`.
|
||||||
|
|
||||||
|
### Docker migration and existing thumbnails
|
||||||
|
|
||||||
|
Stored thumbnail paths created before the Docker deployment may contain the old host prefix such as `/opt/jellyfin-search/data/thumbs/...`. Scene Search now rebases those paths onto the active `DATA_DIR` automatically, so existing indexed frames can still be captioned and served from the Docker container without reindexing solely to change path prefixes.
|
||||||
|
|
||||||
## Removing indexed sources
|
## Removing indexed sources
|
||||||
|
|
||||||
Old prototype clips and Jellyfin-backed items are stored with different source kinds.
|
Old prototype clips and Jellyfin-backed items are stored with different source kinds.
|
||||||
|
|||||||
Reference in New Issue
Block a user