@bitbitpress/client 1.0.1 → 1.0.2

package/README.md

@@ -455,7 +455,7 @@ client.user.synthesizeItem(
 
 ##### Parameters
 
-- `item` (required): A single synthesize item (same shape as items in `synthesize`): `inputs`, `output` (schema as JSON string or Zod 4 schema), optional `configurationKeyName`, optional `searchOptionsOverrides` (e.g. `{ lookbackMinutes: 1440 }` for 24-hour lookback)
+- `item` (required): A single synthesize item (same shape as items in `synthesize`): `inputs`, `output` (schema as JSON string or Zod 4 schema), optional `configurationKeyName`, optional `limit` (number of results to return; defaults to `1`), optional `searchOptionsOverrides` (e.g. `{ lookbackMinutes: 1440 }` for 24-hour lookback)
 - `onStreamingData` (optional): Callback invoked with streaming data whenever a stream event has `complete: false` for this item. Type: `(data: unknown) => void`.
 
 ##### Returns
@@ -515,6 +515,7 @@ client.user.synthesize(
   - `inputs` (optional): Context for synthesis — array of `{ type: "externalId" | "text" | "excludeExternalIds", value: string }` (article ID, freeform text, or comma-separated external IDs to exclude)
   - `output`: `{ schema: string | ZodType }` — output schema as a JSON string or Zod 4 schema (top-level type must be `"object"`; supports object, string, number, boolean, array, and enum)
   - `configurationKeyName` (optional): Key name for configuration
+  - `limit` (optional): Number of results to return. Defaults to `1`.
   - `searchOptionsOverrides` (optional): Per-request overrides, e.g. `{ lookbackMinutes: 1440 }` for 24-hour lookback.
 - `options` (optional): `{ onStreamingData?: (index: number, data: unknown) => void }` — if provided, `onStreamingData` is called for each data event with `complete: false`, with the item's index and streaming data
 
@@ -839,12 +840,13 @@ type SignalResponse = {
 
 #### SynthesizeRequest
 
-Request body for POST `/v1/user/synthesize` (from OpenAPI). Each item has `inputs`, `output`, optional `configurationKeyName`, and optional `searchOptionsOverrides`.
+Request body for POST `/v1/user/synthesize` (from OpenAPI). Each item has `inputs`, `output`, optional `configurationKeyName`, optional `limit` (defaults to `1`), and optional `searchOptionsOverrides`.
 
 ```typescript
 type SynthesizeRequest = {
   items: Array<{
     configurationKeyName?: string;
+    limit?: number; // number of results to return; defaults to 1
     searchOptionsOverrides?: { lookbackMinutes?: number };
     inputs?: Array<{ type: 'externalId' | 'text' | 'excludeExternalIds'; value: string }>;
     output: {

package/dist/generated/openapi.d.ts

@@ -675,6 +675,8 @@ export interface paths {
                         items: {
                             /** @description Optional configuration key name. Loads an existing synthesis config by this name; omit for default configuration. */
                             configurationKeyName?: string;
+                            /** @description Number of results to return. Defaults to 1. */
+                            limit?: number;
                             /** @description Per-request overrides for search options. */
                             searchOptionsOverrides?: {
                                 /** @description Override for search lookback window in minutes (e.g. 1440 for last 24 hours). */

package/dist/user/index.d.ts

@@ -71,7 +71,7 @@ export interface UserMethods {
     /**
      * Synthesize content items personalized to the user (streaming SSE).
      *
-     * @param items - Array of items: optional inputs (type: externalId | text | excludeExternalIds, value), output (schema), optional configurationKeyName, optional searchOptionsOverrides (e.g. lookbackMinutes)
+     * @param items - Array of items: optional inputs (type: externalId | text | excludeExternalIds, value), output (schema), optional configurationKeyName, optional limit (number of results to return; defaults to 1), optional searchOptionsOverrides (e.g. lookbackMinutes)
      * @param options - Optional: onStreamingData(index, data) called for each streaming data update per item index
      * @returns AsyncIterable yielding connection events (connected, complete) and data events (index, data?, complete, error?)
      */

package/dist/user/synthesize.d.ts

@@ -30,7 +30,7 @@ export interface SynthesizeOptions {
  * Synthesize content items personalized to the user (streaming SSE).
  *
  * @param config - Request configuration with base URL, timeout, fetch, and optional token
- * @param items - Array of items: each has optional inputs (`type`: externalId | text | excludeExternalIds, `value`), output (schema as JSON string or Zod 4 schema), optional configurationKeyName, optional searchOptionsOverrides (e.g. lookbackMinutes)
+ * @param items - Array of items: each has optional inputs (`type`: externalId | text | excludeExternalIds, `value`), output (schema as JSON string or Zod 4 schema), optional configurationKeyName, optional limit (number of results to return; defaults to 1), optional searchOptionsOverrides (e.g. lookbackMinutes)
  * @param options - Optional: onStreamingData(index, data) called for each streaming data update per item index
  * @returns AsyncIterable yielding connection events (connected, complete) and data events (index, data?, complete, error?). Data may be partial until an event with complete: true for that index.
  */

package/dist/user/synthesize.js

@@ -27,7 +27,7 @@ function normalizeSynthesizeItems(items) {
  * Synthesize content items personalized to the user (streaming SSE).
  *
  * @param config - Request configuration with base URL, timeout, fetch, and optional token
- * @param items - Array of items: each has optional inputs (`type`: externalId | text | excludeExternalIds, `value`), output (schema as JSON string or Zod 4 schema), optional configurationKeyName, optional searchOptionsOverrides (e.g. lookbackMinutes)
+ * @param items - Array of items: each has optional inputs (`type`: externalId | text | excludeExternalIds, `value`), output (schema as JSON string or Zod 4 schema), optional configurationKeyName, optional limit (number of results to return; defaults to 1), optional searchOptionsOverrides (e.g. lookbackMinutes)
  * @param options - Optional: onStreamingData(index, data) called for each streaming data update per item index
  * @returns AsyncIterable yielding connection events (connected, complete) and data events (index, data?, complete, error?). Data may be partial until an event with complete: true for that index.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitbitpress/client",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "BitBitPress TypeScript client library",
   "type": "module",
   "main": "./dist/index.js",