@botpress/cognitive 0.3.7 → 0.3.9

package/.turbo/turbo-build.log

@@ -1,19 +1,19 @@
 
-> @botpress/cognitive@0.3.7 build /home/runner/work/botpress/botpress/packages/cognitive
+> @botpress/cognitive@0.3.9 build /home/runner/work/botpress/botpress/packages/cognitive
 > pnpm build:type && pnpm build:neutral && size-limit
 
 
-> @botpress/cognitive@0.3.7 build:type /home/runner/work/botpress/botpress/packages/cognitive
+> @botpress/cognitive@0.3.9 build:type /home/runner/work/botpress/botpress/packages/cognitive
 > tsup --tsconfig tsconfig.build.json ./src/index.ts --dts-resolve --dts-only --clean
 
 CLI Building entry: ./src/index.ts
 CLI Using tsconfig: tsconfig.build.json
 CLI tsup v8.0.2
 DTS Build start
-DTS ⚡️ Build success in 7067ms
-DTS dist/index.d.ts 663.58 KB
+DTS ⚡️ Build success in 6954ms
+DTS dist/index.d.ts 665.56 KB
 
-> @botpress/cognitive@0.3.7 build:neutral /home/runner/work/botpress/botpress/packages/cognitive
+> @botpress/cognitive@0.3.9 build:neutral /home/runner/work/botpress/botpress/packages/cognitive
 > ts-node -T ./build.ts --neutral
 
 Done

package/dist/index.d.ts

@@ -49,6 +49,7 @@ type GenerateContentInput = {
     topP?: number;
     /** Sequences where the model should stop generating further tokens. */
     stopSequences?: string[];
+    /** List of tools available for the model to use */
     tools?: Array<{
         type: 'function';
         function: {
@@ -59,14 +60,17 @@ type GenerateContentInput = {
             argumentsSchema?: {};
         };
     }>;
+    /** The chosen tool to use for content generation */
     toolChoice?: {
         type?: 'auto' | 'specific' | 'any' | 'none' | '';
         /** Required if `type` is "specific" */
         functionName?: string;
     };
+    /** Unique identifier of the user that sent the prompt */
     userId?: string;
     /** Set to `true` to output debug information to the bot logs */
     debug?: boolean;
+    /** Contextual metadata about the prompt */
     meta?: {
         /** Source of the prompt, e.g. agent/:id/:version cards/ai-generate, cards/ai-task, nodes/autonomous, etc. */
         promptSource?: string;
@@ -80,8 +84,9 @@ type GenerateContentOutput = {
     id: string;
     /** LLM provider name */
     provider: string;
-    /** Model name */
+    /** The name of the LLM model that was used */
     model: string;
+    /** Array of generated message choices from the model */
     choices: Array<{
         type?: 'text' | 'tool_calls' | 'tool_result' | 'multipart';
         /** Required if `type` is "tool_calls" */
@@ -112,6 +117,7 @@ type GenerateContentOutput = {
         index: number;
         stopReason: 'stop' | 'max_tokens' | 'tool_calls' | 'content_filter' | 'other';
     }>;
+    /** A breakdown of token usage and cost information */
     usage: {
         /** Number of input tokens used by the model */
         inputTokens: number;
@@ -122,12 +128,14 @@ type GenerateContentOutput = {
         /** Cost of the output tokens generated by the model, in U.S. dollars */
         outputCost: number;
     };
+    /** Metadata added by Botpress */
     botpress: {
         /** Total cost of the content generation, in U.S. dollars */
         cost: number;
     };
 };
 type Model$2 = {
+    /** Unique identifier of the large language model */
     id: string;
     name: string;
     description: string;
@@ -4418,6 +4426,52 @@ type TrackAnalyticsInput = TrackAnalyticsRequestBody & TrackAnalyticsRequestHead
 interface TrackAnalyticsResponse {
 }
 
+interface CaptureObservationRequestHeaders {
+}
+interface CaptureObservationRequestQuery {
+}
+interface CaptureObservationRequestParams {
+}
+interface CaptureObservationRequestBody {
+    /**
+     * Name of the observation
+     */
+    name: string;
+    /**
+     * Data of the observation
+     */
+    data: {
+        [k: string]: any;
+    };
+    /**
+     * ID of the message associated with the observation
+     */
+    messageId?: string;
+    /**
+     * ID of the event associated with the observation
+     */
+    eventId?: string;
+    /**
+     * ID of the conversation associated with the observation
+     */
+    conversationId?: string;
+    /**
+     * ID of the user associated with the observation
+     */
+    userId?: string;
+    /**
+     * ID of the error associated with the observation
+     */
+    errorId?: string;
+    /**
+     * ID of the trace associated with the observation
+     */
+    traceId?: string;
+}
+type CaptureObservationInput = CaptureObservationRequestBody & CaptureObservationRequestHeaders & CaptureObservationRequestQuery & CaptureObservationRequestParams;
+interface CaptureObservationResponse {
+}
+
 interface RunVrlRequestHeaders {
 }
 interface RunVrlRequestQuery {
@@ -6882,7 +6936,7 @@ interface CreateBotRequestBody {
         name: string;
     }[];
     /**
-     * URL of the [Bot](#schema_bot); Only available for dev bots
+     * URL of the [Bot](#schema_bot)
      */
     url?: string;
     /**
@@ -7316,9 +7370,9 @@ interface UpdateBotRequestParams {
 }
 interface UpdateBotRequestBody {
     /**
-     * URL of the [Bot](#schema_bot); Only available for dev bots
+     * URL of the [Bot](#schema_bot)
      */
-    url?: string;
+    url?: string | null;
     /**
      * Type of the [Bot](#schema_bot) authentication (`iam`)
      */
@@ -8631,6 +8685,9 @@ interface ListActionRunsResponse {
          * ISO 8601 timestamp of the action run
          */
         timestamp: string;
+        /**
+         * Alias of the integration instance used for this action run
+         */
         integrationName?: string;
         actionType: string;
         /**
@@ -8639,12 +8696,20 @@ interface ListActionRunsResponse {
         input: {
             [k: string]: any;
         };
+        /**
+         * Present if the length of the action's input exceeds 190 KB.
+         */
+        inputTruncated?: boolean;
         /**
          * Output of the action
          */
         output: {
             [k: string]: any;
         } | null;
+        /**
+         * Present if the length of the action's output exceeds 190 KB.
+         */
+        outputTruncated?: boolean;
         status: "SUCCESS" | "FAILURE";
         durationMs: number;
         cached: boolean;
@@ -9170,7 +9235,7 @@ interface CreateWorkspaceResponse {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    billingVersion: "v1" | "v2" | "v3";
+    billingVersion: "v1" | "v2" | "v3" | "v4";
     plan: "community" | "team" | "enterprise" | "plus";
     blocked: boolean;
     spendingLimit: number;
@@ -9224,7 +9289,7 @@ interface GetWorkspaceResponse {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    billingVersion: "v1" | "v2" | "v3";
+    billingVersion: "v1" | "v2" | "v3" | "v4";
     plan: "community" | "team" | "enterprise" | "plus";
     blocked: boolean;
     spendingLimit: number;
@@ -9396,7 +9461,7 @@ interface UpdateWorkspaceResponse$1 {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    billingVersion: "v1" | "v2" | "v3";
+    billingVersion: "v1" | "v2" | "v3" | "v4";
     plan: "community" | "team" | "enterprise" | "plus";
     blocked: boolean;
     spendingLimit: number;
@@ -9453,7 +9518,7 @@ interface UpdateWorkspaceResponse {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    billingVersion: "v1" | "v2" | "v3";
+    billingVersion: "v1" | "v2" | "v3" | "v4";
     plan: "community" | "team" | "enterprise" | "plus";
     blocked: boolean;
     spendingLimit: number;
@@ -18552,6 +18617,7 @@ declare class Client$1 {
     readonly getOrCreateWorkflow: (input: GetOrCreateWorkflowInput) => Promise<GetOrCreateWorkflowResponse>;
     readonly listTagValues: (input: ListTagValuesInput) => Promise<ListTagValuesResponse>;
     readonly trackAnalytics: (input: TrackAnalyticsInput) => Promise<TrackAnalyticsResponse>;
+    readonly captureObservation: (input: CaptureObservationInput) => Promise<CaptureObservationResponse>;
     readonly runVrl: (input: RunVrlInput) => Promise<RunVrlResponse>;
     readonly getAccount: (input: GetAccountInput) => Promise<GetAccountResponse>;
     readonly updateAccount: (input: UpdateAccountInput) => Promise<UpdateAccountResponse>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/cognitive",
-  "version": "0.3.7",
+  "version": "0.3.9",
   "description": "Wrapper around the Botpress Client to call LLMs",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",