@botpress/cognitive 0.1.35 → 0.1.37

package/dist/index.d.ts

@@ -127,7 +127,7 @@ type GenerateContentOutput = {
         cost: number;
     };
 };
-type Model$1 = {
+type Model$2 = {
     id: string;
     name: string;
     description: string;
@@ -144,7 +144,7 @@ type Model$1 = {
     };
 };
 
-type Model = Model$1 & {
+type Model$1 = Model$2 & {
     ref: ModelRef;
     integration: string;
 };
@@ -159,7 +159,7 @@ type ModelPreferences = {
     }>;
 };
 declare abstract class ModelProvider {
-    abstract fetchInstalledModels(): Promise<Model[]>;
+    abstract fetchInstalledModels(): Promise<Model$1[]>;
     abstract fetchModelPreferences(): Promise<ModelPreferences | null>;
     abstract saveModelPreferences(preferences: ModelPreferences): Promise<void>;
     abstract deleteModelPreferences(): Promise<void>;
@@ -168,7 +168,7 @@ declare class RemoteModelProvider extends ModelProvider {
     private _client;
     constructor(client: BotpressClientLike);
     private _fetchInstalledIntegrationNames;
-    fetchInstalledModels(): Promise<Model[]>;
+    fetchInstalledModels(): Promise<Model$1[]>;
     fetchModelPreferences(): Promise<ModelPreferences | null>;
     saveModelPreferences(preferences: ModelPreferences): Promise<void>;
     deleteModelPreferences(): Promise<void>;
@@ -212,6 +212,8 @@ type CognitiveProps = {
     timeout?: number;
     /** Max retry attempts */
     maxRetries?: number;
+    /** Whether to use the beta client. Restricted to authorized users. */
+    __experimental_beta?: boolean;
 };
 type Events = {
     aborted: (req: Request, reason?: string) => void;
@@ -1297,6 +1299,10 @@ interface UpsertFileResponse$1 {
              */
             name?: string;
         };
+        /**
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         */
+        indexingStack?: "v1" | "v2";
         /**
          * URL to upload the file content. File content needs to be sent to this URL via a PUT request.
          */
@@ -1842,6 +1848,10 @@ interface CreateEventRequestBody {
      * ID of the [User](#schema_user) to link the event to.
      */
     userId?: string;
+    /**
+     * ID of the [Workflow](#schema_workflow) to link the event to.
+     */
+    workflowId?: string;
     /**
      * ID of the [Message](#schema_message) to link the event to.
      */
@@ -1952,6 +1962,7 @@ interface ListEventsRequestQuery {
     conversationId?: string;
     userId?: string;
     messageId?: string;
+    workflowId?: string;
     status?: "pending" | "ignored" | "processed" | "failed" | "scheduled";
 }
 interface ListEventsRequestParams {
@@ -6491,7 +6502,7 @@ interface CreateBotResponse {
          */
         signingSecret: string;
         /**
-         * A mapping of integrations to their configuration
+         * A mapping of integrations to their configuration. If the `x-multiple-integrations` header is present, this object is keyed by integration aliases. Otherwise, this object is keyed by integration ids.
          */
         integrations: {
             [k: string]: {
@@ -7122,7 +7133,7 @@ interface UpdateBotResponse {
          */
         signingSecret: string;
         /**
-         * A mapping of integrations to their configuration
+         * A mapping of integrations to their configuration. If the `x-multiple-integrations` header is present, this object is keyed by integration aliases. Otherwise, this object is keyed by integration ids.
          */
         integrations: {
             [k: string]: {
@@ -7585,7 +7596,7 @@ interface GetBotResponse {
          */
         signingSecret: string;
         /**
-         * A mapping of integrations to their configuration
+         * A mapping of integrations to their configuration. If the `x-multiple-integrations` header is present, this object is keyed by integration aliases. Otherwise, this object is keyed by integration ids.
          */
         integrations: {
             [k: string]: {
@@ -15352,6 +15363,10 @@ interface UpsertFileResponse {
              */
             name?: string;
         };
+        /**
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         */
+        indexingStack?: "v1" | "v2";
         /**
          * URL to upload the file content. File content needs to be sent to this URL via a PUT request.
          */
@@ -15474,6 +15489,10 @@ interface ListFilesResponse {
              */
             name?: string;
         };
+        /**
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         */
+        indexingStack?: "v1" | "v2";
     }[];
     meta: {
         /**
@@ -15578,6 +15597,10 @@ interface GetFileResponse {
              */
             name?: string;
         };
+        /**
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         */
+        indexingStack?: "v1" | "v2";
     };
 }
 
@@ -15696,6 +15719,10 @@ interface UpdateFileMetadataResponse {
              */
             name?: string;
         };
+        /**
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         */
+        indexingStack?: "v1" | "v2";
     };
 }
 
@@ -15802,6 +15829,10 @@ interface CopyFileResponse {
              */
             name?: string;
         };
+        /**
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         */
+        indexingStack?: "v1" | "v2";
     };
 }
 
@@ -17972,7 +18003,7 @@ declare function toApiError(err: unknown): Error;
 type IClient = Simplify<Client$1 & {
     uploadFile: (input: UploadFileInput) => Promise<UploadFileOutput>;
 }>;
-type ClientProps = CommonClientProps & {
+type ClientProps$2 = CommonClientProps & {
     integrationId?: string;
     workspaceId?: string;
     botId?: string;
@@ -17980,7 +18011,7 @@ type ClientProps = CommonClientProps & {
 };
 declare class Client extends Client$1 implements IClient {
     readonly config: Readonly<ClientConfig>;
-    constructor(clientProps?: ClientProps);
+    constructor(clientProps?: ClientProps$2);
     get list(): {
         conversations: (props: {
             tags?: {
@@ -18019,6 +18050,7 @@ declare class Client extends Client$1 implements IClient {
             type?: string | undefined;
             userId?: string | undefined;
             conversationId?: string | undefined;
+            workflowId?: string | undefined;
             messageId?: string | undefined;
             status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
         }) => AsyncCollection<{
@@ -18323,6 +18355,7 @@ declare class Client extends Client$1 implements IClient {
                 id?: string;
                 name?: string;
             };
+            indexingStack?: "v1" | "v2";
         }>;
         filePassages: (props: {
             id: string;
@@ -18900,25 +18933,151 @@ declare class Cognitive {
         request: InterceptorManager<Request>;
         response: InterceptorManager<Response>;
     };
-    protected _models: Model[];
+    protected _models: Model$1[];
     protected _timeoutMs: number;
     protected _maxRetries: number;
     protected _client: ExtendedClient;
     protected _preferences: ModelPreferences | null;
     protected _provider: ModelProvider;
     protected _downtimes: ModelPreferences['downtimes'];
+    protected _useBeta: boolean;
     private _events;
     constructor(props: CognitiveProps);
     get client(): ExtendedClient;
     clone(): Cognitive;
     on<K extends keyof Events>(this: this, event: K, cb: Events[K]): Unsubscribe;
-    fetchInstalledModels(): Promise<Model[]>;
+    fetchInstalledModels(): Promise<Model$1[]>;
     fetchPreferences(): Promise<ModelPreferences>;
     setPreferences(preferences: ModelPreferences, save?: boolean): Promise<void>;
     private _cleanupOldDowntimes;
     private _selectModel;
-    getModelDetails(model: string): Promise<Model>;
+    getModelDetails(model: string): Promise<Model$1>;
     generateContent(input: InputProps): Promise<Response>;
+    private _generateContent;
 }
 
-export { type BotpressClientLike, Cognitive, type Events, type GenerateContentInput, type GenerateContentOutput, type Model, type ModelPreferences, ModelProvider, RemoteModelProvider };
+type CognitiveRequest = {
+    /**
+     * @minItems 1
+     */
+    messages: {
+        role: 'user' | 'assistant' | 'system';
+        content: string | {
+            type: 'text' | 'image';
+            text?: string;
+            url?: string;
+            mimeType?: string;
+            [k: string]: any;
+        }[];
+        type?: string;
+    }[];
+    /**
+     * Model ID or routing goal for automatic selection.
+     */
+    model?: 'auto' | 'auto-best' | 'auto-fast' | 'auto-reasoning' | 'auto-cheapest' | 'auto-balance' | 'anthropic/claude-3-5-haiku-20241022' | 'anthropic/claude-3-5-sonnet-20240620' | 'anthropic/claude-3-5-sonnet-20241022' | 'anthropic/claude-3-7-sonnet-20250219' | 'anthropic/claude-3-haiku-20240307' | 'anthropic/claude-sonnet-4-20250514' | 'cerebras/gpt-oss-120b' | 'cerebras/llama-4-scout-17b-16e-instruct' | 'cerebras/llama3.1-8b' | 'cerebras/llama3.3-70b' | 'cerebras/qwen-3-32b' | 'google-ai/gemini-2.5-flash' | 'google-ai/gemini-2.5-pro' | 'google-ai/models/gemini-2.0-flash' | 'groq/openai/gpt-oss-120b' | 'groq/openai/gpt-oss-20b' | 'openai/gpt-4.1-2025-04-14' | 'openai/gpt-4.1-mini-2025-04-14' | 'openai/gpt-4.1-nano-2025-04-14' | 'openai/gpt-4o-2024-11-20' | 'openai/gpt-4o-mini-2024-07-18' | 'openai/gpt-5-2025-08-07' | 'openai/gpt-5-mini-2025-08-07' | 'openai/gpt-5-nano-2025-08-07' | 'openai/o1-2024-12-17' | 'openai/o1-mini-2024-09-12' | 'openai/o3-2025-04-16' | 'openai/o3-mini-2025-01-31' | 'openai/o4-mini-2025-04-16' | 'openrouter/gpt-oss-120b';
+    systemPrompt?: string;
+    temperature?: number;
+    maxTokens?: number;
+    stopSequences?: string | string[];
+    stream?: boolean;
+    responseFormat?: 'text' | 'json';
+    reasoningEffort?: 'low' | 'medium' | 'high';
+};
+type CognitiveStreamChunk = {
+    output?: string;
+    created: number;
+    finished?: boolean;
+    metadata?: {
+        provider: string;
+        model?: string;
+        usage: {
+            inputTokens: number;
+            outputTokens: number;
+            reasoningTokens?: number;
+        };
+        cost?: number;
+        cached?: boolean;
+        latency?: number;
+        stopReason?: string;
+        reasoningEffort?: string;
+        warnings?: {
+            type: 'parameter_ignored' | 'provider_limitation' | 'deprecated_model' | 'fallback_used';
+            message: string;
+        }[];
+        /**
+         * List of models that were tried and failed
+         */
+        fallbackPath?: string[];
+    };
+};
+type CognitiveResponse = {
+    output: string;
+    metadata: {
+        provider: string;
+        model?: string;
+        usage: {
+            inputTokens: number;
+            outputTokens: number;
+            reasoningTokens?: number;
+        };
+        cost?: number;
+        cached?: boolean;
+        latency?: number;
+        stopReason?: string;
+        reasoningEffort?: string;
+        warnings?: {
+            type: 'parameter_ignored' | 'provider_limitation' | 'deprecated_model' | 'fallback_used';
+            message: string;
+        }[];
+        /**
+         * List of models that were tried and failed
+         */
+        fallbackPath?: string[];
+    };
+    error?: string;
+};
+type Model = {
+    id: string;
+    name: string;
+    description: string;
+    tags?: ('recommended' | 'deprecated' | 'general-purpose' | 'low-cost' | 'flagship' | 'vision' | 'coding' | 'agents' | 'function-calling' | 'roleplay' | 'storytelling' | 'reasoning' | 'preview')[];
+    input: {
+        maxTokens: number;
+        /**
+         * Cost per 1 million tokens, in U.S. dollars
+         */
+        costPer1MTokens: number;
+    };
+    output: {
+        maxTokens: number;
+        /**
+         * Cost per 1 million tokens, in U.S. dollars
+         */
+        costPer1MTokens: number;
+    };
+};
+
+type ClientProps = {
+    baseUrl?: string;
+    timeout?: number;
+    botId?: string;
+    token?: string;
+    headers?: Record<string, string>;
+};
+type RequestOptions = {
+    signal?: AbortSignal;
+    timeout?: number;
+};
+declare class CognitiveBeta {
+    private _axiosClient;
+    private readonly _config;
+    constructor(props: ClientProps);
+    generateText(input: CognitiveRequest, options?: RequestOptions): Promise<CognitiveResponse>;
+    listModels(input: void, options?: RequestOptions): Promise<Model[]>;
+    generateTextStream(request: CognitiveRequest, options?: RequestOptions): AsyncGenerator<CognitiveStreamChunk, void, unknown>;
+    private _ndjson;
+    private _isRetryableServerError;
+    private _withServerRetry;
+}
+
+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, RemoteModelProvider };

package/dist/index.mjs

@@ -497,25 +497,25 @@ var require_backoff = __commonJS({
     Object.defineProperty(exports, "__esModule", { value: true });
     var options_1 = require_options();
     var delay_factory_1 = require_delay_factory();
-    function backOff2(request, options) {
+    function backOff3(request, options) {
       if (options === void 0) {
         options = {};
       }
       return __awaiter(this, void 0, void 0, function() {
-        var sanitizedOptions, backOff3;
+        var sanitizedOptions, backOff4;
         return __generator(this, function(_a) {
           switch (_a.label) {
             case 0:
               sanitizedOptions = options_1.getSanitizedOptions(options);
-              backOff3 = new BackOff(request, sanitizedOptions);
-              return [4, backOff3.execute()];
+              backOff4 = new BackOff(request, sanitizedOptions);
+              return [4, backOff4.execute()];
             case 1:
               return [2, _a.sent()];
           }
         });
       });
     }
-    exports.backOff = backOff2;
+    exports.backOff = backOff3;
     var BackOff = (
       /** @class */
       function() {
@@ -591,7 +591,7 @@ var require_backoff = __commonJS({
 });
 
 // src/client.ts
-var import_exponential_backoff = __toESM(require_backoff());
+var import_exponential_backoff2 = __toESM(require_backoff());
 
 // ../../node_modules/.pnpm/nanoevents@9.1.0/node_modules/nanoevents/index.js
 var createNanoEvents = () => ({
@@ -650,6 +650,159 @@ var getExtendedClient = (_client) => {
   };
 };
 
+// src/cognitive_beta/index.ts
+var import_exponential_backoff = __toESM(require_backoff());
+import axios from "axios";
+var isBrowser = () => typeof window !== "undefined" && typeof window.fetch === "function";
+var CognitiveBeta = class {
+  _axiosClient;
+  _config;
+  constructor(props) {
+    this._config = {
+      baseUrl: props.baseUrl || "https://cognitive.botpress.cloud",
+      timeout: props.timeout || 60001,
+      token: props.token || "",
+      botId: props.botId || "",
+      headers: props.headers || {}
+    };
+    this._axiosClient = axios.create({
+      headers: {
+        Authorization: `Bearer ${this._config.token}`,
+        "X-Bot-Id": this._config.botId,
+        ...this._config.headers
+      },
+      baseURL: this._config.baseUrl
+    });
+  }
+  async generateText(input, options = {}) {
+    const signal = options.signal ?? AbortSignal.timeout(this._config.timeout);
+    const { data } = await this._withServerRetry(
+      () => this._axiosClient.post("/v1/generate-text", input, {
+        signal,
+        timeout: options.timeout ?? this._config.timeout
+      })
+    );
+    return data;
+  }
+  async listModels(input, options = {}) {
+    const signal = options.signal ?? AbortSignal.timeout(this._config.timeout);
+    const { data } = await this._withServerRetry(
+      () => this._axiosClient.post("/v1/models", input, {
+        signal,
+        timeout: options.timeout ?? this._config.timeout
+      })
+    );
+    return data;
+  }
+  async *generateTextStream(request, options = {}) {
+    const signal = options.signal ?? AbortSignal.timeout(this._config.timeout);
+    if (isBrowser()) {
+      const res2 = await fetch(`${this._config.baseUrl}/v1/generate-text-stream`, {
+        method: "POST",
+        headers: {
+          Authorization: `Bearer ${this._config.token}`,
+          "X-Bot-Id": this._config.botId,
+          "Content-Type": "application/json"
+        },
+        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)) {
+        yield obj;
+      }
+      return;
+    }
+    const res = await this._withServerRetry(
+      () => this._axiosClient.post(
+        "/v1/generate-text-stream",
+        { ...request, stream: true },
+        {
+          responseType: "stream",
+          signal,
+          timeout: options.timeout ?? this._config.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;
+    }
+  }
+  async *_ndjson(stream) {
+    const decoder = new TextDecoder("utf-8");
+    let buffer = "";
+    for await (const chunk of stream) {
+      buffer += decoder.decode(chunk, { stream: true });
+      for (; ; ) {
+        const i = buffer.indexOf("\n");
+        if (i < 0) {
+          break;
+        }
+        const line = buffer.slice(0, i).replace(/\r$/, "");
+        buffer = buffer.slice(i + 1);
+        if (!line) {
+          continue;
+        }
+        yield JSON.parse(line);
+      }
+    }
+    buffer += decoder.decode();
+    const tail = buffer.trim();
+    if (tail) {
+      yield JSON.parse(tail);
+    }
+  }
+  _isRetryableServerError(error) {
+    if (axios.isAxiosError(error)) {
+      if (!error.response) {
+        return true;
+      }
+      const status = error.response?.status;
+      if (status && [502, 503, 504].includes(status)) {
+        return true;
+      }
+      if (error.code && ["ECONNABORTED", "ECONNRESET", "ETIMEDOUT", "EAI_AGAIN", "ENOTFOUND", "EPIPE"].includes(error.code)) {
+        return true;
+      }
+    }
+    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)
+    });
+  }
+};
+
 // src/errors.ts
 var getActionFromError = (error) => {
   if (!isBotpressError(error)) {
@@ -902,12 +1055,14 @@ var Cognitive = class {
   _preferences = null;
   _provider;
   _downtimes = [];
+  _useBeta = false;
   _events = createNanoEvents();
   constructor(props) {
     this._client = getExtendedClient(props.client);
     this._provider = props.provider ?? new RemoteModelProvider(props.client);
     this._timeoutMs = props.timeout ?? this._timeoutMs;
     this._maxRetries = props.maxRetries ?? this._maxRetries;
+    this._useBeta = props.__experimental_beta ?? false;
   }
   get client() {
     return this._client;
@@ -994,6 +1149,54 @@ var Cognitive = class {
     return def;
   }
   async generateContent(input) {
+    if (!this._useBeta) {
+      return this._generateContent(input);
+    }
+    const betaClient = new CognitiveBeta({
+      headers: this._client.config.headers,
+      baseUrl: this._client.config.apiUrl.includes(".cloud") ? "https://cognitive.botpress.cloud" : "https://cognitive.botpress.dev"
+    });
+    const response = await betaClient.generateText(input);
+    return {
+      output: {
+        id: "beta-output",
+        provider: response.metadata.provider,
+        model: response.metadata.model,
+        choices: [
+          {
+            type: "text",
+            content: response.output,
+            role: "assistant",
+            index: 0,
+            stopReason: response.metadata.stopReason
+          }
+        ],
+        usage: {
+          inputTokens: response.metadata.usage.inputTokens,
+          inputCost: 0,
+          outputTokens: response.metadata.usage.outputTokens,
+          outputCost: response.metadata.cost ?? 0
+        },
+        botpress: {
+          cost: response.metadata.cost ?? 0
+        }
+      },
+      meta: {
+        cached: response.metadata.cached,
+        model: { integration: response.metadata.provider, model: response.metadata.model },
+        latency: response.metadata.latency,
+        cost: {
+          input: 0,
+          output: response.metadata.cost || 0
+        },
+        tokens: {
+          input: response.metadata.usage.inputTokens,
+          output: response.metadata.usage.outputTokens
+        }
+      }
+    };
+  }
+  async _generateContent(input) {
     const start = Date.now();
     const signal = input.signal ?? AbortSignal.timeout(this._timeoutMs);
     const client = this._client.abortable(signal);
@@ -1001,7 +1204,7 @@ var Cognitive = class {
     let integration;
     let model;
     this._events.emit("request", props);
-    const { output, meta } = await (0, import_exponential_backoff.backOff)(
+    const { output, meta } = await (0, import_exponential_backoff2.backOff)(
       async () => {
         const selection = await this._selectModel(input.model ?? "best");
         integration = selection.integration;
@@ -1066,6 +1269,7 @@ var Cognitive = class {
 };
 export {
   Cognitive,
+  CognitiveBeta,
   ModelProvider,
   RemoteModelProvider
 };