unstructured-transform-client 0.18.30 → 0.18.31

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.18.31
+
+- Add `advancedOptions` to `parse.run`: `{ enrichments: { imageDescription: true } }`
+  describes the images in the document (off by default). The facade sends the
+  service's snake_case wire form, and the service rejects any other option
+  rather than ignoring it.
+- `jobs.get` and the job stream now carry `configuration` (`profile` and
+  `advancedOptions`), the settings a job ran with. `advancedOptions` is null for
+  a job created before options were saved, and `configuration` itself is null for
+  an extraction over an existing parse.
+
 ## 0.18.28
 
 - Add a 60 second per-request timeout for ordinary requests, with per-client

package/dist/_generated/apis/ParseApi.d.ts

@@ -49,6 +49,10 @@ export interface ParseRunRequest {
      * Optional customer-facing outcome profile. Omit it to use the current deployment default, balanced, or select one explicitly.
      */
     profile?: ParseRunProfileEnum;
+    /**
+     * Optional JSON object of advanced options. The only supported option is enrichments.image_description, a boolean that defaults to false.
+     */
+    advancedOptions?: string;
 }
 /**
  *

package/dist/_generated/apis/ParseApi.js

@@ -75,6 +75,9 @@ export class ParseApi extends runtime.BaseAPI {
         if (requestParameters['profile'] != null) {
             formParams.append('profile', requestParameters['profile']);
         }
+        if (requestParameters['advancedOptions'] != null) {
+            formParams.append('advanced_options', requestParameters['advancedOptions']);
+        }
         let urlPath = `/api/v2/parse`;
         return {
             path: urlPath,

package/dist/_generated/models/AdvancedOptions.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Unstructured Transform API
+ * One document in, the parsed document back. A single call takes a document and returns structured output — no job graph, no strategy selection, no model provider setup, and no polling loop. An optional schema switches the request from parse-only to parse-then-extract.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Enrichments } from './Enrichments.js';
+/**
+ *
+ * @export
+ * @interface AdvancedOptions
+ */
+export interface AdvancedOptions {
+    /**
+     *
+     */
+    enrichments: Enrichments;
+}
+/**
+ * Check if a given object implements the AdvancedOptions interface.
+ */
+export declare function instanceOfAdvancedOptions(value: object): value is AdvancedOptions;
+export declare function AdvancedOptionsFromJSON(json: any): AdvancedOptions;
+export declare function AdvancedOptionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdvancedOptions;
+export declare function AdvancedOptionsToJSON(json: any): AdvancedOptions;
+export declare function AdvancedOptionsToJSONTyped(value?: AdvancedOptions | null, ignoreDiscriminator?: boolean): any;

package/dist/_generated/models/AdvancedOptions.js

@@ -0,0 +1,44 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Unstructured Transform API
+ * One document in, the parsed document back. A single call takes a document and returns structured output — no job graph, no strategy selection, no model provider setup, and no polling loop. An optional schema switches the request from parse-only to parse-then-extract.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { EnrichmentsFromJSON, EnrichmentsToJSON, } from './Enrichments.js';
+/**
+ * Check if a given object implements the AdvancedOptions interface.
+ */
+export function instanceOfAdvancedOptions(value) {
+    if (!('enrichments' in value) || value['enrichments'] === undefined)
+        return false;
+    return true;
+}
+export function AdvancedOptionsFromJSON(json) {
+    return AdvancedOptionsFromJSONTyped(json, false);
+}
+export function AdvancedOptionsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'enrichments': EnrichmentsFromJSON(json['enrichments']),
+    };
+}
+export function AdvancedOptionsToJSON(json) {
+    return AdvancedOptionsToJSONTyped(json, false);
+}
+export function AdvancedOptionsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'enrichments': EnrichmentsToJSON(value['enrichments']),
+    };
+}

package/dist/_generated/models/Enrichments.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Unstructured Transform API
+ * One document in, the parsed document back. A single call takes a document and returns structured output — no job graph, no strategy selection, no model provider setup, and no polling loop. An optional schema switches the request from parse-only to parse-then-extract.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface Enrichments
+ */
+export interface Enrichments {
+    /**
+     * Whether descriptions were generated for images in the document.
+     */
+    imageDescription: boolean;
+}
+/**
+ * Check if a given object implements the Enrichments interface.
+ */
+export declare function instanceOfEnrichments(value: object): value is Enrichments;
+export declare function EnrichmentsFromJSON(json: any): Enrichments;
+export declare function EnrichmentsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Enrichments;
+export declare function EnrichmentsToJSON(json: any): Enrichments;
+export declare function EnrichmentsToJSONTyped(value?: Enrichments | null, ignoreDiscriminator?: boolean): any;

package/dist/_generated/models/Enrichments.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Unstructured Transform API
+ * One document in, the parsed document back. A single call takes a document and returns structured output — no job graph, no strategy selection, no model provider setup, and no polling loop. An optional schema switches the request from parse-only to parse-then-extract.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the Enrichments interface.
+ */
+export function instanceOfEnrichments(value) {
+    if ((!('imageDescription' in value) && !('image_description' in value)) || (value['imageDescription'] === undefined && value['image_description'] === undefined))
+        return false;
+    return true;
+}
+export function EnrichmentsFromJSON(json) {
+    return EnrichmentsFromJSONTyped(json, false);
+}
+export function EnrichmentsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'imageDescription': json['image_description'],
+    };
+}
+export function EnrichmentsToJSON(json) {
+    return EnrichmentsToJSONTyped(json, false);
+}
+export function EnrichmentsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'image_description': value['imageDescription'],
+    };
+}

package/dist/_generated/models/JobConfiguration.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Unstructured Transform API
+ * One document in, the parsed document back. A single call takes a document and returns structured output — no job graph, no strategy selection, no model provider setup, and no polling loop. An optional schema switches the request from parse-only to parse-then-extract.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { AdvancedOptions } from './AdvancedOptions.js';
+/**
+ * The saved settings of one Parse job.
+ * @export
+ * @interface JobConfiguration
+ */
+export interface JobConfiguration {
+    /**
+     * The effective profile used for raw-document partitioning.
+     */
+    profile: JobConfigurationProfileEnum | null;
+    /**
+     * The effective advanced options. Null only for a job created before options were saved, which keeps it distinguishable from a new job that ran with every option off.
+     */
+    advancedOptions: AdvancedOptions | null;
+}
+/**
+ * @export
+ */
+export declare const JobConfigurationProfileEnum: {
+    readonly Balanced: "balanced";
+    readonly Best: "best";
+    readonly Fast: "fast";
+};
+export type JobConfigurationProfileEnum = typeof JobConfigurationProfileEnum[keyof typeof JobConfigurationProfileEnum];
+/**
+ * Check if a given object implements the JobConfiguration interface.
+ */
+export declare function instanceOfJobConfiguration(value: object): value is JobConfiguration;
+export declare function JobConfigurationFromJSON(json: any): JobConfiguration;
+export declare function JobConfigurationFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobConfiguration;
+export declare function JobConfigurationToJSON(json: any): JobConfiguration;
+export declare function JobConfigurationToJSONTyped(value?: JobConfiguration | null, ignoreDiscriminator?: boolean): any;

package/dist/_generated/models/JobConfiguration.js

@@ -0,0 +1,56 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Unstructured Transform API
+ * One document in, the parsed document back. A single call takes a document and returns structured output — no job graph, no strategy selection, no model provider setup, and no polling loop. An optional schema switches the request from parse-only to parse-then-extract.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AdvancedOptionsFromJSON, AdvancedOptionsToJSON, } from './AdvancedOptions.js';
+/**
+ * @export
+ */
+export const JobConfigurationProfileEnum = {
+    Balanced: 'balanced',
+    Best: 'best',
+    Fast: 'fast',
+};
+/**
+ * Check if a given object implements the JobConfiguration interface.
+ */
+export function instanceOfJobConfiguration(value) {
+    if (!('profile' in value) || value['profile'] === undefined)
+        return false;
+    if ((!('advancedOptions' in value) && !('advanced_options' in value)) || (value['advancedOptions'] === undefined && value['advanced_options'] === undefined))
+        return false;
+    return true;
+}
+export function JobConfigurationFromJSON(json) {
+    return JobConfigurationFromJSONTyped(json, false);
+}
+export function JobConfigurationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'profile': json['profile'],
+        'advancedOptions': AdvancedOptionsFromJSON(json['advanced_options']),
+    };
+}
+export function JobConfigurationToJSON(json) {
+    return JobConfigurationToJSONTyped(json, false);
+}
+export function JobConfigurationToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'profile': value['profile'],
+        'advanced_options': AdvancedOptionsToJSON(value['advancedOptions']),
+    };
+}

package/dist/_generated/models/JobResult.d.ts

@@ -13,6 +13,7 @@ import type { JobStatus } from './JobStatus.js';
 import type { ParseResult } from './ParseResult.js';
 import type { JobRequestSource } from './JobRequestSource.js';
 import type { SourceFile } from './SourceFile.js';
+import type { JobConfiguration } from './JobConfiguration.js';
 /**
  * A job's state, carrying parsed content as soon as it is available.
  * @export
@@ -47,6 +48,10 @@ export interface JobResult {
      *
      */
     error?: Error;
+    /**
+     * The settings this job ran with, available in every status. Null for extraction jobs, which run no partitioner of their own.
+     */
+    configuration?: JobConfiguration | null;
     /**
      *
      */

package/dist/_generated/models/JobResult.js

@@ -15,6 +15,7 @@ import { JobStatusFromJSON, JobStatusToJSON, } from './JobStatus.js';
 import { ParseResultFromJSON, ParseResultToJSON, } from './ParseResult.js';
 import { JobRequestSourceFromJSON, JobRequestSourceToJSON, } from './JobRequestSource.js';
 import { SourceFileFromJSON, SourceFileToJSON, } from './SourceFile.js';
+import { JobConfigurationFromJSON, JobConfigurationToJSON, } from './JobConfiguration.js';
 /**
  * Check if a given object implements the JobResult interface.
  */
@@ -44,6 +45,7 @@ export function JobResultFromJSONTyped(json, ignoreDiscriminator) {
         'cancellationRequested': json['cancellation_requested'] == null ? undefined : json['cancellation_requested'],
         'source': json['source'] === undefined ? undefined : json['source'] === null ? null : SourceFileFromJSON(json['source']),
         'error': json['error'] == null ? undefined : json['error'],
+        'configuration': json['configuration'] === undefined ? undefined : json['configuration'] === null ? null : JobConfigurationFromJSON(json['configuration']),
         'result': json['result'] == null ? undefined : ParseResultFromJSON(json['result']),
         'requestSource': JobRequestSourceFromJSON(json['request_source']),
     };
@@ -63,6 +65,7 @@ export function JobResultToJSONTyped(value, ignoreDiscriminator = false) {
         'cancellation_requested': value['cancellationRequested'],
         'source': SourceFileToJSON(value['source']),
         'error': value['error'],
+        'configuration': JobConfigurationToJSON(value['configuration']),
         'result': ParseResultToJSON(value['result']),
         'request_source': JobRequestSourceToJSON(value['requestSource']),
     };

package/dist/_generated/models/index.d.ts

@@ -1,12 +1,15 @@
+export * from './AdvancedOptions.js';
 export * from './Citation.js';
 export * from './DocumentMetadata.js';
 export * from './Element.js';
 export * from './ElementMetadata.js';
+export * from './Enrichments.js';
 export * from './ErrorCode.js';
 export * from './ExtractRequest.js';
 export * from './ExtractionResult.js';
 export * from './FieldMetadata.js';
 export * from './JobAccepted.js';
+export * from './JobConfiguration.js';
 export * from './JobOperation.js';
 export * from './JobPage.js';
 export * from './JobRequestSource.js';

package/dist/_generated/models/index.js

@@ -1,14 +1,17 @@
 /* tslint:disable */
 /* eslint-disable */
+export * from './AdvancedOptions.js';
 export * from './Citation.js';
 export * from './DocumentMetadata.js';
 export * from './Element.js';
 export * from './ElementMetadata.js';
+export * from './Enrichments.js';
 export * from './ErrorCode.js';
 export * from './ExtractRequest.js';
 export * from './ExtractionResult.js';
 export * from './FieldMetadata.js';
 export * from './JobAccepted.js';
+export * from './JobConfiguration.js';
 export * from './JobOperation.js';
 export * from './JobPage.js';
 export * from './JobRequestSource.js';

package/dist/client.d.ts

@@ -60,6 +60,15 @@ export declare class TransformClient {
     /** @internal */ readonly retries: Required<RetryConfig> | undefined;
     constructor(options?: TransformClientOptions);
 }
+/** Enrichments to run on the parsed document. Every option is off by default. */
+export interface Enrichments {
+    /** Describe the images in the document. Off unless `true`. */
+    imageDescription?: boolean;
+}
+/** Optional settings for `parse.run`. Anything unset keeps its default. */
+export interface AdvancedOptions {
+    enrichments?: Enrichments;
+}
 export interface ParseOptions extends RequestOptions {
     input?: FileInput;
     fileId?: string;
@@ -68,6 +77,8 @@ export interface ParseOptions extends RequestOptions {
     output?: OutputFormat;
     include?: string[];
     profile?: ParseRunProfileEnum;
+    /** `{ enrichments: { imageDescription: true } }` describes the images in the document. */
+    advancedOptions?: AdvancedOptions;
     waitSeconds?: number;
 }
 declare class ParseNamespace {

package/dist/client.js

@@ -114,6 +114,25 @@ function validateTimeoutMs(timeoutMs) {
     }
     return timeoutMs;
 }
+/**
+ * The wire form of {@link AdvancedOptions}: a JSON string with snake_case keys.
+ * Only keys the caller set are sent, so the service sees exactly what was asked
+ * for and rejects anything it does not define instead of ignoring it.
+ */
+function advancedOptionsToWire(options) {
+    if (options === undefined)
+        return undefined;
+    const { enrichments, ...rest } = options;
+    const wire = { ...rest };
+    if (enrichments !== undefined) {
+        const { imageDescription, ...otherEnrichments } = enrichments;
+        wire.enrichments = {
+            ...otherEnrichments,
+            ...(imageDescription === undefined ? {} : { image_description: imageDescription }),
+        };
+    }
+    return JSON.stringify(wire);
+}
 class ParseNamespace {
     client;
     constructor(client) {
@@ -143,6 +162,7 @@ class ParseNamespace {
                 : options.schema,
             prompt: options.prompt,
             profile: options.profile,
+            advancedOptions: advancedOptionsToWire(options.advancedOptions),
         }, requestInit(options)));
     }
 }

package/dist/index.d.ts

@@ -13,7 +13,7 @@
  * response types this SDK returns, so a caller needs to be able to name them.
  */
 export { DEFAULT_SERVER_URL, TransformClient } from "./client.js";
-export type { ExtractFromDocumentOptions, ExtractOptions, JobsGetOptions, JobsListOptions, JobsStreamOptions, ParseOptions, RequestOptions, TransformClientOptions, } from "./client.js";
+export type { AdvancedOptions, Enrichments, ExtractFromDocumentOptions, ExtractOptions, JobsGetOptions, JobsListOptions, JobsStreamOptions, ParseOptions, RequestOptions, TransformClientOptions, } from "./client.js";
 export { RequestTimeoutError, type RetryConfig } from "./retry.js";
 export { isTerminal, type JobEvent } from "./sse.js";
 export { asFile, type FileInput } from "./files.js";
@@ -23,4 +23,4 @@ export { FetchError, RequiredError, ResponseError } from "./_generated/runtime.j
 export type { ModelError as TransformErrorBody } from "./_generated/models/index.js";
 export { ErrorCode, JobStatus, OutputFormat, } from "./_generated/models/index.js";
 export { ParseRunProfileEnum as Profile } from "./_generated/apis/ParseApi.js";
-export type { Element, ExtractionResult, JobAccepted, JobPage, JobResult, JobSummary, ParseResult, UploadResult, } from "./_generated/models/index.js";
+export type { Element, ExtractionResult, JobAccepted, JobConfiguration, JobPage, JobResult, JobSummary, ParseResult, UploadResult, } from "./_generated/models/index.js";

package/dist/version.d.ts

@@ -7,4 +7,4 @@
  * runtime, because importing JSON differs across module systems and bundlers
  * and would make this module's behaviour depend on how it was built.
  */
-export declare const VERSION = "0.18.30";
+export declare const VERSION = "0.18.31";

package/dist/version.js

@@ -7,4 +7,4 @@
  * runtime, because importing JSON differs across module systems and bundlers
  * and would make this module's behaviour depend on how it was built.
  */
-export const VERSION = "0.18.30";
+export const VERSION = "0.18.31";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unstructured-transform-client",
-  "version": "0.18.30",
+  "version": "0.18.31",
   "description": "TypeScript client for the Unstructured Transform v2 API — one document in, structured output back.",
   "license": "MIT",
   "author": "Unstructured",