import * as z from "zod/v4"; import { ExtractionAsset, ExtractionAsset$Outbound } from "./extractionasset.js"; import { ExtractionDateField, ExtractionDateField$Outbound } from "./extractiondatefield.js"; import { ExtractionDatetimeField, ExtractionDatetimeField$Outbound } from "./extractiondatetimefield.js"; import { ExtractionDurationField, ExtractionDurationField$Outbound } from "./extractiondurationfield.js"; import { ExtractionEstimateField, ExtractionEstimateField$Outbound } from "./extractionestimatefield.js"; import { ExtractionForecastField, ExtractionForecastField$Outbound } from "./extractionforecastfield.js"; import { ExtractionListField, ExtractionListField$Outbound } from "./extractionlistfield.js"; import { ExtractionNumberField, ExtractionNumberField$Outbound } from "./extractionnumberfield.js"; import { ExtractionTextField, ExtractionTextField$Outbound } from "./extractiontextfield.js"; import { ExtractionTimeField, ExtractionTimeField$Outbound } from "./extractiontimefield.js"; import { ProviderPreferences, ProviderPreferences$Outbound } from "./providerpreferences.js"; import { TraceConfig, TraceConfig$Outbound } from "./traceconfig.js"; /** * A typed field to extract, compute, estimate or forecast from the state. Which types a model answers is model-specific; unsupported types are rejected with 400. */ export type Fields = ExtractionDateField | ExtractionDatetimeField | ExtractionDurationField | ExtractionEstimateField | ExtractionForecastField | ExtractionListField | ExtractionNumberField | ExtractionTextField | ExtractionTimeField; export type ExtractionsRequest = { /** * Assets keyed by reference string. Write a reference wherever the asset belongs in `state` or a field `instructions`; every asset must be referenced at least once, unless `state` is empty or omitted, in which case the assets are read without a reference. A `state` that is exactly the sole asset's key carries no text of its own and is read as file-only. A model that reads either text or a document per request, not both (ScaleDown Extract with a PDF), takes that form or an empty or omitted `state`: any other text around the key is state text and is rejected with 400. */ assets?: { [k: string]: ExtractionAsset; } | undefined; /** * Map of field name to typed field spec. */ fields: { [k: string]: ExtractionDateField | ExtractionDatetimeField | ExtractionDurationField | ExtractionEstimateField | ExtractionForecastField | ExtractionListField | ExtractionNumberField | ExtractionTextField | ExtractionTimeField; }; model: string; provider?: ProviderPreferences | null | undefined; /** * ISO date that anchors dates written without a year. */ referenceDate?: string | undefined; /** * A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. */ sessionId?: string | undefined; /** * The text to read from. May be empty or omitted only when the request carries assets, which are then read without being referenced by key. */ state?: string | undefined; /** * Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. */ trace?: TraceConfig | undefined; user?: string | undefined; }; /** @internal */ export type Fields$Outbound = ExtractionDateField$Outbound | ExtractionDatetimeField$Outbound | ExtractionDurationField$Outbound | ExtractionEstimateField$Outbound | ExtractionForecastField$Outbound | ExtractionListField$Outbound | ExtractionNumberField$Outbound | ExtractionTextField$Outbound | ExtractionTimeField$Outbound; /** @internal */ export declare const Fields$outboundSchema: z.ZodType; export declare function fieldsToJSON(fields: Fields): string; /** @internal */ export type ExtractionsRequest$Outbound = { assets?: { [k: string]: ExtractionAsset$Outbound; } | undefined; fields: { [k: string]: ExtractionDateField$Outbound | ExtractionDatetimeField$Outbound | ExtractionDurationField$Outbound | ExtractionEstimateField$Outbound | ExtractionForecastField$Outbound | ExtractionListField$Outbound | ExtractionNumberField$Outbound | ExtractionTextField$Outbound | ExtractionTimeField$Outbound; }; model: string; provider?: ProviderPreferences$Outbound | null | undefined; reference_date?: string | undefined; session_id?: string | undefined; state: string; trace?: TraceConfig$Outbound | undefined; user?: string | undefined; }; /** @internal */ export declare const ExtractionsRequest$outboundSchema: z.ZodType; export declare function extractionsRequestToJSON(extractionsRequest: ExtractionsRequest): string; //# sourceMappingURL=extractionsrequest.d.ts.map