@breign/client 1.0.163 → 1.0.165

package/dist/openapi.json

@@ -1781,6 +1781,64 @@
         "tags" : [ "agent" ]
       }
     },
+    "/agents/{agentId}/prompt-init/generate" : {
+      "post" : {
+        "description" : "Writes a ready-to-use initialization prompt from a short brief, using the AI model configured on the agent (or, failing that, on its organisation). The result is returned only — it is never persisted on the agent, which is updated through PATCH /agents/{agentId}.\n",
+        "operationId" : "generateAgentPromptInit",
+        "parameters" : [ {
+          "description" : "ID of the agent",
+          "in" : "path",
+          "name" : "agentId",
+          "required" : true,
+          "schema" : {
+            "format" : "uuid",
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/AgentPromptInitGenerationRequest"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "201" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/AgentPromptInitGenerationResponse"
+                }
+              }
+            },
+            "description" : "Instructions generated successfully"
+          },
+          "400" : {
+            "description" : "Invalid request body"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User doesn't have access to this agent"
+          },
+          "404" : {
+            "description" : "Agent not found"
+          },
+          "409" : {
+            "description" : "No AI model is configured for this agent or its organisation"
+          },
+          "502" : {
+            "description" : "The model failed to produce usable instructions"
+          }
+        },
+        "summary" : "Generate initialization instructions for an agent",
+        "tags" : [ "agent" ]
+      }
+    },
     "/agents/{agentId}/tools/{toolId}" : {
       "delete" : {
         "description" : "Unlinks an organization tool from the specified agent",
@@ -10781,6 +10839,56 @@
       }
     },
     "/knowledge-files/{fileId}/knowledge-site-pages" : {
+      "delete" : {
+        "description" : "Removes every page located in `pathPrefix` or below it, along with its chunks and stored content. The pages are not excluded: the next resync brings them back.\n",
+        "operationId" : "deleteKnowledgeSitePagesUnderPath",
+        "parameters" : [ {
+          "description" : "The ID of the file",
+          "in" : "path",
+          "name" : "fileId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "description" : "Directory of the site, e.g. `/blog`",
+          "in" : "query",
+          "name" : "pathPrefix",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/KnowledgeSitePagesRemoval"
+                }
+              }
+            },
+            "description" : "Pages removed"
+          },
+          "400" : {
+            "description" : "Not a website, or empty `pathPrefix`"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User is not admin of the organization"
+          },
+          "404" : {
+            "description" : "Knowledge site or knowledge base not found"
+          },
+          "409" : {
+            "description" : "The directory holds every page of the site (`SITE_WOULD_BE_EMPTY`)"
+          }
+        },
+        "summary" : "Delete the knowledge site pages of a directory",
+        "tags" : [ "knowledge" ]
+      },
       "get" : {
         "description" : "Get the scraped site pages attached to a knowledge file of type website",
         "operationId" : "getKnowledgeSitePagesForFile",
@@ -10872,6 +10980,107 @@
         "tags" : [ "knowledge" ]
       }
     },
+    "/knowledge-files/{fileId}/scraping-exclusions" : {
+      "delete" : {
+        "description" : "The pages it covered are not scrapped again here: they come back with the next resync.\n",
+        "operationId" : "removeKnowledgeSiteExclusion",
+        "parameters" : [ {
+          "description" : "The ID of the file",
+          "in" : "path",
+          "name" : "fileId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "description" : "The exclusion to remove, as returned in `scrapingExclusions`",
+          "in" : "query",
+          "name" : "url",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/KnowledgeSiteExclusions"
+                }
+              }
+            },
+            "description" : "Exclusion removed"
+          },
+          "400" : {
+            "description" : "Not a website or invalid URL"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User is not admin of the organization"
+          },
+          "404" : {
+            "description" : "Knowledge site, knowledge base or exclusion not found"
+          }
+        },
+        "summary" : "Remove an exclusion from a scrapped site",
+        "tags" : [ "knowledge" ]
+      },
+      "post" : {
+        "description" : "Saves the URL among the site exclusions, which every resync applies, and removes the site pages it covers right away. An exclusion covers the URL and everything below it (`/blog` covers `/blog/a` but not `/blog-news`); an exclusion without a path covers the whole host. Adding a URL already excluded is a no-op.\n",
+        "operationId" : "addKnowledgeSiteExclusion",
+        "parameters" : [ {
+          "description" : "The ID of the file",
+          "in" : "path",
+          "name" : "fileId",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/AddKnowledgeSiteExclusionRequest"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/AddKnowledgeSiteExclusionResponse"
+                }
+              }
+            },
+            "description" : "Exclusion saved and covered pages removed"
+          },
+          "400" : {
+            "description" : "Not a website, invalid URL, URL outside the site, or too many exclusions"
+          },
+          "401" : {
+            "description" : "Unauthorized"
+          },
+          "403" : {
+            "description" : "Forbidden - User is not admin of the organization"
+          },
+          "404" : {
+            "description" : "Knowledge site or knowledge base not found"
+          },
+          "409" : {
+            "description" : "The exclusion covers every page of the site (`SITE_WOULD_BE_EMPTY`)"
+          }
+        },
+        "summary" : "Exclude a page or directory from a scrapped site",
+        "tags" : [ "knowledge" ]
+      }
+    },
     "/knowledge-files/{fileId}/status" : {
       "post" : {
         "description" : "Updates the status of a knowledge file and triggers indexing when uploaded",
@@ -18557,6 +18766,13 @@
           },
           "isActive" : {
             "type" : "boolean"
+          },
+          "scrapingExclusions" : {
+            "description" : "Websites only. URLs never scraped, each one along with everything below it, applied on every resync.\n",
+            "items" : {
+              "type" : "string"
+            },
+            "type" : "array"
           }
         },
         "required" : [ "id" ],
@@ -18664,6 +18880,80 @@
         "required" : [ "transcription" ],
         "type" : "object"
       },
+      "AgentPromptInitGenerationRequest" : {
+        "additionalProperties" : false,
+        "properties" : {
+          "mission" : {
+            "description" : "What the agent is for, in the user's own words.",
+            "maxLength" : 600,
+            "minLength" : 10,
+            "type" : "string"
+          },
+          "audiences" : {
+            "description" : "Who the agent talks to. Several may apply at once; duplicates are rejected. Omit it when `notes.audience` is given — a free-text note replaces the presets. Defaults to `employees` when neither is given. Not declared as `uniqueItems` because the TypeScript generator would turn the field into a `Set`, which does not survive a server-action boundary — the server-side schema enforces uniqueness.\n",
+            "items" : {
+              "enum" : [ "general_public", "customers", "employees", "experts" ],
+              "type" : "string"
+            },
+            "maxItems" : 4,
+            "minItems" : 1,
+            "type" : "array"
+          },
+          "answerStyle" : {
+            "default" : "concise",
+            "description" : "Omit it when `notes.answerStyle` is given. Defaults to `concise`.",
+            "enum" : [ "concise", "detailed", "step_by_step" ],
+            "type" : "string"
+          },
+          "sourcePolicy" : {
+            "default" : "provided_only",
+            "description" : "Omit it when `notes.sourcePolicy` is given. Defaults to `provided_only`.",
+            "enum" : [ "provided_only", "provided_and_general" ],
+            "type" : "string"
+          },
+          "notes" : {
+            "$ref" : "#/components/schemas/AgentPromptInitGenerationRequest_notes"
+          },
+          "constraints" : {
+            "description" : "What the agent must never do.",
+            "maxLength" : 600,
+            "type" : "string"
+          },
+          "lang" : {
+            "description" : "Language the instructions are written in. Defaults to the agent's.",
+            "pattern" : "^[a-z]{2}$",
+            "type" : "string"
+          },
+          "providerId" : {
+            "description" : "Engine to write with, instead of the agent's. Must belong to the agent's organisation. Only honoured together with `model`.\n",
+            "type" : "string"
+          },
+          "model" : {
+            "description" : "Model id within `providerId`.",
+            "type" : "string"
+          }
+        },
+        "required" : [ "mission" ],
+        "type" : "object"
+      },
+      "AgentPromptInitGenerationResponse" : {
+        "properties" : {
+          "promptInit" : {
+            "maxLength" : 50000,
+            "minLength" : 50,
+            "type" : "string"
+          },
+          "warnings" : {
+            "description" : "Adjustments applied to the model's output, for information only.",
+            "items" : {
+              "type" : "string"
+            },
+            "type" : "array"
+          }
+        },
+        "required" : [ "promptInit" ],
+        "type" : "object"
+      },
       "AgentToolAllowedMethodsRequest" : {
         "properties" : {
           "allowedMethods" : {
@@ -22910,6 +23200,58 @@
         "required" : [ "createdAt", "id", "isActive", "key", "knowledgeBaseId", "name", "siteId", "status", "updatedAt", "url" ],
         "type" : "object"
       },
+      "KnowledgeSitePagesRemoval" : {
+        "properties" : {
+          "removedPages" : {
+            "description" : "URLs of the removed pages",
+            "items" : {
+              "type" : "string"
+            },
+            "type" : "array"
+          },
+          "failedPages" : {
+            "description" : "URLs of the pages that could not be removed",
+            "items" : {
+              "type" : "string"
+            },
+            "type" : "array"
+          }
+        },
+        "required" : [ "failedPages", "removedPages" ],
+        "type" : "object"
+      },
+      "AddKnowledgeSiteExclusionRequest" : {
+        "additionalProperties" : false,
+        "properties" : {
+          "url" : {
+            "description" : "Page or directory of the site to exclude, e.g. `https://site.com/blog`",
+            "maxLength" : 2048,
+            "minLength" : 1,
+            "type" : "string"
+          }
+        },
+        "required" : [ "url" ],
+        "type" : "object"
+      },
+      "AddKnowledgeSiteExclusionResponse" : {
+        "allOf" : [ {
+          "$ref" : "#/components/schemas/KnowledgeSiteExclusions"
+        }, {
+          "$ref" : "#/components/schemas/KnowledgeSitePagesRemoval"
+        } ]
+      },
+      "KnowledgeSiteExclusions" : {
+        "properties" : {
+          "scrapingExclusions" : {
+            "items" : {
+              "type" : "string"
+            },
+            "type" : "array"
+          }
+        },
+        "required" : [ "scrapingExclusions" ],
+        "type" : "object"
+      },
       "KnowledgeFilesByIdsRequest" : {
         "properties" : {
           "ids" : {
@@ -26397,6 +26739,7 @@
             "type" : "string"
           },
           "excludeDomains" : {
+            "description" : "URLs to exclude, each one along with everything below it. Saved on the site when the crawl creates it. Ignored with `resync`, which applies the exclusions saved on the site.\n",
             "items" : {
               "type" : "string"
             },
@@ -26915,6 +27258,25 @@
         "required" : [ "x", "y" ],
         "type" : "object"
       },
+      "AgentPromptInitGenerationRequest_notes" : {
+        "additionalProperties" : false,
+        "description" : "What the user wrote themselves when no preset fitted, per question. A note REPLACES the presets of its own question rather than adding to them.\n",
+        "properties" : {
+          "audience" : {
+            "maxLength" : 300,
+            "type" : "string"
+          },
+          "answerStyle" : {
+            "maxLength" : 300,
+            "type" : "string"
+          },
+          "sourcePolicy" : {
+            "maxLength" : 300,
+            "type" : "string"
+          }
+        },
+        "type" : "object"
+      },
       "ChatMessage_audio_inner" : {
         "properties" : {
           "sequence" : {

package/package.json

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