synoppy 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65693e5a2c5e7bef8b207227c4d606efb03adeff7780cee0963d145b5eeebb32
-  data.tar.gz: a4e650761ee1432f0c49e3dd9de39bcbf469c224ee28b792891f1e8d16a735bc
+  metadata.gz: 1d9a80fac3891cb8133f9cffbc7097d6160999fa7e36b39343ede041e2aa8956
+  data.tar.gz: e91fbe09040f73b89c4533452cd6ddfa551e15bd01d66d1ab084dc571ef3cfbd
 SHA512:
-  metadata.gz: 34f4c23fdd06970a58d5d57c7b78409bacc1e29050edfb2fe1de44c84fd9e6cb6e18b0b335d91a3a51e803182de6a7b8427f231b5eeff864828ed5b2ff2b304e
-  data.tar.gz: 2966d35ea34895a70f7079d2e1a1480de70cbbc603113846b786f05cd49208969f52eec971cc27c770169841c8a40226be5edc1e95ee1533b2bf04d0d7591f01
+  metadata.gz: a74f7f2ec4e4c75e90c843aa8775f8ab85f7eb89da746d00ea7e837ba114a0fa02870b2a9f99f7bc4ae555d86393adf02cef9807314f3ee11f06d0a9dfed09da
+  data.tar.gz: f5545ca85edaa51aa2035582528f3d03ff6388e04c7c89c61469cf09252256a026c25f7134617c97326d6c0fe1cf2a6f30b1ba9416757ca9c21b72246e7eb131

data/README.md

@@ -98,9 +98,20 @@ m["source"]          # "sitemap" | "links"
 m["domain"]
 ```
 
-### `extract(url, prompt:)`
+### `search(query, ...)`
 
-`POST /api/extract`. AI-structured JSON extraction (requires a key). `instruction:` is accepted as an alias for `prompt:`.
+`POST /api/search`. Search the live web — ranked results with clean source URLs (requires a key).
+
+```ruby
+found = client.search("best open-weight LLMs 2026", max_results: 5, markdown: true)
+found["results"]     # [{ "title", "url", "snippet", "markdown"? }]
+found["count"]
+# Also: include_domains:, exclude_domains:, fanout:
+```
+
+### `extract(url, prompt:, schema:)`
+
+`POST /api/extract`. AI-structured JSON extraction (requires a key). `instruction:` is accepted as an alias for `prompt:`; pass `schema:` (a JSON Schema as a Hash) to constrain the output to that exact shape (typed output).
 
 ```ruby
 result = client.extract("https://news.ycombinator.com", prompt: "Return { title, summary, topics }")
@@ -109,6 +120,13 @@ result["model"]
 result["metadata"]
 result["truncated"]
 result["usage"]      # { "inputTokens", "outputTokens" }
+
+# Typed output — data matches the schema exactly
+typed = client.extract("https://stripe.com/pricing", schema: {
+  type: "object",
+  properties: { plans: { type: "array", items: { type: "object",
+    properties: { name: { type: "string" }, price: { type: "string" } } } } }
+})
 ```
 
 ### `classify(url, labels:)`

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.1"
   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.1
 platform: ruby
 authors:
 - Saanora
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-21 00:00:00.000000000 Z
+date: 2026-07-03 00:00:00.000000000 Z
 dependencies: []
 description: Scrape, screenshot, crawl, map, extract, classify, enrich, and images
   — one key for the whole web.