Method Create

Namespace

MailFathom.AI.Retrieval

Assembly

MailFathom.AI.dll

Create(EmailKnowledgeBounds, int, int)

Builds a plan, refusing a declaration no filter could run under.

public static PassageRelevanceFilterPlan Create(EmailKnowledgeBounds retrievalBounds, int maximumCandidates, int minimumRelevance)

Parameters

retrievalBounds EmailKnowledgeBounds

What one retrieval hands over, which is the ceiling on what there is to judge.

maximumCandidates int

The greatest number of passages one retrieval puts to the model.

minimumRelevance int

The least relevance a judged passage may carry and still be handed over.

Returns

PassageRelevanceFilterPlan

The plan.

Remarks

The candidate count is capped by what one retrieval hands over rather than by a number of its own, so the two move together: a deployment that narrows MaximumPassages narrows what may be judged with it. A higher count would state a ceiling no question could reach — there is never a candidate past the last passage — so a deployment writing one would be told it had widened a filter that had not moved. The threshold starts at one rather than at zero, because a threshold of zero pays for a judgement that can drop nothing.

Exceptions

ArgumentNullException

Thrown when retrievalBounds is null.

ArgumentOutOfRangeException

Thrown when either value is outside the range this type accepts.