@anyformat/sdk 1.12.0 → 1.14.0

package/dist/index.d.cts

@@ -1765,6 +1765,60 @@ type FloatField = {
      */
     source?: 'extraction' | 'smart_lookup' | 'lookup_if_missing';
 };
+/**
+ * GroundTruthSetRequest
+ *
+ * Body for `PUT /v3/document-packets/{document_packet_id}/ground-truth/`.
+ */
+type GroundTruthSetRequest = {
+    /**
+     * Ground Truth
+     *
+     * The complete expected document. Keys are the workflow schema's field identifiers: advertise `persistent_id` (the API also accepts `sanitized_name`). A scalar field maps to `string | null`; a table or object field maps to an array of row objects. Every field must be present; a list field may be `[]`.
+     */
+    ground_truth: {
+        [key: string]: unknown;
+    };
+    /**
+     * Node Id
+     *
+     * The extract node's `id` in the workflow graph, as `GET /v3/workflows/{workflow_id}/` returns it. Required only when the version has more than one extract node.
+     */
+    node_id?: string | null;
+    /**
+     * Version Id
+     *
+     * A `version_id` from `GET /v3/workflows/{workflow_id}/versions/`. Omit it for the workflow's current version, the one an eval grades by default.
+     */
+    version_id?: string | null;
+};
+/**
+ * GroundTruthV3
+ *
+ * A document packet's stored ground truth and the `(version, node)` it belongs to.
+ */
+type GroundTruthV3 = {
+    /**
+     * Ground Truth
+     *
+     * The expected document, keyed by the workflow's field `persistent_id`s. A scalar field maps to `string | null`; a table or object field maps to an array of row objects keyed the same way. `null` until ground truth is first set for this version and node.
+     */
+    ground_truth: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Node Id
+     *
+     * The extract node's `id` in the workflow graph.
+     */
+    node_id: string;
+    /**
+     * Version Id
+     *
+     * The workflow version the ground truth belongs to.
+     */
+    version_id: string;
+};
 /**
  * Hyperlink
  *
@@ -3436,6 +3490,23 @@ declare class Anyformat {
     getEvalAccuracy(workflowId: string, evalId: string): Promise<AccuracyV3>;
     /** One eval document's extracted values beside its ground truth. The id is the dataset copy's. */
     getEvalDocumentPacketFields(workflowId: string, evalId: string, documentPacketId: string): Promise<EvalDocumentPacketFieldsV3>;
+    /**
+     * A dataset document packet's ground truth, keyed by field `persistent_id`,
+     * or `null` until it is first set. Omit `version` for the workflow's current
+     * version; `nodeId` is needed only when the version has more than one extract node.
+     */
+    getGroundTruth(documentPacketId: string, opts?: {
+        version?: string;
+        nodeId?: string;
+    }): Promise<GroundTruthV3>;
+    /**
+     * Create or replace a dataset document packet's complete ground truth and
+     * return it as stored. A production packet throws with `NOT_IN_DATASET`.
+     */
+    setGroundTruth(documentPacketId: string, groundTruth: Record<string, unknown>, opts?: {
+        versionId?: string;
+        nodeId?: string;
+    }): Promise<GroundTruthV3>;
 }
 
 declare class AnyformatError extends Error {
@@ -3515,4 +3586,4 @@ declare class ExtractionCancelledError extends RunFailedError {
 declare class WorkflowBuilderError extends AnyformatError {
 }
 
-export { APIError, type AccuracyCoverageV3, type AccuracyV3, type AllOfCheck, type AnyOfCheck, Anyformat, AnyformatError, type AnyformatOptions, type ArithmeticCheck, BadRequestError, type Block, type BooleanField, type Branch, type ClassifyCategory, type ComparisonCheck, type DatasetDocument, type DatasetTagAccuracyV3, type DatasetTagFilter, type DatasetTagV3, DatasetUpload, type DatasetUploadFileV3, type DatasetUploadOptions, type DatasetUploadResponseV3, type DateCheck, type DateField, type DatetimeField, type DocumentPacketAccuracyV3, type DocumentPacketDetailV3, type DocumentPacketFileV3, type DocumentPacketStatus, type DocumentPacketSummaryV3, type Edge, type EnumField, type EnumOption, type EvalDetailV3, type EvalDocumentPacketFieldsV3, type EvalLaunchedV3, type ExpressionCheck, type ExtractedField, type ExtractedRows, type Extraction, ExtractionCancelledError, ExtractionFailedError, type ExtractionSchema, type Field, type FieldAccuracyV3, type FieldValuesV3, type FloatField, ForbiddenError, InsufficientScopeError, type IntegerField, type IterOptions, type JsonValue, type ListOptions, type MultiSelectField, type NestedField, NotFoundError, type ObjectField, type OneOfCheck, type Page, type ParseResult, ParseView, PaymentRequiredError, type RangeCheck, RateLimitedError, type RegexCheck, type RequiredCheck, Result, type ResultsResponseV3, Run, type RunDetailV3, RunFailedError, type RunStatus, type RunSummaryV3, type RunTriggerOptions, SDKTimeoutError, type ScalarOrList, Schema, ServerError, type SplitPartition, type SplitResult, type SplitterRule, type StringField, TermsAcceptanceRequiredError, UnauthorizedError, Upload, type UploadFromUrlsOptions, type UploadOptions, type ValidationItem, type ValidationRule, type WaitOptions, Workflow, WorkflowBuilder, WorkflowBuilderError, type WorkflowCreateRequest, type WorkflowDefinition, type WorkflowDetailV3, WorkflowNameConflictError, type WorkflowSummaryV3, type WorkflowVersionSummaryV3 };
+export { APIError, type AccuracyCoverageV3, type AccuracyV3, type AllOfCheck, type AnyOfCheck, Anyformat, AnyformatError, type AnyformatOptions, type ArithmeticCheck, BadRequestError, type Block, type BooleanField, type Branch, type ClassifyCategory, type ComparisonCheck, type DatasetDocument, type DatasetTagAccuracyV3, type DatasetTagFilter, type DatasetTagV3, DatasetUpload, type DatasetUploadFileV3, type DatasetUploadOptions, type DatasetUploadResponseV3, type DateCheck, type DateField, type DatetimeField, type DocumentPacketAccuracyV3, type DocumentPacketDetailV3, type DocumentPacketFileV3, type DocumentPacketStatus, type DocumentPacketSummaryV3, type Edge, type EnumField, type EnumOption, type EvalDetailV3, type EvalDocumentPacketFieldsV3, type EvalLaunchedV3, type ExpressionCheck, type ExtractedField, type ExtractedRows, type Extraction, ExtractionCancelledError, ExtractionFailedError, type ExtractionSchema, type Field, type FieldAccuracyV3, type FieldValuesV3, type FloatField, ForbiddenError, type GroundTruthSetRequest, type GroundTruthV3, InsufficientScopeError, type IntegerField, type IterOptions, type JsonValue, type ListOptions, type MultiSelectField, type NestedField, NotFoundError, type ObjectField, type OneOfCheck, type Page, type ParseResult, ParseView, PaymentRequiredError, type RangeCheck, RateLimitedError, type RegexCheck, type RequiredCheck, Result, type ResultsResponseV3, Run, type RunDetailV3, RunFailedError, type RunStatus, type RunSummaryV3, type RunTriggerOptions, SDKTimeoutError, type ScalarOrList, Schema, ServerError, type SplitPartition, type SplitResult, type SplitterRule, type StringField, TermsAcceptanceRequiredError, UnauthorizedError, Upload, type UploadFromUrlsOptions, type UploadOptions, type ValidationItem, type ValidationRule, type WaitOptions, Workflow, WorkflowBuilder, WorkflowBuilderError, type WorkflowCreateRequest, type WorkflowDefinition, type WorkflowDetailV3, WorkflowNameConflictError, type WorkflowSummaryV3, type WorkflowVersionSummaryV3 };

package/dist/index.d.ts

@@ -1765,6 +1765,60 @@ type FloatField = {
      */
     source?: 'extraction' | 'smart_lookup' | 'lookup_if_missing';
 };
+/**
+ * GroundTruthSetRequest
+ *
+ * Body for `PUT /v3/document-packets/{document_packet_id}/ground-truth/`.
+ */
+type GroundTruthSetRequest = {
+    /**
+     * Ground Truth
+     *
+     * The complete expected document. Keys are the workflow schema's field identifiers: advertise `persistent_id` (the API also accepts `sanitized_name`). A scalar field maps to `string | null`; a table or object field maps to an array of row objects. Every field must be present; a list field may be `[]`.
+     */
+    ground_truth: {
+        [key: string]: unknown;
+    };
+    /**
+     * Node Id
+     *
+     * The extract node's `id` in the workflow graph, as `GET /v3/workflows/{workflow_id}/` returns it. Required only when the version has more than one extract node.
+     */
+    node_id?: string | null;
+    /**
+     * Version Id
+     *
+     * A `version_id` from `GET /v3/workflows/{workflow_id}/versions/`. Omit it for the workflow's current version, the one an eval grades by default.
+     */
+    version_id?: string | null;
+};
+/**
+ * GroundTruthV3
+ *
+ * A document packet's stored ground truth and the `(version, node)` it belongs to.
+ */
+type GroundTruthV3 = {
+    /**
+     * Ground Truth
+     *
+     * The expected document, keyed by the workflow's field `persistent_id`s. A scalar field maps to `string | null`; a table or object field maps to an array of row objects keyed the same way. `null` until ground truth is first set for this version and node.
+     */
+    ground_truth: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Node Id
+     *
+     * The extract node's `id` in the workflow graph.
+     */
+    node_id: string;
+    /**
+     * Version Id
+     *
+     * The workflow version the ground truth belongs to.
+     */
+    version_id: string;
+};
 /**
  * Hyperlink
  *
@@ -3436,6 +3490,23 @@ declare class Anyformat {
     getEvalAccuracy(workflowId: string, evalId: string): Promise<AccuracyV3>;
     /** One eval document's extracted values beside its ground truth. The id is the dataset copy's. */
     getEvalDocumentPacketFields(workflowId: string, evalId: string, documentPacketId: string): Promise<EvalDocumentPacketFieldsV3>;
+    /**
+     * A dataset document packet's ground truth, keyed by field `persistent_id`,
+     * or `null` until it is first set. Omit `version` for the workflow's current
+     * version; `nodeId` is needed only when the version has more than one extract node.
+     */
+    getGroundTruth(documentPacketId: string, opts?: {
+        version?: string;
+        nodeId?: string;
+    }): Promise<GroundTruthV3>;
+    /**
+     * Create or replace a dataset document packet's complete ground truth and
+     * return it as stored. A production packet throws with `NOT_IN_DATASET`.
+     */
+    setGroundTruth(documentPacketId: string, groundTruth: Record<string, unknown>, opts?: {
+        versionId?: string;
+        nodeId?: string;
+    }): Promise<GroundTruthV3>;
 }
 
 declare class AnyformatError extends Error {
@@ -3515,4 +3586,4 @@ declare class ExtractionCancelledError extends RunFailedError {
 declare class WorkflowBuilderError extends AnyformatError {
 }
 
-export { APIError, type AccuracyCoverageV3, type AccuracyV3, type AllOfCheck, type AnyOfCheck, Anyformat, AnyformatError, type AnyformatOptions, type ArithmeticCheck, BadRequestError, type Block, type BooleanField, type Branch, type ClassifyCategory, type ComparisonCheck, type DatasetDocument, type DatasetTagAccuracyV3, type DatasetTagFilter, type DatasetTagV3, DatasetUpload, type DatasetUploadFileV3, type DatasetUploadOptions, type DatasetUploadResponseV3, type DateCheck, type DateField, type DatetimeField, type DocumentPacketAccuracyV3, type DocumentPacketDetailV3, type DocumentPacketFileV3, type DocumentPacketStatus, type DocumentPacketSummaryV3, type Edge, type EnumField, type EnumOption, type EvalDetailV3, type EvalDocumentPacketFieldsV3, type EvalLaunchedV3, type ExpressionCheck, type ExtractedField, type ExtractedRows, type Extraction, ExtractionCancelledError, ExtractionFailedError, type ExtractionSchema, type Field, type FieldAccuracyV3, type FieldValuesV3, type FloatField, ForbiddenError, InsufficientScopeError, type IntegerField, type IterOptions, type JsonValue, type ListOptions, type MultiSelectField, type NestedField, NotFoundError, type ObjectField, type OneOfCheck, type Page, type ParseResult, ParseView, PaymentRequiredError, type RangeCheck, RateLimitedError, type RegexCheck, type RequiredCheck, Result, type ResultsResponseV3, Run, type RunDetailV3, RunFailedError, type RunStatus, type RunSummaryV3, type RunTriggerOptions, SDKTimeoutError, type ScalarOrList, Schema, ServerError, type SplitPartition, type SplitResult, type SplitterRule, type StringField, TermsAcceptanceRequiredError, UnauthorizedError, Upload, type UploadFromUrlsOptions, type UploadOptions, type ValidationItem, type ValidationRule, type WaitOptions, Workflow, WorkflowBuilder, WorkflowBuilderError, type WorkflowCreateRequest, type WorkflowDefinition, type WorkflowDetailV3, WorkflowNameConflictError, type WorkflowSummaryV3, type WorkflowVersionSummaryV3 };
+export { APIError, type AccuracyCoverageV3, type AccuracyV3, type AllOfCheck, type AnyOfCheck, Anyformat, AnyformatError, type AnyformatOptions, type ArithmeticCheck, BadRequestError, type Block, type BooleanField, type Branch, type ClassifyCategory, type ComparisonCheck, type DatasetDocument, type DatasetTagAccuracyV3, type DatasetTagFilter, type DatasetTagV3, DatasetUpload, type DatasetUploadFileV3, type DatasetUploadOptions, type DatasetUploadResponseV3, type DateCheck, type DateField, type DatetimeField, type DocumentPacketAccuracyV3, type DocumentPacketDetailV3, type DocumentPacketFileV3, type DocumentPacketStatus, type DocumentPacketSummaryV3, type Edge, type EnumField, type EnumOption, type EvalDetailV3, type EvalDocumentPacketFieldsV3, type EvalLaunchedV3, type ExpressionCheck, type ExtractedField, type ExtractedRows, type Extraction, ExtractionCancelledError, ExtractionFailedError, type ExtractionSchema, type Field, type FieldAccuracyV3, type FieldValuesV3, type FloatField, ForbiddenError, type GroundTruthSetRequest, type GroundTruthV3, InsufficientScopeError, type IntegerField, type IterOptions, type JsonValue, type ListOptions, type MultiSelectField, type NestedField, NotFoundError, type ObjectField, type OneOfCheck, type Page, type ParseResult, ParseView, PaymentRequiredError, type RangeCheck, RateLimitedError, type RegexCheck, type RequiredCheck, Result, type ResultsResponseV3, Run, type RunDetailV3, RunFailedError, type RunStatus, type RunSummaryV3, type RunTriggerOptions, SDKTimeoutError, type ScalarOrList, Schema, ServerError, type SplitPartition, type SplitResult, type SplitterRule, type StringField, TermsAcceptanceRequiredError, UnauthorizedError, Upload, type UploadFromUrlsOptions, type UploadOptions, type ValidationItem, type ValidationRule, type WaitOptions, Workflow, WorkflowBuilder, WorkflowBuilderError, type WorkflowCreateRequest, type WorkflowDefinition, type WorkflowDetailV3, WorkflowNameConflictError, type WorkflowSummaryV3, type WorkflowVersionSummaryV3 };

package/dist/index.js

@@ -1,7 +1,7 @@
 // package.json
 var package_default = {
   name: "@anyformat/sdk",
-  version: "1.12.0",
+  version: "1.14.0",
   description: "TypeScript SDK for the AnyFormat API",
   license: "MIT",
   author: "Anyformat <info@anyformat.ai>",
@@ -1069,6 +1069,20 @@ var v3GetDocumentPacket = (options) => (options.client ?? client).get({
   url: "/v3/document-packets/{document_packet_id}/",
   ...options
 });
+var v3GetGroundTruth = (options) => (options.client ?? client).get({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/v3/document-packets/{document_packet_id}/ground-truth/",
+  ...options
+});
+var v3SetGroundTruth = (options) => (options.client ?? client).put({
+  security: [{ scheme: "bearer", type: "http" }],
+  url: "/v3/document-packets/{document_packet_id}/ground-truth/",
+  ...options,
+  headers: {
+    "Content-Type": "application/json",
+    ...options.headers
+  }
+});
 var v3RunDocumentPacket = (options) => (options.client ?? client).post({
   security: [{ scheme: "bearer", type: "http" }],
   url: "/v3/document-packets/{document_packet_id}/run/",
@@ -1916,6 +1930,37 @@ var Anyformat = class {
     if (res.error) throw toApiError(res.response?.status ?? 500, res.error, res.response?.headers);
     return res.data;
   }
+  /**
+   * A dataset document packet's ground truth, keyed by field `persistent_id`,
+   * or `null` until it is first set. Omit `version` for the workflow's current
+   * version; `nodeId` is needed only when the version has more than one extract node.
+   */
+  async getGroundTruth(documentPacketId, opts = {}) {
+    const res = await v3GetGroundTruth({
+      client: this._client,
+      path: { document_packet_id: documentPacketId },
+      query: { version: opts.version, node_id: opts.nodeId }
+    });
+    if (res.error) throw toApiError(res.response?.status ?? 500, res.error, res.response?.headers);
+    return res.data;
+  }
+  /**
+   * Create or replace a dataset document packet's complete ground truth and
+   * return it as stored. A production packet throws with `NOT_IN_DATASET`.
+   */
+  async setGroundTruth(documentPacketId, groundTruth, opts = {}) {
+    const res = await v3SetGroundTruth({
+      client: this._client,
+      path: { document_packet_id: documentPacketId },
+      body: {
+        ground_truth: groundTruth,
+        ...opts.versionId ? { version_id: opts.versionId } : {},
+        ...opts.nodeId ? { node_id: opts.nodeId } : {}
+      }
+    });
+    if (res.error) throw toApiError(res.response?.status ?? 500, res.error, res.response?.headers);
+    return res.data;
+  }
 };
 
 // src/schema.ts