Struct RoutingOutcome 

pub struct RoutingOutcome {
    pub selected_model_ids: Vec<ModelId>,
    pub request: Request,
    pub fallback_request: Option<Request>,
    pub response: Option<Response>,
    pub metadata: Option<OutcomeMetadata>,
    pub state: State,
}

The terminal result of routing.

Fields

selected_model_ids: Vec<ModelId>

Models selected by the algorithm, ordered best model first.

request: Request

The request after all routing-time rewrites, stamped with the selected model.

fallback_request: Option<Request>

The request the fallback candidates receive instead of request, when routing rewrote request for the selected model only. Content-policy denials do not advance to these fallback candidates.

response: Option<Response>

A response produced while routing, or None when the client must make the answer call.

metadata: Option<OutcomeMetadata>

Outcome identity and optional algorithm evidence.

Constructors leave this empty; Algorithm::run_stream fills it before publishing a successful outcome.

state: State

Routing state after the run, for hosts that store state outside the algorithm.

Implementations

impl RoutingOutcome

pub fn selected_model_id(&self) -> Result<&ModelId>

The model the algorithm recommends, the best model for this request. LibsyError::NoTargets if the algorithm selected no models, which should be impossible.

pub fn route_to( selected_model_id: ModelId, fallback_models: Vec<ModelId>, request: Request, ) -> Self

The decision is that client should send this request. The selected_model_id will be written into it by this function. If that fails client should try the fallback_models in order.

pub fn answered( selected_model_id: ModelId, request: Request, response: Response, ) -> Self

Algorithm generated the response as part of the routing decision. Here it is. The request will have the selected_model_id written into it by this function.