OCR

OCR

from aibrary import AiBrary
aibrary = AiBrary()
# 1
aibrary.ocr(
    providers="google",
    file=open("tests/assets/ocr-test.jpg", "rb").read(),
    file_name="test.jpg",
)
# 2
aibrary.ocr(
    providers="google",
    file_url="https://builtin.com/sites/www.builtin.com/files/styles/ckeditor_optimize/public/inline-images/5_python-ocr.jpg",
)
# 3
aibrary.ocr(
    providers="google", file="tests/assets/ocr-test.jpg"
)

Receive Ocr Request

post

https://api.aibrary.devhttp://127.0.0.1:8000

/v0/ocr/ocr

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

multipart/form-data

providersstringRequired

settingsany ofOptional

stringOptional

or

nullOptional

response_as_dictbooleanOptionalDefault: true

attributes_as_listbooleanOptionalDefault: false

show_base_64booleanOptionalDefault: true

show_original_responsebooleanOptionalDefault: false

filestring · binaryOptional

file_urlany ofOptional

stringOptional

or

nullOptional

file_passwordany ofOptional

stringOptional

or

nullOptional

languageany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v0/ocr/ocr

HTTPcURLJavaScriptPython

POST /v0/ocr/ocr HTTP/1.1
Host: api.aibrary.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 215

{
  "providers": "text",
  "settings": "text",
  "response_as_dict": true,
  "attributes_as_list": false,
  "show_base_64": true,
  "show_original_response": false,
  "file": "binary",
  "file_url": "text",
  "file_password": "text",
  "language": "text"
}

{
  "text": "text",
  "bounding_boxes": [
    {
      "text": "text",
      "left": 1,
      "top": 1,
      "width": 1,
      "height": 1
    }
  ],
  "status": "text"
}