@byokit/decide weekly downloads statistics

<h1 align="center">@byokit/decide</h1> <p align="center"> <a href="https://www.npmjs.com/package/@byokit/decide"><img alt="npm" src="https://img.shields.io/npm/v/@byokit/decide?style=flat&label=npm" /></a> <a href="https://github.com/umeranjum17/byokit/actions/workflows/ci.yml"><img alt="CI" src="https://img.shields.io/github/actions/workflow/status/umeranjum17/byokit/ci.yml?style=flat&branch=main" /></a> <a href="LICENSE"><img alt="Apache 2.0" src="https://img.shields.io/badge/license-Apache--2.0-666?style=flat" /></a> <img alt="Node | browsers | React Native" src="https://img.shields.io/badge/platform-Node%20%7C%20browsers%20%7C%20React%20Native-666?style=flat" /> </p> <p align="center"><strong>Typed questions in, a typed answer with confidence out.</strong><br/> Below a floor it abstains, so your app takes its safe default (ask the person) instead of guessing. Backends are your own <code>rules</code>, any model you can send a prompt to (on a phone, the person's own plan), general models with structured answers, plan models with a plan key or plan account, and a billed model gateway. Labelled eval files set the floors.</p>

Install

npm install @byokit/decide

That is the whole tree for rules, any host-owned model behind answerer, and Jev: those backends run on plain fetch and install no further packages. Import them from @byokit/decide/slim (import { decide, rules, answerer, jev } from '@byokit/decide/slim') and bundlers resolve zero peers.

The remaining backends are optional peers npm skips unless the app installs them: @byokit/accounts for ChatGPT plan billing (openai({ auth: 'account', ... }), subscription) and the OpenCode Go plan account (opencodeGo({ account, ... }), subscription), and @byokit/pair for the paired Jev route (the host app keeps its API key (billed per use) in its own store). Account billing without the accounts peer throws UnsupportedAccountError naming @byokit/accounts. API-key OpenAI, API-key Anthropic and plain-key OpenCode Go need no peer at runtime. The main entry keeps every export and works either way.

· Latest release · All releases

Quickstart

npm install @byokit/decide

A rules-only backend: nothing leaves the device and no key is needed. The obvious case gets an answer; the rest abstains.

import { decide, rules, type Question } from '@byokit/decide';

const questions: Record<string, Question> = {
  intent: { kind: 'choice', options: { task: 'Something new to do', followup: 'About an earlier job', chat: 'Just talking' } },
};
const backends = [rules((s) => (/^(thanks|thank you)\b/i.test(s.text) ? 'chat' : undefined))];

for (const text of ['thanks, that worked!', 'can you check if the plumber replied?']) {
  const { intent } = await decide({ text }, questions, { privacy: 'stays-here', backends });
  console.log(text, '->', intent);
}

thanks, that worked! -> {
  answer: 'chat',
  confidence: 1,
  probabilities: { task: 0, followup: 0, chat: 1 },
  abstained: false,
  by: 'rules',
  ms: 0
}
can you check if the plumber replied? -> {
  answer: null,
  confidence: 0,
  abstained: true,
  reason: 'no answer',
  by: 'rules',
  ms: 0
}

Add a model after the rules for the cases they leave open. Jev is API-billed: it needs a TypeSafe or OpenRouter key that your host holds.

import { decide, jev, rules } from '@byokit/decide';

const backends = [
  rules((s) => (/^(thanks|thank you)\b/i.test(s.text) ? 'chat' : undefined)), // the obvious cases, free
  jev({ key: hostConfig.jevKey }),            // or jev({ key: openRouterKey, via: 'openrouter' })
];
const { intent } = await decide({ text: 'can you check if the plumber replied?' }, {
  intent: { kind: 'choice', options: { task: 'Something new to do', followup: 'About an earlier job', chat: 'Just talking' } },
}, { privacy: 'may-leave', backends });

if (intent.abstained) askThePerson(); else route(intent.answer);

API at a glance…