Method ReadCapabilityAsync

Namespace

MailFathom.Application.Emails.Search

Assembly

MailFathom.Application.dll

ReadCapabilityAsync(CancellationToken)

Reads what semantic retrieval can do for this instance, without calling a provider.

public Task<SemanticSearchCapability> ReadCapabilityAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Propagates caller cancellation.

Returns

Task<SemanticSearchCapability>

The capability, which is what a search reports when it returns before ranking anything.

Remarks

One committed read of local state and one read of process-local health. It is deliberately cheap and deliberately free: a capability that had to spend a provider call to be reported would put an operator's money behind every question about whether their instance is working.

Exceptions

OperationCanceledException

Thrown when the caller cancels or the host is shutting down.