Skip to main content

Guides

Task-oriented walkthroughs of each feature. Each page answers a specific question of the form "how do I do X with Fovea".

Modelling​

  • Personas covers the persona CRUD surface and the isSystemGenerated flag.
  • Ontologies covers the four type lists (entityTypes, eventTypes, roleTypes, relationTypes) and the POST /api/ontology/augment AI-assisted suggestion path.
  • World state covers worldEntities, worldEvents, worldTimes, worldLocations, and the collection shapes.

Annotation​

  • Annotations covers type vs object annotations, the linkType column, keyframes, and the interpolation model.
  • Tracking covers automated bounding-box tracking through the model service.
  • Detection covers POST /api/videos/:videoId/detect and the persona-driven detection query.

Summarisation and claims​

  • Summaries covers the summary job lifecycle and the (videoId, personaId) scoping.
  • Claims covers claim extraction, gloss items, and modality flags.
  • Relations covers typed claim relations and the cross-claim ownership check.

Linking​

  • Wikidata covers online Wikidata lookups and offline Wikibase mode.

Data exchange​

  • Export and import covers the JSONL format, the v0.1.4 user-scoped stats, and the Annotation.linkType round-trip introduced in v0.1.8.
  • Cross-user imports covers id regeneration, gloss remapping, the metadata provenance line, and the Completed with Warnings flow.

Identity and access​

  • Authentication covers single-user vs multi-user mode, registration, and the session model.
  • API keys covers user-level and admin-level keys for external model providers.

Collaboration and access control​

  • Projects covers project lifecycle, members, and project-scoped resources.
  • Groups covers UserGroup membership and the group-scope role set.
  • Video assignments covers ProjectVideoAssignment, the rule engine, and VideoAccessService.
  • Sharing covers ResourceShare, permission levels, forking, and the privilege cap.
  • Roles and permissions covers system, group, and project roles, the baseline ownership rules, and how to seed a custom role.
  • Admin permissions covers the /api/admin/permissions matrix editing surface.

Operational​

  • Audio transcription covers the seven vendor adapters (AssemblyAI, AWS Transcribe, Azure Speech, Deepgram, Gladia, Google Speech, Rev.ai).
  • Model configuration covers model-service/config/models.yaml, the task slots, and fallbacks.
  • Deployment covers the gpu and cpu Docker Compose profiles and the BUILD_MODE matrix.
  • Observability covers the OpenTelemetry collector, Prometheus, and the Grafana dashboards.