synoppy 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65693e5a2c5e7bef8b207227c4d606efb03adeff7780cee0963d145b5eeebb32
-  data.tar.gz: a4e650761ee1432f0c49e3dd9de39bcbf469c224ee28b792891f1e8d16a735bc
+  metadata.gz: 7519c818414f7a03095c989f2ad280cdbe92807c3bf1abaa9fdc3647cbf3970a
+  data.tar.gz: 7db8a573fd92b05120572edee8975e9752d63427f5d7f1c3a4d72230d9fa0440
 SHA512:
-  metadata.gz: 34f4c23fdd06970a58d5d57c7b78409bacc1e29050edfb2fe1de44c84fd9e6cb6e18b0b335d91a3a51e803182de6a7b8427f231b5eeff864828ed5b2ff2b304e
-  data.tar.gz: 2966d35ea34895a70f7079d2e1a1480de70cbbc603113846b786f05cd49208969f52eec971cc27c770169841c8a40226be5edc1e95ee1533b2bf04d0d7591f01
+  metadata.gz: 6a650c618bb9a44027d52f4a9cda0635b8faf8f71d3e3a779c6cb2d6baef11bd15057ea8fba16088118b1855fc6e5535852056b14612a93976c40a2827a6ae5f
+  data.tar.gz: d9df436ee8a53b639d9524a1b1b971e32a3faf956222d78880294584489e18037cdaef1434e49443e95c7bbbf026b4ec82987b4b5c871864512d6c5d284cd508

data/lib/synoppy.rb

@@ -6,7 +6,7 @@ require "uri"
 
 # Official Ruby SDK for the Synoppy web-data API.
 module Synoppy
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
   DEFAULT_BASE_URL = "https://synoppy.com"
 
   # Raised when the API returns an error response.
@@ -93,13 +93,16 @@ module Synoppy
     #
     # prompt: natural-language instruction describing the JSON to return.
     #         `instruction:` is accepted as an alias for `prompt:`.
+    # schema: optional JSON Schema (a Hash) to constrain the output shape.
+    #         When provided, `data` conforms to it.
     #
     # Returns { success, url, model, data, metadata, truncated,
     # usage:{ inputTokens, outputTokens }, latencyMs, creditsUsed, creditsRemaining }.
-    def extract(url, prompt: nil, instruction: nil)
+    def extract(url, prompt: nil, instruction: nil, schema: nil)
       body = { url: url }
       prompt ||= instruction
       body[:prompt] = prompt unless prompt.nil?
+      body[:schema] = schema unless schema.nil?
       request("/api/extract", body)
     end
 
@@ -146,6 +149,28 @@ module Synoppy
       request("/api/images", { url: url })
     end
 
+    # Web search -> clean, ranked results (requires a key).
+    #
+    # query          : the search query (required).
+    # max_results    : number of results to return (1-15).
+    # markdown       : also read each result to clean markdown, in one trip (boolean).
+    # include_domains: only return results from these domains (array of strings).
+    # exclude_domains: never return results from these domains (array of strings).
+    # fanout         : expand the query into variations for higher recall (boolean,
+    #                  costs more).
+    #
+    # Returns { success, query, results:[{ title, url, snippet, markdown? }],
+    # latencyMs, creditsUsed, creditsRemaining }.
+    def search(query, max_results: nil, markdown: nil, include_domains: nil, exclude_domains: nil, fanout: nil)
+      body = { query: query }
+      body[:maxResults] = max_results unless max_results.nil?
+      body[:markdown] = markdown unless markdown.nil?
+      body[:includeDomains] = include_domains unless include_domains.nil?
+      body[:excludeDomains] = exclude_domains unless exclude_domains.nil?
+      body[:fanout] = fanout unless fanout.nil?
+      request("/api/search", body)
+    end
+
     # Take actions on a page (click, type, navigate). Coming soon —
     # /api/act is not live yet.
     def act(*)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synoppy
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Saanora
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-21 00:00:00.000000000 Z
+date: 2026-06-23 00:00:00.000000000 Z
 dependencies: []
 description: Scrape, screenshot, crawl, map, extract, classify, enrich, and images
   — one key for the whole web.