@breign/client 1.0.82 → 1.0.84

package/dist/apis/KnowledgeApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AgentModuleUio, BodyWithMessageUio, DocumentAddRequestUio, FileCreationRequestUio, FileCreationResponseUio, FileStatusUio, FileStatusUpdateRequestUio, FileWithDownloadUrlUio, ImageKnowledgeUio, ImportFileToAgentKnowledge200ResponseUio, KnowledgeBaseUio, KnowledgeBaseWithFilesUio, KnowledgeFileSummaryUio, KnowledgeFilesByIdsRequestUio, S3UploadBodyUio } from '../models/index';
+import type { AgentModuleUio, BodyWithMessageUio, DocumentAddRequestUio, FileCreationRequestUio, FileCreationResponseUio, FileStatusUio, FileStatusUpdateRequestUio, FileWithDownloadUrlUio, ImageKnowledgeUio, ImportFileToAgentKnowledge200ResponseUio, KnowledgeBaseConfigurationUio, KnowledgeBaseUio, KnowledgeBaseWithFilesUio, KnowledgeFilePagePreviewUio, KnowledgeFileSummaryUio, KnowledgeFilesByIdsRequestUio, S3UploadBodyUio } from '../models/index';
 export interface AddDocumentToKnowledgeBaseRequest {
     agentId: string;
     documentAddRequestUio: DocumentAddRequestUio;
@@ -56,6 +56,16 @@ export interface GetImagesFromKnowledgeBaseLibraryRequest {
 export interface GetInactiveKnowledgeFileIdsRequest {
     knowledgebaseId: string;
 }
+export interface GetKnowledgeBaseConfigurationRequest {
+    knowledgebaseId: string;
+}
+export interface GetKnowledgeFileRequest {
+    fileId: string;
+}
+export interface GetKnowledgeFilePagePreviewRequest {
+    fileId: string;
+    pageIndex: number;
+}
 export interface GetKnowledgeFilesByIdsRequest {
     knowledgeFilesByIdsRequestUio: KnowledgeFilesByIdsRequestUio;
 }
@@ -86,6 +96,14 @@ export interface UpdateImageStatusInKnowledgeBaseLibraryRequest {
     imageId: string;
     fileStatusUpdateRequestUio: FileStatusUpdateRequestUio;
 }
+export interface UpdateKnowledgeBaseConfigurationRequest {
+    knowledgebaseId: string;
+    knowledgeBaseConfigurationUio: KnowledgeBaseConfigurationUio;
+}
+export interface UpdateKnowledgeFileStatusRequest {
+    fileId: string;
+    fileStatusUpdateRequestUio: FileStatusUpdateRequestUio;
+}
 export interface UploadImageToKnowledgeBaseLibraryRequest {
     knowledgebaseId: string;
     image: Blob;
@@ -204,6 +222,36 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
      * Get inactive knowledge file IDs for a knowledge base
      */
     getInactiveKnowledgeFileIds(knowledgebaseId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
+    /**
+     * Returns the current configuration for a knowledge base
+     * Get knowledge base configuration
+     */
+    getKnowledgeBaseConfigurationRaw(requestParameters: GetKnowledgeBaseConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<KnowledgeBaseConfigurationUio>>;
+    /**
+     * Returns the current configuration for a knowledge base
+     * Get knowledge base configuration
+     */
+    getKnowledgeBaseConfiguration(knowledgebaseId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<KnowledgeBaseConfigurationUio>;
+    /**
+     * Retrieves metadata for a specific knowledge file by file ID
+     * Get a specific knowledge file
+     */
+    getKnowledgeFileRaw(requestParameters: GetKnowledgeFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileWithDownloadUrlUio>>;
+    /**
+     * Retrieves metadata for a specific knowledge file by file ID
+     * Get a specific knowledge file
+     */
+    getKnowledgeFile(fileId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileWithDownloadUrlUio>;
+    /**
+     * Returns a presigned URL to preview a specific page image (ColPali knowledge bases only).
+     * Get a presigned preview URL for a knowledge file page
+     */
+    getKnowledgeFilePagePreviewRaw(requestParameters: GetKnowledgeFilePagePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<KnowledgeFilePagePreviewUio>>;
+    /**
+     * Returns a presigned URL to preview a specific page image (ColPali knowledge bases only).
+     * Get a presigned preview URL for a knowledge file page
+     */
+    getKnowledgeFilePagePreview(fileId: string, pageIndex: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<KnowledgeFilePagePreviewUio>;
     /**
      * Returns knowledge file summaries (id and name) for the given file IDs.
      * Get knowledge files by IDs
@@ -284,6 +332,30 @@ export declare class KnowledgeApi extends runtime.BaseAPI {
      * Update the status of a specific knowledge image in a library image in knowledge base
      */
     updateImageStatusInKnowledgeBaseLibrary(knowledgebaseId: string, imageId: string, fileStatusUpdateRequestUio: FileStatusUpdateRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileStatusUio>;
+    /**
+     * Updates the module configuration for a knowledge base
+     * Update knowledge base configuration
+     */
+    updateKnowledgeBaseConfigurationRaw(requestParameters: UpdateKnowledgeBaseConfigurationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Updates the module configuration for a knowledge base
+     * Update knowledge base configuration
+     */
+    updateKnowledgeBaseConfiguration(knowledgebaseId: string, knowledgeBaseConfigurationUio: KnowledgeBaseConfigurationUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Updates the status of a knowledge file and triggers indexing when uploaded
+     * Update knowledge file status
+     */
+    updateKnowledgeFileStatusRaw(requestParameters: UpdateKnowledgeFileStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>>;
+    /**
+     * Updates the status of a knowledge file and triggers indexing when uploaded
+     * Update knowledge file status
+     */
+    updateKnowledgeFileStatus(fileId: string, fileStatusUpdateRequestUio: FileStatusUpdateRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
     /**
      * Upload a new image to a library image in knowledge base and return the upload URL
      * Upload a new image to a library image in knowledge base

package/dist/apis/KnowledgeApi.js

@@ -410,6 +410,99 @@ class KnowledgeApi extends runtime.BaseAPI {
         const response = await this.getInactiveKnowledgeFileIdsRaw({ knowledgebaseId: knowledgebaseId }, initOverrides);
         return await response.value();
     }
+    /**
+     * Returns the current configuration for a knowledge base
+     * Get knowledge base configuration
+     */
+    async getKnowledgeBaseConfigurationRaw(requestParameters, initOverrides) {
+        if (requestParameters['knowledgebaseId'] == null) {
+            throw new runtime.RequiredError('knowledgebaseId', 'Required parameter "knowledgebaseId" was null or undefined when calling getKnowledgeBaseConfiguration().');
+        }
+        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: `/knowledge-bases/{knowledgebaseId}/configuration`.replace(`{${"knowledgebaseId"}}`, encodeURIComponent(String(requestParameters['knowledgebaseId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.KnowledgeBaseConfigurationUioFromJSON)(jsonValue));
+    }
+    /**
+     * Returns the current configuration for a knowledge base
+     * Get knowledge base configuration
+     */
+    async getKnowledgeBaseConfiguration(knowledgebaseId, initOverrides) {
+        const response = await this.getKnowledgeBaseConfigurationRaw({ knowledgebaseId: knowledgebaseId }, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Retrieves metadata for a specific knowledge file by file ID
+     * Get a specific knowledge file
+     */
+    async getKnowledgeFileRaw(requestParameters, initOverrides) {
+        if (requestParameters['fileId'] == null) {
+            throw new runtime.RequiredError('fileId', 'Required parameter "fileId" was null or undefined when calling getKnowledgeFile().');
+        }
+        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: `/knowledge-files/{fileId}`.replace(`{${"fileId"}}`, encodeURIComponent(String(requestParameters['fileId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FileWithDownloadUrlUioFromJSON)(jsonValue));
+    }
+    /**
+     * Retrieves metadata for a specific knowledge file by file ID
+     * Get a specific knowledge file
+     */
+    async getKnowledgeFile(fileId, initOverrides) {
+        const response = await this.getKnowledgeFileRaw({ fileId: fileId }, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Returns a presigned URL to preview a specific page image (ColPali knowledge bases only).
+     * Get a presigned preview URL for a knowledge file page
+     */
+    async getKnowledgeFilePagePreviewRaw(requestParameters, initOverrides) {
+        if (requestParameters['fileId'] == null) {
+            throw new runtime.RequiredError('fileId', 'Required parameter "fileId" was null or undefined when calling getKnowledgeFilePagePreview().');
+        }
+        if (requestParameters['pageIndex'] == null) {
+            throw new runtime.RequiredError('pageIndex', 'Required parameter "pageIndex" was null or undefined when calling getKnowledgeFilePagePreview().');
+        }
+        const queryParameters = {};
+        if (requestParameters['pageIndex'] != null) {
+            queryParameters['pageIndex'] = requestParameters['pageIndex'];
+        }
+        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: `/knowledge-files/{fileId}/page-preview`.replace(`{${"fileId"}}`, encodeURIComponent(String(requestParameters['fileId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.KnowledgeFilePagePreviewUioFromJSON)(jsonValue));
+    }
+    /**
+     * Returns a presigned URL to preview a specific page image (ColPali knowledge bases only).
+     * Get a presigned preview URL for a knowledge file page
+     */
+    async getKnowledgeFilePagePreview(fileId, pageIndex, initOverrides) {
+        const response = await this.getKnowledgeFilePagePreviewRaw({ fileId: fileId, pageIndex: pageIndex }, initOverrides);
+        return await response.value();
+    }
     /**
      * Returns knowledge file summaries (id and name) for the given file IDs.
      * Get knowledge files by IDs
@@ -690,6 +783,79 @@ class KnowledgeApi extends runtime.BaseAPI {
         const response = await this.updateImageStatusInKnowledgeBaseLibraryRaw({ knowledgebaseId: knowledgebaseId, imageId: imageId, fileStatusUpdateRequestUio: fileStatusUpdateRequestUio }, initOverrides);
         return await response.value();
     }
+    /**
+     * Updates the module configuration for a knowledge base
+     * Update knowledge base configuration
+     */
+    async updateKnowledgeBaseConfigurationRaw(requestParameters, initOverrides) {
+        if (requestParameters['knowledgebaseId'] == null) {
+            throw new runtime.RequiredError('knowledgebaseId', 'Required parameter "knowledgebaseId" was null or undefined when calling updateKnowledgeBaseConfiguration().');
+        }
+        if (requestParameters['knowledgeBaseConfigurationUio'] == null) {
+            throw new runtime.RequiredError('knowledgeBaseConfigurationUio', 'Required parameter "knowledgeBaseConfigurationUio" was null or undefined when calling updateKnowledgeBaseConfiguration().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        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: `/knowledge-bases/{knowledgebaseId}/configuration`.replace(`{${"knowledgebaseId"}}`, encodeURIComponent(String(requestParameters['knowledgebaseId']))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.KnowledgeBaseConfigurationUioToJSON)(requestParameters['knowledgeBaseConfigurationUio']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response);
+    }
+    /**
+     * Updates the module configuration for a knowledge base
+     * Update knowledge base configuration
+     */
+    async updateKnowledgeBaseConfiguration(knowledgebaseId, knowledgeBaseConfigurationUio, initOverrides) {
+        const response = await this.updateKnowledgeBaseConfigurationRaw({ knowledgebaseId: knowledgebaseId, knowledgeBaseConfigurationUio: knowledgeBaseConfigurationUio }, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Updates the status of a knowledge file and triggers indexing when uploaded
+     * Update knowledge file status
+     */
+    async updateKnowledgeFileStatusRaw(requestParameters, initOverrides) {
+        if (requestParameters['fileId'] == null) {
+            throw new runtime.RequiredError('fileId', 'Required parameter "fileId" was null or undefined when calling updateKnowledgeFileStatus().');
+        }
+        if (requestParameters['fileStatusUpdateRequestUio'] == null) {
+            throw new runtime.RequiredError('fileStatusUpdateRequestUio', 'Required parameter "fileStatusUpdateRequestUio" was null or undefined when calling updateKnowledgeFileStatus().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        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: `/knowledge-files/{fileId}/status`.replace(`{${"fileId"}}`, encodeURIComponent(String(requestParameters['fileId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.FileStatusUpdateRequestUioToJSON)(requestParameters['fileStatusUpdateRequestUio']),
+        }, initOverrides);
+        if (this.isJsonMime(response.headers.get('content-type'))) {
+            return new runtime.JSONApiResponse(response);
+        }
+        else {
+            return new runtime.TextApiResponse(response);
+        }
+    }
+    /**
+     * Updates the status of a knowledge file and triggers indexing when uploaded
+     * Update knowledge file status
+     */
+    async updateKnowledgeFileStatus(fileId, fileStatusUpdateRequestUio, initOverrides) {
+        const response = await this.updateKnowledgeFileStatusRaw({ fileId: fileId, fileStatusUpdateRequestUio: fileStatusUpdateRequestUio }, initOverrides);
+        return await response.value();
+    }
     /**
      * Upload a new image to a library image in knowledge base and return the upload URL
      * Upload a new image to a library image in knowledge base

package/dist/apis/SkillsApi.d.ts

@@ -0,0 +1,115 @@
+/**
+ * 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 * as runtime from '../runtime';
+import type { SkillAssignRequestUio, SkillCreateRequestUio, SkillUio, SkillUpdateRequestUio } from '../models/index';
+export interface AssignSkillToAgentRequest {
+    agentId: string;
+    skillAssignRequestUio: SkillAssignRequestUio;
+}
+export interface CreateSkillRequest {
+    skillCreateRequestUio: SkillCreateRequestUio;
+}
+export interface DeleteSkillRequest {
+    skillId: string;
+}
+export interface GetAgentSkillsRequest {
+    agentId: string;
+}
+export interface GetSkillRequest {
+    skillId: string;
+}
+export interface ListSkillsRequest {
+    organizationId: string;
+    page?: number;
+    limit?: number;
+}
+export interface UnassignSkillFromAgentRequest {
+    agentId: string;
+    skillId: string;
+}
+export interface UpdateSkillRequest {
+    skillId: string;
+    skillUpdateRequestUio: SkillUpdateRequestUio;
+}
+/**
+ *
+ */
+export declare class SkillsApi extends runtime.BaseAPI {
+    /**
+     * Assign a skill to an agent
+     */
+    assignSkillToAgentRaw(requestParameters: AssignSkillToAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Assign a skill to an agent
+     */
+    assignSkillToAgent(agentId: string, skillAssignRequestUio: SkillAssignRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates a new skill in an organization
+     * Create a skill
+     */
+    createSkillRaw(requestParameters: CreateSkillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SkillUio>>;
+    /**
+     * Creates a new skill in an organization
+     * Create a skill
+     */
+    createSkill(skillCreateRequestUio: SkillCreateRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SkillUio>;
+    /**
+     * Delete a skill
+     */
+    deleteSkillRaw(requestParameters: DeleteSkillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a skill
+     */
+    deleteSkill(skillId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get skills assigned to an agent
+     */
+    getAgentSkillsRaw(requestParameters: GetAgentSkillsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SkillUio>>>;
+    /**
+     * Get skills assigned to an agent
+     */
+    getAgentSkills(agentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SkillUio>>;
+    /**
+     * Get a skill by ID
+     */
+    getSkillRaw(requestParameters: GetSkillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SkillUio>>;
+    /**
+     * Get a skill by ID
+     */
+    getSkill(skillId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SkillUio>;
+    /**
+     * Returns a paginated list of skills scoped to an organization
+     * List skills in an organization
+     */
+    listSkillsRaw(requestParameters: ListSkillsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SkillUio>>>;
+    /**
+     * Returns a paginated list of skills scoped to an organization
+     * List skills in an organization
+     */
+    listSkills(organizationId: string, page?: number, limit?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SkillUio>>;
+    /**
+     * Unassign a skill from an agent
+     */
+    unassignSkillFromAgentRaw(requestParameters: UnassignSkillFromAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Unassign a skill from an agent
+     */
+    unassignSkillFromAgent(agentId: string, skillId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Update a skill
+     */
+    updateSkillRaw(requestParameters: UpdateSkillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SkillUio>>;
+    /**
+     * Update a skill
+     */
+    updateSkill(skillId: string, skillUpdateRequestUio: SkillUpdateRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SkillUio>;
+}