@botpress/cognitive 0.1.49 → 0.2.0

package/dist/index.d.ts

@@ -3977,6 +3977,10 @@ interface GetOrCreateWorkflowRequestBody {
      * Optional list of tag names to use for strict matching when looking up existing workflows. If provided, all specified tags must match exactly for a workflow to be considered a match. For example, with an existing workflow whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
      */
     discriminateByTags?: string[];
+    /**
+     * When provided, will only match workflows whose status corresponds to the status group.
+     */
+    discriminateByStatusGroup?: "active" | "finished";
 }
 type GetOrCreateWorkflowInput = GetOrCreateWorkflowRequestBody & GetOrCreateWorkflowRequestHeaders & GetOrCreateWorkflowRequestQuery & GetOrCreateWorkflowRequestParams;
 interface GetOrCreateWorkflowResponse {
@@ -6615,9 +6619,20 @@ interface CreateBotResponse {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        integrationAlias: string;
+                        integrationInterfaceAlias?: string;
                         interfaceId: string;
                     };
                 };
+                /**
+                 * A mapping of plugin integration aliases to their backing integrations
+                 */
+                integrations?: {
+                    [k: string]: {
+                        integrationId: string;
+                        integrationAlias: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -7108,6 +7123,23 @@ interface UpdateBotRequestBody {
             interfaces?: {
                 [k: string]: {
                     integrationId: string;
+                    /**
+                     * When an alias is provided, the plugin will use the integration corresponding to this alias. If not provided, the first integration matching the integrationId will be used.
+                     */
+                    integrationAlias?: string;
+                    /**
+                     * When an alias is provided, the plugin will use the integration interface corresponding to this alias.
+                     */
+                    integrationInterfaceAlias?: string;
+                };
+            };
+            /**
+             * A mapping of plugin integration aliases to their backing integrations
+             */
+            integrations?: {
+                [k: string]: {
+                    integrationId: string;
+                    integrationAlias: string;
                 };
             };
         } | null;
@@ -7246,9 +7278,20 @@ interface UpdateBotResponse {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        integrationAlias: string;
+                        integrationInterfaceAlias?: string;
                         interfaceId: string;
                     };
                 };
+                /**
+                 * A mapping of plugin integration aliases to their backing integrations
+                 */
+                integrations?: {
+                    [k: string]: {
+                        integrationId: string;
+                        integrationAlias: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -7709,9 +7752,20 @@ interface GetBotResponse {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        integrationAlias: string;
+                        integrationInterfaceAlias?: string;
                         interfaceId: string;
                     };
                 };
+                /**
+                 * A mapping of plugin integration aliases to their backing integrations
+                 */
+                integrations?: {
+                    [k: string]: {
+                        integrationId: string;
+                        integrationAlias: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -8374,6 +8428,7 @@ interface DeployBotVersionResponse {
 interface CreateIntegrationShareableIdRequestHeaders {
 }
 interface CreateIntegrationShareableIdRequestQuery {
+    integrationInstanceAlias?: string;
 }
 interface CreateIntegrationShareableIdRequestParams {
     botId: string;
@@ -8389,6 +8444,7 @@ interface CreateIntegrationShareableIdResponse {
 interface DeleteIntegrationShareableIdRequestHeaders {
 }
 interface DeleteIntegrationShareableIdRequestQuery {
+    integrationInstanceAlias?: string;
 }
 interface DeleteIntegrationShareableIdRequestParams {
     botId: string;
@@ -8403,6 +8459,7 @@ interface DeleteIntegrationShareableIdResponse {
 interface GetIntegrationShareableIdRequestHeaders {
 }
 interface GetIntegrationShareableIdRequestQuery {
+    integrationInstanceAlias?: string;
 }
 interface GetIntegrationShareableIdRequestParams {
     botId: string;
@@ -8419,6 +8476,7 @@ interface GetIntegrationShareableIdResponse {
 interface UnlinkSandboxedConversationsRequestHeaders {
 }
 interface UnlinkSandboxedConversationsRequestQuery {
+    integrationInstanceAlias?: string;
 }
 interface UnlinkSandboxedConversationsRequestParams {
     botId: string;
@@ -8689,6 +8747,7 @@ interface CreateWorkspaceResponse {
     socialAccounts?: string[];
     isPublic?: boolean;
     handle?: string;
+    activeTrialId: string | null;
 }
 
 interface GetPublicWorkspaceRequestHeaders {
@@ -8742,6 +8801,7 @@ interface GetWorkspaceResponse {
     socialAccounts?: string[];
     isPublic?: boolean;
     handle?: string;
+    activeTrialId: string | null;
 }
 
 interface ListWorkspaceUsagesRequestHeaders {
@@ -8913,6 +8973,7 @@ interface UpdateWorkspaceResponse$1 {
     socialAccounts?: string[];
     isPublic?: boolean;
     handle?: string;
+    activeTrialId: string | null;
 }
 
 interface CheckHandleAvailabilityRequestHeaders {
@@ -8969,6 +9030,7 @@ interface UpdateWorkspaceResponse {
     socialAccounts?: string[];
     isPublic?: boolean;
     handle?: string;
+    activeTrialId: string | null;
 }
 
 interface ListPublicWorkspacesRequestHeaders {
@@ -9038,7 +9100,7 @@ interface GetAuditRecordsResponse {
         resourceId: string | null;
         resourceName?: string | null;
         value?: string | null;
-        action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY";
+        action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY" | "EXECUTE_AUTO_RECHARGE_SUCCESS" | "EXECUTE_AUTO_RECHARGE_FAILED";
     }[];
     meta: {
         /**
@@ -17519,6 +17581,10 @@ interface FindTableRowsRequestBody {
      * Search term to apply to the row search. When using this parameter, some rows which doesn't match the search term will be returned, use the similarity field to know how much the row matches the search term.
      */
     search?: string;
+    /**
+     * Specify which columns to return in the response. Supports both top-level columns (e.g., "name") and nested attributes using dot notation (e.g., "attributes.price"). System columns (id, createdAt, updatedAt, etc.) are always included. If omitted, all columns are returned.
+     */
+    select?: string[];
     /**
      * Specifies the column by which to order the results. By default it is ordered by id. Build-in columns: id, createdAt, updatedAt
      */
@@ -19149,6 +19215,20 @@ type Model = {
     lifecycle: 'production' | 'preview' | 'deprecated' | 'discontinued';
 };
 
+type BetaEvents = {
+    request: (req: {
+        input: CognitiveRequest;
+    }) => void;
+    response: (req: {
+        input: CognitiveRequest;
+    }, res: CognitiveResponse) => void;
+    error: (req: {
+        input: CognitiveRequest;
+    }, error: any) => void;
+    retry: (req: {
+        input: CognitiveRequest;
+    }, error: any) => void;
+};
 type ClientProps = {
     apiUrl?: string;
     timeout?: number;
@@ -19170,8 +19250,10 @@ declare class CognitiveBeta {
     private readonly _withCredentials;
     private readonly _headers;
     private readonly _debug;
+    private _events;
     constructor(props: ClientProps);
     clone(): CognitiveBeta;
+    on<K extends keyof BetaEvents>(event: K, cb: BetaEvents[K]): Unsubscribe;
     generateText(input: CognitiveRequest, options?: RequestOptions): Promise<CognitiveResponse>;
     listModels(): Promise<Model[]>;
     generateTextStream(request: CognitiveRequest, options?: RequestOptions): AsyncGenerator<CognitiveStreamChunk, void, unknown>;
@@ -19181,4 +19263,4 @@ declare class CognitiveBeta {
 }
 declare const getCognitiveV2Model: (model: string) => Model | undefined;
 
-export { type BotpressClientLike, Cognitive, CognitiveBeta, type CognitiveRequest, type CognitiveResponse, type CognitiveStreamChunk, type Events, type GenerateContentInput, type GenerateContentOutput, type Model$1 as Model, type ModelPreferences, ModelProvider, type Models, RemoteModelProvider, getCognitiveV2Model };
+export { type BetaEvents, type BotpressClientLike, Cognitive, CognitiveBeta, type CognitiveRequest, type CognitiveResponse, type CognitiveStreamChunk, type Events, type GenerateContentInput, type GenerateContentOutput, type Model$1 as Model, type ModelPreferences, ModelProvider, type Models, RemoteModelProvider, getCognitiveV2Model };

package/dist/index.mjs

@@ -1747,6 +1747,7 @@ var CognitiveBeta = class _CognitiveBeta {
   _withCredentials;
   _headers;
   _debug = false;
+  _events = createNanoEvents();
   constructor(props) {
     this._apiUrl = props.apiUrl || "https://api.botpress.cloud";
     this._timeout = props.timeout || 60001;
@@ -1777,15 +1778,28 @@ var CognitiveBeta = class _CognitiveBeta {
       debug: this._debug
     });
   }
+  on(event, cb) {
+    return this._events.on(event, cb);
+  }
   async generateText(input, options = {}) {
     const signal = options.signal ?? AbortSignal.timeout(this._timeout);
-    const { data } = await this._withServerRetry(
-      () => this._axiosClient.post("/v2/cognitive/generate-text", input, {
-        signal,
-        timeout: options.timeout ?? this._timeout
-      })
-    );
-    return data;
+    const req = { input };
+    this._events.emit("request", req);
+    try {
+      const { data } = await this._withServerRetry(
+        () => this._axiosClient.post("/v2/cognitive/generate-text", input, {
+          signal,
+          timeout: options.timeout ?? this._timeout
+        }),
+        options,
+        req
+      );
+      this._events.emit("response", req, data);
+      return data;
+    } catch (error) {
+      this._events.emit("error", req, error);
+      throw error;
+    }
   }
   async listModels() {
     const { data } = await this._withServerRetry(
@@ -1795,61 +1809,88 @@ var CognitiveBeta = class _CognitiveBeta {
   }
   async *generateTextStream(request, options = {}) {
     const signal = options.signal ?? AbortSignal.timeout(this._timeout);
-    if (isBrowser()) {
-      const res2 = await fetch(`${this._apiUrl}/v2/cognitive/generate-text-stream`, {
-        method: "POST",
-        headers: {
-          ...this._headers,
-          "Content-Type": "application/json"
-        },
-        credentials: this._withCredentials ? "include" : "omit",
-        body: JSON.stringify({ ...request, stream: true }),
-        signal
-      });
-      if (!res2.ok) {
-        const text = await res2.text().catch(() => "");
-        const err = new Error(`HTTP ${res2.status}: ${text || res2.statusText}`);
-        err.response = { status: res2.status, data: text };
-        throw err;
+    const req = { input: request };
+    const chunks = [];
+    let lastChunk;
+    this._events.emit("request", req);
+    try {
+      if (isBrowser()) {
+        const res2 = await fetch(`${this._apiUrl}/v2/cognitive/generate-text-stream`, {
+          method: "POST",
+          headers: {
+            ...this._headers,
+            "Content-Type": "application/json"
+          },
+          credentials: this._withCredentials ? "include" : "omit",
+          body: JSON.stringify({ ...request, stream: true }),
+          signal
+        });
+        if (!res2.ok) {
+          const text = await res2.text().catch(() => "");
+          const err = new Error(`HTTP ${res2.status}: ${text || res2.statusText}`);
+          err.response = { status: res2.status, data: text };
+          throw err;
+        }
+        const body = res2.body;
+        if (!body) {
+          throw new Error("No response body received for streaming request");
+        }
+        const reader = body.getReader();
+        const iterable = (async function* () {
+          for (; ; ) {
+            const { value, done } = await reader.read();
+            if (done) {
+              break;
+            }
+            if (value) {
+              yield value;
+            }
+          }
+        })();
+        for await (const obj of this._ndjson(iterable)) {
+          chunks.push(obj);
+          lastChunk = obj;
+          yield obj;
+        }
+        if (lastChunk?.metadata) {
+          this._events.emit("response", req, {
+            output: chunks.map((c) => c.output || "").join(""),
+            metadata: lastChunk.metadata
+          });
+        }
+        return;
       }
-      const body = res2.body;
-      if (!body) {
+      const res = await this._withServerRetry(
+        () => this._axiosClient.post(
+          "/v2/cognitive/generate-text-stream",
+          { ...request, stream: true },
+          {
+            responseType: "stream",
+            signal,
+            timeout: options.timeout ?? this._timeout
+          }
+        ),
+        options,
+        req
+      );
+      const nodeStream = res.data;
+      if (!nodeStream) {
         throw new Error("No response body received for streaming request");
       }
-      const reader = body.getReader();
-      const iterable = (async function* () {
-        for (; ; ) {
-          const { value, done } = await reader.read();
-          if (done) {
-            break;
-          }
-          if (value) {
-            yield value;
-          }
-        }
-      })();
-      for await (const obj of this._ndjson(iterable)) {
+      for await (const obj of this._ndjson(nodeStream)) {
+        chunks.push(obj);
+        lastChunk = obj;
         yield obj;
       }
-      return;
-    }
-    const res = await this._withServerRetry(
-      () => this._axiosClient.post(
-        "/v2/cognitive/generate-text-stream",
-        { ...request, stream: true },
-        {
-          responseType: "stream",
-          signal,
-          timeout: options.timeout ?? this._timeout
-        }
-      )
-    );
-    const nodeStream = res.data;
-    if (!nodeStream) {
-      throw new Error("No response body received for streaming request");
-    }
-    for await (const obj of this._ndjson(nodeStream)) {
-      yield obj;
+      if (lastChunk?.metadata) {
+        this._events.emit("response", req, {
+          output: chunks.map((c) => c.output || "").join(""),
+          metadata: lastChunk.metadata
+        });
+      }
+    } catch (error) {
+      this._events.emit("error", req, error);
+      throw error;
     }
   }
   async *_ndjson(stream) {
@@ -1891,14 +1932,30 @@ var CognitiveBeta = class _CognitiveBeta {
     }
     return false;
   }
-  async _withServerRetry(fn) {
-    return (0, import_exponential_backoff.backOff)(fn, {
-      numOfAttempts: 3,
-      startingDelay: 300,
-      timeMultiple: 2,
-      jitter: "full",
-      retry: (e) => this._isRetryableServerError(e)
-    });
+  async _withServerRetry(fn, options = {}, req) {
+    let attemptCount = 0;
+    return (0, import_exponential_backoff.backOff)(
+      async () => {
+        try {
+          const result = await fn();
+          attemptCount = 0;
+          return result;
+        } catch (error) {
+          if (attemptCount > 0 && req) {
+            this._events.emit("retry", req, error);
+          }
+          attemptCount++;
+          throw error;
+        }
+      },
+      {
+        numOfAttempts: 3,
+        startingDelay: 300,
+        timeMultiple: 2,
+        jitter: "full",
+        retry: (e) => !options.signal?.aborted && this._isRetryableServerError(e)
+      }
+    );
   }
 };
 var getCognitiveV2Model = (model) => {
@@ -2281,8 +2338,21 @@ var Cognitive = class _Cognitive {
       delete input.systemPrompt;
     }
     const betaClient = new CognitiveBeta(this._client.config);
-    const response = await betaClient.generateText(input);
-    return {
+    const props = { input };
+    betaClient.on("request", () => {
+      this._events.emit("request", props);
+    });
+    betaClient.on("error", (_req, error) => {
+      this._events.emit("error", props, error);
+    });
+    betaClient.on("retry", (_req, error) => {
+      this._events.emit("retry", props, error);
+    });
+    const response = await betaClient.generateText(input, {
+      signal: input.signal,
+      timeout: this._timeoutMs
+    });
+    const result = {
       output: {
         id: "beta-output",
         provider: response.metadata.provider,
@@ -2320,6 +2390,8 @@ var Cognitive = class _Cognitive {
         }
       }
     };
+    this._events.emit("response", props, result);
+    return result;
   }
   async _generateContent(input) {
     const start = Date.now();