Classification Params

Classification Parameters

class ClassificationParameters(model_id, alias=None, webhook_ids=None, polling_options=None, close_file=True)

Parameters accepted by the classification utility v2 endpoint.

Parameters:

• model_id (str)

• alias (str | None)

• webhook_ids (list[str] | None)

• polling_options (PollingOptions | None)

• close_file (bool)

classmethod get_enqueue_slug()

Getter for the enqueue slug.

Return type:

str

get_form_data()

Return the parameters as a config dictionary.

Return type:

dict[str, str | list[str]]

Returns:

A dict of parameters.

alias: str | None = None

Use an alias to link the file to your own DB. If empty, no alias will be used.

close_file: bool = True

Whether to close the file after product.

model_id: str

ID of the model, required.

polling_options: PollingOptions | None = None

Options for polling. Set only if having timeout issues.

webhook_ids: list[str] | None = None

IDs of webhooks to propagate the API response to.