PLAT-9438: Document the thinking parameter in the Ruby SDK

README.md

@@ -509,6 +509,7 @@ explicit in your own code.
 | `max_pages_to_process`  | No                                         | `nil` (= all pages)                           | Hard cap on the number of pages Veryfi reads, starting from page 1. Useful for very long PDFs when you only care about the first few pages. |
 | `bounding_boxes`        | No                                         | `false`                                       | When `true`, the response includes `bounding_box` / `bounding_region` metadata for each extracted field. |
 | `confidence_details`    | No                                         | `false`                                       | When `true`, the response includes per-field `score` and `ocr_score` values. |
+| `thinking`              | No                                         | `nil` (off)                                   | Extra LLM pass on the line items: `"light"` or `"deep"` (slower). Used by `process` / `process_url`, and only takes effect if thinking mode is enabled for your account. |
 
 So all four of the following calls are equivalent and produce the same
 request payload — pick whichever style your team prefers:

lib/veryfi/api/document.rb

@@ -91,6 +91,9 @@ def all(params = {})
       #   Return bounding-box info for extracted fields.
       # @option raw_params [Hash]          :confidence_details (`false`)
       #   Return confidence score details.
+      # @option raw_params [String]        :thinking           (`nil`)
+      #   Extra LLM pass on the line items: `"light"` or `"deep"` (slower).
+      #   Omit to turn it off. Needs thinking mode enabled for your account.
       #
       # @return [Veryfi::Resource] Extracted document data.
       def process(raw_params)
@@ -126,6 +129,7 @@ def process(raw_params)
       # @option raw_params [Boolean]        :async       (`false`)
       # @option raw_params [String]         :external_id (`nil`)
       # @option raw_params [Integer]        :max_pages_to_process (`nil` = all pages)
+      # @option raw_params [String]         :thinking    (`nil`) `"light"` or `"deep"`, see {#process}
       #
       # @return [Veryfi::Resource]
       def process_url(raw_params)

spec/veryfi/document_spec.rb

@@ -86,6 +86,26 @@
 
       expect(response["id"]).to eq(44_691_518)
     end
+
+    %w[light deep].each do |mode|
+      it "sends thinking=#{mode}" do
+        client.document.process(document_params.merge(thinking: mode))
+
+        expect(
+          a_request(:post, "https://api.veryfi.com/api/v8/partner/documents/")
+            .with { |req| JSON.parse(req.body)["thinking"] == mode }
+        ).to have_been_made.once
+      end
+    end
+
+    it "does not send thinking when omitted" do
+      client.document.process(document_params)
+
+      expect(
+        a_request(:post, "https://api.veryfi.com/api/v8/partner/documents/")
+          .with { |req| !JSON.parse(req.body).key?("thinking") }
+      ).to have_been_made.once
+    end
   end
 
   describe "document.process_url(id, params)" do
@@ -122,6 +142,26 @@
 
       expect(response["id"]).to eq(44_691_518)
     end
+
+    %w[light deep].each do |mode|
+      it "sends thinking=#{mode}" do
+        client.document.process_url(document_params.merge(thinking: mode))
+
+        expect(
+          a_request(:post, "https://api.veryfi.com/api/v8/partner/documents/")
+            .with { |req| JSON.parse(req.body)["thinking"] == mode }
+        ).to have_been_made.once
+      end
+    end
+
+    it "does not send thinking when omitted" do
+      client.document.process_url(document_params)
+
+      expect(
+        a_request(:post, "https://api.veryfi.com/api/v8/partner/documents/")
+          .with { |req| !JSON.parse(req.body).key?("thinking") }
+      ).to have_been_made.once
+    end
   end
 
   describe "document.get(id)" do