@onyx.dev/onyx-database 2.1.0 → 2.3.0

package/README.md

@@ -19,6 +19,7 @@ TypeScript client SDK for **Onyx Cloud Database** — a zero-dependency, strict-
 - [Install](#install)
 - [Initialize the client](#initialize-the-client)
 - [Onyx AI (chat & models)](#onyx-ai-chat--models)
+- [Published model predictions](#published-model-predictions)
 - [Generate schema types](#optional-generate-typescript-types-from-your-schema)
 - [Query helpers](#query-helpers-at-a-glance)
 - [Full-text search](#full-text-search-lucene)
@@ -91,7 +92,7 @@ Set these environment variables for your database:
 
 | Variable | Purpose | Default when unset |
 | --- | --- | --- |
-| `ONYX_DATABASE_ID` | Target database ID | required |
+| `ONYX_DATABASE_ID` | Optional database scope for env credentials; omit to use file/profile/default context | optional |
 | `ONYX_DATABASE_BASE_URL` | Base URL for DB API | `https://api.onyx.dev` |
 | `ONYX_DATABASE_API_KEY` | API key | required |
 | `ONYX_DATABASE_API_SECRET` | API secret | required |
@@ -317,6 +318,31 @@ if (approval.requiresApproval) {
 
 ---
 
+## Published model predictions
+
+Use a published model key with raw input rows, or let a saved script provide the
+input rows for prediction.
+
+```ts
+const rawPrediction = await db.predict('churn-model', [
+  { age: 42, country: 'US', usageScore: 0.87 },
+  { age: 31, country: 'CA', usageScore: 0.42 },
+]);
+
+console.log(rawPrediction.predictions);
+console.log(rawPrediction.rawPredictions);
+
+const scriptPrediction = await db.predictFromScript(
+  'churn-model',
+  'score-active-users',
+  { segment: 'enterprise' },
+);
+
+console.log(scriptPrediction.inputCount);
+```
+
+---
+
 ## Optional: generate TypeScript types from your schema
 
 Use the **Onyx CLI** (`onyx`) from <https://github.com/OnyxDevTools/onyx-cli> to

package/dist/{aggregates-DREvey7b.d.cts → aggregates-BpGa31jk.d.cts}

@@ -1,5 +1,5 @@
 var name = "@onyx.dev/onyx-database";
-var version = "2.1.0";
+var version = "2.3.0";
 
 /**
  * Supported operators for building query criteria.
@@ -997,6 +997,25 @@ interface AiErrorResponse {
         [key: string]: unknown;
     } | null;
 }
+type PublishedModelPredictionInput = Record<string, unknown>;
+type PublishedModelPredictionInputs = PublishedModelPredictionInput | PublishedModelPredictionInput[];
+interface PublishedModelRawPredictionRequest {
+    inputs: PublishedModelPredictionInputs;
+}
+interface PublishedModelScriptPredictionRequest {
+    scriptId: string;
+    scriptParameters?: Record<string, string>;
+}
+interface PublishedModelPredictionResponse {
+    publishedModelId: string;
+    modelId: string;
+    inputCount: number;
+    inputs: PublishedModelPredictionInput[];
+    predictions: PublishedModelPredictionInput[];
+    rawPredictions: number[][];
+    scriptId?: string | null;
+    scriptParameters: Record<string, string>;
+}
 interface AiClient {
     /**
      * Run a chat completion. Accepts shorthand strings or full requests.
@@ -1151,6 +1170,31 @@ interface IOnyxDatabase<Schema = Record<string, unknown>> {
      * ```
      */
     requestScriptApproval(input: AiScriptApprovalRequest): Promise<AiScriptApprovalResponse>;
+    /**
+     * Predict with a published model using raw input data.
+     *
+     * @example
+     * ```ts
+     * const prediction = await db.predict('churn-model', {
+     *   age: 42,
+     *   country: 'US'
+     * });
+     * ```
+     */
+    predict(publishedModelId: string, inputs: PublishedModelPredictionInputs): Promise<PublishedModelPredictionResponse>;
+    /**
+     * Predict with a published model using rows returned from a saved script.
+     *
+     * @example
+     * ```ts
+     * const prediction = await db.predictFromScript(
+     *   'churn-model',
+     *   'score-active-users',
+     *   { segment: 'enterprise' }
+     * );
+     * ```
+     */
+    predictFromScript(publishedModelId: string, scriptId: string, scriptParameters?: Record<string, string>): Promise<PublishedModelPredictionResponse>;
     /**
      * Begin a query against a table.
      *
@@ -1761,4 +1805,4 @@ declare const replace: (attribute: string, pattern: string, repl: string) => str
 declare const format: (attribute: string, formatter: string) => string;
 declare const percentile: (attribute: string, p: number) => string;
 
-export { type SchemaIndexChange as $, type AiRequestOptions as A, type AiClient as B, type SecretRecord as C, type SecretsListResponse as D, type SecretSaveRequest as E, type FullTextQuery as F, type SchemaDataType as G, type SchemaIdentifierGenerator as H, type IOnyxDatabase as I, type SchemaIdentifier as J, type SchemaAttribute as K, type SchemaIndexType as L, type SchemaIndex as M, type SchemaResolver as N, type OnyxFacade as O, type SchemaTriggerEvent as P, QueryResults as Q, type RetryOptions as R, type SecretMetadata as S, type SchemaTrigger as T, type SchemaEntity as U, type SchemaRevisionMetadata as V, type SchemaRevision as W, type SchemaHistoryEntry as X, type SchemaUpsertRequest as Y, type SchemaValidationResult as Z, type SchemaAttributeChange as _, type QueryResultsPromise as a, type SchemaResolverChange as a0, type SchemaTriggerChange as a1, type SchemaTableDiff as a2, type SchemaDiff as a3, type QueryCriteriaOperator as a4, type LogicalOperator as a5, type Sort as a6, type StreamAction as a7, type OnyxDocument as a8, type FetchResponse as a9, notMatches as aA, like as aB, notLike as aC, contains as aD, containsIgnoreCase as aE, notContains as aF, notContainsIgnoreCase as aG, startsWith as aH, notStartsWith as aI, isNull as aJ, notNull as aK, avg as aL, sum as aM, count as aN, min as aO, max as aP, std as aQ, variance as aR, median as aS, upper as aT, lower as aU, substring as aV, replace as aW, format as aX, percentile as aY, type FetchImpl as aa, type QueryCriteria as ab, type QueryCondition as ac, type SelectQuery as ad, type UpdateQuery as ae, type QueryPage as af, type IConditionBuilder as ag, type IQueryBuilder as ah, type ISaveBuilder as ai, type ICascadeBuilder as aj, type ICascadeRelationshipBuilder as ak, asc as al, desc as am, eq as an, neq as ao, inOp as ap, within as aq, notIn as ar, notWithin as as, between as at, gt as au, gte as av, lt as aw, lte as ax, matches as ay, search as az, type OnyxConfig as b, type AiChatRole as c, type AiToolCallFunction as d, type AiToolCall as e, type AiChatMessage as f, type AiToolFunction as g, type AiTool as h, type AiToolChoice as i, type AiChatCompletionRequest as j, type AiChatCompletionUsage as k, type AiChatCompletionChoice as l, type AiChatCompletionResponse as m, name as n, type AiChatCompletionChunkDelta as o, type AiChatCompletionChunkChoice as p, type AiChatCompletionChunk as q, type AiChatCompletionStream as r, type AiChatOptions as s, type AiChatClient as t, type AiScriptApprovalRequest as u, version as v, type AiScriptApprovalResponse as w, type AiModelsResponse as x, type AiModel as y, type AiErrorResponse as z };
+export { type SchemaEntity as $, type AiChatClient as A, type IConditionBuilder as B, type IOnyxDatabase as C, type IQueryBuilder as D, type ISaveBuilder as E, type FetchImpl as F, type OnyxConfig as G, type OnyxDocument as H, type ICascadeBuilder as I, type PublishedModelPredictionInputs as J, type PublishedModelPredictionResponse as K, type LogicalOperator as L, type PublishedModelRawPredictionRequest as M, type PublishedModelScriptPredictionRequest as N, type OnyxFacade as O, type PublishedModelPredictionInput as P, type QueryCondition as Q, type QueryCriteria as R, type QueryCriteriaOperator as S, type QueryPage as T, QueryResults as U, type QueryResultsPromise as V, type RetryOptions as W, type SchemaAttribute as X, type SchemaAttributeChange as Y, type SchemaDataType as Z, type SchemaDiff as _, type AiChatCompletionChoice as a, upper as a$, type SchemaHistoryEntry as a0, type SchemaIdentifier as a1, type SchemaIdentifierGenerator as a2, type SchemaIndex as a3, type SchemaIndexChange as a4, type SchemaIndexType as a5, type SchemaResolver as a6, type SchemaResolverChange as a7, type SchemaRevision as a8, type SchemaRevisionMetadata as a9, isNull as aA, like as aB, lower as aC, lt as aD, lte as aE, matches as aF, max as aG, median as aH, min as aI, neq as aJ, notContains as aK, notContainsIgnoreCase as aL, notIn as aM, notLike as aN, notMatches as aO, notNull as aP, notStartsWith as aQ, notWithin as aR, percentile as aS, replace as aT, name as aU, version as aV, search as aW, startsWith as aX, std as aY, substring as aZ, sum as a_, type SchemaTableDiff as aa, type SchemaTrigger as ab, type SchemaTriggerChange as ac, type SchemaTriggerEvent as ad, type SchemaUpsertRequest as ae, type SchemaValidationResult as af, type SecretMetadata as ag, type SecretRecord as ah, type SecretSaveRequest as ai, type SecretsListResponse as aj, type SelectQuery as ak, type Sort as al, type StreamAction as am, type UpdateQuery as an, asc as ao, avg as ap, between as aq, contains as ar, containsIgnoreCase as as, count as at, desc as au, eq as av, format as aw, gt as ax, gte as ay, inOp as az, type AiChatCompletionChunk as b, variance as b0, within as b1, type AiChatCompletionChunkChoice as c, type AiChatCompletionChunkDelta as d, type AiChatCompletionRequest as e, type AiChatCompletionResponse as f, type AiChatCompletionStream as g, type AiChatCompletionUsage as h, type AiChatMessage as i, type AiChatOptions as j, type AiChatRole as k, type AiClient as l, type AiErrorResponse as m, type AiModel as n, type AiModelsResponse as o, type AiRequestOptions as p, type AiScriptApprovalRequest as q, type AiScriptApprovalResponse as r, type AiTool as s, type AiToolCall as t, type AiToolCallFunction as u, type AiToolChoice as v, type AiToolFunction as w, type FetchResponse as x, type FullTextQuery as y, type ICascadeRelationshipBuilder as z };

package/dist/{aggregates-DREvey7b.d.ts → aggregates-BpGa31jk.d.ts}

@@ -1,5 +1,5 @@
 var name = "@onyx.dev/onyx-database";
-var version = "2.1.0";
+var version = "2.3.0";
 
 /**
  * Supported operators for building query criteria.
@@ -997,6 +997,25 @@ interface AiErrorResponse {
         [key: string]: unknown;
     } | null;
 }
+type PublishedModelPredictionInput = Record<string, unknown>;
+type PublishedModelPredictionInputs = PublishedModelPredictionInput | PublishedModelPredictionInput[];
+interface PublishedModelRawPredictionRequest {
+    inputs: PublishedModelPredictionInputs;
+}
+interface PublishedModelScriptPredictionRequest {
+    scriptId: string;
+    scriptParameters?: Record<string, string>;
+}
+interface PublishedModelPredictionResponse {
+    publishedModelId: string;
+    modelId: string;
+    inputCount: number;
+    inputs: PublishedModelPredictionInput[];
+    predictions: PublishedModelPredictionInput[];
+    rawPredictions: number[][];
+    scriptId?: string | null;
+    scriptParameters: Record<string, string>;
+}
 interface AiClient {
     /**
      * Run a chat completion. Accepts shorthand strings or full requests.
@@ -1151,6 +1170,31 @@ interface IOnyxDatabase<Schema = Record<string, unknown>> {
      * ```
      */
     requestScriptApproval(input: AiScriptApprovalRequest): Promise<AiScriptApprovalResponse>;
+    /**
+     * Predict with a published model using raw input data.
+     *
+     * @example
+     * ```ts
+     * const prediction = await db.predict('churn-model', {
+     *   age: 42,
+     *   country: 'US'
+     * });
+     * ```
+     */
+    predict(publishedModelId: string, inputs: PublishedModelPredictionInputs): Promise<PublishedModelPredictionResponse>;
+    /**
+     * Predict with a published model using rows returned from a saved script.
+     *
+     * @example
+     * ```ts
+     * const prediction = await db.predictFromScript(
+     *   'churn-model',
+     *   'score-active-users',
+     *   { segment: 'enterprise' }
+     * );
+     * ```
+     */
+    predictFromScript(publishedModelId: string, scriptId: string, scriptParameters?: Record<string, string>): Promise<PublishedModelPredictionResponse>;
     /**
      * Begin a query against a table.
      *
@@ -1761,4 +1805,4 @@ declare const replace: (attribute: string, pattern: string, repl: string) => str
 declare const format: (attribute: string, formatter: string) => string;
 declare const percentile: (attribute: string, p: number) => string;
 
-export { type SchemaIndexChange as $, type AiRequestOptions as A, type AiClient as B, type SecretRecord as C, type SecretsListResponse as D, type SecretSaveRequest as E, type FullTextQuery as F, type SchemaDataType as G, type SchemaIdentifierGenerator as H, type IOnyxDatabase as I, type SchemaIdentifier as J, type SchemaAttribute as K, type SchemaIndexType as L, type SchemaIndex as M, type SchemaResolver as N, type OnyxFacade as O, type SchemaTriggerEvent as P, QueryResults as Q, type RetryOptions as R, type SecretMetadata as S, type SchemaTrigger as T, type SchemaEntity as U, type SchemaRevisionMetadata as V, type SchemaRevision as W, type SchemaHistoryEntry as X, type SchemaUpsertRequest as Y, type SchemaValidationResult as Z, type SchemaAttributeChange as _, type QueryResultsPromise as a, type SchemaResolverChange as a0, type SchemaTriggerChange as a1, type SchemaTableDiff as a2, type SchemaDiff as a3, type QueryCriteriaOperator as a4, type LogicalOperator as a5, type Sort as a6, type StreamAction as a7, type OnyxDocument as a8, type FetchResponse as a9, notMatches as aA, like as aB, notLike as aC, contains as aD, containsIgnoreCase as aE, notContains as aF, notContainsIgnoreCase as aG, startsWith as aH, notStartsWith as aI, isNull as aJ, notNull as aK, avg as aL, sum as aM, count as aN, min as aO, max as aP, std as aQ, variance as aR, median as aS, upper as aT, lower as aU, substring as aV, replace as aW, format as aX, percentile as aY, type FetchImpl as aa, type QueryCriteria as ab, type QueryCondition as ac, type SelectQuery as ad, type UpdateQuery as ae, type QueryPage as af, type IConditionBuilder as ag, type IQueryBuilder as ah, type ISaveBuilder as ai, type ICascadeBuilder as aj, type ICascadeRelationshipBuilder as ak, asc as al, desc as am, eq as an, neq as ao, inOp as ap, within as aq, notIn as ar, notWithin as as, between as at, gt as au, gte as av, lt as aw, lte as ax, matches as ay, search as az, type OnyxConfig as b, type AiChatRole as c, type AiToolCallFunction as d, type AiToolCall as e, type AiChatMessage as f, type AiToolFunction as g, type AiTool as h, type AiToolChoice as i, type AiChatCompletionRequest as j, type AiChatCompletionUsage as k, type AiChatCompletionChoice as l, type AiChatCompletionResponse as m, name as n, type AiChatCompletionChunkDelta as o, type AiChatCompletionChunkChoice as p, type AiChatCompletionChunk as q, type AiChatCompletionStream as r, type AiChatOptions as s, type AiChatClient as t, type AiScriptApprovalRequest as u, version as v, type AiScriptApprovalResponse as w, type AiModelsResponse as x, type AiModel as y, type AiErrorResponse as z };
+export { type SchemaEntity as $, type AiChatClient as A, type IConditionBuilder as B, type IOnyxDatabase as C, type IQueryBuilder as D, type ISaveBuilder as E, type FetchImpl as F, type OnyxConfig as G, type OnyxDocument as H, type ICascadeBuilder as I, type PublishedModelPredictionInputs as J, type PublishedModelPredictionResponse as K, type LogicalOperator as L, type PublishedModelRawPredictionRequest as M, type PublishedModelScriptPredictionRequest as N, type OnyxFacade as O, type PublishedModelPredictionInput as P, type QueryCondition as Q, type QueryCriteria as R, type QueryCriteriaOperator as S, type QueryPage as T, QueryResults as U, type QueryResultsPromise as V, type RetryOptions as W, type SchemaAttribute as X, type SchemaAttributeChange as Y, type SchemaDataType as Z, type SchemaDiff as _, type AiChatCompletionChoice as a, upper as a$, type SchemaHistoryEntry as a0, type SchemaIdentifier as a1, type SchemaIdentifierGenerator as a2, type SchemaIndex as a3, type SchemaIndexChange as a4, type SchemaIndexType as a5, type SchemaResolver as a6, type SchemaResolverChange as a7, type SchemaRevision as a8, type SchemaRevisionMetadata as a9, isNull as aA, like as aB, lower as aC, lt as aD, lte as aE, matches as aF, max as aG, median as aH, min as aI, neq as aJ, notContains as aK, notContainsIgnoreCase as aL, notIn as aM, notLike as aN, notMatches as aO, notNull as aP, notStartsWith as aQ, notWithin as aR, percentile as aS, replace as aT, name as aU, version as aV, search as aW, startsWith as aX, std as aY, substring as aZ, sum as a_, type SchemaTableDiff as aa, type SchemaTrigger as ab, type SchemaTriggerChange as ac, type SchemaTriggerEvent as ad, type SchemaUpsertRequest as ae, type SchemaValidationResult as af, type SecretMetadata as ag, type SecretRecord as ah, type SecretSaveRequest as ai, type SecretsListResponse as aj, type SelectQuery as ak, type Sort as al, type StreamAction as am, type UpdateQuery as an, asc as ao, avg as ap, between as aq, contains as ar, containsIgnoreCase as as, count as at, desc as au, eq as av, format as aw, gt as ax, gte as ay, inOp as az, type AiChatCompletionChunk as b, variance as b0, within as b1, type AiChatCompletionChunkChoice as c, type AiChatCompletionChunkDelta as d, type AiChatCompletionRequest as e, type AiChatCompletionResponse as f, type AiChatCompletionStream as g, type AiChatCompletionUsage as h, type AiChatMessage as i, type AiChatOptions as j, type AiChatRole as k, type AiClient as l, type AiErrorResponse as m, type AiModel as n, type AiModelsResponse as o, type AiRequestOptions as p, type AiScriptApprovalRequest as q, type AiScriptApprovalResponse as r, type AiTool as s, type AiToolCall as t, type AiToolCallFunction as u, type AiToolChoice as v, type AiToolFunction as w, type FetchResponse as x, type FullTextQuery as y, type ICascadeRelationshipBuilder as z };

package/dist/edge.cjs

@@ -2,7 +2,7 @@
 
 // package.json
 var name = "@onyx.dev/onyx-database";
-var version = "2.1.0";
+var version = "2.3.0";
 
 // src/config/defaults.ts
 var DEFAULT_BASE_URL = "https://api.onyx.dev";
@@ -100,7 +100,6 @@ async function resolveConfig(input) {
   const maxRetries = retryConfig.maxRetries ?? 3;
   const retryInitialDelayMs = retryConfig.initialDelayMs ?? 300;
   const missing = [];
-  if (!databaseId) missing.push("databaseId");
   if (!apiKey) missing.push("apiKey");
   if (!apiSecret) missing.push("apiSecret");
   if (missing.length) {
@@ -1280,6 +1279,27 @@ var OnyxDatabaseImpl = class {
     const { http } = await this.ensureAiClient();
     return http.request("POST", "/api/script-approvals", input);
   }
+  async predict(publishedModelId, inputs) {
+    const { http, databaseId } = await this.ensureClient();
+    const path = `/data/${encodeURIComponent(
+      databaseId
+    )}/model-builder/published-model/${encodeURIComponent(publishedModelId)}/predict`;
+    return http.request(
+      "POST",
+      path,
+      serializeDates({ inputs })
+    );
+  }
+  async predictFromScript(publishedModelId, scriptId, scriptParameters = {}) {
+    const { http, databaseId } = await this.ensureClient();
+    const path = `/data/${encodeURIComponent(
+      databaseId
+    )}/model-builder/published-model/${encodeURIComponent(publishedModelId)}/predict/script`;
+    return http.request("POST", path, {
+      scriptId,
+      scriptParameters
+    });
+  }
   from(table) {
     return new QueryBuilderImpl(this, String(table), this.defaultPartition);
   }