Client

Client(
    api_key=None,
    *,
    base_url=None,
    timeout=DEFAULT_TIMEOUT,
    poll_interval=DEFAULT_POLL_INTERVAL,
    poll_timeout=DEFAULT_POLL_TIMEOUT,
    progress=True,
)

Cliente HTTP do escritório de apoio do LabDados.

Parameters

Name	Type	Description	Default
api_key	str | None	Chave gerada pelo escritório. Quando None, lê de LABDADOS_API_KEY no ambiente. Solicite no portal em /consultoria/api-key.	None
base_url	str | None	URL do backend. Quando None, lê de LABDADOS_BASE_URL no ambiente; se o env var também não estiver setada, usa a URL pública do escritório. Em dev local, passe base_url="http://localhost:8000".	None
timeout	float	Timeout (em segundos) para cada request HTTP. Não confunda com o poll_timeout, que é o tempo total esperando o resultado.	DEFAULT_TIMEOUT
poll_interval	float	Intervalo entre polls quando aguardando processamento.	DEFAULT_POLL_INTERVAL
poll_timeout	float	Tempo máximo total esperando o processamento. Default: 4 horas.	DEFAULT_POLL_TIMEOUT
progress	bool	Se True (default), imprime spinner/status no stderr enquanto aguarda. Use False em scripts não interativos.	True

Examples

>>> import labdados
>>> client = labdados.Client(api_key="sk_lab_xxx")
>>> client.ocr(arquivos="pdfs/", saida="out/")

Em dev local (backend em localhost:8000):

>>> import os
>>> os.environ["LABDADOS_BASE_URL"] = "http://localhost:8000"
>>> os.environ["LABDADOS_API_KEY"] = "sk_lab_xxx"
>>> labdados.ocr(arquivos="pdfs/")  # nem precisa do Client

Methods

Name	Description
test_connection	Confirma que a API key é válida. Retorna metadados da chave.

test_connection

Client.test_connection()

Confirma que a API key é válida. Retorna metadados da chave.