@pdfvector/instance-contract 0.0.11 → 0.0.13

package/.tsc/lib/router/document/ask.d.ts

@@ -19,4 +19,6 @@ export declare const ask: import("@orpc/contract").ContractProcedureBuilderWithI
         pro: "pro";
         max: "max";
     }>;
+    requestId: z.ZodNumber;
+    documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

package/.tsc/lib/router/document/ask.js

@@ -47,12 +47,21 @@ const askOutputSchema = z
         "'mini': Supports PDF, Word, Excel, CSV. " +
         "'pro': Supports PDF, Word, Excel, CSV, Image. " +
         "'max': Supports PDF, Word, Excel, CSV, Image."),
+    requestId: z
+        .number()
+        .int()
+        .describe("Unique request identifier for this API call"),
+    documentId: z
+        .string()
+        .optional()
+        .describe("Document ID if provided via x-pdfvector-document-id header"),
 })
     .meta({
     examples: [
         {
             markdown: "The study found that viral shedding peaked during the first week of symptoms, with the highest viral loads detected in throat swabs.",
             model: "mini",
+            requestId: 1,
         },
     ],
 });

package/.tsc/lib/router/document/extract.d.ts

@@ -1,10 +1,10 @@
 import { z } from "zod";
-export declare const extract: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
+export declare const extract: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
     url: z.ZodOptional<z.ZodURL>;
     file: z.ZodOptional<z.ZodFile>;
     base64: z.ZodOptional<z.ZodString>;
     prompt: z.ZodString;
-    schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    schema: z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodPipe<z.ZodString, z.ZodTransform<Record<string, unknown>, string>>]>;
     model: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
         nano: "nano";
         mini: "mini";
@@ -12,7 +12,7 @@ export declare const extract: import("@orpc/contract").ContractProcedureBuilderW
         max: "max";
         auto: "auto";
     }>>>;
-}, z.core.$strip>>, z.ZodObject<{
+}, z.core.$strip>, z.ZodObject<{
     data: z.ZodUnknown;
     model: z.ZodEnum<{
         nano: "nano";
@@ -20,4 +20,6 @@ export declare const extract: import("@orpc/contract").ContractProcedureBuilderW
         pro: "pro";
         max: "max";
     }>;
+    requestId: z.ZodNumber;
+    documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

package/.tsc/lib/router/document/extract.js

@@ -2,35 +2,7 @@ import { oc } from "@orpc/contract";
 import { z } from "zod";
 import { pdfvectorModelSchema } from "../../pdfvector-model-schema";
 import { getDefaultSpec } from "./get-default-spec";
-// Support for dot-notation in multipart form-data
-function expandDotNotation(input) {
-    if (typeof input !== "object" || input === null)
-        return input;
-    const obj = input;
-    const dotKeys = Object.keys(obj).filter((k) => k.includes("."));
-    if (dotKeys.length === 0)
-        return input;
-    const result = { ...obj };
-    for (const key of dotKeys) {
-        const parts = key.split(".");
-        let current = result;
-        for (let i = 0; i < parts.length - 1; i++) {
-            const part = parts[i];
-            if (part === undefined)
-                continue;
-            if (!(part in current) || typeof current[part] !== "object") {
-                current[part] = {};
-            }
-            current = current[part];
-        }
-        const lastPart = parts[parts.length - 1];
-        if (lastPart !== undefined)
-            current[lastPart] = obj[key];
-        delete result[key];
-    }
-    return result;
-}
-const extractInputSchema = z.preprocess(expandDotNotation, z.object({
+const extractInputSchema = z.object({
     url: z
         .url()
         .optional()
@@ -57,8 +29,32 @@ const extractInputSchema = z.preprocess(expandDotNotation, z.object({
         .min(4)
         .describe("The prompt instructing the AI how to extract data from the document"),
     schema: z
-        .record(z.string(), z.unknown())
-        .describe("JSON Schema describing the structure of the data to extract from the document"),
+        .union([
+        z.record(z.string(), z.unknown()),
+        z.string().transform((str, ctx) => {
+            try {
+                // Strip surrounding quotes added by form-data clients
+                const trimmed = str.startsWith('"') && str.endsWith('"') ? str.slice(1, -1) : str;
+                const parsed = JSON.parse(trimmed);
+                if (typeof parsed !== "object" || parsed === null) {
+                    ctx.addIssue({
+                        code: z.ZodIssueCode.custom,
+                        message: "Schema must be a JSON object",
+                    });
+                    return z.NEVER;
+                }
+                return parsed;
+            }
+            catch {
+                ctx.addIssue({
+                    code: z.ZodIssueCode.custom,
+                    message: "Invalid JSON string for schema",
+                });
+                return z.NEVER;
+            }
+        }),
+    ])
+        .describe("JSON Schema describing the structure of the data to extract from the document. Can be a JSON object or a JSON string."),
     model: z
         .enum(["auto", ...pdfvectorModelSchema.options])
         .optional()
@@ -69,7 +65,7 @@ const extractInputSchema = z.preprocess(expandDotNotation, z.object({
         "'mini': Uses mid-range models (likely better than GPT-5-mini). Supports PDF, Word, Excel, CSV. " +
         "'pro': Uses capable models (likely better than GPT-5.2). Supports PDF, Word, Excel, CSV, Image. " +
         "'max': Uses the most powerful models (likely better than Claude Opus 4.6). Supports PDF, Word, Excel, CSV, Image."),
-}));
+});
 const extractOutputSchema = z
     .object({
     data: z
@@ -80,6 +76,14 @@ const extractOutputSchema = z
         "'mini': Supports PDF, Word, Excel, CSV. " +
         "'pro': Supports PDF, Word, Excel, CSV, Image. " +
         "'max': Supports PDF, Word, Excel, CSV, Image."),
+    requestId: z
+        .number()
+        .int()
+        .describe("Unique request identifier for this API call"),
+    documentId: z
+        .string()
+        .optional()
+        .describe("Document ID if provided via x-pdfvector-document-id header"),
 })
     .meta({
     examples: [
@@ -90,6 +94,7 @@ const extractOutputSchema = z
                 year: 2020,
             },
             model: "mini",
+            requestId: 1,
         },
     ],
 });
@@ -99,7 +104,7 @@ const requestExamples = {
         value: {
             url: "https://drive.google.com/file/d/13T04Yk20OwBNIDyvJJ3XlUg9WfOsmbjm/view?usp=share_link",
             prompt: "Extract the title, authors, and publication year from this research paper",
-            schema: {
+            schema: JSON.stringify({
                 type: "object",
                 properties: {
                     title: { type: "string" },
@@ -107,7 +112,7 @@ const requestExamples = {
                     year: { type: "number" },
                 },
                 required: ["title", "authors", "year"],
-            },
+            }),
         },
     },
     "Extract from base64": {
@@ -115,13 +120,13 @@ const requestExamples = {
         value: {
             base64: "JVBERi0xLjAKMSAwIG9iajw8L1R5cGUvQ2F0YWxvZy9QYWdlcyAyIDAgUj4+ZW5kb2JqIDIgMCBvYmo8PC9UeXBlL1BhZ2VzL0tpZHNbMyAwIFJdL0NvdW50IDE+PmVuZG9iaiAzIDAgb2JqPDwvVHlwZS9QYWdlL01lZGlhQm94WzAgMCAzIDNdL1BhcmVudCAyIDAgUj4+ZW5kb2JqCnhyZWYKMCA0CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAwOSAwMDAwMCBuIAowMDAwMDAwMDU4IDAwMDAwIG4gCjAwMDAwMDAxMTUgMDAwMDAgbiAKdHJhaWxlcjw8L1NpemUgNC9Sb290IDEgMCBSPj4Kc3RhcnR4cmVmCjE5MAolJUVPRg==",
             prompt: "Extract the main content from this document",
-            schema: {
+            schema: JSON.stringify({
                 type: "object",
                 properties: {
                     content: { type: "string" },
                 },
                 required: ["content"],
-            },
+            }),
         },
     },
     "Extract from file upload": {
@@ -129,14 +134,14 @@ const requestExamples = {
         value: {
             file: "(binary)",
             prompt: "Extract the title and summary from this document",
-            schema: {
+            schema: JSON.stringify({
                 type: "object",
                 properties: {
                     title: { type: "string" },
                     summary: { type: "string" },
                 },
                 required: ["title", "summary"],
-            },
+            }),
         },
     },
 };

package/.tsc/lib/router/document/get-default-spec.js

@@ -1,5 +1,14 @@
 export function getDefaultSpec(op, requestExamples) {
     op.security = [{ bearerAuth: [] }];
+    const params = (op.parameters ?? []);
+    params.push({
+        name: "x-pdfvector-document-id",
+        in: "header",
+        required: false,
+        schema: { type: "string", default: "my-doc-123" },
+        description: "Optional document ID to associate with this request. Returned in the response and saved for usage tracking.",
+    });
+    op.parameters = params;
     const reqBody = op.requestBody;
     if (reqBody?.content) {
         for (const mediaType of Object.values(reqBody.content)) {

package/.tsc/lib/router/document/parse.d.ts

@@ -19,4 +19,6 @@ export declare const parse: import("@orpc/contract").ContractProcedureBuilderWit
         pro: "pro";
         max: "max";
     }>;
+    requestId: z.ZodNumber;
+    documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

package/.tsc/lib/router/document/parse.js

@@ -35,27 +35,22 @@ const parseInputSchema = z.object({
         "'pro': For documents up to 30 pages with tables, handwritten text, figures, math, and Arabic. File up to 30 pages, up to 40MB in size. Supports PDF, Word, Excel, CSV, Image. " +
         "'max': For large documents with full Pro capabilities plus enhanced multilingual support. File up to 1000 pages, up to 500MB in size. Supports PDF, Word, Excel, CSV, Image."),
 });
-const parseOutputSchema = z
-    .object({
+const parseOutputSchema = z.object({
     markdown: z.string().describe("Extracted text content from the document"),
-    pageCount: z
-        .number()
-        .int()
-        .describe("Total number of pages in the document"),
+    pageCount: z.number().int().describe("Total number of pages in the document"),
     model: pdfvectorModelSchema.describe("Model tier used to parse the document. " +
         "'nano': Supports PDF, Word, Excel, CSV. " +
         "'mini': Supports PDF, Word, Excel, CSV. " +
         "'pro': Supports PDF, Word, Excel, CSV, Image. " +
         "'max': Supports PDF, Word, Excel, CSV, Image."),
-})
-    .meta({
-    examples: [
-        {
-            markdown: "Nature | Vol 581 | 28 May 2020 | 465\nArticle\nVirological assessment of hospitalized patients with COVID-2019...",
-            pageCount: 12,
-            model: "nano",
-        },
-    ],
+    requestId: z
+        .number()
+        .int()
+        .describe("Unique request identifier for this API call"),
+    documentId: z
+        .string()
+        .optional()
+        .describe("Document ID if provided via x-pdfvector-document-id header"),
 });
 const requestExamples = {
     "Parse from URL": {

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @pdfvector/instance-contract
 
+## 0.0.13
+### Patch Changes
+
+
+
+- [#87](https://github.com/phuctm97/pdfvector/pull/87) [`a147b7c`](https://github.com/phuctm97/pdfvector/commit/a147b7c7646aab95422e5b874acbc89695a1c985) Thanks [@khanhduyvt0101](https://github.com/khanhduyvt0101)! - Dont store file in instance and update org for spa
+
+## 0.0.12
+### Patch Changes
+
+
+
+- [#73](https://github.com/phuctm97/pdfvector/pull/73) [`ac9abc9`](https://github.com/phuctm97/pdfvector/commit/ac9abc91033f12b2af2ff9e49393873f1759dcda) Thanks [@khanhduyvt0101](https://github.com/khanhduyvt0101)! - Add usage tracker
+
 ## 0.0.11
 ### Patch Changes
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdfvector/instance-contract",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "type": "module",
   "main": ".tsc/lib/index.js",
   "dependencies": {