Skip to content

✨ add text context option return param #401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sebastianMindee merged 2 commits into from
Dec 2, 2025
Merged

✨ add text context option return param #401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
953e41c
bump dependencies
sebastianMindee Dec 2, 2025
83aa1d9
:sparkles: add text context option return param
sebastianMindee Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions src/parsing/v2/inferenceActiveOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,17 @@ export class InferenceActiveOptions {
*/
public confidence: boolean;

/**
* Whether the text context feature was activated.
*/
public textContext: boolean;

constructor(serverResponse: StringDict) {
this.rag = serverResponse["rag"];
this.rawText = serverResponse["raw_text"];
this.polygon = serverResponse["polygon"];
this.confidence = serverResponse["confidence"];
this.textContext = serverResponse["text_context"];
}

toString(): string {
Expand Down
2 changes: 1 addition & 1 deletion tests/data
Open in desktop
Submodule data updated 10 files
+5 −1 v2/inference/deep_nested_fields.json
+5 −1 v2/inference/rag_matched.json
+5 −1 v2/inference/rag_not_matched.json
+5 −1 v2/inference/raw_texts.json
+5 −1 v2/inference/standard_field_types.json
+35 −0 v2/inference/text_context_enabled.json
+21 −0 v2/job/ok_processed_webhooks_ok.json
+2 −1 v2/products/financial_document/blank.json
+2 −1 v2/products/financial_document/complete.json
+2 −1 v2/products/financial_document/complete_with_coordinates.json
3 changes: 3 additions & 0 deletions tests/v2/clientV2.integration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ describe("MindeeV2 – Client Integration Tests", () => {
expect(inference.activeOptions?.rawText).to.be.false;
expect(inference.activeOptions?.polygon).to.be.false;
expect(inference.activeOptions?.confidence).to.be.false;
expect(inference.activeOptions?.textContext).to.be.false;
}).timeout(60000);

it("Filled, single-page image – PathInput - enqueueAndGetInference must succeed", async () => {
Expand Down Expand Up @@ -107,6 +108,7 @@ describe("MindeeV2 – Client Integration Tests", () => {
expect(inference.activeOptions?.rawText).to.be.true;
expect(inference.activeOptions?.polygon).to.be.true;
expect(inference.activeOptions?.confidence).to.be.false;
expect(inference.activeOptions?.textContext).to.be.true;

expect(inference.result.rawText?.pages).to.have.lengthOf(1);
}).timeout(120000);
Expand Down Expand Up @@ -143,6 +145,7 @@ describe("MindeeV2 – Client Integration Tests", () => {
expect(inference.activeOptions?.rawText).to.be.false;
expect(inference.activeOptions?.polygon).to.be.false;
expect(inference.activeOptions?.confidence).to.be.false;
expect(inference.activeOptions?.textContext).to.be.false;
}).timeout(120000);

it("Invalid model ID – enqueue must raise 422", async () => {
Expand Down
32 changes: 13 additions & 19 deletions tests/v2/input/localResponse.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,34 @@ import { InferenceResponse, LocalResponse } from "../../../src";

import path from "path";
import { V2_RESOURCE_PATH } from "../../index";
import { Buffer } from "node:buffer";

const signature: string = "a1bc9012fa63539d602f163d8980604a0cf2b2ae88e56009cfa1db33382736cf";
const signature: string = "b82a515c832fd2c4f4ce3a7e6f53c12e8d10e19223f6cf0e3a9809a7a3da26be";
const dummySecretKey: string = "ogNjY44MhvKPGTtVsI8zG82JqWQa68woYQH";
const filePath: string = path.join(V2_RESOURCE_PATH, "inference/standard_field_types.json");

async function assertLocalResponse(localResponse: LocalResponse) {
await localResponse.init();
expect(localResponse.asDict()).to.not.be.null;
expect(localResponse.isValidHmacSignature(dummySecretKey, "invalid signature")).to.be.false;
expect(localResponse.getHmacSignature(dummySecretKey)).to.eq(signature);
expect(localResponse.isValidHmacSignature(dummySecretKey, signature)).to.be.true;
}

describe("MindeeV2 - Load Local Response", () => {
it("should load a string properly.", async () => {
const fileObj = await fs.readFile(filePath, { encoding: "utf-8" });
const localResponse = new LocalResponse(fileObj);
await localResponse.init();
expect(localResponse.asDict()).to.not.be.null;
expect(localResponse.isValidHmacSignature(dummySecretKey, "invalid signature")).to.be.false;
expect(localResponse.getHmacSignature(dummySecretKey)).to.eq(signature);
expect(localResponse.isValidHmacSignature(dummySecretKey, signature)).to.be.true;
await assertLocalResponse(new LocalResponse(fileObj));
});

it("should load a file properly.", async () => {
const localResponse = new LocalResponse(filePath);
await localResponse.init();
expect(localResponse.asDict()).to.not.be.null;
expect(localResponse.isValidHmacSignature(dummySecretKey, "invalid signature")).to.be.false;
expect(localResponse.getHmacSignature(dummySecretKey)).to.eq(signature);
expect(localResponse.isValidHmacSignature(dummySecretKey, signature)).to.be.true;
await assertLocalResponse(new LocalResponse(filePath));
});

it("should load a buffer properly.", async () => {
const fileStr = (await fs.readFile(filePath, { encoding: "utf-8" })).replace(/\r/g, "").replace(/\n/g, "");
const fileBuffer = Buffer.from(fileStr, "utf-8");
const localResponse = new LocalResponse(fileBuffer);
await localResponse.init();
expect(localResponse.asDict()).to.not.be.null;
expect(localResponse.isValidHmacSignature(dummySecretKey, "invalid signature")).to.be.false;
expect(localResponse.getHmacSignature(dummySecretKey)).to.eq(signature);
expect(localResponse.isValidHmacSignature(dummySecretKey, signature)).to.be.true;
await assertLocalResponse(new LocalResponse(fileBuffer));
});

it("should deserialize a prediction.", async () => {
Expand Down