Package com.mindee.v2.cli

Class BaseInferenceCommand

java.lang.Object

com.mindee.v2.cli.BaseInferenceCommand

All Implemented Interfaces:

Callable<Integer>

Direct Known Subclasses:

ClassificationCommand, CropCommand, ExtractionCommand, OcrCommand, SplitCommand

public abstract class BaseInferenceCommand
extends Object
implements Callable<Integer>

Abstract base class for V2 inference CLI commands. Handles common options (path, model-id, api-key, alias, output) and output formatting.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseInferenceCommand.OutputType	Output format for the command.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	alias
protected String	apiKey
protected File	file
protected String	modelId
protected BaseInferenceCommand.OutputType	output

Constructor Summary

Constructors

Constructor	Description
BaseInferenceCommand()

Method Summary

Modifier and Type	Method	Description
Integer	call()
protected abstract CommonResponse	executeRequest(MindeeClient client, LocalInputSource inputSource)	Executes the inference request and returns the product response.
protected String	getFullOutput(CommonResponse response)	Returns the full (inference + options + result) string for the given response.
protected abstract String	getSummary(CommonResponse response)	Returns the summary (result-only) string for the given response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

file

protected File file

modelId

protected String modelId

apiKey

protected String apiKey

alias

protected String alias

output

protected BaseInferenceCommand.OutputType output

Constructor Detail

BaseInferenceCommand

public BaseInferenceCommand()

Method Detail

executeRequest

protected abstract CommonResponse executeRequest(MindeeClient client,
                                                 LocalInputSource inputSource)
                                          throws Exception

Executes the inference request and returns the product response.

Parameters:

client - the V2 Mindee client

inputSource - the prepared local input source

Returns:

the product response

Throws:

Exception - on IO or API error

getSummary

protected abstract String getSummary(CommonResponse response)

Returns the summary (result-only) string for the given response. Override in each product command.

Parameters:

response - the product response

Returns:

the summary string

getFullOutput

protected String getFullOutput(CommonResponse response)

Returns the full (inference + options + result) string for the given response. Defaults to the same as getSummary(com.mindee.v2.parsing.CommonResponse); override for richer output.

Parameters:

response - the product response

Returns:

the full output string

call

public Integer call()
             throws Exception

Specified by:

call in interface Callable<Integer>

Throws:

Exception