@botpress/cognitive 0.3.18 → 0.4.0

package/dist/index.d.ts

@@ -1415,6 +1415,10 @@ interface CreateConversationResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Number of messages in the conversation
+         */
+        messageCount: number;
     };
 }
 
@@ -1468,6 +1472,10 @@ interface GetConversationResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Number of messages in the conversation
+         */
+        messageCount: number;
     };
 }
 
@@ -1528,6 +1536,10 @@ interface ListConversationsResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Number of messages in the conversation
+         */
+        messageCount: number;
     }[];
     meta: {
         /**
@@ -1605,6 +1617,10 @@ interface GetOrCreateConversationResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Number of messages in the conversation
+         */
+        messageCount: number;
     };
     meta: {
         created: boolean;
@@ -1672,6 +1688,10 @@ interface UpdateConversationResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Number of messages in the conversation
+         */
+        messageCount: number;
     };
 }
 
@@ -1727,6 +1747,12 @@ interface ListParticipantsResponse {
          * Picture URL of the [User](#schema_user)
          */
         pictureUrl?: string;
+        /**
+         * Optional properties
+         */
+        properties?: {
+            [k: string]: string;
+        };
         /**
          * Optional attributes
          */
@@ -1787,6 +1813,12 @@ interface AddParticipantResponse {
          * Picture URL of the [User](#schema_user)
          */
         pictureUrl?: string;
+        /**
+         * Optional properties
+         */
+        properties?: {
+            [k: string]: string;
+        };
         /**
          * Optional attributes
          */
@@ -1838,6 +1870,12 @@ interface GetParticipantResponse {
          * Picture URL of the [User](#schema_user)
          */
         pictureUrl?: string;
+        /**
+         * Optional properties
+         */
+        properties?: {
+            [k: string]: string;
+        };
         /**
          * Optional attributes
          */
@@ -2189,7 +2227,7 @@ interface GetOrCreateMessageRequestBody {
     /**
      * Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
      */
-    payload: {
+    payload?: {
         [k: string]: any;
     };
     /**
@@ -2280,6 +2318,9 @@ interface GetOrCreateMessageResponse {
          */
         origin?: "synthetic";
     };
+    meta: {
+        created: boolean;
+    };
 }
 
 interface GetMessageRequestHeaders {
@@ -2531,7 +2572,14 @@ interface InitializeIncomingMessageRequestBody {
          */
         pictureUrl?: string;
         /**
-         * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
+         * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+         */
+        properties?: {
+            [k: string]: string;
+        };
+        /**
+         * @deprecated
+         * DEPRECATED - Use properties instead.
          */
         attributes?: {
             [k: string]: string;
@@ -2619,6 +2667,12 @@ interface InitializeIncomingMessageResponse {
          * Picture URL of the [User](#schema_user)
          */
         pictureUrl?: string;
+        /**
+         * Optional properties
+         */
+        properties?: {
+            [k: string]: string;
+        };
         /**
          * Optional attributes
          */
@@ -2665,6 +2719,10 @@ interface InitializeIncomingMessageResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Number of messages in the conversation
+         */
+        messageCount: number;
     };
     /**
      * The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
@@ -2839,7 +2897,14 @@ interface CreateUserRequestBody {
      */
     pictureUrl?: string;
     /**
-     * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
+     * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+     */
+    properties?: {
+        [k: string]: string;
+    };
+    /**
+     * @deprecated
+     * DEPRECATED - Use properties instead.
      */
     attributes?: {
         [k: string]: string;
@@ -2877,6 +2942,12 @@ interface CreateUserResponse {
          * Picture URL of the [User](#schema_user)
          */
         pictureUrl?: string;
+        /**
+         * Optional properties
+         */
+        properties?: {
+            [k: string]: string;
+        };
         /**
          * Optional attributes
          */
@@ -2927,6 +2998,12 @@ interface GetUserResponse {
          * Picture URL of the [User](#schema_user)
          */
         pictureUrl?: string;
+        /**
+         * Optional properties
+         */
+        properties?: {
+            [k: string]: string;
+        };
         /**
          * Optional attributes
          */
@@ -2983,6 +3060,12 @@ interface ListUsersResponse {
          * Picture URL of the [User](#schema_user)
          */
         pictureUrl?: string;
+        /**
+         * Optional properties
+         */
+        properties?: {
+            [k: string]: string;
+        };
         /**
          * Optional attributes
          */
@@ -3025,7 +3108,14 @@ interface GetOrCreateUserRequestBody {
      */
     pictureUrl?: string;
     /**
-     * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
+     * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+     */
+    properties?: {
+        [k: string]: string;
+    };
+    /**
+     * @deprecated
+     * DEPRECATED - Use properties instead.
      */
     attributes?: {
         [k: string]: string;
@@ -3067,6 +3157,12 @@ interface GetOrCreateUserResponse {
          * Picture URL of the [User](#schema_user)
          */
         pictureUrl?: string;
+        /**
+         * Optional properties
+         */
+        properties?: {
+            [k: string]: string;
+        };
         /**
          * Optional attributes
          */
@@ -3074,6 +3170,9 @@ interface GetOrCreateUserResponse {
             [k: string]: string;
         };
     };
+    meta: {
+        created: boolean;
+    };
 }
 
 interface UpdateUserRequestHeaders {
@@ -3099,11 +3198,18 @@ interface UpdateUserRequestBody {
      */
     pictureUrl?: string | null;
     /**
-     * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations. Set individual attributes to null to remove them.
+     * @deprecated
+     * DEPRECATED - Use properties instead.
      */
     attributes?: {
         [k: string]: string | null;
     };
+    /**
+     * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them.
+     */
+    properties?: {
+        [k: string]: string | null;
+    };
 }
 type UpdateUserInput = UpdateUserRequestBody & UpdateUserRequestHeaders & UpdateUserRequestQuery & UpdateUserRequestParams;
 interface UpdateUserResponse {
@@ -3137,6 +3243,12 @@ interface UpdateUserResponse {
          * Picture URL of the [User](#schema_user)
          */
         pictureUrl?: string;
+        /**
+         * Optional properties
+         */
+        properties?: {
+            [k: string]: string;
+        };
         /**
          * Optional attributes
          */
@@ -18761,6 +18873,7 @@ declare class Client extends Client$1 implements IClient {
             tags: {
                 [k: string]: string;
             };
+            messageCount: number;
         }>;
         participants: (props: {
             id: string;
@@ -18773,6 +18886,9 @@ declare class Client extends Client$1 implements IClient {
             };
             name?: string;
             pictureUrl?: string;
+            properties?: {
+                [k: string]: string;
+            };
             attributes?: {
                 [k: string]: string;
             };
@@ -18839,6 +18955,9 @@ declare class Client extends Client$1 implements IClient {
             };
             name?: string;
             pictureUrl?: string;
+            properties?: {
+                [k: string]: string;
+            };
             attributes?: {
                 [k: string]: string;
             };
@@ -19669,6 +19788,9 @@ declare class Cognitive {
     protected _downtimes: ModelPreferences['downtimes'];
     protected _useBeta: boolean;
     protected _debug: boolean;
+    private _remoteModelCache;
+    private _remoteModelCacheTime;
+    private _remoteModelCachePending;
     private _events;
     constructor(props: CognitiveProps);
     get client(): ExtendedClient;
@@ -19679,8 +19801,11 @@ declare class Cognitive {
     setPreferences(preferences: ModelPreferences, save?: boolean): Promise<void>;
     private _cleanupOldDowntimes;
     private _selectModel;
+    fetchRemoteModels(): Promise<Map<string, Model$1>>;
+    private _doFetchRemoteModels;
     getModelDetails(model: string): Promise<Model$1>;
     generateContent(input: InputProps): Promise<Response>;
+    private _generateContentV2;
     private _generateContent;
 }
 
@@ -19895,6 +20020,7 @@ declare class CognitiveBeta {
     private _isRetryableServerError;
     private _withServerRetry;
 }
+declare const isKnownV2Model: (model: string | undefined) => boolean;
 declare const getCognitiveV2Model: (model: string) => Model | undefined;
 
-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 };
+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, isKnownV2Model };

package/dist/index.mjs

@@ -2332,6 +2332,23 @@ var CognitiveBeta = class _CognitiveBeta {
     );
   }
 };
+var COGNITIVE_V2_PROVIDERS = /* @__PURE__ */ new Set([
+  "openai",
+  "anthropic",
+  "google-ai",
+  "groq",
+  "cerebras",
+  "fireworks-ai",
+  "xai",
+  "openrouter"
+]);
+var isKnownV2Model = (model) => {
+  if (!model || ["auto", "best", "fast"].includes(model)) {
+    return true;
+  }
+  const provider = model.split(":")[0];
+  return !!provider && COGNITIVE_V2_PROVIDERS.has(provider);
+};
 var getCognitiveV2Model = (model) => {
   if (models[model]) {
     return models[model];
@@ -2603,6 +2620,9 @@ var Cognitive = class _Cognitive {
   _downtimes = [];
   _useBeta = false;
   _debug = false;
+  _remoteModelCache = /* @__PURE__ */ new Map();
+  _remoteModelCacheTime = 0;
+  _remoteModelCachePending = null;
   _events = createNanoEvents();
   constructor(props) {
     this._client = getExtendedClient(props.client);
@@ -2626,6 +2646,9 @@ var Cognitive = class _Cognitive {
     copy._models = [...this._models];
     copy._preferences = this._preferences ? { ...this._preferences } : null;
     copy._downtimes = [...this._downtimes];
+    copy._remoteModelCache = new Map(this._remoteModelCache);
+    copy._remoteModelCacheTime = this._remoteModelCacheTime;
+    copy._remoteModelCachePending = null;
     copy.interceptors.request = this.interceptors.request;
     copy.interceptors.response = this.interceptors.response;
     return copy;
@@ -2688,12 +2711,50 @@ var Cognitive = class _Cognitive {
     }
     return parseRef(pickModel([ref, ...preferences.best, ...preferences.fast], downtimes));
   }
+  async fetchRemoteModels() {
+    if (this._remoteModelCacheTime > 0 && Date.now() - this._remoteModelCacheTime < 60 * 60 * 1e3) {
+      return this._remoteModelCache;
+    }
+    if (this._remoteModelCachePending !== null) {
+      return this._remoteModelCachePending;
+    }
+    this._remoteModelCachePending = this._doFetchRemoteModels().finally(() => {
+      this._remoteModelCachePending = null;
+    });
+    return this._remoteModelCachePending;
+  }
+  async _doFetchRemoteModels() {
+    const betaClient = new CognitiveBeta(this._client.config);
+    const remoteModels = await betaClient.listModels();
+    this._remoteModelCache.clear();
+    this._remoteModelCacheTime = Date.now();
+    for (const m of remoteModels) {
+      const converted = { ...m, ref: m.id, integration: "cognitive-v2" };
+      this._remoteModelCache.set(m.id, converted);
+      if (m.aliases) {
+        for (const alias of m.aliases) {
+          this._remoteModelCache.set(alias, converted);
+        }
+      }
+    }
+    return this._remoteModelCache;
+  }
   async getModelDetails(model) {
     if (this._useBeta) {
       const resolvedModel = getCognitiveV2Model(model);
       if (resolvedModel) {
         return { ...resolvedModel, ref: resolvedModel.id, integration: "cognitive-v2" };
       }
+      if (isKnownV2Model(model)) {
+        try {
+          const remoteModels = await this.fetchRemoteModels();
+          const found = remoteModels.get(model);
+          if (found) {
+            return found;
+          }
+        } catch {
+        }
+      }
     }
     await this.fetchInstalledModels();
     const { integration, model: modelName } = await this._selectModel(model);
@@ -2704,12 +2765,23 @@ var Cognitive = class _Cognitive {
     return def;
   }
   async generateContent(input) {
-    if (!this._useBeta || !input.model || !getCognitiveV2Model(input.model)) {
+    if (!this._useBeta || !isKnownV2Model(input.model)) {
+      return this._generateContent(input);
+    }
+    try {
+      return await this._generateContentV2(input);
+    } catch (err) {
+      if (input.signal?.aborted) {
+        throw err;
+      }
       return this._generateContent(input);
     }
-    if (input.systemPrompt) {
-      input.messages.unshift({ role: "system", content: input.systemPrompt });
-      delete input.systemPrompt;
+  }
+  async _generateContentV2(input) {
+    const v2Input = { ...input, messages: [...input.messages] };
+    if (v2Input.systemPrompt) {
+      v2Input.messages.unshift({ role: "system", content: v2Input.systemPrompt });
+      delete v2Input.systemPrompt;
     }
     const betaClient = new CognitiveBeta(this._client.config);
     const props = { input };
@@ -2722,7 +2794,7 @@ var Cognitive = class _Cognitive {
     betaClient.on("retry", (_req, error) => {
       this._events.emit("retry", props, error);
     });
-    const response = await betaClient.generateText(input, {
+    const response = await betaClient.generateText(v2Input, {
       signal: input.signal,
       timeout: this._timeoutMs
     });
@@ -2737,7 +2809,7 @@ var Cognitive = class _Cognitive {
             content: response.output,
             role: "assistant",
             index: 0,
-            stopReason: response.metadata.stopReason
+            stopReason: response.metadata.stopReason ?? "stop"
           }
         ],
         usage: {
@@ -2843,6 +2915,7 @@ export {
   CognitiveBeta,
   ModelProvider,
   RemoteModelProvider,
-  getCognitiveV2Model
+  getCognitiveV2Model,
+  isKnownV2Model
 };
 //# sourceMappingURL=index.mjs.map