Class FrameEmbeddingSearchResult

Namespace

VisioForge.Core.Types.X.AI

Assembly

VisioForge.Core.dll

A single hit returned by VisioForge.Core.Types.X.AI.FrameEmbeddingIndex.Search(System.Single[],System.Int32): the video timestamp of an indexed frame, the source tag it was indexed under, and the cosine similarity score against the query embedding.

public sealed class FrameEmbeddingSearchResult

Inheritance

object

FrameEmbeddingSearchResult

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object?, object?)

object.ToString()

Constructors

FrameEmbeddingSearchResult(TimeSpan, string, float)

Initializes a new instance of the VisioForge.Core.Types.X.AI.FrameEmbeddingSearchResult class.

public FrameEmbeddingSearchResult(TimeSpan timestamp, string sourceTag, float score)

Parameters

timestamp TimeSpan

The presentation timestamp of the indexed frame.

sourceTag string

The source tag the frame was indexed under (may be null or empty).

score float

The cosine similarity (typically -1..1) of the frame embedding against the query.

Properties

Score

Gets the cosine similarity of this frame's embedding against the query embedding. Higher means more similar.

public float Score { get; }

Property Value

float

SourceTag

Gets the source tag the frame was indexed under (for example a file name or camera id). May be null or empty.

public string SourceTag { get; }

Property Value

string

Timestamp

Gets the presentation timestamp of the indexed frame within its source.

public TimeSpan Timestamp { get; }

Property Value

TimeSpan