Skip to main content

Engine

Struct Engine 

Source
pub struct Engine { /* private fields */ }
Expand description

A compiled decision engine. train needs &mut, hence the RwLock; the Arc lets the async path hand a clone to the libuv thread pool.

Implementations§

Source§

impl Engine

Source

pub fn instance_of<V: NapiRaw>(env: Env, value: V) -> Result<bool>

Source§

impl Engine

Source§

impl Engine

Source

pub fn new(options_json: String) -> Result<Self>

optionsJson: {"embedder":"hash","dims":256} or {"embedder":{"kind":"onnx","modelDir":"...","manifest":"..."}} (onnx requires the native-onnx build feature). Throws on malformed options JSON, an unsupported embedder, or an onnx model that fails to load.

Source

pub fn decide_json(&self, request_json: String) -> String

Synchronous decide. Returns a DecisionResponse JSON, or the documented error JSON — never throws for a request-level failure.

Source

pub fn decide(&self, request_json: String) -> AsyncTask<DecideTask>

Asynchronous decide, implemented as a napi AsyncTask so the CPU work runs off the JS thread (ADR-002 §4). Resolves to the same JSON string decideJson returns.

Source

pub fn train_json(&self, train_json: String) -> String

Admit labeled examples for one question. Returns a TrainReport JSON or the documented error JSON.

Source

pub fn stats_json(&self) -> String

Introspection: {"embedderId","dims","examples","promotable"}. The example counts come from the bank’s redacted summary (no text).

Source

pub fn optimize_json(&self, campaign_json: String) -> String

Run an optimize campaign (ADR-004). campaignJson is a CampaignSpec; returns a CampaignReport JSON, or the documented error JSON. The model arm is chosen by constructing one engine per embedder — this campaign is over EngineOptions for the engine’s fixed embedder.

Source

pub fn export_bank_json(&self) -> String

Full-fidelity bank JSON (the user’s own examples) for typesafe train --bank bank.json, or the documented error JSON.

Source

pub fn import_bank_json(&self, bank_json: String) -> String

Replace the bank from JSON (re-embeds every stored text). Returns {"ok":true} or the documented error JSON.

Trait Implementations§

Source§

impl FromNapiMutRef for Engine

Source§

unsafe fn from_napi_mut_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static mut Self>

Safety Read more
Source§

impl FromNapiRef for Engine

Source§

unsafe fn from_napi_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static Self>

Safety Read more
Source§

impl FromNapiValue for &Engine

Source§

unsafe fn from_napi_value(env: napi_env, napi_val: napi_value) -> Result<Self>

Safety Read more
Source§

fn from_unknown(value: JsUnknown) -> Result<Self, Error>

Source§

impl FromNapiValue for &mut Engine

Source§

unsafe fn from_napi_value(env: napi_env, napi_val: napi_value) -> Result<Self>

Safety Read more
Source§

fn from_unknown(value: JsUnknown) -> Result<Self, Error>

Source§

impl ObjectFinalize for Engine

Source§

fn finalize(self, env: Env) -> Result<(), Error>

Source§

impl ToNapiValue for Engine

Source§

impl TypeName for Engine

Source§

impl TypeName for &Engine

Source§

impl TypeName for &mut Engine

Source§

impl ValidateNapiValue for &Engine

Source§

unsafe fn validate(env: napi_env, napi_val: napi_value) -> Result<napi_value>

Safety Read more
Source§

impl ValidateNapiValue for &mut Engine

Source§

unsafe fn validate(env: napi_env, napi_val: napi_value) -> Result<napi_value>

Safety Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> JsValuesTupleIntoVec for T
where T: ToNapiValue,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.