flexorch-sdk 0.2.1 → 0.2.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/README.md CHANGED
@@ -134,6 +134,10 @@ for (const r of results) {
134
134
 
135
135
  Throws `JobFailedError` if the job fails, `JobTimeoutError` if timeout is exceeded.
136
136
 
137
+ Key properties: `id`, `status`, `qualityGrade`, `qualityScore`, `documentId`, `hasDataset`, `degraded`, `failureReason`.
138
+
139
+ `degraded` is `true` when the underlying pipeline execution completed but one or more non-critical steps failed (e.g. structured extraction couldn't find a table in the document). The job still succeeds — PII detection and quality scoring results are still meaningful — but the resulting dataset's records/columns may be empty. `wait()` does not throw for a degraded completion.
140
+
137
141
  ---
138
142
 
139
143
  ### `Dataset`
package/dist/index.cjs CHANGED
@@ -366,6 +366,16 @@ var Job = class _Job {
366
366
  qualityScore;
367
367
  documentId;
368
368
  hasDataset;
369
+ /**
370
+ * True when the underlying pipeline execution completed but one or more
371
+ * non-critical steps failed (e.g. structured extraction couldn't find a
372
+ * table in the document). The job still succeeds — PII detection and
373
+ * quality scoring results are still meaningful — but `records`/columns
374
+ * may be empty. Read from `execution_summary.degraded`; false for jobs
375
+ * with no execution (e.g. dataset_build). wait() does not throw for a
376
+ * degraded completion.
377
+ */
378
+ degraded;
369
379
  failureReason;
370
380
  _transport;
371
381
  constructor(data) {
@@ -375,11 +385,13 @@ var Job = class _Job {
375
385
  this.qualityScore = data.qualityScore;
376
386
  this.documentId = data.documentId;
377
387
  this.hasDataset = data.hasDataset;
388
+ this.degraded = data.degraded;
378
389
  this.failureReason = data.failureReason;
379
390
  this._transport = data._transport;
380
391
  }
381
392
  static fromDict(data, transport) {
382
393
  const quality = data["quality"] ?? {};
394
+ const executionSummary = data["execution_summary"];
383
395
  return new _Job({
384
396
  id: String(data["job_id"] ?? data["id"] ?? ""),
385
397
  status: String(data["status"] ?? ""),
@@ -387,6 +399,7 @@ var Job = class _Job {
387
399
  qualityScore: quality["score"] ?? null,
388
400
  documentId: data["document_id"] ?? null,
389
401
  hasDataset: Boolean(data["has_dataset"] ?? false),
402
+ degraded: Boolean(executionSummary?.["degraded"] ?? false),
390
403
  failureReason: data["failure_reason"] ?? null,
391
404
  _transport: transport
392
405
  });
@@ -594,7 +607,15 @@ var Connector = class _Connector {
594
607
  };
595
608
 
596
609
  // src/resources/connectors.ts
597
- var VALID_TYPES = /* @__PURE__ */ new Set(["s3", "gcs", "azure_blob", "google_drive"]);
610
+ var VALID_TYPES = /* @__PURE__ */ new Set([
611
+ "s3",
612
+ "gcs",
613
+ "azure_blob",
614
+ "google_drive",
615
+ "pgvector_external",
616
+ "pinecone",
617
+ "qdrant"
618
+ ]);
598
619
  var ConnectorsResource = class {
599
620
  constructor(_t) {
600
621
  this._t = _t;
@@ -904,7 +925,7 @@ var FlexOrchReader = class {
904
925
  };
905
926
 
906
927
  // src/index.ts
907
- var version = "0.2.0";
928
+ var version = "0.2.3";
908
929
  // Annotate the CommonJS export names for ESM import in node:
909
930
  0 && (module.exports = {
910
931
  AuthError,
package/dist/index.d.cts CHANGED
@@ -77,6 +77,16 @@ declare class Job {
77
77
  readonly qualityScore: number | null;
78
78
  readonly documentId: string | null;
79
79
  readonly hasDataset: boolean;
80
+ /**
81
+ * True when the underlying pipeline execution completed but one or more
82
+ * non-critical steps failed (e.g. structured extraction couldn't find a
83
+ * table in the document). The job still succeeds — PII detection and
84
+ * quality scoring results are still meaningful — but `records`/columns
85
+ * may be empty. Read from `execution_summary.degraded`; false for jobs
86
+ * with no execution (e.g. dataset_build). wait() does not throw for a
87
+ * degraded completion.
88
+ */
89
+ readonly degraded: boolean;
80
90
  readonly failureReason: string | null;
81
91
  private readonly _transport;
82
92
  constructor(data: {
@@ -86,6 +96,7 @@ declare class Job {
86
96
  qualityScore: number | null;
87
97
  documentId: string | null;
88
98
  hasDataset: boolean;
99
+ degraded: boolean;
89
100
  failureReason: string | null;
90
101
  _transport: Transport;
91
102
  });
@@ -201,7 +212,7 @@ interface ConnectorTestResult {
201
212
  latencyMs: number | null;
202
213
  message: string;
203
214
  }
204
- type ConnectorType = "s3" | "gcs" | "azure_blob" | "google_drive";
215
+ type ConnectorType = "s3" | "gcs" | "azure_blob" | "google_drive" | "pgvector_external" | "pinecone" | "qdrant";
205
216
  interface S3ConnectorConfig {
206
217
  bucket: string;
207
218
  region: string;
@@ -399,6 +410,6 @@ declare class FlexOrchReader {
399
410
  toString(): string;
400
411
  }
401
412
 
402
- declare const version = "0.2.0";
413
+ declare const version = "0.2.3";
403
414
 
404
415
  export { AuthError, Connector, type ConnectorTestResult, type ConnectorType, Dataset, type ExportFormat, FlexOrchClient, type FlexOrchClientOptions, FlexOrchError, FlexOrchReader, FlexOrchRetriever, Job, JobFailedError, JobTimeoutError, NotFoundError, QuotaError, RAGDocument, RateLimitError, type ReaderLoadOptions, type RetrieverOptions, type S3ConnectorConfig, type SearchFilters, SearchResult, ServerError, type UsageSnapshot, ValidationError, type Webhook, type WebhookEvent, version };
package/dist/index.d.ts CHANGED
@@ -77,6 +77,16 @@ declare class Job {
77
77
  readonly qualityScore: number | null;
78
78
  readonly documentId: string | null;
79
79
  readonly hasDataset: boolean;
80
+ /**
81
+ * True when the underlying pipeline execution completed but one or more
82
+ * non-critical steps failed (e.g. structured extraction couldn't find a
83
+ * table in the document). The job still succeeds — PII detection and
84
+ * quality scoring results are still meaningful — but `records`/columns
85
+ * may be empty. Read from `execution_summary.degraded`; false for jobs
86
+ * with no execution (e.g. dataset_build). wait() does not throw for a
87
+ * degraded completion.
88
+ */
89
+ readonly degraded: boolean;
80
90
  readonly failureReason: string | null;
81
91
  private readonly _transport;
82
92
  constructor(data: {
@@ -86,6 +96,7 @@ declare class Job {
86
96
  qualityScore: number | null;
87
97
  documentId: string | null;
88
98
  hasDataset: boolean;
99
+ degraded: boolean;
89
100
  failureReason: string | null;
90
101
  _transport: Transport;
91
102
  });
@@ -201,7 +212,7 @@ interface ConnectorTestResult {
201
212
  latencyMs: number | null;
202
213
  message: string;
203
214
  }
204
- type ConnectorType = "s3" | "gcs" | "azure_blob" | "google_drive";
215
+ type ConnectorType = "s3" | "gcs" | "azure_blob" | "google_drive" | "pgvector_external" | "pinecone" | "qdrant";
205
216
  interface S3ConnectorConfig {
206
217
  bucket: string;
207
218
  region: string;
@@ -399,6 +410,6 @@ declare class FlexOrchReader {
399
410
  toString(): string;
400
411
  }
401
412
 
402
- declare const version = "0.2.0";
413
+ declare const version = "0.2.3";
403
414
 
404
415
  export { AuthError, Connector, type ConnectorTestResult, type ConnectorType, Dataset, type ExportFormat, FlexOrchClient, type FlexOrchClientOptions, FlexOrchError, FlexOrchReader, FlexOrchRetriever, Job, JobFailedError, JobTimeoutError, NotFoundError, QuotaError, RAGDocument, RateLimitError, type ReaderLoadOptions, type RetrieverOptions, type S3ConnectorConfig, type SearchFilters, SearchResult, ServerError, type UsageSnapshot, ValidationError, type Webhook, type WebhookEvent, version };
package/dist/index.js CHANGED
@@ -198,6 +198,16 @@ var Job = class _Job {
198
198
  qualityScore;
199
199
  documentId;
200
200
  hasDataset;
201
+ /**
202
+ * True when the underlying pipeline execution completed but one or more
203
+ * non-critical steps failed (e.g. structured extraction couldn't find a
204
+ * table in the document). The job still succeeds — PII detection and
205
+ * quality scoring results are still meaningful — but `records`/columns
206
+ * may be empty. Read from `execution_summary.degraded`; false for jobs
207
+ * with no execution (e.g. dataset_build). wait() does not throw for a
208
+ * degraded completion.
209
+ */
210
+ degraded;
201
211
  failureReason;
202
212
  _transport;
203
213
  constructor(data) {
@@ -207,11 +217,13 @@ var Job = class _Job {
207
217
  this.qualityScore = data.qualityScore;
208
218
  this.documentId = data.documentId;
209
219
  this.hasDataset = data.hasDataset;
220
+ this.degraded = data.degraded;
210
221
  this.failureReason = data.failureReason;
211
222
  this._transport = data._transport;
212
223
  }
213
224
  static fromDict(data, transport) {
214
225
  const quality = data["quality"] ?? {};
226
+ const executionSummary = data["execution_summary"];
215
227
  return new _Job({
216
228
  id: String(data["job_id"] ?? data["id"] ?? ""),
217
229
  status: String(data["status"] ?? ""),
@@ -219,6 +231,7 @@ var Job = class _Job {
219
231
  qualityScore: quality["score"] ?? null,
220
232
  documentId: data["document_id"] ?? null,
221
233
  hasDataset: Boolean(data["has_dataset"] ?? false),
234
+ degraded: Boolean(executionSummary?.["degraded"] ?? false),
222
235
  failureReason: data["failure_reason"] ?? null,
223
236
  _transport: transport
224
237
  });
@@ -425,7 +438,15 @@ var Connector = class _Connector {
425
438
  };
426
439
 
427
440
  // src/resources/connectors.ts
428
- var VALID_TYPES = /* @__PURE__ */ new Set(["s3", "gcs", "azure_blob", "google_drive"]);
441
+ var VALID_TYPES = /* @__PURE__ */ new Set([
442
+ "s3",
443
+ "gcs",
444
+ "azure_blob",
445
+ "google_drive",
446
+ "pgvector_external",
447
+ "pinecone",
448
+ "qdrant"
449
+ ]);
429
450
  var ConnectorsResource = class {
430
451
  constructor(_t) {
431
452
  this._t = _t;
@@ -732,7 +753,7 @@ var FlexOrchReader = class {
732
753
  };
733
754
 
734
755
  // src/index.ts
735
- var version = "0.2.0";
756
+ var version = "0.2.3";
736
757
  export {
737
758
  AuthError,
738
759
  Connector,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "flexorch-sdk",
3
- "version": "0.2.1",
3
+ "version": "0.2.3",
4
4
  "description": "TypeScript/JavaScript SDK for the FlexOrch API — process documents, build LLM-ready datasets",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",