@breign/client 1.0.149 → 1.0.150

package/dist/models/ChatUio.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ConversationContextUsageUio } from './ConversationContextUsageUio';
 import type { TokenUsageUio } from './TokenUsageUio';
 import type { ChatContextUio } from './ChatContextUio';
 import type { ChatMessageUio } from './ChatMessageUio';
@@ -96,6 +97,12 @@ export interface ChatUio {
      * @memberof ChatUio
      */
     usage?: TokenUsageUio;
+    /**
+     *
+     * @type {ConversationContextUsageUio}
+     * @memberof ChatUio
+     */
+    contextUsage?: ConversationContextUsageUio;
     /**
      *
      * @type {string}

package/dist/models/ChatUio.js

@@ -19,6 +19,7 @@ exports.ChatUioFromJSON = ChatUioFromJSON;
 exports.ChatUioFromJSONTyped = ChatUioFromJSONTyped;
 exports.ChatUioToJSON = ChatUioToJSON;
 exports.ChatUioToJSONTyped = ChatUioToJSONTyped;
+const ConversationContextUsageUio_1 = require("./ConversationContextUsageUio");
 const TokenUsageUio_1 = require("./TokenUsageUio");
 const ChatContextUio_1 = require("./ChatContextUio");
 const ChatMessageUio_1 = require("./ChatMessageUio");
@@ -70,6 +71,7 @@ function ChatUioFromJSONTyped(json, ignoreDiscriminator) {
         'init': json['init'] == null ? undefined : json['init'],
         'messages': (json['messages'].map(ChatMessageUio_1.ChatMessageUioFromJSON)),
         'usage': json['usage'] == null ? undefined : (0, TokenUsageUio_1.TokenUsageUioFromJSON)(json['usage']),
+        'contextUsage': json['contextUsage'] == null ? undefined : (0, ConversationContextUsageUio_1.ConversationContextUsageUioFromJSON)(json['contextUsage']),
         'createdAt': json['createdAt'],
         'updatedAt': json['updatedAt'],
         'context': (0, ChatContextUio_1.ChatContextUioFromJSON)(json['context']),
@@ -96,6 +98,7 @@ function ChatUioToJSONTyped(value, ignoreDiscriminator = false) {
         'init': value['init'],
         'messages': (value['messages'].map(ChatMessageUio_1.ChatMessageUioToJSON)),
         'usage': (0, TokenUsageUio_1.TokenUsageUioToJSON)(value['usage']),
+        'contextUsage': (0, ConversationContextUsageUio_1.ConversationContextUsageUioToJSON)(value['contextUsage']),
         'createdAt': value['createdAt'],
         'updatedAt': value['updatedAt'],
         'context': (0, ChatContextUio_1.ChatContextUioToJSON)(value['context']),

package/dist/models/ConversationContextUsageUio.d.ts

@@ -0,0 +1,59 @@
+/**
+ * brain-client
+ * Api ands models for brain-app and brain-app
+ *
+ * The version of the OpenAPI document: 0.0.0-SNAPSHOT
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * How much of the model's context window this conversation occupies: the prompt of the last generation call, not the conversation's cumulated token count. Absent until a turn has been measured — an unmeasured conversation has an unknown occupancy, not an empty window.
+ * @export
+ * @interface ConversationContextUsageUio
+ */
+export interface ConversationContextUsageUio {
+    /**
+     * Prompt of the last generation call, in tokens, as reported by the provider. Always > 0.
+     * @type {number}
+     * @memberof ConversationContextUsageUio
+     */
+    usedTokens: number;
+    /**
+     * Context window of the conversation's model, in tokens. Always greater than 0.
+     * @type {number}
+     * @memberof ConversationContextUsageUio
+     */
+    contextWindow: number;
+    /**
+     * Where the window above comes from. `declared`: carried by the model definition. `catalog`: known to the backend only. `fallback`: unknown, shown as an approximation.
+     * @type {string}
+     * @memberof ConversationContextUsageUio
+     */
+    contextWindowConfidence: ConversationContextUsageUioContextWindowConfidenceEnum;
+    /**
+     * Model the conversation runs on, absent when its engine reference resolves to none.
+     * @type {string}
+     * @memberof ConversationContextUsageUio
+     */
+    modelName?: string;
+}
+/**
+ * @export
+ */
+export declare const ConversationContextUsageUioContextWindowConfidenceEnum: {
+    readonly Declared: "declared";
+    readonly Catalog: "catalog";
+    readonly Fallback: "fallback";
+};
+export type ConversationContextUsageUioContextWindowConfidenceEnum = typeof ConversationContextUsageUioContextWindowConfidenceEnum[keyof typeof ConversationContextUsageUioContextWindowConfidenceEnum];
+/**
+ * Check if a given object implements the ConversationContextUsageUio interface.
+ */
+export declare function instanceOfConversationContextUsageUio(value: object): value is ConversationContextUsageUio;
+export declare function ConversationContextUsageUioFromJSON(json: any): ConversationContextUsageUio;
+export declare function ConversationContextUsageUioFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationContextUsageUio;
+export declare function ConversationContextUsageUioToJSON(json: any): ConversationContextUsageUio;
+export declare function ConversationContextUsageUioToJSONTyped(value?: ConversationContextUsageUio | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ConversationContextUsageUio.js

@@ -0,0 +1,69 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * brain-client
+ * Api ands models for brain-app and brain-app
+ *
+ * The version of the OpenAPI document: 0.0.0-SNAPSHOT
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConversationContextUsageUioContextWindowConfidenceEnum = void 0;
+exports.instanceOfConversationContextUsageUio = instanceOfConversationContextUsageUio;
+exports.ConversationContextUsageUioFromJSON = ConversationContextUsageUioFromJSON;
+exports.ConversationContextUsageUioFromJSONTyped = ConversationContextUsageUioFromJSONTyped;
+exports.ConversationContextUsageUioToJSON = ConversationContextUsageUioToJSON;
+exports.ConversationContextUsageUioToJSONTyped = ConversationContextUsageUioToJSONTyped;
+/**
+ * @export
+ */
+exports.ConversationContextUsageUioContextWindowConfidenceEnum = {
+    Declared: 'declared',
+    Catalog: 'catalog',
+    Fallback: 'fallback'
+};
+/**
+ * Check if a given object implements the ConversationContextUsageUio interface.
+ */
+function instanceOfConversationContextUsageUio(value) {
+    if (!('usedTokens' in value) || value['usedTokens'] === undefined)
+        return false;
+    if (!('contextWindow' in value) || value['contextWindow'] === undefined)
+        return false;
+    if (!('contextWindowConfidence' in value) || value['contextWindowConfidence'] === undefined)
+        return false;
+    return true;
+}
+function ConversationContextUsageUioFromJSON(json) {
+    return ConversationContextUsageUioFromJSONTyped(json, false);
+}
+function ConversationContextUsageUioFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'usedTokens': json['usedTokens'],
+        'contextWindow': json['contextWindow'],
+        'contextWindowConfidence': json['contextWindowConfidence'],
+        'modelName': json['modelName'] == null ? undefined : json['modelName'],
+    };
+}
+function ConversationContextUsageUioToJSON(json) {
+    return ConversationContextUsageUioToJSONTyped(json, false);
+}
+function ConversationContextUsageUioToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'usedTokens': value['usedTokens'],
+        'contextWindow': value['contextWindow'],
+        'contextWindowConfidence': value['contextWindowConfidence'],
+        'modelName': value['modelName'],
+    };
+}

package/dist/models/MessageStatusUio.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { MessageStatusErrorUio } from './MessageStatusErrorUio';
+import type { ConversationContextUsageUio } from './ConversationContextUsageUio';
 import type { MessageStatusToolCallUio } from './MessageStatusToolCallUio';
 import type { ToolUsedUio } from './ToolUsedUio';
 /**
@@ -18,6 +19,12 @@ import type { ToolUsedUio } from './ToolUsedUio';
  * @interface MessageStatusUio
  */
 export interface MessageStatusUio {
+    /**
+     *
+     * @type {ConversationContextUsageUio}
+     * @memberof MessageStatusUio
+     */
+    contextUsage?: ConversationContextUsageUio;
     /**
      *
      * @type {string}

package/dist/models/MessageStatusUio.js

@@ -20,6 +20,7 @@ exports.MessageStatusUioFromJSONTyped = MessageStatusUioFromJSONTyped;
 exports.MessageStatusUioToJSON = MessageStatusUioToJSON;
 exports.MessageStatusUioToJSONTyped = MessageStatusUioToJSONTyped;
 const MessageStatusErrorUio_1 = require("./MessageStatusErrorUio");
+const ConversationContextUsageUio_1 = require("./ConversationContextUsageUio");
 const MessageStatusToolCallUio_1 = require("./MessageStatusToolCallUio");
 const ToolUsedUio_1 = require("./ToolUsedUio");
 /**
@@ -45,6 +46,7 @@ function MessageStatusUioFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'contextUsage': json['contextUsage'] == null ? undefined : (0, ConversationContextUsageUio_1.ConversationContextUsageUioFromJSON)(json['contextUsage']),
         'status': json['status'],
         'content': json['content'] == null ? undefined : json['content'],
         'reasoning': json['reasoning'] == null ? undefined : json['reasoning'],
@@ -62,6 +64,7 @@ function MessageStatusUioToJSONTyped(value, ignoreDiscriminator = false) {
         return value;
     }
     return {
+        'contextUsage': (0, ConversationContextUsageUio_1.ConversationContextUsageUioToJSON)(value['contextUsage']),
         'status': value['status'],
         'content': value['content'],
         'reasoning': value['reasoning'],

package/dist/models/index.d.ts

@@ -170,6 +170,7 @@ export * from './ContextUio';
 export * from './ContextualKnowledgeConversationEmbeddingUio';
 export * from './ContextualKnowledgeConversationUio';
 export * from './ConversationAttachmentDownloadUrlUio';
+export * from './ConversationContextUsageUio';
 export * from './ConversationDetailUio';
 export * from './ConversationMessageApprovalUio';
 export * from './ConversationMessagesInnerFlowNodeEntrypointsUio';

package/dist/models/index.js

@@ -188,6 +188,7 @@ __exportStar(require("./ContextUio"), exports);
 __exportStar(require("./ContextualKnowledgeConversationEmbeddingUio"), exports);
 __exportStar(require("./ContextualKnowledgeConversationUio"), exports);
 __exportStar(require("./ConversationAttachmentDownloadUrlUio"), exports);
+__exportStar(require("./ConversationContextUsageUio"), exports);
 __exportStar(require("./ConversationDetailUio"), exports);
 __exportStar(require("./ConversationMessageApprovalUio"), exports);
 __exportStar(require("./ConversationMessagesInnerFlowNodeEntrypointsUio"), exports);

package/dist/openapi.json

@@ -17254,6 +17254,9 @@
           "usage" : {
             "$ref" : "#/components/schemas/TokenUsage"
           },
+          "contextUsage" : {
+            "$ref" : "#/components/schemas/ConversationContextUsage"
+          },
           "createdAt" : {
             "type" : "string"
           },
@@ -17540,6 +17543,34 @@
         "required" : [ "inputTokens", "outputTokens", "reasoningTokens", "totalTokens" ],
         "type" : "object"
       },
+      "ConversationContextUsage" : {
+        "additionalProperties" : false,
+        "description" : "How much of the model's context window this conversation occupies: the prompt of the last generation call, not the conversation's cumulated token count. Absent until a turn has been measured — an unmeasured conversation has an unknown occupancy, not an empty window.",
+        "properties" : {
+          "usedTokens" : {
+            "description" : "Prompt of the last generation call, in tokens, as reported by the provider. Always > 0.",
+            "example" : 18342,
+            "type" : "number"
+          },
+          "contextWindow" : {
+            "description" : "Context window of the conversation's model, in tokens. Always greater than 0.",
+            "example" : 128000,
+            "type" : "number"
+          },
+          "contextWindowConfidence" : {
+            "description" : "Where the window above comes from. `declared`: carried by the model definition. `catalog`: known to the backend only. `fallback`: unknown, shown as an approximation.",
+            "enum" : [ "declared", "catalog", "fallback" ],
+            "type" : "string"
+          },
+          "modelName" : {
+            "description" : "Model the conversation runs on, absent when its engine reference resolves to none.",
+            "type" : "string"
+          }
+        },
+        "required" : [ "contextWindow", "contextWindowConfidence", "usedTokens" ],
+        "title" : "ConversationContextUsage",
+        "type" : "object"
+      },
       "ChatContext" : {
         "properties" : {
           "attachments" : {
@@ -22037,6 +22068,9 @@
       },
       "MessageStatus" : {
         "properties" : {
+          "contextUsage" : {
+            "$ref" : "#/components/schemas/ConversationContextUsage"
+          },
           "status" : {
             "type" : "string"
           },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breign/client",
-  "version": "1.0.149",
+  "version": "1.0.150",
   "main": "dist/index.js",
   "exports": {
     ".": "./dist/index.js",