Enum SemanticSearchCapability

Namespace

MailFathom.Application.Emails.Search

Assembly

MailFathom.Application.dll

Says what semantic retrieval can do for this instance right now.

public enum SemanticSearchCapability

Fields

Available = 1

An embedding profile is active and its provider is answering, so a search is ranked both ways.

It says what the instance can do rather than what one call did: a query whose provider call fails is still answered, lexically, and reports the degraded state below.

Degraded = 2

An embedding profile is active but a query cannot be placed in its space, so searches are answered lexically until it recovers.

The credential was refused, the endpoint chain is unreachable, no provider is declared any more, or the declared model is not the one the active profile records. Every one of them needs an operator, and recovery is automatic once the cause is gone.

Inactive = 0

This instance has activated no embedding profile, so nothing is ranked by meaning.

A supported deployment rather than a fault. Synchronization, listing, content retrieval, and lexical search are unaffected, and activating a declared profile is what changes it.

Remarks

Three states, and the profile is what separates the first from the other two. An instance that has activated none does not embed at all, which ADR 0006 makes a supported deployment rather than an unfinished one; an instance that has activated one either can place a query in that profile's space or currently cannot.

It exists because a search that quietly returns less is worse than one that says it is degraded. Without it an expired credential and a deliberately lexical deployment both answer with a lexical ranking and are indistinguishable, so the operator whose key expired reads worse results instead of a state to fix.

It is read rather than probed. Nothing here calls a provider to establish it: what it reports is the outcome of the calls the embedding workers already made, so no query pays for a health check and a provider that is refusing is not asked again by every search that arrives while it refuses.