V2 Mindee HTTP

Mindee API V2

class MindeeAPIV2(api_key, http_client=None)

Settings class relating to API V2 requests.

Parameters:

  • api_key (str | None)

  • http_client (Client | None)

close()

Closes the underlying HTTP client.

Return type:

None

delete_http_client()

Delete the underlying HTTP client.

enqueue(input_source, params)

Enqueues a document to a given model. :type input_source: LocalInputSource | URLInputSource :param input_source: Input object. :type params: BaseParameters :param params: Parameters

Return type:

JobResponse

Returns:

A valid inference Response.

Parameters:
get_job(job_id)

Get the status of an inference that was previously enqueued.

Can be used for polling.

Parameters:

job_id (str) – UUID of the job to retrieve.

Return type:

JobResponse

Returns:

A job response.

get_models(name, model_type)

Get a list of models matching the provided name and type.

Parameters:

  • name (str | None) – Name of the model to filter by.

  • model_type (str | None) – Type of the model to filter by.

Returns:

A list of models matching the provided criteria.

get_result(response_type, inference_id)

Get the result of an inference that was previously enqueued.

Parameters:

  • response_type (type[TypeVar(ResponseT, bound= BaseResponse)]) – Type of the response to return.

  • inference_id (str) – UUID of the inference to retrieve.

Returns:

The result of the inference.

get_result_by_url(response_type, url)

Get the result of an inference that was previously enqueued by its URL.

Parameters:

  • response_type (type[TypeVar(ResponseT, bound= BaseResponse)]) – Type of the response to return.

  • url (str) – URL of the inference to retrieve.

Returns:

The result of the inference.

req_get_inference(inference_id, slug)

Sends a request matching a given queue_id. Returns either a Job or a Document.

Parameters:

  • inference_id (str) – Inference ID, returned by the job request.

  • slug (str) – Slug of the inference, defaults to nothing.

Return type:

Response

req_get_inference_by_url(url)

Sends a request matching a given inference_id. Returns either a Job or a Document.

Parameters:

url (str) – URL to use for the request.

Return type:

Response

Returns:

Response object from the request.

req_get_job(job_id)

Sends a request matching a given queue_id. Returns either a Job or a Document.

Parameters:

job_id (str) – Job ID, returned by the enqueue request.

Return type:

Response

req_get_search_models(name, model_type)

Searches for a list of models matching criteria. :type name: str | None :param name: Name pattern to search for. :type model_type: str | None :param model_type: Type of model to search for (exact match).

Return type:

Response

Returns:

Response object containing search results.

Parameters:

  • name (str | None)

  • model_type (str | None)

req_post_inference_enqueue(input_source, params, slug)

Make a request to POST a document for enqueue on the V2 API.

Parameters:
Return type:

Response

Returns:

httpx response.

set_base_url(value)

Set the base URL for all requests.

Return type:

None

Parameters:

value (str)

set_from_env()

Set various parameters from environment variables, if present.

Return type:

None

set_timeout(value)

Set the timeout for all requests.

Return type:

None

Parameters:

value (str | int)

api_key: str | None

API Key for the client.

property base_headers: dict[str, str]

Base headers to send with all API requests.

base_url: str

Base URL for all V2 requests.

http_client: Client | None

HTTP client for making requests.

request_timeout: float

Timeout for all requests.

url_root: str

Root of the URL to use for polling.

Response Validation V2

is_valid_get_response(response)

Checks if the GET response is valid and of the expected format.

Parameters:

response (Response) – HTTP response object.

Return type:

bool

Returns:

True if the response is valid.

is_valid_post_response(response)

Checks if the POST response is valid and of the expected format.

Parameters:

response (Response) – HTTP response object.

Return type:

bool

Returns:

True if the response is valid.