@breign/client 1.0.83 → 1.0.85

package/dist/openapi.json

@@ -6084,6 +6084,185 @@
         "tags" : [ "knowledge" ]
       }
     },
+    "/knowledge-bases/{knowledgebaseId}/configuration" : {
+      "get" : {
+        "description" : "Returns the current configuration for a knowledge base",
+        "operationId" : "getKnowledgeBaseConfiguration",
+        "parameters" : [ {
+          "description" : "ID of the knowledge base to retrieve",
+          "in" : "path",
+          "name" : "knowledgebaseId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/KnowledgeBaseConfiguration"
+                }
+              }
+            },
+            "description" : "Configuration retrieved successfully"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "404" : {
+            "description" : "Knowledge base not found"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Get knowledge base configuration",
+        "tags" : [ "knowledge" ]
+      },
+      "put" : {
+        "description" : "Updates the module configuration for a knowledge base",
+        "operationId" : "updateKnowledgeBaseConfiguration",
+        "parameters" : [ {
+          "description" : "ID of the knowledge base to retrieve",
+          "in" : "path",
+          "name" : "knowledgebaseId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/KnowledgeBaseConfiguration"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "additionalProperties" : true,
+                  "type" : "object"
+                }
+              }
+            },
+            "description" : "Configuration updated successfully"
+          },
+          "400" : {
+            "description" : "Invalid configuration payload"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "404" : {
+            "description" : "Knowledge base not found"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Update knowledge base configuration",
+        "tags" : [ "knowledge" ]
+      }
+    },
+    "/knowledge-files/{fileId}" : {
+      "get" : {
+        "description" : "Retrieves metadata for a specific knowledge file by file ID",
+        "operationId" : "getKnowledgeFile",
+        "parameters" : [ {
+          "description" : "The ID of the file",
+          "in" : "path",
+          "name" : "fileId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/FileWithDownloadUrl"
+                }
+              }
+            },
+            "description" : "File details retrieved successfully"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "404" : {
+            "description" : "File not found"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Get a specific knowledge file",
+        "tags" : [ "knowledge" ]
+      }
+    },
+    "/knowledge-files/{fileId}/status" : {
+      "post" : {
+        "description" : "Updates the status of a knowledge file and triggers indexing when uploaded",
+        "operationId" : "updateKnowledgeFileStatus",
+        "parameters" : [ {
+          "description" : "The ID of the file",
+          "in" : "path",
+          "name" : "fileId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/FileStatusUpdateRequest"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/File"
+                }
+              }
+            },
+            "description" : "File status updated successfully"
+          },
+          "400" : {
+            "description" : "Invalid status update"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "404" : {
+            "description" : "File not found"
+          },
+          "500" : {
+            "description" : "Server error"
+          }
+        },
+        "summary" : "Update knowledge file status",
+        "tags" : [ "knowledge" ]
+      }
+    },
     "/knowledge-files/by-ids" : {
       "post" : {
         "description" : "Returns knowledge file summaries (id and name) for the given file IDs.",
@@ -6123,6 +6302,53 @@
         "tags" : [ "knowledge" ]
       }
     },
+    "/knowledge-files/{fileId}/page-preview" : {
+      "get" : {
+        "description" : "Returns a presigned URL to preview a specific page image (ColPali knowledge bases only).",
+        "operationId" : "getKnowledgeFilePagePreview",
+        "parameters" : [ {
+          "description" : "The ID of the file",
+          "in" : "path",
+          "name" : "fileId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "description" : "Zero-based page index.",
+          "in" : "query",
+          "name" : "pageIndex",
+          "required" : true,
+          "schema" : {
+            "minimum" : 0,
+            "type" : "integer"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/KnowledgeFilePagePreview"
+                }
+              }
+            },
+            "description" : "Presigned preview URL"
+          },
+          "400" : {
+            "description" : "Invalid page index or unsupported knowledge base type"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "404" : {
+            "description" : "File not found"
+          }
+        },
+        "summary" : "Get a presigned preview URL for a knowledge file page",
+        "tags" : [ "knowledge" ]
+      }
+    },
     "/tools" : {
       "get" : {
         "description" : "Returns tools matching optional search query, with pagination",
@@ -6696,6 +6922,49 @@
         "tags" : [ "tools" ]
       }
     },
+    "/tools/{toolId}/mcp/introspect" : {
+      "get" : {
+        "operationId" : "introspectMcpTool",
+        "parameters" : [ {
+          "description" : "Tool identifier",
+          "in" : "path",
+          "name" : "toolId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/introspectMcpTool_200_response"
+                }
+              }
+            },
+            "description" : "MCP introspection result"
+          },
+          "400" : {
+            "description" : "Tool configuration missing"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden"
+          },
+          "404" : {
+            "description" : "Tool not found"
+          },
+          "500" : {
+            "description" : "MCP introspection failed"
+          }
+        },
+        "summary" : "Introspect an MCP tool server to refresh available actions",
+        "tags" : [ "tools" ]
+      }
+    },
     "/skills" : {
       "get" : {
         "description" : "Returns a paginated list of skills scoped to an organization",
@@ -11175,6 +11444,84 @@
         "enum" : [ "SCRAPING", "PENDING", "UPLOADED", "PROCESSING", "INDEXED" ],
         "type" : "string"
       },
+      "KnowledgeBaseConfiguration" : {
+        "properties" : {
+          "host" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "scheme" : {
+            "enum" : [ "http", "https" ],
+            "nullable" : true,
+            "type" : "string"
+          },
+          "authentication" : {
+            "$ref" : "#/components/schemas/KnowledgeBaseConfiguration_authentication"
+          },
+          "indexName" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "colpaliKnowledgeBaseId" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "emptyKnowledgeResult" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "additionalInstructions" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "fusionType" : {
+            "enum" : [ "rankedFusion", "relativeScoreFusion" ],
+            "nullable" : true,
+            "type" : "string"
+          },
+          "toolDescription" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "toolParametersQueryDescription" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "scoreThreshold" : {
+            "nullable" : true,
+            "type" : "number"
+          },
+          "maxDocuments" : {
+            "nullable" : true,
+            "type" : "number"
+          },
+          "maxRetrievalLength" : {
+            "nullable" : true,
+            "type" : "number"
+          },
+          "vectorizerModel" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "vectorizerModelDimensions" : {
+            "nullable" : true,
+            "type" : "number"
+          },
+          "embeddingProviderId" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "embeddingModelId" : {
+            "nullable" : true,
+            "type" : "string"
+          },
+          "embeddingDimensions" : {
+            "nullable" : true,
+            "type" : "number"
+          }
+        },
+        "type" : "object"
+      },
       "KnowledgeFilesByIdsRequest" : {
         "properties" : {
           "ids" : {
@@ -11188,6 +11535,21 @@
         "required" : [ "ids" ],
         "type" : "object"
       },
+      "KnowledgeFilePagePreview" : {
+        "properties" : {
+          "url" : {
+            "type" : "string"
+          },
+          "key" : {
+            "type" : "string"
+          },
+          "pageIndex" : {
+            "type" : "integer"
+          }
+        },
+        "required" : [ "pageIndex", "url" ],
+        "type" : "object"
+      },
       "ToolCreateRequest" : {
         "additionalProperties" : false,
         "properties" : {
@@ -11925,6 +12287,25 @@
         "required" : [ "authorizationUrl" ],
         "type" : "object"
       },
+      "introspectMcpTool_200_response" : {
+        "properties" : {
+          "introspection" : {
+            "additionalProperties" : true,
+            "type" : "object"
+          },
+          "definition" : {
+            "additionalProperties" : true,
+            "type" : "object"
+          },
+          "allowedTools" : {
+            "items" : {
+              "type" : "string"
+            },
+            "type" : "array"
+          }
+        },
+        "type" : "object"
+      },
       "KnowledgeBase_files_inner" : {
         "properties" : {
           "id" : {
@@ -12594,6 +12975,28 @@
           "type" : "array"
         } ]
       },
+      "KnowledgeBaseConfiguration_authentication_oneOf" : {
+        "nullable" : true,
+        "properties" : {
+          "apiKey" : {
+            "type" : "string"
+          },
+          "type" : {
+            "enum" : [ "API_KEY" ],
+            "type" : "string"
+          }
+        },
+        "type" : "object"
+      },
+      "KnowledgeBaseConfiguration_authentication" : {
+        "oneOf" : [ {
+          "enum" : [ "NONE" ],
+          "nullable" : true,
+          "type" : "string"
+        }, {
+          "$ref" : "#/components/schemas/KnowledgeBaseConfiguration_authentication_oneOf"
+        } ]
+      },
       "ToolSecure_configuration" : {
         "additionalProperties" : true,
         "properties" : {

package/package.json

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