@breign/client 1.0.161 → 1.0.162

package/dist/apis/AgentApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AddModuleRequestUio, AdvancedFlowEditorUio, AdvancedFlowEditorUpdateRequestUio, AgentDuplicateRequestUio, AgentFlowCreateUio, AgentFlowUio, AgentImportRequestUio, AgentImportResponseUio, AgentMetricsEventUio, AgentMetricsOverviewUio, AgentModuleUio, AgentPatchUio, AgentRequestUio, AgentSubscriptionUio, AgentToolAllowedMethodsRequestUio, AgentUio, AgentUsageMetricsUio, BodyWithIdUio, ChatUio, ConversationAttachmentDownloadUrlUio, DeleteMessageAudio200ResponseUio, EphemeralInstancesMetricsResponseUio, FileCreationRequestUio, FileCreationResponseUio, FlowEditorUio, FlowEditorUpdateRequestUio, MessageAudioDownloadUrlUio, OrgUsageMetricsResponseUio, S3UploadBodyUio, STTResponseUio } from '../models/index';
+import type { AddModuleRequestUio, AdvancedFlowEditorUio, AdvancedFlowEditorUpdateRequestUio, AgentDuplicateRequestUio, AgentFlowCreateUio, AgentFlowUio, AgentImportRequestUio, AgentImportResponseUio, AgentMetricsEventUio, AgentMetricsOverviewUio, AgentModuleUio, AgentPatchUio, AgentRequestUio, AgentSubscriptionUio, AgentToolAllowedMethodsRequestUio, AgentUio, AgentUsageMetricsUio, BodyWithIdUio, ChatUio, ConversationAttachmentDownloadUrlUio, ConversationMessageImagesUio, DeleteMessageAudio200ResponseUio, EphemeralInstancesMetricsResponseUio, FileCreationRequestUio, FileCreationResponseUio, FlowEditorUio, FlowEditorUpdateRequestUio, MessageAudioDownloadUrlUio, OrgUsageMetricsResponseUio, S3UploadBodyUio, STTResponseUio } from '../models/index';
 export interface AddModuleRequest {
     agentId: string;
     addModuleRequestUio: AddModuleRequestUio;
@@ -104,6 +104,11 @@ export interface GetConversationContextAttachmentDownloadUrlRequest {
     conversationId: string;
     attachmentId: string;
 }
+export interface GetConversationMessageImagesRequest {
+    agentId: string;
+    conversationId: string;
+    messageId: string;
+}
 export interface GetConversationsForAgentRequest {
     agentId: string;
     page?: number;
@@ -400,6 +405,16 @@ export declare class AgentApi extends runtime.BaseAPI {
      * Get presigned download URL for a conversation context attachment
      */
     getConversationContextAttachmentDownloadUrl(agentId: string, conversationId: string, attachmentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAttachmentDownloadUrlUio>;
+    /**
+     * Returns the images of documents the language model received while answering, with presigned URLs created on each call. For an assistant message, the images of every tool message of its turn; for a tool (System) message, its own. Returns an empty list for a turn without images. Call this when displaying a message\'s \"consulted images\" block, live or in history.
+     * Get the document images the agent was given in a conversation turn
+     */
+    getConversationMessageImagesRaw(requestParameters: GetConversationMessageImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationMessageImagesUio>>;
+    /**
+     * Returns the images of documents the language model received while answering, with presigned URLs created on each call. For an assistant message, the images of every tool message of its turn; for a tool (System) message, its own. Returns an empty list for a turn without images. Call this when displaying a message\'s \"consulted images\" block, live or in history.
+     * Get the document images the agent was given in a conversation turn
+     */
+    getConversationMessageImages(agentId: string, conversationId: string, messageId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationMessageImagesUio>;
     /**
      * Get conversations for an agent
      * Get conversations for an agent

package/dist/apis/AgentApi.js

@@ -742,6 +742,41 @@ class AgentApi extends runtime.BaseAPI {
         const response = await this.getConversationContextAttachmentDownloadUrlRaw({ agentId: agentId, conversationId: conversationId, attachmentId: attachmentId }, initOverrides);
         return await response.value();
     }
+    /**
+     * Returns the images of documents the language model received while answering, with presigned URLs created on each call. For an assistant message, the images of every tool message of its turn; for a tool (System) message, its own. Returns an empty list for a turn without images. Call this when displaying a message\'s \"consulted images\" block, live or in history.
+     * Get the document images the agent was given in a conversation turn
+     */
+    async getConversationMessageImagesRaw(requestParameters, initOverrides) {
+        if (requestParameters['agentId'] == null) {
+            throw new runtime.RequiredError('agentId', 'Required parameter "agentId" was null or undefined when calling getConversationMessageImages().');
+        }
+        if (requestParameters['conversationId'] == null) {
+            throw new runtime.RequiredError('conversationId', 'Required parameter "conversationId" was null or undefined when calling getConversationMessageImages().');
+        }
+        if (requestParameters['messageId'] == null) {
+            throw new runtime.RequiredError('messageId', 'Required parameter "messageId" was null or undefined when calling getConversationMessageImages().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+        const response = await this.request({
+            path: `/agents/{agentId}/conversations/{conversationId}/messages/{messageId}/images`.replace(`{${"agentId"}}`, encodeURIComponent(String(requestParameters['agentId']))).replace(`{${"conversationId"}}`, encodeURIComponent(String(requestParameters['conversationId']))).replace(`{${"messageId"}}`, encodeURIComponent(String(requestParameters['messageId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ConversationMessageImagesUioFromJSON)(jsonValue));
+    }
+    /**
+     * Returns the images of documents the language model received while answering, with presigned URLs created on each call. For an assistant message, the images of every tool message of its turn; for a tool (System) message, its own. Returns an empty list for a turn without images. Call this when displaying a message\'s \"consulted images\" block, live or in history.
+     * Get the document images the agent was given in a conversation turn
+     */
+    async getConversationMessageImages(agentId, conversationId, messageId, initOverrides) {
+        const response = await this.getConversationMessageImagesRaw({ agentId: agentId, conversationId: conversationId, messageId: messageId }, initOverrides);
+        return await response.value();
+    }
     /**
      * Get conversations for an agent
      * Get conversations for an agent

package/dist/models/ConversationMessageImageUio.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface ConversationMessageImageUio
+ */
+export interface ConversationMessageImageUio {
+    /**
+     * Identifier of the image within its document (16 hexadecimal characters)
+     * @type {string}
+     * @memberof ConversationMessageImageUio
+     */
+    imageId: string;
+    /**
+     * Alternative text of the image, empty when the document gives none
+     * @type {string}
+     * @memberof ConversationMessageImageUio
+     */
+    alt: string;
+    /**
+     * Presigned download URL, short-lived and created on each call
+     * @type {string}
+     * @memberof ConversationMessageImageUio
+     */
+    url: string;
+}
+/**
+ * Check if a given object implements the ConversationMessageImageUio interface.
+ */
+export declare function instanceOfConversationMessageImageUio(value: object): value is ConversationMessageImageUio;
+export declare function ConversationMessageImageUioFromJSON(json: any): ConversationMessageImageUio;
+export declare function ConversationMessageImageUioFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationMessageImageUio;
+export declare function ConversationMessageImageUioToJSON(json: any): ConversationMessageImageUio;
+export declare function ConversationMessageImageUioToJSONTyped(value?: ConversationMessageImageUio | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ConversationMessageImageUio.js

@@ -0,0 +1,58 @@
+"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.instanceOfConversationMessageImageUio = instanceOfConversationMessageImageUio;
+exports.ConversationMessageImageUioFromJSON = ConversationMessageImageUioFromJSON;
+exports.ConversationMessageImageUioFromJSONTyped = ConversationMessageImageUioFromJSONTyped;
+exports.ConversationMessageImageUioToJSON = ConversationMessageImageUioToJSON;
+exports.ConversationMessageImageUioToJSONTyped = ConversationMessageImageUioToJSONTyped;
+/**
+ * Check if a given object implements the ConversationMessageImageUio interface.
+ */
+function instanceOfConversationMessageImageUio(value) {
+    if (!('imageId' in value) || value['imageId'] === undefined)
+        return false;
+    if (!('alt' in value) || value['alt'] === undefined)
+        return false;
+    if (!('url' in value) || value['url'] === undefined)
+        return false;
+    return true;
+}
+function ConversationMessageImageUioFromJSON(json) {
+    return ConversationMessageImageUioFromJSONTyped(json, false);
+}
+function ConversationMessageImageUioFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'imageId': json['imageId'],
+        'alt': json['alt'],
+        'url': json['url'],
+    };
+}
+function ConversationMessageImageUioToJSON(json) {
+    return ConversationMessageImageUioToJSONTyped(json, false);
+}
+function ConversationMessageImageUioToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'imageId': value['imageId'],
+        'alt': value['alt'],
+        'url': value['url'],
+    };
+}

package/dist/models/ConversationMessageImagesUio.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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.
+ */
+import type { ConversationMessageImageUio } from './ConversationMessageImageUio';
+/**
+ *
+ * @export
+ * @interface ConversationMessageImagesUio
+ */
+export interface ConversationMessageImagesUio {
+    /**
+     *
+     * @type {Array<ConversationMessageImageUio>}
+     * @memberof ConversationMessageImagesUio
+     */
+    images: Array<ConversationMessageImageUio>;
+}
+/**
+ * Check if a given object implements the ConversationMessageImagesUio interface.
+ */
+export declare function instanceOfConversationMessageImagesUio(value: object): value is ConversationMessageImagesUio;
+export declare function ConversationMessageImagesUioFromJSON(json: any): ConversationMessageImagesUio;
+export declare function ConversationMessageImagesUioFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationMessageImagesUio;
+export declare function ConversationMessageImagesUioToJSON(json: any): ConversationMessageImagesUio;
+export declare function ConversationMessageImagesUioToJSONTyped(value?: ConversationMessageImagesUio | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ConversationMessageImagesUio.js

@@ -0,0 +1,51 @@
+"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.instanceOfConversationMessageImagesUio = instanceOfConversationMessageImagesUio;
+exports.ConversationMessageImagesUioFromJSON = ConversationMessageImagesUioFromJSON;
+exports.ConversationMessageImagesUioFromJSONTyped = ConversationMessageImagesUioFromJSONTyped;
+exports.ConversationMessageImagesUioToJSON = ConversationMessageImagesUioToJSON;
+exports.ConversationMessageImagesUioToJSONTyped = ConversationMessageImagesUioToJSONTyped;
+const ConversationMessageImageUio_1 = require("./ConversationMessageImageUio");
+/**
+ * Check if a given object implements the ConversationMessageImagesUio interface.
+ */
+function instanceOfConversationMessageImagesUio(value) {
+    if (!('images' in value) || value['images'] === undefined)
+        return false;
+    return true;
+}
+function ConversationMessageImagesUioFromJSON(json) {
+    return ConversationMessageImagesUioFromJSONTyped(json, false);
+}
+function ConversationMessageImagesUioFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'images': (json['images'].map(ConversationMessageImageUio_1.ConversationMessageImageUioFromJSON)),
+    };
+}
+function ConversationMessageImagesUioToJSON(json) {
+    return ConversationMessageImagesUioToJSONTyped(json, false);
+}
+function ConversationMessageImagesUioToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'images': (value['images'].map(ConversationMessageImageUio_1.ConversationMessageImageUioToJSON)),
+    };
+}

package/dist/models/index.d.ts

@@ -188,6 +188,8 @@ export * from './ConversationDetailUio';
 export * from './ConversationHumanRequestRequestedByUio';
 export * from './ConversationHumanRequestUio';
 export * from './ConversationMessageApprovalUio';
+export * from './ConversationMessageImageUio';
+export * from './ConversationMessageImagesUio';
 export * from './ConversationMessagesInnerFlowNodeEntrypointsUio';
 export * from './ConversationMessagesInnerFlowNodeUio';
 export * from './ConversationMessagesInnerSuggestionsInnerUio';

package/dist/models/index.js

@@ -206,6 +206,8 @@ __exportStar(require("./ConversationDetailUio"), exports);
 __exportStar(require("./ConversationHumanRequestRequestedByUio"), exports);
 __exportStar(require("./ConversationHumanRequestUio"), exports);
 __exportStar(require("./ConversationMessageApprovalUio"), exports);
+__exportStar(require("./ConversationMessageImageUio"), exports);
+__exportStar(require("./ConversationMessageImagesUio"), exports);
 __exportStar(require("./ConversationMessagesInnerFlowNodeEntrypointsUio"), exports);
 __exportStar(require("./ConversationMessagesInnerFlowNodeUio"), exports);
 __exportStar(require("./ConversationMessagesInnerSuggestionsInnerUio"), exports);

package/dist/openapi.json

@@ -2349,6 +2349,61 @@
         "tags" : [ "agent" ]
       }
     },
+    "/agents/{agentId}/conversations/{conversationId}/messages/{messageId}/images" : {
+      "get" : {
+        "description" : "Returns the images of documents the language model received while answering, with presigned\nURLs created on each call. For an assistant message, the images of every tool message of its\nturn; for a tool (System) message, its own. Returns an empty list for a turn without images.\nCall this when displaying a message's \"consulted images\" block, live or in history.\n",
+        "operationId" : "getConversationMessageImages",
+        "parameters" : [ {
+          "description" : "ID of the agent",
+          "in" : "path",
+          "name" : "agentId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        }, {
+          "description" : "The ID of the conversation",
+          "in" : "path",
+          "name" : "conversationId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "description" : "The ID of the message",
+          "in" : "path",
+          "name" : "messageId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/ConversationMessageImages"
+                }
+              }
+            },
+            "description" : "The images of the turn, each with a short-lived presigned URL"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User doesn't have access to this agent"
+          },
+          "404" : {
+            "description" : "Agent, conversation, or message not found, or the message is a user message"
+          }
+        },
+        "summary" : "Get the document images the agent was given in a conversation turn",
+        "tags" : [ "agent" ]
+      }
+    },
     "/agents/{agentId}/scheduled-tasks" : {
       "get" : {
         "operationId" : "listScheduledTasks",
@@ -16396,6 +16451,15 @@
           "type" : "string"
         }
       },
+      "messageIdPath" : {
+        "description" : "The ID of the message",
+        "in" : "path",
+        "name" : "messageId",
+        "required" : true,
+        "schema" : {
+          "type" : "string"
+        }
+      },
       "taskIdPath" : {
         "description" : "ID of the scheduled task",
         "in" : "path",
@@ -16691,15 +16755,6 @@
           "type" : "boolean"
         }
       },
-      "messageIdPath" : {
-        "description" : "The ID of the message",
-        "in" : "path",
-        "name" : "messageId",
-        "required" : true,
-        "schema" : {
-          "type" : "string"
-        }
-      },
       "languagePath" : {
         "description" : "Language code",
         "in" : "path",
@@ -18994,6 +19049,36 @@
         "required" : [ "url" ],
         "type" : "object"
       },
+      "ConversationMessageImages" : {
+        "properties" : {
+          "images" : {
+            "items" : {
+              "$ref" : "#/components/schemas/ConversationMessageImage"
+            },
+            "type" : "array"
+          }
+        },
+        "required" : [ "images" ],
+        "type" : "object"
+      },
+      "ConversationMessageImage" : {
+        "properties" : {
+          "imageId" : {
+            "description" : "Identifier of the image within its document (16 hexadecimal characters)",
+            "type" : "string"
+          },
+          "alt" : {
+            "description" : "Alternative text of the image, empty when the document gives none",
+            "type" : "string"
+          },
+          "url" : {
+            "description" : "Presigned download URL, short-lived and created on each call",
+            "type" : "string"
+          }
+        },
+        "required" : [ "alt", "imageId", "url" ],
+        "type" : "object"
+      },
       "ScheduledTaskList" : {
         "properties" : {
           "tasks" : {

package/package.json

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