Module: VisionAPI

Defined in:

lib/vision_api.rb,
lib/vision_api/client.rb,
lib/vision_api/errors.rb,
lib/vision_api/result.rb,
lib/vision_api/version.rb,
lib/vision_api/webhook.rb,
lib/vision_api/multipart.rb

Overview

Official Ruby client for the Vision API — credit-based OCR and visual intelligence.

Send an image or a PDF, describe the fields you want in plain language, and get structured JSON back with a confidence level on every value.

require "vision_api"

vision = VisionAPI.new                        # reads ENV["VISION_API_KEY"]
res = vision.analyze(file: "invoice.pdf", preset: "invoice")
res["result"]["invoice_id"]["value"]          # => "A-10422"

• Website: https://visionapi.io
• Documentation: https://docs.visionapi.io
• API keys: https://app.visionapi.io/dashboard/keys

Defined Under Namespace

Modules: ErrorFactory, Multipart, Result, Webhook Classes: APIError, AuthenticationError, Client, ConflictError, ConnectionError, Error, InsufficientCreditsError, InternalError, InvalidRequestError, NotFoundError, PayloadTooLargeError, PermissionDeniedError, ProviderError, RateLimitError, ResultExpiredError, SyncTimeoutError, TaskFailedError, TaskTimeoutError, TimeoutError, TooManyTasksError, UnprocessableError, UnsupportedTypeError, UsageError, WebhookSignatureError

Constant Summary

DEFAULT_BASE_URL =

"https://api.visionapi.io"

VERSION =

"1.0.0"

Class Method Summary

• .new(**options) ⇒ Client

  Builds a Client.

Class Method Details

.new(**options) ⇒ Client

Builds a Client. Everything VisionAPI::Client#initialize accepts is accepted here.

Returns:

• (Client)

# File 'lib/vision_api.rb', line 28

def self.new(**options)
  Client.new(**options)
end