@pdfvector/instance-contract 0.0.22 → 0.0.24

package/.tsc/lib/router/admin/set-environment.js

@@ -9,6 +9,7 @@ const reservedKeys = new Set([
     "PDFVECTOR_RELEASES_S3_BUCKET",
     "PDFVECTOR_RELEASES_DYNAMODB_TABLE",
     "PDFVECTOR_INSTANCE_SERVER_DOMAIN",
+    "PDFVECTOR_INSTANCE_SERVER_DATA_DIR",
 ]);
 export const setEnvironment = oc
     .route({

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

@@ -13,12 +13,14 @@ export declare const ask: import("@orpc/contract").ContractProcedureBuilderWithI
     }>>;
 }, z.core.$strip>, z.ZodObject<{
     markdown: z.ZodString;
+    pageCount: z.ZodNumber;
     model: z.ZodEnum<{
         nano: "nano";
         mini: "mini";
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

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

@@ -40,7 +40,12 @@ const askInputSchema = z.object({
 });
 const askOutputSchema = z.object({
     markdown: z.string().describe("The answer to the question"),
+    pageCount: z.number().int().describe("Total number of pages in the document"),
     model: pdfvectorModelSchema.describe("Model tier used to answer the question"),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

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

@@ -14,12 +14,14 @@ export declare const extract: import("@orpc/contract").ContractProcedureBuilderW
     }>>;
 }, z.core.$strip>, z.ZodObject<{
     data: z.ZodUnknown;
+    pageCount: z.ZodNumber;
     model: z.ZodEnum<{
         nano: "nano";
         mini: "mini";
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

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

@@ -68,7 +68,12 @@ const extractOutputSchema = z.object({
     data: z
         .unknown()
         .describe("Extracted structured data matching the provided JSON Schema"),
+    pageCount: z.number().int().describe("Total number of pages in the document"),
     model: pdfvectorModelSchema.describe("Model tier used to extract the data"),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

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

@@ -15,6 +15,7 @@ export declare const parse: import("@orpc/contract").ContractProcedureBuilderWit
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     html: z.ZodOptional<z.ZodString>;
     documentId: z.ZodOptional<z.ZodString>;

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

@@ -41,6 +41,10 @@ const parseOutputSchema = z.object({
     model: z
         .enum(["pro", "max"])
         .describe("Model tier used to parse the bank statement"),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

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

@@ -13,12 +13,14 @@ export declare const ask: import("@orpc/contract").ContractProcedureBuilderWithI
     }>>>;
 }, z.core.$strip>, z.ZodObject<{
     markdown: z.ZodString;
+    pageCount: z.ZodNumber;
     model: z.ZodEnum<{
         nano: "nano";
         mini: "mini";
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

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

@@ -42,11 +42,19 @@ const askInputSchema = z.object({
 const askOutputSchema = z
     .object({
     markdown: z.string().describe("The answer to the question"),
+    pageCount: z
+        .number()
+        .int()
+        .describe("Total number of pages in the document"),
     model: pdfvectorModelSchema.describe("Model tier used to answer the question. " +
         "'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."),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()
@@ -60,7 +68,9 @@ const askOutputSchema = z
     examples: [
         {
             markdown: "The study found that viral shedding peaked during the first week of symptoms, with the highest viral loads detected in throat swabs.",
+            pageCount: 12,
             model: "mini",
+            credits: 48,
             requestId: 1,
         },
     ],

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

@@ -14,12 +14,14 @@ export declare const extract: import("@orpc/contract").ContractProcedureBuilderW
     }>>>;
 }, z.core.$strip>, z.ZodObject<{
     data: z.ZodUnknown;
+    pageCount: z.ZodNumber;
     model: z.ZodEnum<{
         nano: "nano";
         mini: "mini";
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

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

@@ -71,11 +71,19 @@ const extractOutputSchema = z
     data: z
         .unknown()
         .describe("Extracted structured data matching the provided JSON Schema"),
+    pageCount: z
+        .number()
+        .int()
+        .describe("Total number of pages in the document"),
     model: pdfvectorModelSchema.describe("Model tier used to extract the data. " +
         "'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."),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()
@@ -93,7 +101,9 @@ const extractOutputSchema = z
                 authors: ["Roman Wölfel", "Victor M. Corman"],
                 year: 2020,
             },
+            pageCount: 12,
             model: "mini",
+            credits: 48,
             requestId: 1,
         },
     ],

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

@@ -19,6 +19,7 @@ export declare const parse: import("@orpc/contract").ContractProcedureBuilderWit
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     html: z.ZodOptional<z.ZodString>;
     documentId: z.ZodOptional<z.ZodString>;

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

@@ -43,6 +43,10 @@ const parseOutputSchema = z.object({
         "'mini': Supports PDF, Word, Excel, CSV. " +
         "'pro': Supports PDF, Word, Excel, CSV, Image. " +
         "'max': Supports PDF, Word, Excel, CSV, Image."),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

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

@@ -13,12 +13,14 @@ export declare const ask: import("@orpc/contract").ContractProcedureBuilderWithI
     }>>;
 }, z.core.$strip>, z.ZodObject<{
     markdown: z.ZodString;
+    pageCount: z.ZodNumber;
     model: z.ZodEnum<{
         nano: "nano";
         mini: "mini";
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

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

@@ -40,7 +40,12 @@ const askInputSchema = z.object({
 });
 const askOutputSchema = z.object({
     markdown: z.string().describe("The answer to the question"),
+    pageCount: z.number().int().describe("Total number of pages in the document"),
     model: pdfvectorModelSchema.describe("Model tier used to answer the question"),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

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

@@ -14,12 +14,14 @@ export declare const extract: import("@orpc/contract").ContractProcedureBuilderW
     }>>;
 }, z.core.$strip>, z.ZodObject<{
     data: z.ZodUnknown;
+    pageCount: z.ZodNumber;
     model: z.ZodEnum<{
         nano: "nano";
         mini: "mini";
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

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

@@ -68,7 +68,12 @@ const extractOutputSchema = z.object({
     data: z
         .unknown()
         .describe("Extracted structured data matching the provided JSON Schema"),
+    pageCount: z.number().int().describe("Total number of pages in the document"),
     model: pdfvectorModelSchema.describe("Model tier used to extract the data"),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

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

@@ -17,6 +17,7 @@ export declare const parse: import("@orpc/contract").ContractProcedureBuilderWit
     }>;
     documentType: z.ZodOptional<z.ZodString>;
     html: z.ZodOptional<z.ZodString>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

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

@@ -50,6 +50,10 @@ const parseOutputSchema = z.object({
         .optional()
         .describe("Full HTML representation of the document content. Only available when using the 'max' model. " +
         "Preserves rich formatting, tables, selection marks, and visual layout that cannot be fully represented in markdown."),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

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

@@ -13,12 +13,14 @@ export declare const ask: import("@orpc/contract").ContractProcedureBuilderWithI
     }>>;
 }, z.core.$strip>, z.ZodObject<{
     markdown: z.ZodString;
+    pageCount: z.ZodNumber;
     model: z.ZodEnum<{
         nano: "nano";
         mini: "mini";
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

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

@@ -37,7 +37,12 @@ const askInputSchema = z.object({
 });
 const askOutputSchema = z.object({
     markdown: z.string().describe("The answer to the question"),
+    pageCount: z.number().int().describe("Total number of pages in the document"),
     model: pdfvectorModelSchema.describe("Model tier used to answer the question"),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

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

@@ -14,12 +14,14 @@ export declare const extract: import("@orpc/contract").ContractProcedureBuilderW
     }>>;
 }, z.core.$strip>, z.ZodObject<{
     data: z.ZodUnknown;
+    pageCount: z.ZodNumber;
     model: z.ZodEnum<{
         nano: "nano";
         mini: "mini";
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

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

@@ -65,7 +65,12 @@ const extractOutputSchema = z.object({
     data: z
         .unknown()
         .describe("Extracted structured data matching the provided JSON Schema"),
+    pageCount: z.number().int().describe("Total number of pages in the document"),
     model: pdfvectorModelSchema.describe("Model tier used to extract the data"),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

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

@@ -15,6 +15,7 @@ export declare const parse: import("@orpc/contract").ContractProcedureBuilderWit
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     html: z.ZodOptional<z.ZodString>;
     documentId: z.ZodOptional<z.ZodString>;

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

@@ -36,6 +36,10 @@ const parseOutputSchema = z.object({
     model: z
         .enum(["pro", "max"])
         .describe("Model tier used to parse the invoice"),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @pdfvector/instance-contract
 
+## 0.0.24
+### Patch Changes
+
+
+
+- [#133](https://github.com/phuctm97/pdfvector/pull/133) [`953cf32`](https://github.com/phuctm97/pdfvector/commit/953cf328a9eb30dd4dff3f40fd68dbfe4078901d) Thanks [@khanhduyvt0101](https://github.com/khanhduyvt0101)! - Add credits and pageCount to API responses, deduplicate ask/extract handlers, and improve extract prompt
+
+## 0.0.23
+### Patch Changes
+
+
+
+- [#130](https://github.com/phuctm97/pdfvector/pull/130) [`41110b1`](https://github.com/phuctm97/pdfvector/commit/41110b1a1c078183c1014fbf45828c3da40d7971) Thanks [@phuctm97](https://github.com/phuctm97)! - Store the instance server SQLite database in `PDFVECTOR_INSTANCE_SERVER_DATA_DIR` when set, while keeping migrations and control files in the working directory. Fresh Docker and non-Docker installs now create a dedicated data directory for the instance server, and admin environment updates reserve the new data-dir variable.
+
 ## 0.0.22
 ### Patch Changes
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdfvector/instance-contract",
-  "version": "0.0.22",
+  "version": "0.0.24",
   "type": "module",
   "description": "API contract definitions for PDFVector instance server",
   "license": "MIT",