flexinference 1.3.0 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.4.0
+
+Surfaces the router's **`doc_url`** on `FlexInferenceError` as a new `docUrl` field: a deep
+link straight to the docs row for that error's `code` (when the router supplied one), so an
+error caught in code can point a developer -- or an agent reading the message -- at the fix.
+Also enriches the local `start_within` validation messages with concrete examples. Additive;
+no breaking changes.
+
 ## 1.3.0
 
 Adds a typed **`PaymentRequiredError`** (a subclass of `FlexInferenceError`) thrown on

package/dist/index.d.ts

@@ -60,6 +60,7 @@ export interface FlexErrorBody {
         type: string;
         code?: string | null;
         param?: string | null;
+        doc_url?: string | null;
     };
 }
 export declare class FlexInferenceError extends Error {
@@ -67,6 +68,8 @@ export declare class FlexInferenceError extends Error {
     readonly type: string | undefined;
     readonly code: string | null | undefined;
     readonly param: string | null | undefined;
+    /** Deep link into the docs for this error's code, when the router supplied one. */
+    readonly docUrl: string | null | undefined;
     constructor(status: number, body: Partial<FlexErrorBody> | undefined, fallback: string);
 }
 /**

package/dist/index.js

@@ -90,6 +90,8 @@ export class FlexInferenceError extends Error {
     type;
     code;
     param;
+    /** Deep link into the docs for this error's code, when the router supplied one. */
+    docUrl;
     constructor(status, body, fallback) {
         const err = body?.error;
         super(err?.message ?? fallback);
@@ -98,6 +100,7 @@ export class FlexInferenceError extends Error {
         this.type = err?.type;
         this.code = err?.code;
         this.param = err?.param;
+        this.docUrl = err?.doc_url;
     }
 }
 /**
@@ -124,16 +127,18 @@ function assertStartWithin(body) {
         ? body["start_within"]
         : undefined;
     if (value === undefined) {
-        throw new Error(`FlexInference: \`start_within\` is required. Set it to ${START_WITHIN_VALUES}.`);
+        throw new Error(`FlexInference: \`start_within\` is required on every request. Set it to ${START_WITHIN_VALUES}, ` +
+            `for example "start_within": "default" for standard-tier behavior or "00h-00m-30s" for a 30-second flex race.`);
     }
     if (typeof value !== "string") {
-        throw new Error(`FlexInference: \`start_within\` must be a string (${START_WITHIN_VALUES}).`);
+        throw new Error(`FlexInference: \`start_within\` must be a string (${START_WITHIN_VALUES}), for example "default".`);
     }
     if (value === "default" || value === "priority" || value === "auto")
         return;
     const match = DURATION_RE.exec(value);
     if (match === null) {
-        throw new Error(`FlexInference: \`start_within\` "${value}" is not ${START_WITHIN_VALUES}.`);
+        throw new Error(`FlexInference: \`start_within\` "${value}" is not ${START_WITHIN_VALUES}. ` +
+            `A duration is two digits each for hours, minutes, and seconds, for example "00h-05m-00s" for a 5-minute deadline.`);
     }
     const seconds = Number(match[1]) * SECONDS_PER_HOUR + Number(match[2]) * SECONDS_PER_MINUTE + Number(match[3]);
     if (seconds < MIN_DEADLINE_SECONDS || seconds > MAX_DEADLINE_SECONDS) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flexinference",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Official TypeScript SDK for FlexInference - a deadline-aware, OpenAI-compatible inference router.",
   "license": "MIT",
   "author": "Aditya Perswal <adityaperswal@gmail.com>",