@soat/sdk 0.54.0 → 0.55.0

package/dist/index.d.cts

@@ -1542,6 +1542,10 @@ type ConversationRecord = {
    * Actor ID associated with this conversation
    */
   actor_id?: string | null;
+  /**
+   * Whether this conversation's turns are embedded for vector retrieval. Turns are stored and chunked either way, so `none` leaves them readable and reachable by full-text search without paying for an embedding. `null` (the default) inherits the project's `default_conversation_retrieval`.
+   */
+  retrieval?: 'embed' | 'none' | null;
 };
 type ConversationMessageRecord = {
   /**
@@ -5267,6 +5271,10 @@ type ProjectRecord = {
    * Whether `GET` requests naming this project are recorded in the audit log. `false` by default — v1 audits mutations only.
    */
   audit_reads_enabled?: boolean;
+  /**
+   * What a conversation that names no `retrieval` of its own does. `none` by default.
+   */
+  default_conversation_retrieval?: 'embed' | 'none';
   /**
    * Days of trace/generation content retention before the daily sweep purges it. `null` means retention is disabled (the default) and content is kept until purged on demand.
    */
@@ -5642,6 +5650,8 @@ type SubmitSessionToolOutputsRequest = {
 };
 /**
  * Key-value labels on a resource. A flat object of string values — an array, a nested object or a number is rejected with `400 VALIDATION_FAILED`, never coerced. Keys are opaque and stored verbatim, so `cost_center` and `costCenter` are two different tags. Matched by JSONB containment wherever tags are read: the `?tags=` filter, knowledge search, and the IAM `soat:ResourceTag/<key>` condition.
+ *
+ * Keys beginning `system.` are reserved: the platform writes them to record which conversation, actor, agent and role a row came from, and a write naming one is refused with `400 RESERVED_TAG_KEY`. They are read and filtered like any other tag.
  */
 type TagBag = {
   [key: string]: string;
@@ -9345,6 +9355,10 @@ type CreateConversationData = {
      * Actor ID to associate with this conversation
      */
     actor_id?: string | null;
+    /**
+     * Whether this conversation's turns are embedded for vector retrieval. Turns are stored and chunked either way, so `none` leaves them readable and reachable by full-text search without paying for an embedding. `null` (the default) inherits the project's `default_conversation_retrieval`.
+     */
+    retrieval?: 'embed' | 'none' | null;
   };
   path?: never;
   query?: never;
@@ -9448,6 +9462,10 @@ type UpdateConversationData = {
      * New conversation name
      */
     name?: string | null;
+    /**
+     * Whether this conversation's turns are embedded for vector retrieval. Turns are stored and chunked either way, so `none` leaves them readable and reachable by full-text search without paying for an embedding. `null` (the default) inherits the project's `default_conversation_retrieval`. Switching it on embeds the turns already in the conversation, so the whole conversation becomes retrievable rather than only what is said next.
+     */
+    retrieval?: 'embed' | 'none' | null;
   };
   path: {
     /**
@@ -9855,7 +9873,7 @@ type CreateDocumentData = {
     project_id?: string;
     content: string;
     /**
-     * Logical path within the project (e.g. /reports/q1.txt). Defaults to /filename if omitted.
+     * Logical path within the project (e.g. /reports/q1.txt). Defaults to `/<filename>`, or to `/<document_id>.txt` when neither is given — a document with no path is reachable only by its id, since a prefix filter never matches null.
      */
     path?: string;
     filename?: string;
@@ -11463,6 +11481,10 @@ type ListFilesData = {
      * Filter files by project ID
      */
     project_id?: string;
+    /**
+     * Only files under this directory. The prefix is a path boundary, not a substring: `/reports` returns `/reports/q1.txt` and never `/reports-archive/q1.txt`, and `/` selects the whole project. A leading slash is optional and a trailing one is ignored, so `reports`, `/reports` and `/reports/` are the same filter. `%` and `_` are literal characters, not wildcards. Naming a directory under `/.system/` is what includes platform-written files, which a list without this parameter leaves out.
+     */
+    path_prefix?: string;
     /**
      * Filter by tag pairs, written `key:value` (split on the first colon, so a value may contain colons). Repeat the parameter for several pairs; **all** must be present with exactly that value.
      *
@@ -15437,6 +15459,10 @@ type UpdateProjectData = {
      * Opt the project into read auditing. When true, `GET` requests that name this project are recorded in the audit log alongside mutations. Defaults to `false`.
      */
     audit_reads_enabled?: boolean;
+    /**
+     * What a conversation that names no `retrieval` of its own does. `none` by default: a turn is embedded because someone asked for the conversation to be retrievable, never merely because it was said. Turns are stored and chunked on both settings.
+     */
+    default_conversation_retrieval?: 'embed' | 'none';
     /**
      * How long trace and generation content is kept before the daily retention sweep content-purges it. `null` (the default) disables retention; otherwise an integer >= 1. The sweep uses the same purge path as `DELETE /traces/{trace_id}/content`, so the row survives as an auditable skeleton with `content_redacted_at` set.
      */

package/dist/index.d.mts

@@ -1542,6 +1542,10 @@ type ConversationRecord = {
    * Actor ID associated with this conversation
    */
   actor_id?: string | null;
+  /**
+   * Whether this conversation's turns are embedded for vector retrieval. Turns are stored and chunked either way, so `none` leaves them readable and reachable by full-text search without paying for an embedding. `null` (the default) inherits the project's `default_conversation_retrieval`.
+   */
+  retrieval?: 'embed' | 'none' | null;
 };
 type ConversationMessageRecord = {
   /**
@@ -5267,6 +5271,10 @@ type ProjectRecord = {
    * Whether `GET` requests naming this project are recorded in the audit log. `false` by default — v1 audits mutations only.
    */
   audit_reads_enabled?: boolean;
+  /**
+   * What a conversation that names no `retrieval` of its own does. `none` by default.
+   */
+  default_conversation_retrieval?: 'embed' | 'none';
   /**
    * Days of trace/generation content retention before the daily sweep purges it. `null` means retention is disabled (the default) and content is kept until purged on demand.
    */
@@ -5642,6 +5650,8 @@ type SubmitSessionToolOutputsRequest = {
 };
 /**
  * Key-value labels on a resource. A flat object of string values — an array, a nested object or a number is rejected with `400 VALIDATION_FAILED`, never coerced. Keys are opaque and stored verbatim, so `cost_center` and `costCenter` are two different tags. Matched by JSONB containment wherever tags are read: the `?tags=` filter, knowledge search, and the IAM `soat:ResourceTag/<key>` condition.
+ *
+ * Keys beginning `system.` are reserved: the platform writes them to record which conversation, actor, agent and role a row came from, and a write naming one is refused with `400 RESERVED_TAG_KEY`. They are read and filtered like any other tag.
  */
 type TagBag = {
   [key: string]: string;
@@ -9345,6 +9355,10 @@ type CreateConversationData = {
      * Actor ID to associate with this conversation
      */
     actor_id?: string | null;
+    /**
+     * Whether this conversation's turns are embedded for vector retrieval. Turns are stored and chunked either way, so `none` leaves them readable and reachable by full-text search without paying for an embedding. `null` (the default) inherits the project's `default_conversation_retrieval`.
+     */
+    retrieval?: 'embed' | 'none' | null;
   };
   path?: never;
   query?: never;
@@ -9448,6 +9462,10 @@ type UpdateConversationData = {
      * New conversation name
      */
     name?: string | null;
+    /**
+     * Whether this conversation's turns are embedded for vector retrieval. Turns are stored and chunked either way, so `none` leaves them readable and reachable by full-text search without paying for an embedding. `null` (the default) inherits the project's `default_conversation_retrieval`. Switching it on embeds the turns already in the conversation, so the whole conversation becomes retrievable rather than only what is said next.
+     */
+    retrieval?: 'embed' | 'none' | null;
   };
   path: {
     /**
@@ -9855,7 +9873,7 @@ type CreateDocumentData = {
     project_id?: string;
     content: string;
     /**
-     * Logical path within the project (e.g. /reports/q1.txt). Defaults to /filename if omitted.
+     * Logical path within the project (e.g. /reports/q1.txt). Defaults to `/<filename>`, or to `/<document_id>.txt` when neither is given — a document with no path is reachable only by its id, since a prefix filter never matches null.
      */
     path?: string;
     filename?: string;
@@ -11463,6 +11481,10 @@ type ListFilesData = {
      * Filter files by project ID
      */
     project_id?: string;
+    /**
+     * Only files under this directory. The prefix is a path boundary, not a substring: `/reports` returns `/reports/q1.txt` and never `/reports-archive/q1.txt`, and `/` selects the whole project. A leading slash is optional and a trailing one is ignored, so `reports`, `/reports` and `/reports/` are the same filter. `%` and `_` are literal characters, not wildcards. Naming a directory under `/.system/` is what includes platform-written files, which a list without this parameter leaves out.
+     */
+    path_prefix?: string;
     /**
      * Filter by tag pairs, written `key:value` (split on the first colon, so a value may contain colons). Repeat the parameter for several pairs; **all** must be present with exactly that value.
      *
@@ -15437,6 +15459,10 @@ type UpdateProjectData = {
      * Opt the project into read auditing. When true, `GET` requests that name this project are recorded in the audit log alongside mutations. Defaults to `false`.
      */
     audit_reads_enabled?: boolean;
+    /**
+     * What a conversation that names no `retrieval` of its own does. `none` by default: a turn is embedded because someone asked for the conversation to be retrievable, never merely because it was said. Turns are stored and chunked on both settings.
+     */
+    default_conversation_retrieval?: 'embed' | 'none';
     /**
      * How long trace and generation content is kept before the daily retention sweep content-purges it. `null` (the default) disables retention; otherwise an integer >= 1. The sweep uses the same purge path as `DELETE /traces/{trace_id}/content`, so the row survives as an auditable skeleton with `content_redacted_at` set.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soat/sdk",
-  "version": "0.54.0",
+  "version": "0.55.0",
   "description": "TypeScript SDK for SOAT — open-source infrastructure for production-ready AI agents.",
   "keywords": [
     "ai-agents",