context.dev 2.1.0 → 2.3.0

data/rbi/context_dev/models/monitor_update_response.rbi

@@ -128,6 +128,26 @@ module ContextDev
       end
       attr_writer :webhook
 
+      # Present while webhook deliveries are failing consecutively; null when deliveries
+      # are healthy or no webhook is configured. Cleared on the next successful delivery
+      # and when the webhook URL changes.
+      sig do
+        returns(
+          T.nilable(ContextDev::Models::MonitorUpdateResponse::WebhookFailure)
+        )
+      end
+      attr_reader :webhook_failure
+
+      sig do
+        params(
+          webhook_failure:
+            T.nilable(
+              ContextDev::Models::MonitorUpdateResponse::WebhookFailure::OrHash
+            )
+        ).void
+      end
+      attr_writer :webhook_failure
+
       # A web monitor. `mode` is the constant `web`; behavior is described by `target`
       # (page/sitemap/extract) and `change_detection` (exact/semantic).
       sig do
@@ -169,6 +189,10 @@ module ContextDev
           webhook:
             T.nilable(
               ContextDev::Models::MonitorUpdateResponse::Webhook::OrHash
+            ),
+          webhook_failure:
+            T.nilable(
+              ContextDev::Models::MonitorUpdateResponse::WebhookFailure::OrHash
             )
         ).returns(T.attached_class)
       end
@@ -207,7 +231,11 @@ module ContextDev
         next_run_at: nil,
         # User-defined tags for grouping and filtering monitors and their changes.
         tags: nil,
-        webhook: nil
+        webhook: nil,
+        # Present while webhook deliveries are failing consecutively; null when deliveries
+        # are healthy or no webhook is configured. Cleared on the next successful delivery
+        # and when the webhook URL changes.
+        webhook_failure: nil
       )
       end
 
@@ -236,7 +264,11 @@ module ContextDev
             next_run_at: T.nilable(Time),
             tags: T::Array[String],
             webhook:
-              T.nilable(ContextDev::Models::MonitorUpdateResponse::Webhook)
+              T.nilable(ContextDev::Models::MonitorUpdateResponse::Webhook),
+            webhook_failure:
+              T.nilable(
+                ContextDev::Models::MonitorUpdateResponse::WebhookFailure
+              )
           }
         )
       end
@@ -296,9 +328,9 @@ module ContextDev
           sig { params(confidence_threshold: Float).void }
           attr_writer :confidence_threshold
 
-          # Detect meaning-level changes to the extracted data, ignoring cosmetic or
-          # paraphrase-only differences. What is watched is determined by the extract
-          # target's `schema` and `instructions`.
+          # Detect meaning-level changes to tracked page content, ignoring cosmetic or
+          # paraphrase-only differences. Which changes are meaningful is judged against the
+          # extract target's `instructions` (and `schema`, when provided).
           sig do
             params(confidence_threshold: Float, type: Symbol).returns(
               T.attached_class
@@ -708,9 +740,14 @@ module ContextDev
           sig { params(max_pages: Integer).void }
           attr_writer :max_pages
 
-          # JSON Schema describing the data you care about. It guides which pages are
-          # selected for tracking and gives the change judge context on what matters. If
-          # omitted, a default summary + key-points schema is used.
+          # JSON Schema describing the data you care about. It is used three ways: it guides
+          # which pages are selected for tracking, it gives the change judge extra context
+          # on which changes matter (alongside `instructions`), and it defines the shape of
+          # the baseline `data` snapshot on GET /monitors/{monitor_id} (refreshed at most
+          # about once a day). It is not a response format for changes: change events and
+          # webhook payloads always contain diffs, summaries, and evidence excerpts — never
+          # data in this schema's shape. If omitted, a default summary + key-points schema
+          # is used.
           sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
           attr_reader :schema
 
@@ -720,8 +757,8 @@ module ContextDev
           # Watch the monitor-relevant pages of a site for meaningful changes. A crawl
           # guided by `schema`/`instructions` selects up to `max_pages` relevant pages to
           # track; each run re-checks exactly those pages, and confirmed content changes are
-          # judged against the monitor's instructions. The tracked page set is refreshed by
-          # a periodic re-discovery crawl.
+          # judged for relevance against the monitor's `instructions` (and `schema`, when
+          # provided). The tracked page set is refreshed by a periodic re-discovery crawl.
           sig do
             params(
               instructions: String,
@@ -744,9 +781,14 @@ module ContextDev
             max_depth: nil,
             # Maximum number of pages to track.
             max_pages: nil,
-            # JSON Schema describing the data you care about. It guides which pages are
-            # selected for tracking and gives the change judge context on what matters. If
-            # omitted, a default summary + key-points schema is used.
+            # JSON Schema describing the data you care about. It is used three ways: it guides
+            # which pages are selected for tracking, it gives the change judge extra context
+            # on which changes matter (alongside `instructions`), and it defines the shape of
+            # the baseline `data` snapshot on GET /monitors/{monitor_id} (refreshed at most
+            # about once a day). It is not a response format for changes: change events and
+            # webhook payloads always contain diffs, summaries, and evidence excerpts — never
+            # data in this schema's shape. If omitted, a default summary + key-points schema
+            # is used.
             schema: nil,
             type: :extract
           )
@@ -983,10 +1025,35 @@ module ContextDev
             )
           end
 
-        # Webhook URL called when a change is detected.
+        # Webhook URL events are delivered to.
         sig { returns(String) }
         attr_accessor :url
 
+        # Events delivered to this endpoint. `change.detected` fires only when a run
+        # detects a change; `run.completed` fires on every completed run — including runs
+        # that detected no change — and embeds the change when one was detected. Defaults
+        # to `["change.detected"]` when omitted.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                ContextDev::Models::MonitorUpdateResponse::Webhook::Event::TaggedSymbol
+              ]
+            )
+          )
+        end
+        attr_reader :events
+
+        sig do
+          params(
+            events:
+              T::Array[
+                ContextDev::Models::MonitorUpdateResponse::Webhook::Event::OrSymbol
+              ]
+          ).void
+        end
+        attr_writer :events
+
         # Signing secret used to verify webhook authenticity. Each delivery includes an
         # `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
         # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
@@ -998,10 +1065,24 @@ module ContextDev
         sig { params(secret: String).void }
         attr_writer :secret
 
-        sig { params(url: String, secret: String).returns(T.attached_class) }
+        sig do
+          params(
+            url: String,
+            events:
+              T::Array[
+                ContextDev::Models::MonitorUpdateResponse::Webhook::Event::OrSymbol
+              ],
+            secret: String
+          ).returns(T.attached_class)
+        end
         def self.new(
-          # Webhook URL called when a change is detected.
+          # Webhook URL events are delivered to.
           url:,
+          # Events delivered to this endpoint. `change.detected` fires only when a run
+          # detects a change; `run.completed` fires on every completed run — including runs
+          # that detected no change — and embeds the change when one was detected. Defaults
+          # to `["change.detected"]` when omitted.
+          events: nil,
           # Signing secret used to verify webhook authenticity. Each delivery includes an
           # `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
           # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
@@ -1011,9 +1092,166 @@ module ContextDev
         )
         end
 
-        sig { override.returns({ url: String, secret: String }) }
+        sig do
+          override.returns(
+            {
+              url: String,
+              events:
+                T::Array[
+                  ContextDev::Models::MonitorUpdateResponse::Webhook::Event::TaggedSymbol
+                ],
+              secret: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Event
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::MonitorUpdateResponse::Webhook::Event
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CHANGE_DETECTED =
+            T.let(
+              :"change.detected",
+              ContextDev::Models::MonitorUpdateResponse::Webhook::Event::TaggedSymbol
+            )
+          RUN_COMPLETED =
+            T.let(
+              :"run.completed",
+              ContextDev::Models::MonitorUpdateResponse::Webhook::Event::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::MonitorUpdateResponse::Webhook::Event::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class WebhookFailure < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::MonitorUpdateResponse::WebhookFailure,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Number of consecutive delivery attempts that did not succeed.
+        sig { returns(Integer) }
+        attr_accessor :consecutive_failures
+
+        sig { returns(Time) }
+        attr_accessor :last_failed_at
+
+        # Human-readable description of the most recent failure.
+        sig { returns(String) }
+        attr_accessor :last_message
+
+        # Outcome of the most recent failed delivery. rejected means a non-2xx response;
+        # failed means no HTTP response was received; skipped_unsafe_url means the URL
+        # failed the public-endpoint safety check.
+        sig do
+          returns(
+            ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus::TaggedSymbol
+          )
+        end
+        attr_accessor :last_status
+
+        # Present while webhook deliveries are failing consecutively; null when deliveries
+        # are healthy or no webhook is configured. Cleared on the next successful delivery
+        # and when the webhook URL changes.
+        sig do
+          params(
+            consecutive_failures: Integer,
+            last_failed_at: Time,
+            last_message: String,
+            last_status:
+              ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Number of consecutive delivery attempts that did not succeed.
+          consecutive_failures:,
+          last_failed_at:,
+          # Human-readable description of the most recent failure.
+          last_message:,
+          # Outcome of the most recent failed delivery. rejected means a non-2xx response;
+          # failed means no HTTP response was received; skipped_unsafe_url means the URL
+          # failed the public-endpoint safety check.
+          last_status:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              consecutive_failures: Integer,
+              last_failed_at: Time,
+              last_message: String,
+              last_status:
+                ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus::TaggedSymbol
+            }
+          )
+        end
         def to_hash
         end
+
+        # Outcome of the most recent failed delivery. rejected means a non-2xx response;
+        # failed means no HTTP response was received; skipped_unsafe_url means the URL
+        # failed the public-endpoint safety check.
+        module LastStatus
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          REJECTED =
+            T.let(
+              :rejected,
+              ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :failed,
+              ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus::TaggedSymbol
+            )
+          SKIPPED_UNSAFE_URL =
+            T.let(
+              :skipped_unsafe_url,
+              ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/context_dev/models/parse_handle_params.rbi

@@ -0,0 +1,163 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class ParseHandleParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ContextDev::ParseHandleParams, ContextDev::Internal::AnyHash)
+        end
+
+      sig { returns(ContextDev::Internal::FileInput) }
+      attr_accessor :body
+
+      # Optional HTTP(S) source document URL used to resolve relative links and image
+      # references. Relative references remain relative when omitted.
+      sig { returns(T.nilable(String)) }
+      attr_reader :base_url
+
+      sig { params(base_url: String).void }
+      attr_writer :base_url
+
+      # Optional file extension hint, such as pdf, docx, xlsx, pptx, html, json, csv,
+      # md, py, rtf, jpg, png, or txt.
+      sig { returns(T.nilable(String)) }
+      attr_reader :extension
+
+      sig { params(extension: String).void }
+      attr_writer :extension
+
+      # Optional filename hint used to infer the extension when extension is omitted.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filename
+
+      sig { params(filename: String).void }
+      attr_writer :filename
+
+      # Include image references in Markdown output
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :include_images
+
+      sig { params(include_images: T::Boolean).void }
+      attr_writer :include_images
+
+      # Preserve hyperlinks in Markdown output
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :include_links
+
+      sig { params(include_links: T::Boolean).void }
+      attr_writer :include_links
+
+      # When true for PDF inputs, detect and OCR images embedded in the selected pages,
+      # inserting recognized text at each image's position in page reading order while
+      # preserving the PDF text layer. pdfStart/pdfEnd limit the inclusive page range.
+      # This is separate from automatic scanned-PDF OCR fallback.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :ocr
+
+      sig { params(ocr: T::Boolean).void }
+      attr_writer :ocr
+
+      # Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
+      # Must be greater than or equal to pdfStart when both are provided.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :pdf_end
+
+      sig { params(pdf_end: Integer).void }
+      attr_writer :pdf_end
+
+      # First 1-based PDF page to parse. When omitted, parsing starts at the first page.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :pdf_start
+
+      sig { params(pdf_start: Integer).void }
+      attr_writer :pdf_start
+
+      # Shorten base64-encoded image data in the Markdown output
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :shorten_base64_images
+
+      sig { params(shorten_base64_images: T::Boolean).void }
+      attr_writer :shorten_base64_images
+
+      # Extract only the main content from HTML-like inputs
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :use_main_content_only
+
+      sig { params(use_main_content_only: T::Boolean).void }
+      attr_writer :use_main_content_only
+
+      sig do
+        params(
+          body: ContextDev::Internal::FileInput,
+          base_url: String,
+          extension: String,
+          filename: String,
+          include_images: T::Boolean,
+          include_links: T::Boolean,
+          ocr: T::Boolean,
+          pdf_end: Integer,
+          pdf_start: Integer,
+          shorten_base64_images: T::Boolean,
+          use_main_content_only: T::Boolean,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        body:,
+        # Optional HTTP(S) source document URL used to resolve relative links and image
+        # references. Relative references remain relative when omitted.
+        base_url: nil,
+        # Optional file extension hint, such as pdf, docx, xlsx, pptx, html, json, csv,
+        # md, py, rtf, jpg, png, or txt.
+        extension: nil,
+        # Optional filename hint used to infer the extension when extension is omitted.
+        filename: nil,
+        # Include image references in Markdown output
+        include_images: nil,
+        # Preserve hyperlinks in Markdown output
+        include_links: nil,
+        # When true for PDF inputs, detect and OCR images embedded in the selected pages,
+        # inserting recognized text at each image's position in page reading order while
+        # preserving the PDF text layer. pdfStart/pdfEnd limit the inclusive page range.
+        # This is separate from automatic scanned-PDF OCR fallback.
+        ocr: nil,
+        # Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
+        # Must be greater than or equal to pdfStart when both are provided.
+        pdf_end: nil,
+        # First 1-based PDF page to parse. When omitted, parsing starts at the first page.
+        pdf_start: nil,
+        # Shorten base64-encoded image data in the Markdown output
+        shorten_base64_images: nil,
+        # Extract only the main content from HTML-like inputs
+        use_main_content_only: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            body: ContextDev::Internal::FileInput,
+            base_url: String,
+            extension: String,
+            filename: String,
+            include_images: T::Boolean,
+            include_links: T::Boolean,
+            ocr: T::Boolean,
+            pdf_end: Integer,
+            pdf_start: Integer,
+            shorten_base64_images: T::Boolean,
+            use_main_content_only: T::Boolean,
+            request_options: ContextDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end