@soat/sdk 0.13.2 → 0.13.3

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
@@ -1265,7 +1265,11 @@ type DocumentRecord = {
1265
1265
  */
1266
1266
  size?: number;
1267
1267
  /**
1268
- * Text content (only present on getDocument)
1268
+ * Ingestion lifecycle state. `pending` enqueued; `processing` — chunks being extracted and embedded; `ready` — fully indexed; `failed` — processing error (see `metadata.failure_reason`).
1269
+ */
1270
+ status?: 'pending' | 'processing' | 'ready' | 'failed';
1271
+ /**
1272
+ * Text content (only present on getDocument, and only when status is ready)
1269
1273
  */
1270
1274
  content?: string | null;
1271
1275
  created_at?: Date;
@@ -2265,6 +2269,10 @@ type MemoryKnowledgeResult = {
2265
2269
  * Public ID of the parent memory
2266
2270
  */
2267
2271
  memory_id: string;
2272
+ /**
2273
+ * Human-readable name of the parent memory
2274
+ */
2275
+ memory_name: string;
2268
2276
  /**
2269
2277
  * Text content of the memory entry
2270
2278
  */
@@ -2567,7 +2575,7 @@ type NodeExecution = {
2567
2575
  * Type of the executed node (e.g. agent, transform).
2568
2576
  */
2569
2577
  node_type?: string | null;
2570
- status: 'completed' | 'failed' | 'requires_action';
2578
+ status: 'completed' | 'failed' | 'requires_action' | 'skipped';
2571
2579
  /**
2572
2580
  * Resolved input_mapping the node received.
2573
2581
  */
@@ -4953,12 +4961,17 @@ type IngestDocumentData = {
4953
4961
  chunk_overlap?: number;
4954
4962
  };
4955
4963
  path?: never;
4956
- query?: never;
4964
+ query?: {
4965
+ /**
4966
+ * When omitted or `true` (default), processing runs in the background and `202 Accepted` is returned immediately with `status=pending`. Pass `false` to run synchronously and receive `201 Created` with `status=ready`.
4967
+ */
4968
+ async?: boolean;
4969
+ };
4957
4970
  url: '/api/v1/documents/ingest';
4958
4971
  };
4959
4972
  type IngestDocumentErrors = {
4960
4973
  /**
4961
- * Invalid request, file not found, unsupported content type, or no extractable text
4974
+ * Invalid request, file not found, or unsupported content type
4962
4975
  */
4963
4976
  400: ErrorResponse;
4964
4977
  /**
@@ -4973,9 +4986,13 @@ type IngestDocumentErrors = {
4973
4986
  type IngestDocumentError = IngestDocumentErrors[keyof IngestDocumentErrors];
4974
4987
  type IngestDocumentResponses = {
4975
4988
  /**
4976
- * Document created from file
4989
+ * Ingestion completed synchronously (only when `?async=false`). The document is fully indexed and ready for search.
4977
4990
  */
4978
4991
  201: IngestedDocumentRecord;
4992
+ /**
4993
+ * Ingestion accepted. The document record has been created with `status=pending` and processing runs in the background. Poll `GET /api/v1/documents/{document_id}` until `status` is `ready` or `failed`.
4994
+ */
4995
+ 202: IngestedDocumentRecord;
4979
4996
  };
4980
4997
  type IngestDocumentResponse = IngestDocumentResponses[keyof IngestDocumentResponses];
4981
4998
  type DeleteDocumentData = {
package/dist/index.d.mts CHANGED
@@ -1265,7 +1265,11 @@ type DocumentRecord = {
1265
1265
  */
1266
1266
  size?: number;
1267
1267
  /**
1268
- * Text content (only present on getDocument)
1268
+ * Ingestion lifecycle state. `pending` enqueued; `processing` — chunks being extracted and embedded; `ready` — fully indexed; `failed` — processing error (see `metadata.failure_reason`).
1269
+ */
1270
+ status?: 'pending' | 'processing' | 'ready' | 'failed';
1271
+ /**
1272
+ * Text content (only present on getDocument, and only when status is ready)
1269
1273
  */
1270
1274
  content?: string | null;
1271
1275
  created_at?: Date;
@@ -2265,6 +2269,10 @@ type MemoryKnowledgeResult = {
2265
2269
  * Public ID of the parent memory
2266
2270
  */
2267
2271
  memory_id: string;
2272
+ /**
2273
+ * Human-readable name of the parent memory
2274
+ */
2275
+ memory_name: string;
2268
2276
  /**
2269
2277
  * Text content of the memory entry
2270
2278
  */
@@ -2567,7 +2575,7 @@ type NodeExecution = {
2567
2575
  * Type of the executed node (e.g. agent, transform).
2568
2576
  */
2569
2577
  node_type?: string | null;
2570
- status: 'completed' | 'failed' | 'requires_action';
2578
+ status: 'completed' | 'failed' | 'requires_action' | 'skipped';
2571
2579
  /**
2572
2580
  * Resolved input_mapping the node received.
2573
2581
  */
@@ -4953,12 +4961,17 @@ type IngestDocumentData = {
4953
4961
  chunk_overlap?: number;
4954
4962
  };
4955
4963
  path?: never;
4956
- query?: never;
4964
+ query?: {
4965
+ /**
4966
+ * When omitted or `true` (default), processing runs in the background and `202 Accepted` is returned immediately with `status=pending`. Pass `false` to run synchronously and receive `201 Created` with `status=ready`.
4967
+ */
4968
+ async?: boolean;
4969
+ };
4957
4970
  url: '/api/v1/documents/ingest';
4958
4971
  };
4959
4972
  type IngestDocumentErrors = {
4960
4973
  /**
4961
- * Invalid request, file not found, unsupported content type, or no extractable text
4974
+ * Invalid request, file not found, or unsupported content type
4962
4975
  */
4963
4976
  400: ErrorResponse;
4964
4977
  /**
@@ -4973,9 +4986,13 @@ type IngestDocumentErrors = {
4973
4986
  type IngestDocumentError = IngestDocumentErrors[keyof IngestDocumentErrors];
4974
4987
  type IngestDocumentResponses = {
4975
4988
  /**
4976
- * Document created from file
4989
+ * Ingestion completed synchronously (only when `?async=false`). The document is fully indexed and ready for search.
4977
4990
  */
4978
4991
  201: IngestedDocumentRecord;
4992
+ /**
4993
+ * Ingestion accepted. The document record has been created with `status=pending` and processing runs in the background. Poll `GET /api/v1/documents/{document_id}` until `status` is `ready` or `failed`.
4994
+ */
4995
+ 202: IngestedDocumentRecord;
4979
4996
  };
4980
4997
  type IngestDocumentResponse = IngestDocumentResponses[keyof IngestDocumentResponses];
4981
4998
  type DeleteDocumentData = {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@soat/sdk",
3
- "version": "0.13.2",
3
+ "version": "0.13.3",
4
4
  "description": "TypeScript SDK for the SOAT API",
5
5
  "type": "module",
6
6
  "main": "dist/index.mjs",