@naturali/sdk 0.133.0 → 0.133.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -420,6 +420,8 @@ type ErrorResponse = {
420
420
  };
421
421
  /**
422
422
  * 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 and knowledge search.
423
+ *
424
+ * 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.
423
425
  */
424
426
  type TagBag = {
425
427
  [key: string]: string;
@@ -2343,6 +2345,10 @@ type ConversationRecord = {
2343
2345
  * Actor ID associated with this conversation
2344
2346
  */
2345
2347
  actor_id?: string | null;
2348
+ /**
2349
+ * 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`.
2350
+ */
2351
+ retrieval?: 'embed' | 'none' | null;
2346
2352
  };
2347
2353
  type ConversationMessageRecord = {
2348
2354
  /**
@@ -11246,6 +11252,10 @@ type CreateConversationData = {
11246
11252
  * Actor ID to associate with this conversation
11247
11253
  */
11248
11254
  actor_id?: string | null;
11255
+ /**
11256
+ * 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`.
11257
+ */
11258
+ retrieval?: 'embed' | 'none' | null;
11249
11259
  };
11250
11260
  path: {
11251
11261
  /**
@@ -11362,6 +11372,10 @@ type UpdateConversationData = {
11362
11372
  * New conversation name
11363
11373
  */
11364
11374
  name?: string | null;
11375
+ /**
11376
+ * 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.
11377
+ */
11378
+ retrieval?: 'embed' | 'none' | null;
11365
11379
  };
11366
11380
  path: {
11367
11381
  /**
@@ -11798,7 +11812,7 @@ type CreateDocumentData = {
11798
11812
  body: {
11799
11813
  content: string;
11800
11814
  /**
11801
- * Logical path within the project (e.g. /reports/q1.txt). Defaults to /filename if omitted.
11815
+ * 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.
11802
11816
  */
11803
11817
  path?: string;
11804
11818
  filename?: string;
@@ -13475,6 +13489,10 @@ type ListFilesData = {
13475
13489
  project_id: string;
13476
13490
  };
13477
13491
  query?: {
13492
+ /**
13493
+ * 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.
13494
+ */
13495
+ path_prefix?: string;
13478
13496
  /**
13479
13497
  * 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.
13480
13498
  *
package/dist/index.d.mts CHANGED
@@ -420,6 +420,8 @@ type ErrorResponse = {
420
420
  };
421
421
  /**
422
422
  * 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 and knowledge search.
423
+ *
424
+ * 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.
423
425
  */
424
426
  type TagBag = {
425
427
  [key: string]: string;
@@ -2343,6 +2345,10 @@ type ConversationRecord = {
2343
2345
  * Actor ID associated with this conversation
2344
2346
  */
2345
2347
  actor_id?: string | null;
2348
+ /**
2349
+ * 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`.
2350
+ */
2351
+ retrieval?: 'embed' | 'none' | null;
2346
2352
  };
2347
2353
  type ConversationMessageRecord = {
2348
2354
  /**
@@ -11246,6 +11252,10 @@ type CreateConversationData = {
11246
11252
  * Actor ID to associate with this conversation
11247
11253
  */
11248
11254
  actor_id?: string | null;
11255
+ /**
11256
+ * 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`.
11257
+ */
11258
+ retrieval?: 'embed' | 'none' | null;
11249
11259
  };
11250
11260
  path: {
11251
11261
  /**
@@ -11362,6 +11372,10 @@ type UpdateConversationData = {
11362
11372
  * New conversation name
11363
11373
  */
11364
11374
  name?: string | null;
11375
+ /**
11376
+ * 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.
11377
+ */
11378
+ retrieval?: 'embed' | 'none' | null;
11365
11379
  };
11366
11380
  path: {
11367
11381
  /**
@@ -11798,7 +11812,7 @@ type CreateDocumentData = {
11798
11812
  body: {
11799
11813
  content: string;
11800
11814
  /**
11801
- * Logical path within the project (e.g. /reports/q1.txt). Defaults to /filename if omitted.
11815
+ * 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.
11802
11816
  */
11803
11817
  path?: string;
11804
11818
  filename?: string;
@@ -13475,6 +13489,10 @@ type ListFilesData = {
13475
13489
  project_id: string;
13476
13490
  };
13477
13491
  query?: {
13492
+ /**
13493
+ * 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.
13494
+ */
13495
+ path_prefix?: string;
13478
13496
  /**
13479
13497
  * 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.
13480
13498
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@naturali/sdk",
3
- "version": "0.133.0",
3
+ "version": "0.133.1",
4
4
  "description": "TypeScript SDK for the naturali.ai API, generated from its OpenAPI specs",
5
5
  "type": "module",
6
6
  "sideEffects": false,
@@ -31,7 +31,7 @@
31
31
  },
32
32
  "devDependencies": {
33
33
  "@hey-api/openapi-ts": "^0.99.0",
34
- "@naturali/api": "0.133.0",
34
+ "@naturali/api": "0.133.1",
35
35
  "@ttoss/openapi-codegen": "^0.3.1",
36
36
  "@types/node": "^26.5.1",
37
37
  "tsdown": "^0.23.0",