convertorio-sdk 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b8ce9e583f4cb4a935ef71823e4599a7a3228ccff647e29fc002e57028bcefe
-  data.tar.gz: 1d4f19246026389a87b1d37d06c305609fc3fb93d67c6ee123efde14f9f0183d
+  metadata.gz: 48843d3f36c609b819ed906a746e6af91312c44c487d8e25ca8f184a136156eb
+  data.tar.gz: b4e88e74f5e2376ce9f1b843dfacae6f08a0f349f325d2b5ed06eac3106e1e1a
 SHA512:
-  metadata.gz: 7d925f1ffb56fff8351230e49c461acd0fcf0ea7d7bd739b6664c327f1a2477e8a668105f9eda35990f2d9fe6f3a39e385693793991dd300fb71d63d8b0de361
-  data.tar.gz: 06fb17ee887b5d8ec98b41ced91dde7e002b12dd995f4e9974ff5b79f6399c78587ce67aa752361ad23e4c9be1be9dc51e3375f9b7acb0877edb57df7d0ab1f9
+  metadata.gz: 48a0845b64716f21e4165136326bd4e138ad452fecd1a9f7adf7c50f009bf13b032bd343668216444516898645d895f96615d617aacd503aa7704a14223b5a3f
+  data.tar.gz: 8fee683d9f857964130080f31a5cce03af56fe5336e160ec6a55f2ca6565baa1961dec20d0acd37b00daf8b52ebd73c7a8915870952bcf21db4b4422cfc10ce0

data/README.md

@@ -272,6 +272,85 @@ The SDK supports conversion between all formats supported by Convertorio:
 - EPS
 - JXL (JPEG XL)
 
+**✨ AI-Powered OCR:**
+- Extract text from any image format
+- Powered by advanced AI technology
+- Support for printed and handwritten text
+- JSON or TXT output formats
+
+## 🤖 AI-Powered OCR
+
+Extract text from images with state-of-the-art AI accuracy.
+
+### Quick OCR Example
+
+```ruby
+result = client.convert_file(
+  input_path: './form.jpg',
+  target_format: 'ocr',
+  output_path: './form.txt',
+  conversion_metadata: {
+    ocr_format: 'txt',
+    ocr_instructions: 'Extract all text preserving formatting'
+  }
+)
+
+puts "Tokens used: #{result[:tokens_used]}"
+```
+
+### OCR Features
+
+- **High Accuracy**: Powered by advanced AI for state-of-the-art text recognition
+- **Multiple Languages**: Automatic language detection and support
+- **Flexible Output**: Choose between `txt` (plain text) or `json` (structured data)
+- **Custom Instructions**: Guide the AI to extract specific information
+- **Handwriting Support**: Recognizes both printed and handwritten text
+- **Table Recognition**: Preserves table structure in extracted text
+- **Token-Based Billing**: Pay only for what you use, with transparent token counts
+
+### OCR Options
+
+| Option | Type | Values | Description |
+|--------|------|--------|-------------|
+| `ocr_format` | string | `txt`, `json` | Output format (default: `txt`) |
+| `ocr_instructions` | string | Any text | Custom instructions to guide extraction |
+
+### OCR Use Cases
+
+- 📄 **Invoice Processing**: Extract structured data from invoices and receipts
+- 📝 **Form Digitization**: Convert paper forms to digital data
+- 📋 **Document Archival**: Make scanned documents searchable
+- 🏷️ **Label Reading**: Extract text from product labels and tags
+- ✍️ **Handwriting Recognition**: Digitize handwritten notes and documents
+
+### Complete OCR Example
+
+```ruby
+require 'convertorio'
+require 'json'
+
+client = Convertorio::Client.new(api_key: 'your_api_key_here')
+
+# Extract text as JSON with custom instructions
+result = client.convert_file(
+  input_path: './invoice.jpg',
+  target_format: 'ocr',
+  output_path: './invoice.json',
+  conversion_metadata: {
+    ocr_format: 'json',
+    ocr_instructions: 'Extract merchant name, date, items with prices, and total amount'
+  }
+)
+
+puts 'OCR completed!'
+puts "Tokens used: #{result[:tokens_used]}"
+puts "Output saved to: #{result[:output_path]}"
+
+# Read the extracted text
+extracted_data = JSON.parse(File.read('./invoice.json'))
+puts extracted_data
+```
+
 ## Advanced Conversion Options
 
 You can control various aspects of the conversion process by passing a `conversion_metadata` hash:

data/lib/convertorio.rb

@@ -34,6 +34,7 @@ module Convertorio
         'Authorization' => "Bearer #{@api_key}",
         'Content-Type' => 'application/json'
       )
+      self.class.default_timeout 60
     end
 
     # Register a callback for events
@@ -177,7 +178,8 @@ module Convertorio
           target_format: target_format.downcase,
           file_size: File.size(final_output_path),
           processing_time: job_result['processing_time_ms'],
-          download_url: job_result['download_url']
+          download_url: job_result['download_url'],
+          tokens_used: job_result['tokens_used']
         }
 
         emit(:complete, conversion_result)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: convertorio-sdk
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Convertorio
@@ -93,9 +93,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.18'
-description: Ruby SDK for the Convertorio API. Convert images between 20+ formats
-  with just a few lines of code. Supports JPG, PNG, WebP, AVIF, HEIC, GIF, BMP, TIFF,
-  ICO, and more.
+description: Ruby SDK for the Convertorio API. Convert files between 20+ formats with
+  AI-powered OCR for text extraction. Supports JPG, PNG, WebP, AVIF, HEIC, GIF, BMP,
+  TIFF, ICO, PDF, and more.
 email:
 - support@convertorio.com
 executables: []