Skip to main content

Interface: AnalyzeVideoResult

Defined in: packages/agentos/src/api/analyzeVideo.ts:105

The result returned by analyzeVideo.

Extends the core VideoAnalysis with optional rich scene data when scene detection and description are enabled.

Properties

description

description: string

Defined in: packages/agentos/src/api/analyzeVideo.ts:107

Free-form textual description / answer from the analyser.


durationSec?

optional durationSec: number

Defined in: packages/agentos/src/api/analyzeVideo.ts:115

Overall duration of the analysed video in seconds.


fullTranscript?

optional fullTranscript: string

Defined in: packages/agentos/src/api/analyzeVideo.ts:121

Full transcript when audio transcription was enabled.


model?

optional model: string

Defined in: packages/agentos/src/api/analyzeVideo.ts:117

Model that produced the analysis.


objects?

optional objects: string[]

Defined in: packages/agentos/src/api/analyzeVideo.ts:111

Detected objects / entities across the video.


provider?

optional provider: string

Defined in: packages/agentos/src/api/analyzeVideo.ts:119

Provider that produced the analysis.


providerMetadata?

optional providerMetadata: Record<string, unknown>

Defined in: packages/agentos/src/api/analyzeVideo.ts:125

Provider-specific metadata.


ragChunkIds?

optional ragChunkIds: string[]

Defined in: packages/agentos/src/api/analyzeVideo.ts:123

IDs of RAG chunks created, when indexForRAG was enabled.


scenes?

optional scenes: SceneDescription[]

Defined in: packages/agentos/src/api/analyzeVideo.ts:109

Detected scene segments with timestamps.


text?

optional text: string[]

Defined in: packages/agentos/src/api/analyzeVideo.ts:113

Detected on-screen or spoken text (OCR / ASR).