V2 Client Options
Base Product Parameters
- class BaseProductParameters(model_id, alias=None, webhook_ids=None, polling_options=None, close_file=True)
Base parameters for sending a file to a Mindee V2 product.
- 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_request_parameters()
Return the parameters as a config dictionary.
- Return type:
dict[str,str|list[str]]- Returns:
A dict of parameters.
- alias: str | None = None
Optional: a free-form string to tag the request with your own identifier. For example, an internal document ID, reference number, or database key. If set, it will be included in the job and result responses.
- close_file: bool = True
Whether to close the file after product.
- model_id: str
Model ID to use for the inference. Required.
- polling_options: PollingOptions | None = None
Options for polling. Set only if having timeout issues.
- webhook_ids: list[str] | None = None
Webhook IDs to call after all processing is finished. If empty, no webhooks will be used.
Base Search Parameters
- class BaseSearchParameters(*, page=None, per_page=None, _response_class)
Base parameters for searches.
- Parameters:
page (int | None)
per_page (int | None)
_response_class (type[TypeSearchResponse])
- get_request_parameters()
Gets the request parameters for the search request.
- Return type:
dict[str,str|list[str]]- Returns:
A dict of parameters.
- get_response_class()
Gets the response class for the search.
- Return type:
type[TypeVar(TypeSearchResponse, bound=BaseSearchResponse)]
- get_slug()
Gets the slug of the resource.
- Return type:
str
- page: int | None = None
1-based page index.
- per_page: int | None = None
Number of items per page.