ExBifrost.Api.OCR (ex_bifrost v0.1.0)

Copy Markdown View Source

API calls for all endpoints tagged OCR.

Summary

Functions

perform_ocr(connection, ocr_request, opts \\ [])

Perform OCR Extracts text and content from documents or images using optical character recognition. Supports PDF URLs, base64-encoded documents, and image URLs.

Functions

perform_ocr(connection, ocr_request, opts \\ [])

@spec perform_ocr(Tesla.Env.client(), ExBifrost.Model.OcrRequest.t(), keyword()) ::
  {:ok, ExBifrost.Model.BifrostError.t()}
  | {:ok, ExBifrost.Model.OcrResponse.t()}
  | {:error, Tesla.Env.t()}

Perform OCR Extracts text and content from documents or images using optical character recognition. Supports PDF URLs, base64-encoded documents, and image URLs.

Parameters

  • connection (ExBifrost.Connection): Connection to server
  • ocr_request (OcrRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, ExBifrost.Model.OcrResponse.t} on success
  • {:error, Tesla.Env.t} on failure