ExtractResult

The artifacts produced by extract: the same files, under the same names and with the same content, that the hosted service returns for the same request.

from nutrient_sdk import ExtractResult

Construction

Methods

get_artifact

def get_artifact(self, name: str) -> str

Returns the content of an artifact, exactly as the run produced it.

Parameters:

Returns: str - The artifact content. Raises:

• NullOrEmptyParameterException: Thrown when name is null or empty.
• InvalidArgumentException: Thrown when this run did not produce that artifact.

has_artifact

def has_artifact(self, name: str) -> bool

Whether this run produced an artifact with the given file name.

Parameters:

Returns: bool - True when the artifact was produced.

save_to

def save_to(self, directory: str) -> None

Writes every artifact into a directory under its own file name, creating the directory when needed and replacing files that already exist.

Parameters:

Raises:

• NullOrEmptyParameterException: Thrown when directory is null or empty.
• InvalidArgumentException: Thrown when an artifact name is not a plain file name.

Properties

artifact_names

@property
def artifact_names(self) -> list

The file names of the artifacts this run produced, sorted.

Type: list

Read-only property.

confidence_json

@property
def confidence_json(self) -> str

The content of confidence.json, or null when this run did not produce it.

Type: str

Read-only property.

diagnostics_json

@property
def diagnostics_json(self) -> str

The content of diagnostics.json, or null when this run did not produce it.

Type: str

Read-only property.

result_json

@property
def result_json(self) -> str

The content of result.json, or null when this run did not produce it.

Type: str

Read-only property.

warnings_json

@property
def warnings_json(self) -> str

The content of warnings.json, or null when this run did not produce it.

Type: str

Read-only property.