Saltar al contenido principal

SaveDocumentToPathUnit

Unit
DashAI.back.units.SaveDocumentToPathUnit

Write the document to a destination given in the configuration.

The document counterpart of SaveDatasetToPathUnit. Declares no outputs: its result is on disk, not in the context.

The error message keeps the original exception's text, since only the message of the outermost error reaches the user.

Parameters​

path : string, default=
Destination directory for the parsed document.

Methods​

execute(self, ctx: DashAI.back.units.context.ExecutionContext) -> None

Defined on SaveDocumentToPathUnit

Do the unit's work, reading from and writing to the context.

Parameters

ctx : ExecutionContext
The shared execution context.

get_credential(self, name: str)

Defined on ConfigObject

Resolve a registered credential component by name.

Parameters

name : str
Credential component class name (e.g. "HuggingFaceCredential").

Returns

BaseCredential
An instance of the requested credential component.

get_schema(cls) -> dict

Defined on ConfigObject

Generates the component related Json Schema.

Returns

dict
Dictionary representing the Json Schema of the component.

validate(self, ctx: DashAI.back.units.context.ExecutionContext) -> None

Defined on BaseUnit

Check preconditions without executing the unit.

Parameters

ctx : ExecutionContext
The shared execution context.

validate_and_transform(self, raw_data: dict) -> dict

Defined on ConfigObject

It takes the data given by the user to initialize the model and returns it with all the objects that the model needs to work.

Parameters

raw_data : dict
A dictionary with the data provided by the user to initialize the model.

Returns

dict
A validated dictionary with the necessary objects.