@databricks/sdk-aifunctions 0.0.0-beta → 0.5.0

package/dist/v1/model.d.ts

@@ -0,0 +1,317 @@
+import { z } from "zod";
+import { JsonValue } from "@databricks/sdk-core/wkt";
+
+//#region src/v1/model.d.ts
+/** ai_classify */
+interface AiClassifyOptions {
+  /** Natural-language guidance that steers how the text is classified (up to 20,000 characters). */
+  instructions?: string | undefined;
+  /** The function version to invoke. Defaults to the latest version. Supported versions: ["2.1"]. */
+  version?: string | undefined;
+  /** When true, allows more than one label to be returned per input. */
+  multilabel?: boolean | undefined;
+  /** When true, includes a per-label confidence score in the response. */
+  enableConfidenceScores?: boolean | undefined;
+  /** When true, includes a rationale explaining each classification in the response. */
+  enableRationales?: boolean | undefined;
+}
+interface AiClassifyRequest {
+  /** The content to classify. It accepts a plain string or the response object of [ai_parse_document](:method:AiFunctions/AiParseDocument). */
+  content?: JsonValue | undefined;
+  /** The label set to classify as. Either a JSON array of label strings (e.g. ["spam", "not_spam"]), or a JSON object mapping each label to a description (e.g. {"spam": "unsolicited bulk message", "not_spam": "a legitimate message"}). Accepts 2 to 500 labels, each 1 to 100 characters. */
+  labels?: JsonValue | undefined;
+  /** Function options. Omitted fields fall back to their documented defaults. */
+  options?: AiClassifyOptions | undefined;
+}
+interface AiClassifyResponse {
+  /** The function result as a JSON value. An array of per-label objects: one element in single-label mode (the default), or multiple elements when `multilabel` is true. When `enable_confidence_scores` and `enable_rationales` are true, `confidence_score` and `rationale` are included in each response value, respectively. */
+  response?: JsonValue | undefined;
+  /** Additional metadata returned by AI Classify. */
+  metadata?: AiClassifyResponseMetadata | undefined;
+}
+interface AiClassifyResponseMetadata {
+  /** The resolved function version. */
+  version?: string | undefined;
+}
+/** ai_decide */
+interface AiDecideOptions {
+  /** The function API version to invoke. Defaults to "1.0". Supported versions: ["1.0"]. */
+  version?: string | undefined;
+}
+interface AiDecideRequest {
+  /** A string, JSON object, or array containing the content, related context, and examples needed to answer the provided questions. For example, provide a support message, a conversation, or records describing the current state of an application. All questions receive this same state. */
+  state?: JsonValue | undefined;
+  /**
+   * A JSON object mapping question IDs to their definitions. Choose a nonempty string for each ID; its answer is returned with the same ID in `response.answers`.
+   *
+   * Each definition is an object with the required fields `type` and `instructions`. The `criteria` field is optional for the type `noul` but is required for the types `choice` and `score`.
+   *
+   * The `instructions` field describes the judgment to make and can be a string, object, or array. Use an object or array to include supporting context alongside the instructions.
+   *
+   * The `type` can be one of:
+   *
+   * - `choice`: Selects one option from a defined set. Requires `criteria` to be an object mapping 1 to 255 nonempty option names to descriptions. The criteria description can be a string, object, array, or null when the name needs no additional detail. For example:
+   *
+   * ```json
+   * {
+   * "team": {
+   * "type": "choice",
+   * "instructions": "Which team should handle this ticket?",
+   * "criteria": {
+   * "billing": "Payments, charges, and refunds",
+   * "technical_support": null
+   * }
+   * }
+   * }
+   * ```
+   *
+   * - `noul`: Estimates the probability that the answer to a true-or-false question is true. `criteria` can take the fields `true` or `false`, or both, with descriptions that are strings, objects, or arrays. Omit `criteria` to use the question alone. For example, both of the following are valid:
+   *
+   * ```json
+   * {
+   * "escalate": {
+   * "type": "noul",
+   * "instructions": "Does this ticket need escalation?",
+   * "criteria": {
+   * "true": "Suspected fraud or an exception to standard policy",
+   * "false": "A routine issue frontline support can resolve"
+   * }
+   * }
+   * }
+   * ```
+   *
+   * or
+   *
+   * ```json
+   * {
+   * "escalate": {
+   * "type": "noul",
+   * "instructions": "Does this ticket need escalation?"
+   * }
+   * }
+   * ```
+   *
+   * - `score`: Rates the state on an ordered scale. Requires `criteria` to be an array of 2 to 10 level descriptions, ordered from low to high. Descriptions can be strings, objects, or arrays. Array positions define levels starting at 0. For example:
+   *
+   * ```json
+   * {
+   * "urgency": {
+   * "type": "score",
+   * "instructions": "How urgent is this ticket?",
+   * "criteria": [
+   * "Routine: can wait a few days",
+   * "Time-sensitive: needs attention today",
+   * "Critical: needs immediate action"
+   * ]
+   * }
+   * }
+   * ```
+   */
+  questions?: JsonValue | undefined;
+  /** Function options. Omitted fields fall back to their documented defaults. */
+  options?: AiDecideOptions | undefined;
+}
+interface AiDecideResponse {
+  /**
+   * A JSON object containing an `answers` map with one answer for each question, keyed by the same IDs as `questions`.
+   *
+   * Each answer has a `type` matching its question and the following fields:
+   *
+   * - `choice`: choice is the highest-probability option from `criteria`. `probabilities` maps every option name to its probability. `confidence` is a number from 0 to 1 indicating how well the state supports the assessment. The `probabilities` values sum to 1. For example:
+   *
+   * ```json
+   * {
+   * "answers": {
+   * "team": {
+   * "type": "choice",
+   * "choice": "billing",
+   * "probabilities": {
+   * "billing": 0.85,
+   * "technical_support": 0.15
+   * },
+   * "confidence": 0.9
+   * }
+   * }
+   * }
+   * ```
+   *
+   * - `noul`: `probability` is a number from 0 to 1 estimating the probability that the answer is true. For example:
+   *
+   * ```json
+   * {
+   * "answers": {
+   * "escalate": {
+   * "type": "noul",
+   * "probability": 0.8
+   * }
+   * }
+   * }
+   * ```
+   *
+   * - `score`: score is the probability-weighted mean of the zero-based level indices. It can fall between levels, from 0 to the number of levels minus 1. `probabilities` maps each level index to its probability, and `legend` maps each index to its original description. Both maps use string keys such as "0", "1", and "2". `confidence` is a number from 0 to 1 indicating how well the state supports the assessment. The `probabilities` values sum to 1. For example:
+   *
+   * ```json
+   * {
+   * "answers": {
+   * "urgency": {
+   * "type": "score",
+   * "score": 1.6,
+   * "probabilities": {
+   * "0": 0.1,
+   * "1": 0.2,
+   * "2": 0.7
+   * },
+   * "legend": {
+   * "0": "Routine: can wait a few days",
+   * "1": "Time-sensitive: needs attention today",
+   * "2": "Critical: needs immediate action"
+   * },
+   * "confidence": 0.85
+   * }
+   * }
+   * }
+   * ```
+   */
+  response?: JsonValue | undefined;
+  /** Metadata identifying the function API version used for this request. */
+  metadata?: AiDecideResponseMetadata | undefined;
+}
+interface AiDecideResponseMetadata {
+  /** The function API version used to evaluate the request. */
+  version?: string | undefined;
+}
+/** A bounding box on a source page; used by bbox-input citations. */
+interface AiExtractBbox {
+  /** Pixel coordinates on the page image as [x0, y0, x1, y1]. */
+  coord?: bigint[] | undefined;
+  /** 0-based page index the box is on. */
+  pageId?: bigint | undefined;
+}
+/** A citation locating an extracted value in the source. start/stop are set for span (STRING input) citations, bbox for bbox (parsed-document input) citations. */
+interface AiExtractCitation {
+  /** Integer matching a citation_ids entry on an extracted field. */
+  id?: bigint | undefined;
+  /** Inclusive 0-based character offset into the input string; set for span citations. */
+  start?: bigint | undefined;
+  /** Exclusive 0-based character offset into the input string; set for span citations. */
+  stop?: bigint | undefined;
+  /** Bounding boxes locating the citation on the source pages; set for bbox citations. */
+  bbox?: AiExtractBbox[] | undefined;
+}
+/** ai_extract */
+interface AiExtractOptions {
+  /** Natural-language guidance that steers how data is extracted (up to 20,000 characters). */
+  instructions?: string | undefined;
+  /** The function version to invoke. Defaults to the latest version. Supported versions: ["2.1"]. */
+  version?: string | undefined;
+  /** Extraction mode. Supported modes: "precision" — more powerful extraction for complex schemas, long documents, and reasoning-heavy extractions. Defaults to none (standard extraction). */
+  mode?: string | undefined;
+  /**
+   * When true, includes citation metadata locating each extracted value in the source. Depending on the type of input, citations can be one of two types:
+   *
+   * For raw text (STRING) inputs, a citation is a span of text in the original input. Each object in `metadata.citations` has an `id` (integer matching a `citation_ids` entry on a field), a `start` (inclusive 0-based character offset into the input string), and a `stop` (exclusive 0-based character offset into the input string).
+   *
+   * For PDF documents and images (when using ai_extract downstream of ai_parse_document), a citation is a bounding box in the original input. Each object in `metadata.citations` has an `id` (integer matching a `citation_ids` entry on a field) and a `bbox` (array of {coord, page_id} objects, identical in shape to element.bbox in ai_parse_document output; coord is pixel coordinates on the page image as [x0, y0, x1, y1], and page_id is a 0-based page index).
+   */
+  enableCitations?: boolean | undefined;
+  /** When true, includes a per-field confidence score in the response. */
+  enableConfidenceScores?: boolean | undefined;
+}
+interface AiExtractRequest {
+  /** The text to extract from. It accepts a plain string or the response object of [ai_parse_document](:method:AiFunctions/AiParseDocument). */
+  content?: JsonValue | undefined;
+  /** The extraction schema defining the fields to extract. Either a JSON array of field names, assumed to be strings (e.g. ["company", "valuation"]), or a JSON object mapping each field to its type/description/nullability (e.g. {"company": {"type": "string", "description": "the company name"}}). Accepts up to 256 fields, 12 levels of nesting, and 500 enum values. Supported field types are string, integer, number, boolean, and enum. */
+  schema?: JsonValue | undefined;
+  /** Function options. Omitted fields fall back to their documented defaults. */
+  options?: AiExtractOptions | undefined;
+}
+interface AiExtractResponse {
+  /** The function result as a JSON value. When `enable_confidence_scores` and `enable_citations` are true, `confidence` and `citation_ids` are included in each response field, respectively. */
+  response?: JsonValue | undefined;
+  /** Additional metadata returned by AI Extract. */
+  metadata?: AiExtractResponseMetadata | undefined;
+}
+interface AiExtractResponseMetadata {
+  /** The resolved function version. */
+  version?: string | undefined;
+  /** The resolved extraction mode; present when a non-default mode was used. */
+  mode?: string | undefined;
+  /** How the source was chunked for citation offsets (span for text input, bbox for parsed-document input); present when citations are enabled. */
+  chunkType?: string | undefined;
+  /** Citation objects locating each result in the source; present when citations are enabled. */
+  citations?: AiExtractCitation[] | undefined;
+}
+/** Metadata about the source file; present only for file-path input. */
+interface AiParseDocumentFileMetadata {
+  /** Unity Catalog volume path of the source file. */
+  filePath?: string | undefined;
+  /** Base name of the source file. */
+  fileName?: string | undefined;
+  /** Size of the source file in bytes. */
+  fileSize?: bigint | undefined;
+  /** Last-modified timestamp of the source file, as an HTTP date string. */
+  fileModificationTime?: string | undefined;
+}
+/** ai_parse_document */
+interface AiParseDocumentOptions {
+  /** The ai_parse_document output schema version. Supported value: "2.0". */
+  version?: string | undefined;
+  /** Element types for which an AI-generated description is produced. Use "*" (default) to generate descriptions for all supported element types, "figure" to generate them for figures only, or "" (empty string) to generate none. Only figure descriptions are supported for version "2.0", so "*" and "figure" produce the same behavior. */
+  descriptionElementTypes?: string | undefined;
+  /** Unity Catalog volume path where rendered page and element images are written. */
+  imageOutputPath?: string | undefined;
+  /** Pages to parse (1-indexed), as a comma-separated list of page numbers or ranges (e.g. "1,3,5-10"). */
+  pageRange?: string | undefined;
+}
+/** A single page that failed to parse while the overall request succeeded. */
+interface AiParseDocumentPageError {
+  /** Message describing why the page failed. */
+  errorMessage?: string | undefined;
+  /** 0-based index of the page that failed. */
+  pageId?: bigint | undefined;
+}
+interface AiParseDocumentRequest {
+  /** The document to parse, given as a Unity Catalog volume path to the source file (the REST API accepts only a UC volume path, not inline binary data). Supported formats: PDF, DOCX, DOC, PPTX, PPT, JPG, JPEG, PNG, TIFF. Accepts up to 100 pages and 100 MB per document. */
+  content?: string | undefined;
+  /** Function options. Omitted fields fall back to their documented defaults. */
+  options?: AiParseDocumentOptions | undefined;
+}
+interface AiParseDocumentResponse {
+  /** The parsed document as a JSON value, containing the extracted pages and elements. */
+  document?: JsonValue | undefined;
+  /** Per-page partial-failure details; present when the request succeeds (2xx) but individual pages fail. */
+  errorStatus?: AiParseDocumentPageError[] | undefined;
+  /** Additional metadata returned by AI Parse Document. */
+  metadata?: AiParseDocumentResponseMetadata | undefined;
+}
+interface AiParseDocumentResponseMetadata {
+  /** Unique identifier for the parse request. */
+  id?: string | undefined;
+  /** The resolved function version. */
+  version?: string | undefined;
+  /** Describes the source file; present only for file-path input. */
+  fileMetadata?: AiParseDocumentFileMetadata | undefined;
+}
+declare const unmarshalAiClassifyResponseSchema: z.ZodType<AiClassifyResponse>;
+declare const unmarshalAiClassifyResponseMetadataSchema: z.ZodType<AiClassifyResponseMetadata>;
+declare const unmarshalAiDecideResponseSchema: z.ZodType<AiDecideResponse>;
+declare const unmarshalAiDecideResponseMetadataSchema: z.ZodType<AiDecideResponseMetadata>;
+declare const unmarshalAiExtractBboxSchema: z.ZodType<AiExtractBbox>;
+declare const unmarshalAiExtractCitationSchema: z.ZodType<AiExtractCitation>;
+declare const unmarshalAiExtractResponseSchema: z.ZodType<AiExtractResponse>;
+declare const unmarshalAiExtractResponseMetadataSchema: z.ZodType<AiExtractResponseMetadata>;
+declare const unmarshalAiParseDocumentFileMetadataSchema: z.ZodType<AiParseDocumentFileMetadata>;
+declare const unmarshalAiParseDocumentPageErrorSchema: z.ZodType<AiParseDocumentPageError>;
+declare const unmarshalAiParseDocumentResponseSchema: z.ZodType<AiParseDocumentResponse>;
+declare const unmarshalAiParseDocumentResponseMetadataSchema: z.ZodType<AiParseDocumentResponseMetadata>;
+declare const marshalAiClassifyOptionsSchema: z.ZodType;
+declare const marshalAiClassifyRequestSchema: z.ZodType;
+declare const marshalAiDecideOptionsSchema: z.ZodType;
+declare const marshalAiDecideRequestSchema: z.ZodType;
+declare const marshalAiExtractOptionsSchema: z.ZodType;
+declare const marshalAiExtractRequestSchema: z.ZodType;
+declare const marshalAiParseDocumentOptionsSchema: z.ZodType;
+declare const marshalAiParseDocumentRequestSchema: z.ZodType;
+//#endregion
+export { AiClassifyOptions, AiClassifyRequest, AiClassifyResponse, AiClassifyResponseMetadata, AiDecideOptions, AiDecideRequest, AiDecideResponse, AiDecideResponseMetadata, AiExtractBbox, AiExtractCitation, AiExtractOptions, AiExtractRequest, AiExtractResponse, AiExtractResponseMetadata, AiParseDocumentFileMetadata, AiParseDocumentOptions, AiParseDocumentPageError, AiParseDocumentRequest, AiParseDocumentResponse, AiParseDocumentResponseMetadata, marshalAiClassifyOptionsSchema, marshalAiClassifyRequestSchema, marshalAiDecideOptionsSchema, marshalAiDecideRequestSchema, marshalAiExtractOptionsSchema, marshalAiExtractRequestSchema, marshalAiParseDocumentOptionsSchema, marshalAiParseDocumentRequestSchema, unmarshalAiClassifyResponseMetadataSchema, unmarshalAiClassifyResponseSchema, unmarshalAiDecideResponseMetadataSchema, unmarshalAiDecideResponseSchema, unmarshalAiExtractBboxSchema, unmarshalAiExtractCitationSchema, unmarshalAiExtractResponseMetadataSchema, unmarshalAiExtractResponseSchema, unmarshalAiParseDocumentFileMetadataSchema, unmarshalAiParseDocumentPageErrorSchema, unmarshalAiParseDocumentResponseMetadataSchema, unmarshalAiParseDocumentResponseSchema };
+//# sourceMappingURL=model.d.ts.map

package/dist/v1/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","names":[],"sources":["../../src/v1/model.ts"],"mappings":";;;;;UAiBiB,iBAAA;EAAA;EAEf,YAAA;;EAEA,OAAA;EAFA;EAIA,UAAA;EAAA;EAEA,sBAAA;EAEA;EAAA,gBAAA;AAAA;AAAA,UAGe,iBAAA;EAAiB;EAEhC,OAAA,GAAU,SAAA;EAAA;EAEV,MAAA,GAAS,SAAA;EAEC;EAAV,OAAA,GAAU,iBAAA;AAAA;AAAA,UAGK,kBAAA;EAPL;EASV,QAAA,GAAW,SAAA;EAPF;EAST,QAAA,GAAW,0BAAA;AAAA;AAAA,UAGI,0BAAA;EAVY;EAY3B,OAAA;AAAA;;UAIe,eAAA;EAXf;EAaA,OAAA;AAAA;AAAA,UAGe,eAAA;EAdsB;EAgBrC,KAAA,GAAQ,SAAA;EAbO;;;;;AAMjB;;;;;AAKA;;;;;;;;;;;;;;;;AA0EA;;;;;;;;;;AAkEA;;;;;AAMA;;;;;AAQA;;;;;;;;;;;AAYA;;;;;;;;;EAjGE,SAAA,GAAY,SAAA;EAiHU;EA/GtB,OAAA,GAAU,eAAA;AAAA;AAAA,UAGK,gBAAA;EAiHL;;;;;;;;;;;;;AAOZ;;;;;;;;;;AAOA;;;;;;;;;;;AAYA;;;;;;;;;;AAYA;;;;;;;;;;AAYA;;;;;AAOA;EA7GE,QAAA,GAAW,SAAA;;EAEX,QAAA,GAAW,wBAAA;AAAA;AAAA,UAGI,wBAAA;EA4GL;EA1GV,OAAA;AAAA;AA6GF;AAAA,UAzGiB,aAAA;;EAEf,KAAA;EA2Gc;EAzGd,MAAA;AAAA;;UAIe,iBAAA;EAmGJ;EAjGX,EAAA;EAmGc;EAjGd,KAAA;EAmGW;EAjGX,IAAA;EAiG0C;EA/F1C,IAAA,GAAO,aAAA;AAAA;;UAIQ,gBAAA;EAgGf;EA9FA,YAAA;EAkGA;EAhGA,OAAA;EAgG0C;EA9F1C,IAAA;EAiGW;;;;;;;EAzFX,eAAA;EAyF0E;EAvF1E,sBAAA;AAAA;AAAA,UAGe,gBAAA;EAiGgD;EA/F/D,OAAA,GAAU,SAAA;EA+F8C;EA7FxD,MAAA,GAAS,SAAA;EA6FiF;EA3F1F,OAAA,GAAU,gBAAA;AAAA;AAAA,UAGK,iBAAA;;EAEf,QAAA,GAAW,SAAA;EA+FiC;EA7F5C,QAAA,GAAW,yBAAA;AAAA;AAAA,UAGI,yBAAA;EA0FuD;EAxFtE,OAAA;EAyGK;EAvGL,IAAA;EAgG6D;EA9F7D,SAAA;EA8FsD;EA5FtD,SAAA,GAAY,iBAAA;AAAA;;UAIG,2BAAA;EAgHZ;EA9GH,QAAA;EA+FkD;EA7FlD,QAAA;EA6F2C;EA3F3C,QAAA;EA2FgE;EAzFhE,oBAAA;AAAA;;UAIe,sBAAA;EAsGuC;EApGtD,OAAA;EAoG+C;EAlG/C,uBAAA;EAkGwE;EAhGxE,eAAA;EAuHW;EArHX,SAAA;AAAA;;UAIe,wBAAA;EAiHgC;EA/G/C,YAAA;EA+GwE;EA7GxE,MAAA;AAAA;AAAA,UAGe,sBAAA;;EAEf,OAAA;EAkHqD;EAhHrD,OAAA,GAAU,sBAAA;AAAA;AAAA,UAGK,uBAAA;EA6GyE;EA3GxF,QAAA,GAAW,SAAA;EA4IN;EA1IL,WAAA,GAAc,wBAAA;EA0HkD;EAxHhE,QAAA,GAAW,+BAAA;AAAA;AAAA,UAGI,+BAAA;EAqH6E;EAnH5F,EAAA;EAqIW;EAnIX,OAAA;;EAEA,YAAA,GAAe,2BAAA;AAAA;AAAA,cAGJ,iCAAA,EAAmC,CAAA,CAAE,OAAA,CAAQ,kBAAA;AAAA,cAa7C,yCAAA,EAA2C,CAAA,CAAE,OAAA,CAAQ,0BAAA;AAAA,cASrD,+BAAA,EAAiC,CAAA,CAAE,OAAA,CAAQ,gBAAA;AAAA,cAU3C,uCAAA,EAAyC,CAAA,CAAE,OAAA,CAAQ,wBAAA;AAAA,cASnD,4BAAA,EAA8B,CAAA,CAAE,OAAA,CAAQ,aAAA;AAAA,cAiBxC,gCAAA,EAAkC,CAAA,CAAE,OAAA,CAAQ,iBAAA;AAAA,cAuB5C,gCAAA,EAAkC,CAAA,CAAE,OAAA,CAAQ,iBAAA;AAAA,cAU5C,wCAAA,EAA0C,CAAA,CAAE,OAAA,CAAQ,yBAAA;AAAA,cAiBpD,0CAAA,EAA4C,CAAA,CAAE,OAAA,CAAQ,2BAAA;AAAA,cAkBtD,uCAAA,EAAyC,CAAA,CAAE,OAAA,CAAQ,wBAAA;AAAA,cAcnD,sCAAA,EAAwC,CAAA,CAAE,OAAA,CAAQ,uBAAA;AAAA,cAiBlD,8CAAA,EAAgD,CAAA,CAAE,OAAA,CAAQ,+BAAA;AAAA,cAe1D,8BAAA,EAAgC,CAAA,CAAE,OAAA;AAAA,cAgBlC,8BAAA,EAAgC,CAAA,CAAE,OAAA;AAAA,cAYlC,4BAAA,EAA8B,CAAA,CAAE,OAAA;AAAA,cAQhC,4BAAA,EAA8B,CAAA,CAAE,OAAA;AAAA,cAYhC,6BAAA,EAA+B,CAAA,CAAE,OAAA;AAAA,cAgBjC,6BAAA,EAA+B,CAAA,CAAE,OAAA;AAAA,cAYjC,mCAAA,EAAqC,CAAA,CAAE,OAAA;AAAA,cAcvC,mCAAA,EAAqC,CAAA,CAAE,OAAA"}

package/dist/v1/model.js

@@ -0,0 +1,203 @@
+import { z } from "zod";
+
+//#region src/v1/model.ts
+const jsonValueSchema = z.lazy(() => z.union([
+	z.null(),
+	z.number(),
+	z.string(),
+	z.boolean(),
+	z.record(z.string(), jsonValueSchema),
+	z.array(jsonValueSchema)
+]));
+const unmarshalAiClassifyResponseSchema = z.object({
+	response: jsonValueSchema.optional(),
+	metadata: z.lazy(() => unmarshalAiClassifyResponseMetadataSchema).optional()
+}).transform((d) => ({
+	response: d.response,
+	metadata: d.metadata
+}));
+const unmarshalAiClassifyResponseMetadataSchema = z.object({ version: z.string().optional() }).transform((d) => ({ version: d.version }));
+const unmarshalAiDecideResponseSchema = z.object({
+	response: jsonValueSchema.optional(),
+	metadata: z.lazy(() => unmarshalAiDecideResponseMetadataSchema).optional()
+}).transform((d) => ({
+	response: d.response,
+	metadata: d.metadata
+}));
+const unmarshalAiDecideResponseMetadataSchema = z.object({ version: z.string().optional() }).transform((d) => ({ version: d.version }));
+const unmarshalAiExtractBboxSchema = z.object({
+	coord: z.array(z.union([
+		z.number(),
+		z.bigint(),
+		z.string()
+	]).transform((v) => BigInt(v))).optional(),
+	page_id: z.union([
+		z.number(),
+		z.bigint(),
+		z.string()
+	]).transform((v) => BigInt(v)).optional()
+}).transform((d) => ({
+	coord: d.coord,
+	pageId: d.page_id
+}));
+const unmarshalAiExtractCitationSchema = z.object({
+	id: z.union([
+		z.number(),
+		z.bigint(),
+		z.string()
+	]).transform((v) => BigInt(v)).optional(),
+	start: z.union([
+		z.number(),
+		z.bigint(),
+		z.string()
+	]).transform((v) => BigInt(v)).optional(),
+	stop: z.union([
+		z.number(),
+		z.bigint(),
+		z.string()
+	]).transform((v) => BigInt(v)).optional(),
+	bbox: z.array(z.lazy(() => unmarshalAiExtractBboxSchema)).optional()
+}).transform((d) => ({
+	id: d.id,
+	start: d.start,
+	stop: d.stop,
+	bbox: d.bbox
+}));
+const unmarshalAiExtractResponseSchema = z.object({
+	response: jsonValueSchema.optional(),
+	metadata: z.lazy(() => unmarshalAiExtractResponseMetadataSchema).optional()
+}).transform((d) => ({
+	response: d.response,
+	metadata: d.metadata
+}));
+const unmarshalAiExtractResponseMetadataSchema = z.object({
+	version: z.string().optional(),
+	mode: z.string().optional(),
+	chunk_type: z.string().optional(),
+	citations: z.array(z.lazy(() => unmarshalAiExtractCitationSchema)).optional()
+}).transform((d) => ({
+	version: d.version,
+	mode: d.mode,
+	chunkType: d.chunk_type,
+	citations: d.citations
+}));
+const unmarshalAiParseDocumentFileMetadataSchema = z.object({
+	file_path: z.string().optional(),
+	file_name: z.string().optional(),
+	file_size: z.union([
+		z.number(),
+		z.bigint(),
+		z.string()
+	]).transform((v) => BigInt(v)).optional(),
+	file_modification_time: z.string().optional()
+}).transform((d) => ({
+	filePath: d.file_path,
+	fileName: d.file_name,
+	fileSize: d.file_size,
+	fileModificationTime: d.file_modification_time
+}));
+const unmarshalAiParseDocumentPageErrorSchema = z.object({
+	error_message: z.string().optional(),
+	page_id: z.union([
+		z.number(),
+		z.bigint(),
+		z.string()
+	]).transform((v) => BigInt(v)).optional()
+}).transform((d) => ({
+	errorMessage: d.error_message,
+	pageId: d.page_id
+}));
+const unmarshalAiParseDocumentResponseSchema = z.object({
+	document: jsonValueSchema.optional(),
+	error_status: z.array(z.lazy(() => unmarshalAiParseDocumentPageErrorSchema)).optional(),
+	metadata: z.lazy(() => unmarshalAiParseDocumentResponseMetadataSchema).optional()
+}).transform((d) => ({
+	document: d.document,
+	errorStatus: d.error_status,
+	metadata: d.metadata
+}));
+const unmarshalAiParseDocumentResponseMetadataSchema = z.object({
+	id: z.string().optional(),
+	version: z.string().optional(),
+	file_metadata: z.lazy(() => unmarshalAiParseDocumentFileMetadataSchema).optional()
+}).transform((d) => ({
+	id: d.id,
+	version: d.version,
+	fileMetadata: d.file_metadata
+}));
+const marshalAiClassifyOptionsSchema = z.object({
+	instructions: z.string().optional(),
+	version: z.string().optional(),
+	multilabel: z.boolean().optional(),
+	enableConfidenceScores: z.boolean().optional(),
+	enableRationales: z.boolean().optional()
+}).transform((d) => ({
+	instructions: d.instructions,
+	version: d.version,
+	multilabel: d.multilabel,
+	enable_confidence_scores: d.enableConfidenceScores,
+	enable_rationales: d.enableRationales
+}));
+const marshalAiClassifyRequestSchema = z.object({
+	content: jsonValueSchema.optional(),
+	labels: jsonValueSchema.optional(),
+	options: z.lazy(() => marshalAiClassifyOptionsSchema).optional()
+}).transform((d) => ({
+	content: d.content,
+	labels: d.labels,
+	options: d.options
+}));
+const marshalAiDecideOptionsSchema = z.object({ version: z.string().optional() }).transform((d) => ({ version: d.version }));
+const marshalAiDecideRequestSchema = z.object({
+	state: jsonValueSchema.optional(),
+	questions: jsonValueSchema.optional(),
+	options: z.lazy(() => marshalAiDecideOptionsSchema).optional()
+}).transform((d) => ({
+	state: d.state,
+	questions: d.questions,
+	options: d.options
+}));
+const marshalAiExtractOptionsSchema = z.object({
+	instructions: z.string().optional(),
+	version: z.string().optional(),
+	mode: z.string().optional(),
+	enableCitations: z.boolean().optional(),
+	enableConfidenceScores: z.boolean().optional()
+}).transform((d) => ({
+	instructions: d.instructions,
+	version: d.version,
+	mode: d.mode,
+	enable_citations: d.enableCitations,
+	enable_confidence_scores: d.enableConfidenceScores
+}));
+const marshalAiExtractRequestSchema = z.object({
+	content: jsonValueSchema.optional(),
+	schema: jsonValueSchema.optional(),
+	options: z.lazy(() => marshalAiExtractOptionsSchema).optional()
+}).transform((d) => ({
+	content: d.content,
+	schema: d.schema,
+	options: d.options
+}));
+const marshalAiParseDocumentOptionsSchema = z.object({
+	version: z.string().optional(),
+	descriptionElementTypes: z.string().optional(),
+	imageOutputPath: z.string().optional(),
+	pageRange: z.string().optional()
+}).transform((d) => ({
+	version: d.version,
+	description_element_types: d.descriptionElementTypes,
+	image_output_path: d.imageOutputPath,
+	page_range: d.pageRange
+}));
+const marshalAiParseDocumentRequestSchema = z.object({
+	content: z.string().optional(),
+	options: z.lazy(() => marshalAiParseDocumentOptionsSchema).optional()
+}).transform((d) => ({
+	content: d.content,
+	options: d.options
+}));
+
+//#endregion
+export { marshalAiClassifyOptionsSchema, marshalAiClassifyRequestSchema, marshalAiDecideOptionsSchema, marshalAiDecideRequestSchema, marshalAiExtractOptionsSchema, marshalAiExtractRequestSchema, marshalAiParseDocumentOptionsSchema, marshalAiParseDocumentRequestSchema, unmarshalAiClassifyResponseMetadataSchema, unmarshalAiClassifyResponseSchema, unmarshalAiDecideResponseMetadataSchema, unmarshalAiDecideResponseSchema, unmarshalAiExtractBboxSchema, unmarshalAiExtractCitationSchema, unmarshalAiExtractResponseMetadataSchema, unmarshalAiExtractResponseSchema, unmarshalAiParseDocumentFileMetadataSchema, unmarshalAiParseDocumentPageErrorSchema, unmarshalAiParseDocumentResponseMetadataSchema, unmarshalAiParseDocumentResponseSchema };
+//# sourceMappingURL=model.js.map

package/dist/v1/model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.js","names":[],"sources":["../../src/v1/model.ts"],"sourcesContent":["// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.\n\nimport type {JsonValue} from '@databricks/sdk-core/wkt';\nimport {z} from 'zod';\n\nconst jsonValueSchema: z.ZodType<JsonValue> = z.lazy(() =>\n  z.union([\n    z.null(),\n    z.number(),\n    z.string(),\n    z.boolean(),\n    z.record(z.string(), jsonValueSchema),\n    z.array(jsonValueSchema),\n  ])\n);\n\n/** ai_classify */\nexport interface AiClassifyOptions {\n  /** Natural-language guidance that steers how the text is classified (up to 20,000 characters). */\n  instructions?: string | undefined;\n  /** The function version to invoke. Defaults to the latest version. Supported versions: [\"2.1\"]. */\n  version?: string | undefined;\n  /** When true, allows more than one label to be returned per input. */\n  multilabel?: boolean | undefined;\n  /** When true, includes a per-label confidence score in the response. */\n  enableConfidenceScores?: boolean | undefined;\n  /** When true, includes a rationale explaining each classification in the response. */\n  enableRationales?: boolean | undefined;\n}\n\nexport interface AiClassifyRequest {\n  /** The content to classify. It accepts a plain string or the response object of [ai_parse_document](:method:AiFunctions/AiParseDocument). */\n  content?: JsonValue | undefined;\n  /** The label set to classify as. Either a JSON array of label strings (e.g. [\"spam\", \"not_spam\"]), or a JSON object mapping each label to a description (e.g. {\"spam\": \"unsolicited bulk message\", \"not_spam\": \"a legitimate message\"}). Accepts 2 to 500 labels, each 1 to 100 characters. */\n  labels?: JsonValue | undefined;\n  /** Function options. Omitted fields fall back to their documented defaults. */\n  options?: AiClassifyOptions | undefined;\n}\n\nexport interface AiClassifyResponse {\n  /** The function result as a JSON value. An array of per-label objects: one element in single-label mode (the default), or multiple elements when `multilabel` is true. When `enable_confidence_scores` and `enable_rationales` are true, `confidence_score` and `rationale` are included in each response value, respectively. */\n  response?: JsonValue | undefined;\n  /** Additional metadata returned by AI Classify. */\n  metadata?: AiClassifyResponseMetadata | undefined;\n}\n\nexport interface AiClassifyResponseMetadata {\n  /** The resolved function version. */\n  version?: string | undefined;\n}\n\n/** ai_decide */\nexport interface AiDecideOptions {\n  /** The function API version to invoke. Defaults to \"1.0\". Supported versions: [\"1.0\"]. */\n  version?: string | undefined;\n}\n\nexport interface AiDecideRequest {\n  /** A string, JSON object, or array containing the content, related context, and examples needed to answer the provided questions. For example, provide a support message, a conversation, or records describing the current state of an application. All questions receive this same state. */\n  state?: JsonValue | undefined;\n  /**\n   * A JSON object mapping question IDs to their definitions. Choose a nonempty string for each ID; its answer is returned with the same ID in `response.answers`.\n   *\n   * Each definition is an object with the required fields `type` and `instructions`. The `criteria` field is optional for the type `noul` but is required for the types `choice` and `score`.\n   *\n   * The `instructions` field describes the judgment to make and can be a string, object, or array. Use an object or array to include supporting context alongside the instructions.\n   *\n   * The `type` can be one of:\n   *\n   * - `choice`: Selects one option from a defined set. Requires `criteria` to be an object mapping 1 to 255 nonempty option names to descriptions. The criteria description can be a string, object, array, or null when the name needs no additional detail. For example:\n   *\n   * ```json\n   * {\n   * \"team\": {\n   * \"type\": \"choice\",\n   * \"instructions\": \"Which team should handle this ticket?\",\n   * \"criteria\": {\n   * \"billing\": \"Payments, charges, and refunds\",\n   * \"technical_support\": null\n   * }\n   * }\n   * }\n   * ```\n   *\n   * - `noul`: Estimates the probability that the answer to a true-or-false question is true. `criteria` can take the fields `true` or `false`, or both, with descriptions that are strings, objects, or arrays. Omit `criteria` to use the question alone. For example, both of the following are valid:\n   *\n   * ```json\n   * {\n   * \"escalate\": {\n   * \"type\": \"noul\",\n   * \"instructions\": \"Does this ticket need escalation?\",\n   * \"criteria\": {\n   * \"true\": \"Suspected fraud or an exception to standard policy\",\n   * \"false\": \"A routine issue frontline support can resolve\"\n   * }\n   * }\n   * }\n   * ```\n   *\n   * or\n   *\n   * ```json\n   * {\n   * \"escalate\": {\n   * \"type\": \"noul\",\n   * \"instructions\": \"Does this ticket need escalation?\"\n   * }\n   * }\n   * ```\n   *\n   * - `score`: Rates the state on an ordered scale. Requires `criteria` to be an array of 2 to 10 level descriptions, ordered from low to high. Descriptions can be strings, objects, or arrays. Array positions define levels starting at 0. For example:\n   *\n   * ```json\n   * {\n   * \"urgency\": {\n   * \"type\": \"score\",\n   * \"instructions\": \"How urgent is this ticket?\",\n   * \"criteria\": [\n   * \"Routine: can wait a few days\",\n   * \"Time-sensitive: needs attention today\",\n   * \"Critical: needs immediate action\"\n   * ]\n   * }\n   * }\n   * ```\n   */\n  questions?: JsonValue | undefined;\n  /** Function options. Omitted fields fall back to their documented defaults. */\n  options?: AiDecideOptions | undefined;\n}\n\nexport interface AiDecideResponse {\n  /**\n   * A JSON object containing an `answers` map with one answer for each question, keyed by the same IDs as `questions`.\n   *\n   * Each answer has a `type` matching its question and the following fields:\n   *\n   * - `choice`: choice is the highest-probability option from `criteria`. `probabilities` maps every option name to its probability. `confidence` is a number from 0 to 1 indicating how well the state supports the assessment. The `probabilities` values sum to 1. For example:\n   *\n   * ```json\n   * {\n   * \"answers\": {\n   * \"team\": {\n   * \"type\": \"choice\",\n   * \"choice\": \"billing\",\n   * \"probabilities\": {\n   * \"billing\": 0.85,\n   * \"technical_support\": 0.15\n   * },\n   * \"confidence\": 0.9\n   * }\n   * }\n   * }\n   * ```\n   *\n   * - `noul`: `probability` is a number from 0 to 1 estimating the probability that the answer is true. For example:\n   *\n   * ```json\n   * {\n   * \"answers\": {\n   * \"escalate\": {\n   * \"type\": \"noul\",\n   * \"probability\": 0.8\n   * }\n   * }\n   * }\n   * ```\n   *\n   * - `score`: score is the probability-weighted mean of the zero-based level indices. It can fall between levels, from 0 to the number of levels minus 1. `probabilities` maps each level index to its probability, and `legend` maps each index to its original description. Both maps use string keys such as \"0\", \"1\", and \"2\". `confidence` is a number from 0 to 1 indicating how well the state supports the assessment. The `probabilities` values sum to 1. For example:\n   *\n   * ```json\n   * {\n   * \"answers\": {\n   * \"urgency\": {\n   * \"type\": \"score\",\n   * \"score\": 1.6,\n   * \"probabilities\": {\n   * \"0\": 0.1,\n   * \"1\": 0.2,\n   * \"2\": 0.7\n   * },\n   * \"legend\": {\n   * \"0\": \"Routine: can wait a few days\",\n   * \"1\": \"Time-sensitive: needs attention today\",\n   * \"2\": \"Critical: needs immediate action\"\n   * },\n   * \"confidence\": 0.85\n   * }\n   * }\n   * }\n   * ```\n   */\n  response?: JsonValue | undefined;\n  /** Metadata identifying the function API version used for this request. */\n  metadata?: AiDecideResponseMetadata | undefined;\n}\n\nexport interface AiDecideResponseMetadata {\n  /** The function API version used to evaluate the request. */\n  version?: string | undefined;\n}\n\n/** A bounding box on a source page; used by bbox-input citations. */\nexport interface AiExtractBbox {\n  /** Pixel coordinates on the page image as [x0, y0, x1, y1]. */\n  coord?: bigint[] | undefined;\n  /** 0-based page index the box is on. */\n  pageId?: bigint | undefined;\n}\n\n/** A citation locating an extracted value in the source. start/stop are set for span (STRING input) citations, bbox for bbox (parsed-document input) citations. */\nexport interface AiExtractCitation {\n  /** Integer matching a citation_ids entry on an extracted field. */\n  id?: bigint | undefined;\n  /** Inclusive 0-based character offset into the input string; set for span citations. */\n  start?: bigint | undefined;\n  /** Exclusive 0-based character offset into the input string; set for span citations. */\n  stop?: bigint | undefined;\n  /** Bounding boxes locating the citation on the source pages; set for bbox citations. */\n  bbox?: AiExtractBbox[] | undefined;\n}\n\n/** ai_extract */\nexport interface AiExtractOptions {\n  /** Natural-language guidance that steers how data is extracted (up to 20,000 characters). */\n  instructions?: string | undefined;\n  /** The function version to invoke. Defaults to the latest version. Supported versions: [\"2.1\"]. */\n  version?: string | undefined;\n  /** Extraction mode. Supported modes: \"precision\" — more powerful extraction for complex schemas, long documents, and reasoning-heavy extractions. Defaults to none (standard extraction). */\n  mode?: string | undefined;\n  /**\n   * When true, includes citation metadata locating each extracted value in the source. Depending on the type of input, citations can be one of two types:\n   *\n   * For raw text (STRING) inputs, a citation is a span of text in the original input. Each object in `metadata.citations` has an `id` (integer matching a `citation_ids` entry on a field), a `start` (inclusive 0-based character offset into the input string), and a `stop` (exclusive 0-based character offset into the input string).\n   *\n   * For PDF documents and images (when using ai_extract downstream of ai_parse_document), a citation is a bounding box in the original input. Each object in `metadata.citations` has an `id` (integer matching a `citation_ids` entry on a field) and a `bbox` (array of {coord, page_id} objects, identical in shape to element.bbox in ai_parse_document output; coord is pixel coordinates on the page image as [x0, y0, x1, y1], and page_id is a 0-based page index).\n   */\n  enableCitations?: boolean | undefined;\n  /** When true, includes a per-field confidence score in the response. */\n  enableConfidenceScores?: boolean | undefined;\n}\n\nexport interface AiExtractRequest {\n  /** The text to extract from. It accepts a plain string or the response object of [ai_parse_document](:method:AiFunctions/AiParseDocument). */\n  content?: JsonValue | undefined;\n  /** The extraction schema defining the fields to extract. Either a JSON array of field names, assumed to be strings (e.g. [\"company\", \"valuation\"]), or a JSON object mapping each field to its type/description/nullability (e.g. {\"company\": {\"type\": \"string\", \"description\": \"the company name\"}}). Accepts up to 256 fields, 12 levels of nesting, and 500 enum values. Supported field types are string, integer, number, boolean, and enum. */\n  schema?: JsonValue | undefined;\n  /** Function options. Omitted fields fall back to their documented defaults. */\n  options?: AiExtractOptions | undefined;\n}\n\nexport interface AiExtractResponse {\n  /** The function result as a JSON value. When `enable_confidence_scores` and `enable_citations` are true, `confidence` and `citation_ids` are included in each response field, respectively. */\n  response?: JsonValue | undefined;\n  /** Additional metadata returned by AI Extract. */\n  metadata?: AiExtractResponseMetadata | undefined;\n}\n\nexport interface AiExtractResponseMetadata {\n  /** The resolved function version. */\n  version?: string | undefined;\n  /** The resolved extraction mode; present when a non-default mode was used. */\n  mode?: string | undefined;\n  /** How the source was chunked for citation offsets (span for text input, bbox for parsed-document input); present when citations are enabled. */\n  chunkType?: string | undefined;\n  /** Citation objects locating each result in the source; present when citations are enabled. */\n  citations?: AiExtractCitation[] | undefined;\n}\n\n/** Metadata about the source file; present only for file-path input. */\nexport interface AiParseDocumentFileMetadata {\n  /** Unity Catalog volume path of the source file. */\n  filePath?: string | undefined;\n  /** Base name of the source file. */\n  fileName?: string | undefined;\n  /** Size of the source file in bytes. */\n  fileSize?: bigint | undefined;\n  /** Last-modified timestamp of the source file, as an HTTP date string. */\n  fileModificationTime?: string | undefined;\n}\n\n/** ai_parse_document */\nexport interface AiParseDocumentOptions {\n  /** The ai_parse_document output schema version. Supported value: \"2.0\". */\n  version?: string | undefined;\n  /** Element types for which an AI-generated description is produced. Use \"*\" (default) to generate descriptions for all supported element types, \"figure\" to generate them for figures only, or \"\" (empty string) to generate none. Only figure descriptions are supported for version \"2.0\", so \"*\" and \"figure\" produce the same behavior. */\n  descriptionElementTypes?: string | undefined;\n  /** Unity Catalog volume path where rendered page and element images are written. */\n  imageOutputPath?: string | undefined;\n  /** Pages to parse (1-indexed), as a comma-separated list of page numbers or ranges (e.g. \"1,3,5-10\"). */\n  pageRange?: string | undefined;\n}\n\n/** A single page that failed to parse while the overall request succeeded. */\nexport interface AiParseDocumentPageError {\n  /** Message describing why the page failed. */\n  errorMessage?: string | undefined;\n  /** 0-based index of the page that failed. */\n  pageId?: bigint | undefined;\n}\n\nexport interface AiParseDocumentRequest {\n  /** The document to parse, given as a Unity Catalog volume path to the source file (the REST API accepts only a UC volume path, not inline binary data). Supported formats: PDF, DOCX, DOC, PPTX, PPT, JPG, JPEG, PNG, TIFF. Accepts up to 100 pages and 100 MB per document. */\n  content?: string | undefined;\n  /** Function options. Omitted fields fall back to their documented defaults. */\n  options?: AiParseDocumentOptions | undefined;\n}\n\nexport interface AiParseDocumentResponse {\n  /** The parsed document as a JSON value, containing the extracted pages and elements. */\n  document?: JsonValue | undefined;\n  /** Per-page partial-failure details; present when the request succeeds (2xx) but individual pages fail. */\n  errorStatus?: AiParseDocumentPageError[] | undefined;\n  /** Additional metadata returned by AI Parse Document. */\n  metadata?: AiParseDocumentResponseMetadata | undefined;\n}\n\nexport interface AiParseDocumentResponseMetadata {\n  /** Unique identifier for the parse request. */\n  id?: string | undefined;\n  /** The resolved function version. */\n  version?: string | undefined;\n  /** Describes the source file; present only for file-path input. */\n  fileMetadata?: AiParseDocumentFileMetadata | undefined;\n}\n\nexport const unmarshalAiClassifyResponseSchema: z.ZodType<AiClassifyResponse> =\n  z\n    .object({\n      response: jsonValueSchema.optional(),\n      metadata: z\n        .lazy(() => unmarshalAiClassifyResponseMetadataSchema)\n        .optional(),\n    })\n    .transform(d => ({\n      response: d.response,\n      metadata: d.metadata,\n    }));\n\nexport const unmarshalAiClassifyResponseMetadataSchema: z.ZodType<AiClassifyResponseMetadata> =\n  z\n    .object({\n      version: z.string().optional(),\n    })\n    .transform(d => ({\n      version: d.version,\n    }));\n\nexport const unmarshalAiDecideResponseSchema: z.ZodType<AiDecideResponse> = z\n  .object({\n    response: jsonValueSchema.optional(),\n    metadata: z.lazy(() => unmarshalAiDecideResponseMetadataSchema).optional(),\n  })\n  .transform(d => ({\n    response: d.response,\n    metadata: d.metadata,\n  }));\n\nexport const unmarshalAiDecideResponseMetadataSchema: z.ZodType<AiDecideResponseMetadata> =\n  z\n    .object({\n      version: z.string().optional(),\n    })\n    .transform(d => ({\n      version: d.version,\n    }));\n\nexport const unmarshalAiExtractBboxSchema: z.ZodType<AiExtractBbox> = z\n  .object({\n    coord: z\n      .array(\n        z.union([z.number(), z.bigint(), z.string()]).transform(v => BigInt(v))\n      )\n      .optional(),\n    page_id: z\n      .union([z.number(), z.bigint(), z.string()])\n      .transform(v => BigInt(v))\n      .optional(),\n  })\n  .transform(d => ({\n    coord: d.coord,\n    pageId: d.page_id,\n  }));\n\nexport const unmarshalAiExtractCitationSchema: z.ZodType<AiExtractCitation> = z\n  .object({\n    id: z\n      .union([z.number(), z.bigint(), z.string()])\n      .transform(v => BigInt(v))\n      .optional(),\n    start: z\n      .union([z.number(), z.bigint(), z.string()])\n      .transform(v => BigInt(v))\n      .optional(),\n    stop: z\n      .union([z.number(), z.bigint(), z.string()])\n      .transform(v => BigInt(v))\n      .optional(),\n    bbox: z.array(z.lazy(() => unmarshalAiExtractBboxSchema)).optional(),\n  })\n  .transform(d => ({\n    id: d.id,\n    start: d.start,\n    stop: d.stop,\n    bbox: d.bbox,\n  }));\n\nexport const unmarshalAiExtractResponseSchema: z.ZodType<AiExtractResponse> = z\n  .object({\n    response: jsonValueSchema.optional(),\n    metadata: z.lazy(() => unmarshalAiExtractResponseMetadataSchema).optional(),\n  })\n  .transform(d => ({\n    response: d.response,\n    metadata: d.metadata,\n  }));\n\nexport const unmarshalAiExtractResponseMetadataSchema: z.ZodType<AiExtractResponseMetadata> =\n  z\n    .object({\n      version: z.string().optional(),\n      mode: z.string().optional(),\n      chunk_type: z.string().optional(),\n      citations: z\n        .array(z.lazy(() => unmarshalAiExtractCitationSchema))\n        .optional(),\n    })\n    .transform(d => ({\n      version: d.version,\n      mode: d.mode,\n      chunkType: d.chunk_type,\n      citations: d.citations,\n    }));\n\nexport const unmarshalAiParseDocumentFileMetadataSchema: z.ZodType<AiParseDocumentFileMetadata> =\n  z\n    .object({\n      file_path: z.string().optional(),\n      file_name: z.string().optional(),\n      file_size: z\n        .union([z.number(), z.bigint(), z.string()])\n        .transform(v => BigInt(v))\n        .optional(),\n      file_modification_time: z.string().optional(),\n    })\n    .transform(d => ({\n      filePath: d.file_path,\n      fileName: d.file_name,\n      fileSize: d.file_size,\n      fileModificationTime: d.file_modification_time,\n    }));\n\nexport const unmarshalAiParseDocumentPageErrorSchema: z.ZodType<AiParseDocumentPageError> =\n  z\n    .object({\n      error_message: z.string().optional(),\n      page_id: z\n        .union([z.number(), z.bigint(), z.string()])\n        .transform(v => BigInt(v))\n        .optional(),\n    })\n    .transform(d => ({\n      errorMessage: d.error_message,\n      pageId: d.page_id,\n    }));\n\nexport const unmarshalAiParseDocumentResponseSchema: z.ZodType<AiParseDocumentResponse> =\n  z\n    .object({\n      document: jsonValueSchema.optional(),\n      error_status: z\n        .array(z.lazy(() => unmarshalAiParseDocumentPageErrorSchema))\n        .optional(),\n      metadata: z\n        .lazy(() => unmarshalAiParseDocumentResponseMetadataSchema)\n        .optional(),\n    })\n    .transform(d => ({\n      document: d.document,\n      errorStatus: d.error_status,\n      metadata: d.metadata,\n    }));\n\nexport const unmarshalAiParseDocumentResponseMetadataSchema: z.ZodType<AiParseDocumentResponseMetadata> =\n  z\n    .object({\n      id: z.string().optional(),\n      version: z.string().optional(),\n      file_metadata: z\n        .lazy(() => unmarshalAiParseDocumentFileMetadataSchema)\n        .optional(),\n    })\n    .transform(d => ({\n      id: d.id,\n      version: d.version,\n      fileMetadata: d.file_metadata,\n    }));\n\nexport const marshalAiClassifyOptionsSchema: z.ZodType = z\n  .object({\n    instructions: z.string().optional(),\n    version: z.string().optional(),\n    multilabel: z.boolean().optional(),\n    enableConfidenceScores: z.boolean().optional(),\n    enableRationales: z.boolean().optional(),\n  })\n  .transform(d => ({\n    instructions: d.instructions,\n    version: d.version,\n    multilabel: d.multilabel,\n    enable_confidence_scores: d.enableConfidenceScores,\n    enable_rationales: d.enableRationales,\n  }));\n\nexport const marshalAiClassifyRequestSchema: z.ZodType = z\n  .object({\n    content: jsonValueSchema.optional(),\n    labels: jsonValueSchema.optional(),\n    options: z.lazy(() => marshalAiClassifyOptionsSchema).optional(),\n  })\n  .transform(d => ({\n    content: d.content,\n    labels: d.labels,\n    options: d.options,\n  }));\n\nexport const marshalAiDecideOptionsSchema: z.ZodType = z\n  .object({\n    version: z.string().optional(),\n  })\n  .transform(d => ({\n    version: d.version,\n  }));\n\nexport const marshalAiDecideRequestSchema: z.ZodType = z\n  .object({\n    state: jsonValueSchema.optional(),\n    questions: jsonValueSchema.optional(),\n    options: z.lazy(() => marshalAiDecideOptionsSchema).optional(),\n  })\n  .transform(d => ({\n    state: d.state,\n    questions: d.questions,\n    options: d.options,\n  }));\n\nexport const marshalAiExtractOptionsSchema: z.ZodType = z\n  .object({\n    instructions: z.string().optional(),\n    version: z.string().optional(),\n    mode: z.string().optional(),\n    enableCitations: z.boolean().optional(),\n    enableConfidenceScores: z.boolean().optional(),\n  })\n  .transform(d => ({\n    instructions: d.instructions,\n    version: d.version,\n    mode: d.mode,\n    enable_citations: d.enableCitations,\n    enable_confidence_scores: d.enableConfidenceScores,\n  }));\n\nexport const marshalAiExtractRequestSchema: z.ZodType = z\n  .object({\n    content: jsonValueSchema.optional(),\n    schema: jsonValueSchema.optional(),\n    options: z.lazy(() => marshalAiExtractOptionsSchema).optional(),\n  })\n  .transform(d => ({\n    content: d.content,\n    schema: d.schema,\n    options: d.options,\n  }));\n\nexport const marshalAiParseDocumentOptionsSchema: z.ZodType = z\n  .object({\n    version: z.string().optional(),\n    descriptionElementTypes: z.string().optional(),\n    imageOutputPath: z.string().optional(),\n    pageRange: z.string().optional(),\n  })\n  .transform(d => ({\n    version: d.version,\n    description_element_types: d.descriptionElementTypes,\n    image_output_path: d.imageOutputPath,\n    page_range: d.pageRange,\n  }));\n\nexport const marshalAiParseDocumentRequestSchema: z.ZodType = z\n  .object({\n    content: z.string().optional(),\n    options: z.lazy(() => marshalAiParseDocumentOptionsSchema).optional(),\n  })\n  .transform(d => ({\n    content: d.content,\n    options: d.options,\n  }));\n"],"mappings":";;;AAKA,MAAM,kBAAwC,EAAE,WAC9C,EAAE,MAAM;CACN,EAAE,MAAM;CACR,EAAE,QAAQ;CACV,EAAE,QAAQ;CACV,EAAE,SAAS;CACX,EAAE,OAAO,EAAE,QAAQ,EAAE,gBAAgB;CACrC,EAAE,MAAM,gBAAgB;CACzB,CAAC,CACH;AAwTD,MAAa,oCACX,EACG,OAAO;CACN,UAAU,gBAAgB,UAAU;CACpC,UAAU,EACP,WAAW,0CAA0C,CACrD,UAAU;CACd,CAAC,CACD,WAAU,OAAM;CACf,UAAU,EAAE;CACZ,UAAU,EAAE;CACb,EAAE;AAEP,MAAa,4CACX,EACG,OAAO,EACN,SAAS,EAAE,QAAQ,CAAC,UAAU,EAC/B,CAAC,CACD,WAAU,OAAM,EACf,SAAS,EAAE,SACZ,EAAE;AAEP,MAAa,kCAA+D,EACzE,OAAO;CACN,UAAU,gBAAgB,UAAU;CACpC,UAAU,EAAE,WAAW,wCAAwC,CAAC,UAAU;CAC3E,CAAC,CACD,WAAU,OAAM;CACf,UAAU,EAAE;CACZ,UAAU,EAAE;CACb,EAAE;AAEL,MAAa,0CACX,EACG,OAAO,EACN,SAAS,EAAE,QAAQ,CAAC,UAAU,EAC/B,CAAC,CACD,WAAU,OAAM,EACf,SAAS,EAAE,SACZ,EAAE;AAEP,MAAa,+BAAyD,EACnE,OAAO;CACN,OAAO,EACJ,MACC,EAAE,MAAM;EAAC,EAAE,QAAQ;EAAE,EAAE,QAAQ;EAAE,EAAE,QAAQ;EAAC,CAAC,CAAC,WAAU,MAAK,OAAO,EAAE,CAAC,CACxE,CACA,UAAU;CACb,SAAS,EACN,MAAM;EAAC,EAAE,QAAQ;EAAE,EAAE,QAAQ;EAAE,EAAE,QAAQ;EAAC,CAAC,CAC3C,WAAU,MAAK,OAAO,EAAE,CAAC,CACzB,UAAU;CACd,CAAC,CACD,WAAU,OAAM;CACf,OAAO,EAAE;CACT,QAAQ,EAAE;CACX,EAAE;AAEL,MAAa,mCAAiE,EAC3E,OAAO;CACN,IAAI,EACD,MAAM;EAAC,EAAE,QAAQ;EAAE,EAAE,QAAQ;EAAE,EAAE,QAAQ;EAAC,CAAC,CAC3C,WAAU,MAAK,OAAO,EAAE,CAAC,CACzB,UAAU;CACb,OAAO,EACJ,MAAM;EAAC,EAAE,QAAQ;EAAE,EAAE,QAAQ;EAAE,EAAE,QAAQ;EAAC,CAAC,CAC3C,WAAU,MAAK,OAAO,EAAE,CAAC,CACzB,UAAU;CACb,MAAM,EACH,MAAM;EAAC,EAAE,QAAQ;EAAE,EAAE,QAAQ;EAAE,EAAE,QAAQ;EAAC,CAAC,CAC3C,WAAU,MAAK,OAAO,EAAE,CAAC,CACzB,UAAU;CACb,MAAM,EAAE,MAAM,EAAE,WAAW,6BAA6B,CAAC,CAAC,UAAU;CACrE,CAAC,CACD,WAAU,OAAM;CACf,IAAI,EAAE;CACN,OAAO,EAAE;CACT,MAAM,EAAE;CACR,MAAM,EAAE;CACT,EAAE;AAEL,MAAa,mCAAiE,EAC3E,OAAO;CACN,UAAU,gBAAgB,UAAU;CACpC,UAAU,EAAE,WAAW,yCAAyC,CAAC,UAAU;CAC5E,CAAC,CACD,WAAU,OAAM;CACf,UAAU,EAAE;CACZ,UAAU,EAAE;CACb,EAAE;AAEL,MAAa,2CACX,EACG,OAAO;CACN,SAAS,EAAE,QAAQ,CAAC,UAAU;CAC9B,MAAM,EAAE,QAAQ,CAAC,UAAU;CAC3B,YAAY,EAAE,QAAQ,CAAC,UAAU;CACjC,WAAW,EACR,MAAM,EAAE,WAAW,iCAAiC,CAAC,CACrD,UAAU;CACd,CAAC,CACD,WAAU,OAAM;CACf,SAAS,EAAE;CACX,MAAM,EAAE;CACR,WAAW,EAAE;CACb,WAAW,EAAE;CACd,EAAE;AAEP,MAAa,6CACX,EACG,OAAO;CACN,WAAW,EAAE,QAAQ,CAAC,UAAU;CAChC,WAAW,EAAE,QAAQ,CAAC,UAAU;CAChC,WAAW,EACR,MAAM;EAAC,EAAE,QAAQ;EAAE,EAAE,QAAQ;EAAE,EAAE,QAAQ;EAAC,CAAC,CAC3C,WAAU,MAAK,OAAO,EAAE,CAAC,CACzB,UAAU;CACb,wBAAwB,EAAE,QAAQ,CAAC,UAAU;CAC9C,CAAC,CACD,WAAU,OAAM;CACf,UAAU,EAAE;CACZ,UAAU,EAAE;CACZ,UAAU,EAAE;CACZ,sBAAsB,EAAE;CACzB,EAAE;AAEP,MAAa,0CACX,EACG,OAAO;CACN,eAAe,EAAE,QAAQ,CAAC,UAAU;CACpC,SAAS,EACN,MAAM;EAAC,EAAE,QAAQ;EAAE,EAAE,QAAQ;EAAE,EAAE,QAAQ;EAAC,CAAC,CAC3C,WAAU,MAAK,OAAO,EAAE,CAAC,CACzB,UAAU;CACd,CAAC,CACD,WAAU,OAAM;CACf,cAAc,EAAE;CAChB,QAAQ,EAAE;CACX,EAAE;AAEP,MAAa,yCACX,EACG,OAAO;CACN,UAAU,gBAAgB,UAAU;CACpC,cAAc,EACX,MAAM,EAAE,WAAW,wCAAwC,CAAC,CAC5D,UAAU;CACb,UAAU,EACP,WAAW,+CAA+C,CAC1D,UAAU;CACd,CAAC,CACD,WAAU,OAAM;CACf,UAAU,EAAE;CACZ,aAAa,EAAE;CACf,UAAU,EAAE;CACb,EAAE;AAEP,MAAa,iDACX,EACG,OAAO;CACN,IAAI,EAAE,QAAQ,CAAC,UAAU;CACzB,SAAS,EAAE,QAAQ,CAAC,UAAU;CAC9B,eAAe,EACZ,WAAW,2CAA2C,CACtD,UAAU;CACd,CAAC,CACD,WAAU,OAAM;CACf,IAAI,EAAE;CACN,SAAS,EAAE;CACX,cAAc,EAAE;CACjB,EAAE;AAEP,MAAa,iCAA4C,EACtD,OAAO;CACN,cAAc,EAAE,QAAQ,CAAC,UAAU;CACnC,SAAS,EAAE,QAAQ,CAAC,UAAU;CAC9B,YAAY,EAAE,SAAS,CAAC,UAAU;CAClC,wBAAwB,EAAE,SAAS,CAAC,UAAU;CAC9C,kBAAkB,EAAE,SAAS,CAAC,UAAU;CACzC,CAAC,CACD,WAAU,OAAM;CACf,cAAc,EAAE;CAChB,SAAS,EAAE;CACX,YAAY,EAAE;CACd,0BAA0B,EAAE;CAC5B,mBAAmB,EAAE;CACtB,EAAE;AAEL,MAAa,iCAA4C,EACtD,OAAO;CACN,SAAS,gBAAgB,UAAU;CACnC,QAAQ,gBAAgB,UAAU;CAClC,SAAS,EAAE,WAAW,+BAA+B,CAAC,UAAU;CACjE,CAAC,CACD,WAAU,OAAM;CACf,SAAS,EAAE;CACX,QAAQ,EAAE;CACV,SAAS,EAAE;CACZ,EAAE;AAEL,MAAa,+BAA0C,EACpD,OAAO,EACN,SAAS,EAAE,QAAQ,CAAC,UAAU,EAC/B,CAAC,CACD,WAAU,OAAM,EACf,SAAS,EAAE,SACZ,EAAE;AAEL,MAAa,+BAA0C,EACpD,OAAO;CACN,OAAO,gBAAgB,UAAU;CACjC,WAAW,gBAAgB,UAAU;CACrC,SAAS,EAAE,WAAW,6BAA6B,CAAC,UAAU;CAC/D,CAAC,CACD,WAAU,OAAM;CACf,OAAO,EAAE;CACT,WAAW,EAAE;CACb,SAAS,EAAE;CACZ,EAAE;AAEL,MAAa,gCAA2C,EACrD,OAAO;CACN,cAAc,EAAE,QAAQ,CAAC,UAAU;CACnC,SAAS,EAAE,QAAQ,CAAC,UAAU;CAC9B,MAAM,EAAE,QAAQ,CAAC,UAAU;CAC3B,iBAAiB,EAAE,SAAS,CAAC,UAAU;CACvC,wBAAwB,EAAE,SAAS,CAAC,UAAU;CAC/C,CAAC,CACD,WAAU,OAAM;CACf,cAAc,EAAE;CAChB,SAAS,EAAE;CACX,MAAM,EAAE;CACR,kBAAkB,EAAE;CACpB,0BAA0B,EAAE;CAC7B,EAAE;AAEL,MAAa,gCAA2C,EACrD,OAAO;CACN,SAAS,gBAAgB,UAAU;CACnC,QAAQ,gBAAgB,UAAU;CAClC,SAAS,EAAE,WAAW,8BAA8B,CAAC,UAAU;CAChE,CAAC,CACD,WAAU,OAAM;CACf,SAAS,EAAE;CACX,QAAQ,EAAE;CACV,SAAS,EAAE;CACZ,EAAE;AAEL,MAAa,sCAAiD,EAC3D,OAAO;CACN,SAAS,EAAE,QAAQ,CAAC,UAAU;CAC9B,yBAAyB,EAAE,QAAQ,CAAC,UAAU;CAC9C,iBAAiB,EAAE,QAAQ,CAAC,UAAU;CACtC,WAAW,EAAE,QAAQ,CAAC,UAAU;CACjC,CAAC,CACD,WAAU,OAAM;CACf,SAAS,EAAE;CACX,2BAA2B,EAAE;CAC7B,mBAAmB,EAAE;CACrB,YAAY,EAAE;CACf,EAAE;AAEL,MAAa,sCAAiD,EAC3D,OAAO;CACN,SAAS,EAAE,QAAQ,CAAC,UAAU;CAC9B,SAAS,EAAE,WAAW,oCAAoC,CAAC,UAAU;CACtE,CAAC,CACD,WAAU,OAAM;CACf,SAAS,EAAE;CACX,SAAS,EAAE;CACZ,EAAE"}

package/dist/v1/transport.d.ts

@@ -0,0 +1,37 @@
+import { HttpClient } from "@databricks/sdk-core/http";
+import { ClientOptions } from "@databricks/sdk-options/client";
+
+//#region src/v1/transport.d.ts
+/**
+ * The configuration a client needs to issue requests, resolved from
+ * {@link ClientOptions} and a configuration profile.
+ */
+interface ResolvedClientConfig {
+  /** Host with any trailing slash removed. */
+  host: string;
+  /**
+   * Default account ID for account-level paths that contain an account_id
+   * segment. A request's own accountId still wins.
+   */
+  accountId?: string;
+  /**
+   * Workspace ID used to route workspace-level calls on unified hosts (SPOG).
+   */
+  workspaceId?: string;
+  /** HTTP client with authentication, and any configured timeout, applied. */
+  httpClient: HttpClient;
+}
+/**
+ * Resolves {@link ClientOptions} into a {@link ResolvedClientConfig}.
+ *
+ * A configuration profile is always resolved from the config file and
+ * environment variables (per options.profileOptions); it supplies host,
+ * accountId, workspaceId, and credentials wherever the caller did not set them
+ * explicitly. Explicit options always take precedence.
+ *
+ * @throws if host is neither provided nor present in the resolved profile.
+ */
+declare function resolveClientConfig(options: ClientOptions): Promise<ResolvedClientConfig>;
+//#endregion
+export { ResolvedClientConfig, resolveClientConfig };
+//# sourceMappingURL=transport.d.ts.map

package/dist/v1/transport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transport.d.ts","names":[],"sources":["../../src/v1/transport.ts"],"mappings":";;;;;;AAkBA;;UAAiB,oBAAA;EAgBO;EAdtB,IAAA;EAMA;;;;EAAA,SAAA;EAQsB;AAaxB;;EAhBE,WAAA;EAiBS;EAdT,UAAA,EAAY,UAAA;AAAA;;;;;;;;;;;iBAaQ,mBAAA,CACpB,OAAA,EAAS,aAAA,GACR,OAAA,CAAQ,oBAAA"}