@pdfvector/instance-contract 0.0.55 → 0.0.56

package/.tsc/lib/router/academic/fetch.js

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { getOpenApiCodeSamples } from "@pdfvector/api-docs";
 import { academicCreditCosts } from "@pdfvector/util";
 import { z } from "zod";
 import { providerSchema } from "./provider.js";
@@ -112,6 +113,7 @@ export const fetch = oc
                 mediaType.examples = requestExamples;
             }
         }
+        op["x-codeSamples"] = getOpenApiCodeSamples("academic-fetch");
         return op;
     },
 });

package/.tsc/lib/router/academic/find-citations.js

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { getOpenApiCodeSamples } from "@pdfvector/api-docs";
 import { academicCreditCosts } from "@pdfvector/util";
 import { z } from "zod";
 import { providerSchema } from "./provider.js";
@@ -109,6 +110,7 @@ export const findCitations = oc
                 mediaType.examples = requestExamples;
             }
         }
+        op["x-codeSamples"] = getOpenApiCodeSamples("academic-find-citations");
         return op;
     },
 });

package/.tsc/lib/router/academic/paper-graph.js

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { getOpenApiCodeSamples } from "@pdfvector/api-docs";
 import { academicCreditCosts } from "@pdfvector/util";
 import { z } from "zod";
 import { providerSchema } from "./provider.js";
@@ -137,6 +138,7 @@ export const paperGraph = oc
                 mediaType.examples = requestExamples;
             }
         }
+        op["x-codeSamples"] = getOpenApiCodeSamples("academic-paper-graph");
         return op;
     },
 });

package/.tsc/lib/router/academic/search-grants.js

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { getOpenApiCodeSamples } from "@pdfvector/api-docs";
 import { academicCreditCosts } from "@pdfvector/util";
 import { z } from "zod";
 import { grantProviderSchema } from "./provider.js";
@@ -164,6 +165,7 @@ export const searchGrants = oc
                 mediaType.examples = requestExamples;
             }
         }
+        op["x-codeSamples"] = getOpenApiCodeSamples("academic-search-grants");
         return op;
     },
 });

package/.tsc/lib/router/academic/search.js

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { getOpenApiCodeSamples } from "@pdfvector/api-docs";
 import { academicCreditCosts } from "@pdfvector/util";
 import { z } from "zod";
 import { providerSchema } from "./provider.js";
@@ -147,6 +148,7 @@ export const search = oc
                 mediaType.examples = requestExamples;
             }
         }
+        op["x-codeSamples"] = getOpenApiCodeSamples("academic-search");
         return op;
     },
 });

package/.tsc/lib/router/academic/similar-papers.js

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { getOpenApiCodeSamples } from "@pdfvector/api-docs";
 import { academicCreditCosts } from "@pdfvector/util";
 import { z } from "zod";
 import { providerSchema } from "./provider.js";
@@ -136,6 +137,7 @@ export const similarPapers = oc
                 mediaType.examples = requestExamples;
             }
         }
+        op["x-codeSamples"] = getOpenApiCodeSamples("academic-similar-papers");
         return op;
     },
 });

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

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { getOpenApiCodeSamples } from "@pdfvector/api-docs";
 import { z } from "zod";
 import { fetchableUrlSchema } from "../../fetchable-url-schema.js";
 import { pdfvectorModelSchema } from "../../pdfvector-model-schema.js";
@@ -70,7 +71,11 @@ export const ask = oc
     summary: "Ask a question about a bank statement",
     description: `Parse a bank statement and answer a question about its content using AI. Supports ${supportedFileTypesLong}. Provide the document via file upload, a public URL, or a base64-encoded string.`,
     tags: ["Bank Statement"],
-    spec: (op) => getDefaultSpec(op, requestExamples),
+    spec: (op) => {
+        const spec = getDefaultSpec(op, requestExamples);
+        spec["x-codeSamples"] = getOpenApiCodeSamples("bank-statement-ask");
+        return spec;
+    },
 })
     .input(askInputSchema)
     .output(askOutputSchema);

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

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { getOpenApiCodeSamples } from "@pdfvector/api-docs";
 import { z } from "zod";
 import { fetchableUrlSchema } from "../../fetchable-url-schema.js";
 import { jsonSchemaInput } from "../../json-schema-input.js";
@@ -95,7 +96,11 @@ export const extract = oc
     summary: "Extract structured data from a bank statement",
     description: `Parse a bank statement and extract structured data matching a provided JSON Schema using AI. Supports ${supportedFileTypesLong}. Provide the document via file upload, a public URL, or a base64-encoded string.`,
     tags: ["Bank Statement"],
-    spec: (op) => getDefaultSpec(op, requestExamples),
+    spec: (op) => {
+        const spec = getDefaultSpec(op, requestExamples);
+        spec["x-codeSamples"] = getOpenApiCodeSamples("bank-statement-extract");
+        return spec;
+    },
 })
     .input(extractInputSchema)
     .output(extractOutputSchema);

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

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { getOpenApiCodeSamples } from "@pdfvector/api-docs";
 import { z } from "zod";
 import { fetchableUrlSchema } from "../../fetchable-url-schema.js";
 import { specializedParseModelDescription, supportedFileFormatsDescription, supportedFileMimeErrorMessage, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes.js";
@@ -87,7 +88,11 @@ export const parse = oc
     summary: "Parse a bank statement",
     description: `Extract text and structured data from a bank statement. Supports ${supportedFileTypesLong}. Provide the document via file upload, a public URL, or a base64-encoded string.`,
     tags: ["Bank Statement"],
-    spec: (op) => getDefaultSpec(op, requestExamples),
+    spec: (op) => {
+        const spec = getDefaultSpec(op, requestExamples);
+        spec["x-codeSamples"] = getOpenApiCodeSamples("bank-statement-parse");
+        return spec;
+    },
 })
     .input(parseInputSchema)
     .output(parseOutputSchema);

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

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { getOpenApiCodeSamples } from "@pdfvector/api-docs";
 import { z } from "zod";
 import { fetchableUrlSchema } from "../../fetchable-url-schema.js";
 import { pdfvectorModelSchema } from "../../pdfvector-model-schema.js";
@@ -116,7 +117,11 @@ export const ask = oc
     summary: "Ask a question about a document",
     description: `Parse a document and answer a question about its content using AI. Supports ${supportedFileTypesLong}. Files up to 1000 pages and up to 500MB in size. Provide the document via file upload, a public URL, or a base64-encoded string.`,
     tags: ["Document"],
-    spec: (op) => getDefaultSpec(op, requestExamples),
+    spec: (op) => {
+        const spec = getDefaultSpec(op, requestExamples);
+        spec["x-codeSamples"] = getOpenApiCodeSamples("document-ask");
+        return spec;
+    },
 })
     .input(askInputSchema)
     .output(askOutputSchema);

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

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { getOpenApiCodeSamples } from "@pdfvector/api-docs";
 import { z } from "zod";
 import { fetchableUrlSchema } from "../../fetchable-url-schema.js";
 import { jsonSchemaInput } from "../../json-schema-input.js";
@@ -134,7 +135,11 @@ export const extract = oc
     summary: "Extract structured data from a document",
     description: `Parse a document and extract structured data matching a provided JSON Schema using AI. Supports ${supportedFileTypesLong}. Files up to 1000 pages and up to 500MB in size. Provide the document via file upload, a public URL, or a base64-encoded string.`,
     tags: ["Document"],
-    spec: (op) => getDefaultSpec(op, requestExamples),
+    spec: (op) => {
+        const spec = getDefaultSpec(op, requestExamples);
+        spec["x-codeSamples"] = getOpenApiCodeSamples("document-extract");
+        return spec;
+    },
 })
     .input(extractInputSchema)
     .output(extractOutputSchema);

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

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { getOpenApiCodeSamples } from "@pdfvector/api-docs";
 import { z } from "zod";
 import { fetchableUrlSchema } from "../../fetchable-url-schema.js";
 import { pdfvectorModelSchema } from "../../pdfvector-model-schema.js";
@@ -77,7 +78,11 @@ export const ask = oc
     summary: "Ask a question about an identity document",
     description: `Parse an identity document and answer a question about its content using AI. Supports ${supportedFileTypesLong}. Provide the document via file upload, a public URL, or a base64-encoded string.`,
     tags: ["Identity"],
-    spec: (op) => getDefaultSpec(op, requestExamples),
+    spec: (op) => {
+        const spec = getDefaultSpec(op, requestExamples);
+        spec["x-codeSamples"] = getOpenApiCodeSamples("identity-ask");
+        return spec;
+    },
 })
     .input(askInputSchema)
     .output(askOutputSchema);

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

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { getOpenApiCodeSamples } from "@pdfvector/api-docs";
 import { z } from "zod";
 import { fetchableUrlSchema } from "../../fetchable-url-schema.js";
 import { jsonSchemaInput } from "../../json-schema-input.js";
@@ -85,7 +86,11 @@ export const extract = oc
     summary: "Extract structured data from an identity document",
     description: `Parse an identity document and extract structured data matching a provided JSON Schema using AI. Supports ${supportedFileTypesLong}. Provide the document via file upload, a public URL, or a base64-encoded string.`,
     tags: ["Identity"],
-    spec: (op) => getDefaultSpec(op, requestExamples),
+    spec: (op) => {
+        const spec = getDefaultSpec(op, requestExamples);
+        spec["x-codeSamples"] = getOpenApiCodeSamples("identity-extract");
+        return spec;
+    },
 })
     .input(extractInputSchema)
     .output(extractOutputSchema);

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

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { getOpenApiCodeSamples } from "@pdfvector/api-docs";
 import { z } from "zod";
 import { fetchableUrlSchema } from "../../fetchable-url-schema.js";
 import { specializedParseModelDescription, supportedFileFormatsDescription, supportedFileMimeErrorMessage, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes.js";
@@ -91,7 +92,11 @@ export const parse = oc
     summary: "Parse an identity document",
     description: `Extract text and structured data from an identity document. Supports ${supportedFileTypesLong}. Provide the document via file upload, a public URL, or a base64-encoded string.`,
     tags: ["Identity"],
-    spec: (op) => getDefaultSpec(op, requestExamples),
+    spec: (op) => {
+        const spec = getDefaultSpec(op, requestExamples);
+        spec["x-codeSamples"] = getOpenApiCodeSamples("identity-parse");
+        return spec;
+    },
 })
     .input(parseInputSchema)
     .output(parseOutputSchema);

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

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { getOpenApiCodeSamples } from "@pdfvector/api-docs";
 import { z } from "zod";
 import { fetchableUrlSchema } from "../../fetchable-url-schema.js";
 import { pdfvectorModelSchema } from "../../pdfvector-model-schema.js";
@@ -67,7 +68,11 @@ export const ask = oc
     summary: "Ask a question about an invoice",
     description: `Parse an invoice and answer a question about its content using AI. Supports ${supportedFileTypesLong}. Provide the document via file upload, a public URL, or a base64-encoded string.`,
     tags: ["Invoice"],
-    spec: (op) => getDefaultSpec(op, requestExamples),
+    spec: (op) => {
+        const spec = getDefaultSpec(op, requestExamples);
+        spec["x-codeSamples"] = getOpenApiCodeSamples("invoice-ask");
+        return spec;
+    },
 })
     .input(askInputSchema)
     .output(askOutputSchema);

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

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { getOpenApiCodeSamples } from "@pdfvector/api-docs";
 import { z } from "zod";
 import { fetchableUrlSchema } from "../../fetchable-url-schema.js";
 import { jsonSchemaInput } from "../../json-schema-input.js";
@@ -91,7 +92,11 @@ export const extract = oc
     summary: "Extract structured data from an invoice",
     description: `Parse an invoice and extract structured data matching a provided JSON Schema using AI. Supports ${supportedFileTypesLong}. Provide the document via file upload, a public URL, or a base64-encoded string.`,
     tags: ["Invoice"],
-    spec: (op) => getDefaultSpec(op, requestExamples),
+    spec: (op) => {
+        const spec = getDefaultSpec(op, requestExamples);
+        spec["x-codeSamples"] = getOpenApiCodeSamples("invoice-extract");
+        return spec;
+    },
 })
     .input(extractInputSchema)
     .output(extractOutputSchema);

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

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { getOpenApiCodeSamples } from "@pdfvector/api-docs";
 import { z } from "zod";
 import { fetchableUrlSchema } from "../../fetchable-url-schema.js";
 import { specializedParseModelDescription, supportedFileFormatsDescription, supportedFileMimeErrorMessage, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes.js";
@@ -82,7 +83,11 @@ export const parse = oc
     summary: "Parse an invoice",
     description: `Extract text and structured data from an invoice. Supports ${supportedFileTypesLong}. Provide the document via file upload, a public URL, or a base64-encoded string.`,
     tags: ["Invoice"],
-    spec: (op) => getDefaultSpec(op, requestExamples),
+    spec: (op) => {
+        const spec = getDefaultSpec(op, requestExamples);
+        spec["x-codeSamples"] = getOpenApiCodeSamples("invoice-parse");
+        return spec;
+    },
 })
     .input(parseInputSchema)
     .output(parseOutputSchema);

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @pdfvector/instance-contract
 
+## 0.0.56
+### Patch Changes
+
+
+
+- [#274](https://github.com/phuctm97/pdfvector/pull/274) [`5f61021`](https://github.com/phuctm97/pdfvector/commit/5f61021385f3d97e02bc92d2d8b5ed2ad3ffd17f) Thanks [@khanhduyvt0101](https://github.com/khanhduyvt0101)! - Expand shared public API docs, export pricing, add full OpenAPI code samples, and remove the redundant website skills.sh route.
+
+- Updated dependencies [[`5f61021`](https://github.com/phuctm97/pdfvector/commit/5f61021385f3d97e02bc92d2d8b5ed2ad3ffd17f)]:
+  - @pdfvector/api-docs@0.0.6
+
 ## 0.0.55
 ### Patch Changes
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdfvector/instance-contract",
-  "version": "0.0.55",
+  "version": "0.0.56",
   "type": "module",
   "description": "API contract definitions for PDF Vector instance server",
   "license": "MIT",
@@ -22,7 +22,7 @@
   "dependencies": {
     "@orpc/client": "^1.14.5",
     "@orpc/contract": "^1.14.5",
-    "@pdfvector/api-docs": "^0.0.5",
+    "@pdfvector/api-docs": "^0.0.6",
     "@pdfvector/util": "^0.0.23"
   },
   "peerDependencies": {