Mindee HTTP

Response Validation

clean_request_json(response)

Checks and correct the response error format depending on the two possible kind of returns.

Parameters:

response (Response) – Raw request response.

Return type:

dict[str, Any]

Returns:

Returns the job error if the error is due to parsing, returns the http error otherwise.

is_valid_async_response(response)

Checks if the asynchronous response is valid. Also checks if it is a valid synchronous response.

Returns True if the response is valid.

Parameters:

response (Response) – an httpx response object.

Return type:

bool

Returns:

bool

is_valid_sync_response(response)

Checks if the synchronous response is valid. Returns True if the response is valid.

Parameters:

response (Response) – a requests response object.

Return type:

bool

Returns:

bool

Settings Mixin

class SettingsMixin

Settings mixin for V2 & V2 common methods & attributes.

set_base_url(value)

Set the base URL for all requests.

Return type:

None

Parameters:

value (str)

set_timeout(value)

Set the timeout for all requests.

Return type:

None

Parameters:

value (str | int)

base_url: str

Base URL for all V2 requests.

request_timeout: float

Timeout for all requests.