context.dev 2.21.0 → 2.22.0

data/rbi/context_dev/models/monitor_list_changes_response.rbi

@@ -22,6 +22,27 @@ module ContextDev
       sig { returns(T.nilable(String)) }
       attr_accessor :next_cursor
 
+      # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+      # support.
+      sig { returns(String) }
+      attr_accessor :request_id
+
+      # Credits this request used and your remaining balance.
+      sig do
+        returns(
+          T.nilable(ContextDev::Models::MonitorListChangesResponse::KeyMetadata)
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::MonitorListChangesResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       sig do
         params(
           data:
@@ -29,10 +50,22 @@ module ContextDev
               ContextDev::Models::MonitorListChangesResponse::Data::OrHash
             ],
           has_more: T::Boolean,
-          next_cursor: T.nilable(String)
+          next_cursor: T.nilable(String),
+          request_id: String,
+          key_metadata:
+            ContextDev::Models::MonitorListChangesResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(data:, has_more:, next_cursor:)
+      def self.new(
+        data:,
+        has_more:,
+        next_cursor:,
+        # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+        # support.
+        request_id:,
+        # Credits this request used and your remaining balance.
+        key_metadata: nil
+      )
       end
 
       sig do
@@ -41,7 +74,10 @@ module ContextDev
             data:
               T::Array[ContextDev::Models::MonitorListChangesResponse::Data],
             has_more: T::Boolean,
-            next_cursor: T.nilable(String)
+            next_cursor: T.nilable(String),
+            request_id: String,
+            key_metadata:
+              ContextDev::Models::MonitorListChangesResponse::KeyMetadata
           }
         )
       end
@@ -70,8 +106,7 @@ module ContextDev
         sig { returns(Time) }
         attr_accessor :detected_at
 
-        # Top-level monitor category. Always `web` today; the concrete behavior is
-        # described by `target` and `change_detection`.
+        # Always `web`. Optional.
         sig do
           returns(
             ContextDev::Models::MonitorListChangesResponse::Data::Mode::TaggedSymbol
@@ -82,9 +117,17 @@ module ContextDev
         sig { returns(String) }
         attr_accessor :monitor_id
 
+        # The run that detected this change.
+        sig { returns(String) }
+        attr_accessor :run_id
+
         sig { returns(String) }
         attr_accessor :summary
 
+        # Labels for filtering monitors, their changes, and their usage.
+        sig { returns(T::Array[String]) }
+        attr_accessor :tags
+
         sig do
           returns(
             ContextDev::Models::MonitorListChangesResponse::Data::TargetType::TaggedSymbol
@@ -104,12 +147,59 @@ module ContextDev
         sig { params(added_url_count: Integer).void }
         attr_writer :added_url_count
 
+        # At most 500 URLs are included; the corresponding count field is always exact.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :added_urls
+
+        sig { params(added_urls: T::Array[String]).void }
+        attr_writer :added_urls
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :after_text_excerpt
+
+        sig { params(after_text_excerpt: String).void }
+        attr_writer :after_text_excerpt
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :before_text_excerpt
+
+        sig { params(before_text_excerpt: String).void }
+        attr_writer :before_text_excerpt
+
         sig { returns(T.nilable(Float)) }
         attr_reader :confidence
 
         sig { params(confidence: Float).void }
         attr_writer :confidence
 
+        # Text diff between the previous and current page baseline (page targets).
+        sig { returns(T.nilable(String)) }
+        attr_reader :diff
+
+        sig { params(diff: String).void }
+        attr_writer :diff
+
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                ContextDev::Models::MonitorListChangesResponse::Data::Evidence
+              ]
+            )
+          )
+        end
+        attr_reader :evidence
+
+        sig do
+          params(
+            evidence:
+              T::Array[
+                ContextDev::Models::MonitorListChangesResponse::Data::Evidence::OrHash
+              ]
+          ).void
+        end
+        attr_writer :evidence
+
         sig do
           returns(
             T.nilable(
@@ -133,25 +223,27 @@ module ContextDev
         sig { params(matched_url_count: Integer).void }
         attr_writer :matched_url_count
 
+        # At most 500 URLs are included; the corresponding count field is always exact.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :matched_urls
+
+        sig { params(matched_urls: T::Array[String]).void }
+        attr_writer :matched_urls
+
         sig { returns(T.nilable(Integer)) }
         attr_reader :removed_url_count
 
         sig { params(removed_url_count: Integer).void }
         attr_writer :removed_url_count
 
-        # User-defined tags for grouping and filtering monitors and their changes.
-        # Duplicates are removed.
+        # At most 500 URLs are included; the corresponding count field is always exact.
         sig { returns(T.nilable(T::Array[String])) }
-        attr_reader :tags
+        attr_reader :removed_urls
 
-        sig { params(tags: T::Array[String]).void }
-        attr_writer :tags
+        sig { params(removed_urls: T::Array[String]).void }
+        attr_writer :removed_urls
 
-        # A lightweight change summary. `mode` is the constant `web`; `target_type` and
-        # `change_detection_type` describe the change, and which optional fields are
-        # present depends on them (e.g. sitemap changes include
-        # `added_url_count`/`removed_url_count`; semantic changes include
-        # `confidence`/`importance`).
+        # Detected change, including applicable diffs, URLs, and supporting evidence.
         sig do
           params(
             id: String,
@@ -161,40 +253,62 @@ module ContextDev
             mode:
               ContextDev::Models::MonitorListChangesResponse::Data::Mode::OrSymbol,
             monitor_id: String,
+            run_id: String,
             summary: String,
+            tags: T::Array[String],
             target_type:
               ContextDev::Models::MonitorListChangesResponse::Data::TargetType::OrSymbol,
             title: String,
             url: String,
             added_url_count: Integer,
+            added_urls: T::Array[String],
+            after_text_excerpt: String,
+            before_text_excerpt: String,
             confidence: Float,
+            diff: String,
+            evidence:
+              T::Array[
+                ContextDev::Models::MonitorListChangesResponse::Data::Evidence::OrHash
+              ],
             importance:
               ContextDev::Models::MonitorListChangesResponse::Data::Importance::OrSymbol,
             matched_url_count: Integer,
+            matched_urls: T::Array[String],
             removed_url_count: Integer,
-            tags: T::Array[String]
+            removed_urls: T::Array[String]
           ).returns(T.attached_class)
         end
         def self.new(
           id:,
           change_detection_type:,
           detected_at:,
-          # Top-level monitor category. Always `web` today; the concrete behavior is
-          # described by `target` and `change_detection`.
+          # Always `web`. Optional.
           mode:,
           monitor_id:,
+          # The run that detected this change.
+          run_id:,
           summary:,
+          # Labels for filtering monitors, their changes, and their usage.
+          tags:,
           target_type:,
           title:,
           url:,
           added_url_count: nil,
+          # At most 500 URLs are included; the corresponding count field is always exact.
+          added_urls: nil,
+          after_text_excerpt: nil,
+          before_text_excerpt: nil,
           confidence: nil,
+          # Text diff between the previous and current page baseline (page targets).
+          diff: nil,
+          evidence: nil,
           importance: nil,
           matched_url_count: nil,
+          # At most 500 URLs are included; the corresponding count field is always exact.
+          matched_urls: nil,
           removed_url_count: nil,
-          # User-defined tags for grouping and filtering monitors and their changes.
-          # Duplicates are removed.
-          tags: nil
+          # At most 500 URLs are included; the corresponding count field is always exact.
+          removed_urls: nil
         )
         end
 
@@ -208,18 +322,29 @@ module ContextDev
               mode:
                 ContextDev::Models::MonitorListChangesResponse::Data::Mode::TaggedSymbol,
               monitor_id: String,
+              run_id: String,
               summary: String,
+              tags: T::Array[String],
               target_type:
                 ContextDev::Models::MonitorListChangesResponse::Data::TargetType::TaggedSymbol,
               title: String,
               url: String,
               added_url_count: Integer,
+              added_urls: T::Array[String],
+              after_text_excerpt: String,
+              before_text_excerpt: String,
               confidence: Float,
+              diff: String,
+              evidence:
+                T::Array[
+                  ContextDev::Models::MonitorListChangesResponse::Data::Evidence
+                ],
               importance:
                 ContextDev::Models::MonitorListChangesResponse::Data::Importance::TaggedSymbol,
               matched_url_count: Integer,
+              matched_urls: T::Array[String],
               removed_url_count: Integer,
-              tags: T::Array[String]
+              removed_urls: T::Array[String]
             }
           )
         end
@@ -260,8 +385,7 @@ module ContextDev
           end
         end
 
-        # Top-level monitor category. Always `web` today; the concrete behavior is
-        # described by `target` and `change_detection`.
+        # Always `web`. Optional.
         module Mode
           extend ContextDev::Internal::Type::Enum
 
@@ -330,6 +454,52 @@ module ContextDev
           end
         end
 
+        class Evidence < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::Models::MonitorListChangesResponse::Data::Evidence,
+                ContextDev::Internal::AnyHash
+              )
+            end
+
+          # Snapshot of the content after the change.
+          sig { returns(String) }
+          attr_accessor :after
+
+          # Snapshot of the content before the change.
+          sig { returns(String) }
+          attr_accessor :before
+
+          # Optional URL the evidence relates to. Absent for whole-target diffs.
+          sig { returns(T.nilable(String)) }
+          attr_reader :url
+
+          sig { params(url: String).void }
+          attr_writer :url
+
+          sig do
+            params(after: String, before: String, url: String).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # Snapshot of the content after the change.
+            after:,
+            # Snapshot of the content before the change.
+            before:,
+            # Optional URL the evidence relates to. Absent for whole-target diffs.
+            url: nil
+          )
+          end
+
+          sig do
+            override.returns({ after: String, before: String, url: String })
+          end
+          def to_hash
+          end
+        end
+
         module Importance
           extend ContextDev::Internal::Type::Enum
 
@@ -369,6 +539,46 @@ module ContextDev
           end
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::MonitorListChangesResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Credits charged for this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # Credits remaining for your organization.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Credits this request used and your remaining balance.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Credits charged for this request.
+          credits_consumed:,
+          # Credits remaining for your organization.
+          credits_remaining:
+        )
+        end
+
+        sig do
+          override.returns(
+            { credits_consumed: Integer, credits_remaining: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models/monitor_list_params.rbi

@@ -50,8 +50,8 @@ module ContextDev
       sig { params(q: String).void }
       attr_writer :q
 
-      # Comma-separated fields to search with `q`. Defaults to all of them. Note
-      # `instructions` only exists on extract monitors.
+      # Fields to search with `q`. Defaults to all fields; page and extract targets can
+      # have instructions.
       sig do
         returns(
           T.nilable(T::Array[ContextDev::MonitorListParams::SearchBy::OrSymbol])
@@ -136,8 +136,8 @@ module ContextDev
         limit: nil,
         # Free-text search term, matched against the fields named in `search_by`.
         q: nil,
-        # Comma-separated fields to search with `q`. Defaults to all of them. Note
-        # `instructions` only exists on extract monitors.
+        # Fields to search with `q`. Defaults to all fields; page and extract targets can
+        # have instructions.
         search_by: nil,
         # `prefix` for as-you-type prefix matching (default), `exact` for full-token
         # matching.