riveter-sdk 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 867ffe82023d427f6584d46ad9d0e0e1799bbab22ac173a66eb542859d13fd7d
-  data.tar.gz: 6906da4985f0795a6074d4b3891f02cb27ccd02009165a13e9a550bb962449a6
+  metadata.gz: 5287a59260bd3fbf2f4069af7bcc49ec2c8cb9015d55e36db170c50c62ca5fa9
+  data.tar.gz: 50ecfae1ff05b163f8479d9c63aabad0a18e31f001fd2a7fb4656901dc471f00
 SHA512:
-  metadata.gz: 2663f0f05a85eb76a748775bae906427513d103d259ff9bab9cb7a8661ad8237bfbb65e3ce35c1cf94a39215749decd733640a8e739423a1358890f88c889bad
-  data.tar.gz: 45ef4e0f5b33e003ca0bc9916d0105f23d15a7fbd03280f5cd5ab84001884e86202673e48632f3e8100eee0e5fde2f8b58a8f17852aa7df0081f4c3c6375870d
+  metadata.gz: 2bd4722b2d5c49a06390a520ca1b7f0319923390debe5a3301496cd58f6257de10aff9e28254175a52c9745b9a9038915a27bc6acaa354137641fc3b61b3c414
+  data.tar.gz: ad7644661ae6d842485962aa4db8006936f26db528243ebebcdc721440f2cf879c4a05734a78924b3cf4b75d335e70ab2a36409f32a65c4d64b5af73426c81f3

data/lib/riveter/errors.rb

@@ -43,7 +43,7 @@ module Riveter
     end
 
     # Builds an APIError from either the clean { "error" => {...} } envelope
-    # or the legacy { "request_status" => "error" } shape (401s).
+    # or the { "request_status" => "error" } shape (401s).
     def self.from_response(status, body)
       if body.is_a?(Hash)
         error = body["error"]

data/lib/riveter/models.rb

@@ -57,14 +57,13 @@ module Riveter
   # Endpoint-specific kickoff extras (dataset_id, credits_charged, ...) are
   # plain fields; #output is nil until the run finishes. An `estimate_cost: true`
   # kickoff returns this shape with #estimate_cost set, no #id, and the priced
-  # #credit_detail. #legacy ({"notice", "successor", "docs"}) is set when the
-  # kickoff took a legacy mode.
+  # #credit_detail.
   class Run < Model
     field :id, :type, :status, :credits_used, :estimate_cost, :app_url, :result_url,
           :started_at, :finished_at, :error, :stopped_reason, :enrichment_id, :enrichment_name,
           :dataset_id, :extraction_id, :monitor_id, :webhook_url, :output,
           :max_items, :configured_dataset_id, :credits_charged, :variables,
-          :validation_warning, :tier, :legacy
+          :validation_warning, :tier
     model_field :progress, RunProgress
     model_field :credit_detail, CreditDetail
 
@@ -87,21 +86,18 @@ module Riveter
     field :counts
   end
 
-  # Compact list-endpoint shape. Column configuration is on Enrichments#get. #status,
-  # #app_url, and #dataset_id (the dataset copy to fill instead) are set on legacy
-  # enrichments only.
+  # Compact list-endpoint shape. Column configuration is on Enrichments#get.
   class EnrichmentSummary < Model
-    field :id, :name, :status, :app_url, :dataset_id, :column_count, :input_columns,
+    field :id, :name, :column_count, :input_columns,
           :output_columns, :column_names_truncated, :created_at, :updated_at
   end
 
   # An enrichment: #prompt, #input_columns, #output as an array of column hashes ("name" /
   # "prompt" / "output_schema" / "tool"), #tools, the budget fields, and #version.
-  # #dataset_id / #app_url are set on Enrichments#create. A legacy enrichment's id answers
-  # its older shape (the legacy API docs, kept in #raw) with #legacy set.
+  # #dataset_id / #app_url are set on Enrichments#create.
   class Enrichment < Model
     field :id, :name, :prompt, :input_columns, :output, :tools, :budget_credits_per_row,
-          :budget_locked, :version, :created_at, :updated_at, :app_url, :dataset_id, :legacy
+          :budget_locked, :version, :created_at, :updated_at, :app_url, :dataset_id
   end
 
   # One cell. #state is pending / running / ok / not_found / failed / manual / stale;
@@ -120,6 +116,36 @@ module Riveter
     end
   end
 
+  # A row as compact: true answers it: the values alone. #cells is each output column's value
+  # (nil when the cell has none). Address the row by #position elsewhere.
+  class CompactDatasetRow < Model
+    field :position, :input, :cells
+  end
+
+  # One of a column's most common values (a string is cut at 200 characters) and its row count.
+  class DatasetColumnValueCount < Model
+    field :value, :count
+  end
+
+  # One column's counts over every row: #states (output columns only: cells by state, pending /
+  # stale / failed / not_found / ok / manual), #filled, #distinct_values, the most common #values.
+  class DatasetColumnSummary < Model
+    field :name, :kind, :states, :filled, :distinct_values
+
+    def values
+      (@raw["values"] || []).map { |item| DatasetColumnValueCount.new(item) }
+    end
+  end
+
+  # Per-column counts over every row of a dataset (Datasets#summary).
+  class DatasetSummary < Model
+    field :row_count
+
+    def columns
+      (@raw["columns"] || []).map { |item| DatasetColumnSummary.new(item) }
+    end
+  end
+
   # A run on a dataset as the dataset lists it; #type is dataset_build or enrichment.
   class DatasetRunSummary < Model
     field :id, :type, :status, :created_at, :finished_at
@@ -207,19 +233,17 @@ module Riveter
   end
 
   # A monitor fills #dataset_id's #columns (every output column when nil) again on a
-  # schedule. #enrichment_name and #has_input belong to a monitor on a legacy enrichment;
-  # #legacy is true on such a list item and the notice hash on Monitors#get / #update. An
-  # `estimate_cost: true` create returns this shape with #estimate_cost set, no #id, and
-  # the priced #credit_detail for one tick.
+  # schedule. An `estimate_cost: true` create returns this shape with #estimate_cost set,
+  # no #id, and the priced #credit_detail for one tick.
   class Monitor < Model
     field :id, :name, :enabled, :cadence, :minute, :hour, :day_of_week,
           :day_of_month, :timezone, :webhook_url, :alert_rule, :output_format,
           :next_run_at, :schedule_summary, :dataset_id, :dataset_name, :columns,
-          :enrichment_id, :enrichment_name, :created_at, :has_input, :legacy, :estimate_cost
+          :enrichment_id, :created_at, :estimate_cost
     model_field :credit_detail, CreditDetail
   end
 
-  # Synchronous scrape result (legacy request_status format, per the spec).
+  # Synchronous scrape result (request_status format, per the spec).
   class ScrapeResult < Model
     field :request_status, :text, :url, :base_url_for_links, :status_code,
           :possibly_blocked, :credit_used, :riveter_app_link, :estimate_cost
@@ -239,7 +263,7 @@ module Riveter
     field :name, :last_used_at, :created_by
   end
 
-  # Account info (legacy request_status format, per the spec).
+  # Account info (request_status format, per the spec).
   class AccountInfo < Model
     field :request_status, :message
     model_field :account, Account

data/lib/riveter/page.rb

@@ -41,18 +41,20 @@ module Riveter
   end
 
   # One page of dataset rows (cursor-paginated). #each iterates the page;
-  # #auto_paging_each walks every following page too.
+  # #auto_paging_each walks every following page too. Rows are DatasetRow, or
+  # CompactDatasetRow for a compact: true read (row_class).
   class DatasetRowsPage
     include Enumerable
 
     attr_reader :rows, :next_cursor, :row_count
 
-    def initialize(data, fetch_page)
+    def initialize(data, fetch_page, row_class: DatasetRow)
       data = data.is_a?(Hash) ? data : {}
-      @rows = (data["rows"] || []).map { |item| DatasetRow.new(item) }
+      @rows = (data["rows"] || []).map { |item| row_class.new(item) }
       @next_cursor = data["next_cursor"]
       @row_count = data["row_count"]
       @fetch_page = fetch_page
+      @row_class = row_class
     end
 
     def each(&block)
@@ -66,7 +68,7 @@ module Riveter
     def next_page
       raise Error, "No next page" unless next_page?
 
-      DatasetRowsPage.new(@fetch_page.call(next_cursor), @fetch_page)
+      DatasetRowsPage.new(@fetch_page.call(next_cursor), @fetch_page, row_class: @row_class)
     end
 
     def auto_paging_each(&block)

data/lib/riveter/resources.rb

@@ -58,8 +58,8 @@ module Riveter
         @client = client
       end
 
-      # Paginated compact list of enrichments: names, status, column names and
-      # counts. Params: status:, name:, page:, per_page:. (operationId: listEnrichments)
+      # Paginated compact list of enrichments: names, column names and counts.
+      # Params: name:, page:, per_page:. (operationId: listEnrichments)
       def list(**params)
         fetch_page = ->(page) { @client.request(:get, "/enrichments", query: params.merge(page: page)) }
         EnrichmentsPage.new(fetch_page.call(params[:page] || 1), fetch_page)
@@ -135,12 +135,28 @@ module Riveter
       end
 
       # A page of rows in position order (`limit:`, `cursor:`, `updated_since:`);
-      # #auto_paging_each walks every following page. (operationId: listDatasetRows)
-      def list_rows(dataset_id, **params)
+      # #auto_paging_each walks every following page. `columns:` (an Array of names) keeps only
+      # those columns; `compact: true` answers CompactDatasetRow (the values alone), so a
+      # 1,000-row page of one column is one small call. (operationId: listDatasetRows)
+      def list_rows(dataset_id, columns: nil, compact: false, **params)
+        query = params.merge(columns: columns && Array(columns).join(","), compact: compact ? "true" : nil)
         fetch_page = lambda do |cursor|
-          @client.request(:get, "/datasets/#{dataset_id}/rows", query: params.merge(cursor: cursor))
+          @client.request(:get, "/datasets/#{dataset_id}/rows", query: query.merge(cursor: cursor))
         end
-        DatasetRowsPage.new(fetch_page.call(params[:cursor]), fetch_page)
+        row_class = compact ? CompactDatasetRow : DatasetRow
+        DatasetRowsPage.new(fetch_page.call(params[:cursor]), fetch_page, row_class: row_class)
+      end
+
+      # Per-column counts over every row, no rows read: an output column's cells by state and its
+      # most common values; an input column's filled rows and values. `columns:` picks the columns,
+      # `top_values:` how many values per column (1–100, default 20). (operationId: getDatasetSummary)
+      def summary(dataset_id, columns: nil, top_values: nil)
+        DatasetSummary.new(
+          @client.request(
+            :get, "/datasets/#{dataset_id}/summary",
+            query: { columns: columns && Array(columns).join(","), top_values: top_values }
+          )
+        )
       end
 
       # Append rows (≤ 100 per call) keyed by input column name; duplicates on the index

data/lib/riveter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Riveter
-  VERSION = "1.0.1"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riveter-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Riveter
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-27 00:00:00.000000000 Z
+date: 2026-11-12 00:00:00.000000000 Z
 dependencies: []
 description: Client for the Riveter API — enrich data, build datasets, scrape pages,
   and run web searches. https://docs.riveterhq.com