Henara.Scan.Client

Setup

dotnet add package Henara.Scan.Client

builder.Services.AddScanClient(builder.Configuration);

Results

if ((await scan.Crop(image, cancellationToken)).TryGetValue(out var page, out var error) == false)
    return error;

var city = front.PatientCity.Or("unknown");

if (front.PatientBirthDate.TryGetValue(out var born))
    Use(born);

Calls

Leave IsAutocropEnabled off for images that are already cropped.

var cropped = await scan.Crop(image, cancellationToken);

var pdf = await scan.Combine([front, back], isAutocropEnabled: true, cancellationToken);

Muster 13 and Muster 56

var reading = await scan.ReadMuster13(
    new SheetsReadRequest(
        [
            new SheetImage(SheetSide.Front, front, IsAutocropEnabled: true),
            new SheetImage(SheetSide.Back, back)
        ],
        IsFieldImageRequested: true,
        new ReadOutputs(RenderTargets.Pdf | RenderTargets.Html, false, false)),
    cancellationToken);

ReadMuster56 takes the same request. A PDF of one or two pages goes in a single SheetImage, with IsFieldImageRequested: false.

Front page with either engine

var frontPage = await scan.ReadMuster13FrontPage(
    OcrEngine.Azure,
    new FrontPageReadRequest(front, new ReadOutputs(RenderTargets.None, false, false)),
    cancellationToken);

ReadMuster56FrontPage returns only the fields both forms share; use ReadMuster56 for the rest.

Teilnahmebestätigung

var attendance = await scan.ReadAttendanceSheet(
    new AttendanceSheetReadRequest(sheet, IsAutocropEnabled: true),
    cancellationToken);

Own schema

var schemas = await scan.ListSchemas(cancellationToken);

var custom = await scan.ReadMuster13(
    new SheetsReadRequest([new SheetImage(SheetSide.Front, front)], false, new ReadOutputs())
    {
        SchemaJson = schemaJson
    },
    cancellationToken);

var annotation = await scan.ReadImagesWithSchemaWithMistral(
    new SchemaReadRequest(schemaJson, [page1, page2]),
    cancellationToken);

Batches

Inject IScanBatchClient. Each instance is one client: it sees only the batches, jobs and events it created. Options apply to every item; each item is answered once it is stored.

await foreach (var receipt in batches.Submit(
                   new BatchOptions(new ReadOutputs(RenderTargets.Pdf, false, false)),
                   items,
                   cancellationToken))
{
    if (receipt.TryGetValue(out var answer, out var error) == false)
        return error;
}

A Muster 56 item with a Teilnahmebestätigung produces two jobs.

var item = new Muster56Item(
    "vo-17",
    new PageImage(front, IsAutocropEnabled: true),
    Option<PageImage>.None,
    new PageImage(attendanceSheet));

One event stream per client; a second Subscribe ends the first. Unacknowledged events come again on the next subscription.

await using var subscription = batches.Subscribe(cancellationToken);

await foreach (var next in subscription.Events)
{
    if (next.TryGetValue(out var jobEvent, out var error) == false)
        break;

    Handle(jobEvent);
    subscription.Acknowledge(jobEvent);
}

var selection = new JobSelection([batchId], []);

var status = await batches.GetStatus(selection, cancellationToken);

await foreach (var result in batches.StreamResults(selection, cancellationToken))
    Use(result);

var restarted = await batches.Restart(selection, cancellationToken);

Field images

var stamp = reading.Reading.FieldImages.FirstOrDefault(image => image.FieldId == "stempel-arzt");

if (stamp is { HasInk: true })
    Save(stamp.Content, stamp.ContentType);