context.dev 2.21.0 → 2.22.0

data/rbi/context_dev/models/news_search_params.rbi

@@ -49,7 +49,7 @@ module ContextDev
       sig { params(sort_by: ContextDev::NewsSearchParams::SortBy::OrHash).void }
       attr_writer :sort_by
 
-      # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      # Labels for filtering usage in the dashboard.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :tags
 
@@ -80,7 +80,7 @@ module ContextDev
         limit: nil,
         # Result ordering. Defaults to newest.
         sort_by: nil,
-        # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+        # Labels for filtering usage in the dashboard.
         tags: nil,
         request_options: {}
       )
@@ -193,6 +193,7 @@ module ContextDev
             sig { returns(String) }
             attr_accessor :name
 
+            # Use `name` to identify the company by name.
             sig { returns(Symbol) }
             attr_accessor :type
 
@@ -201,6 +202,7 @@ module ContextDev
             def self.new(
               # Company name.
               name:,
+              # Use `name` to identify the company by name.
               type: :name
             )
             end
@@ -223,6 +225,7 @@ module ContextDev
             sig { returns(String) }
             attr_accessor :domain
 
+            # Use `domain` to identify the company by website domain.
             sig { returns(Symbol) }
             attr_accessor :type
 
@@ -233,6 +236,7 @@ module ContextDev
             def self.new(
               # Company website domain, such as apple.com.
               domain:,
+              # Use `domain` to identify the company by website domain.
               type: :domain
             )
             end
@@ -255,6 +259,7 @@ module ContextDev
             sig { returns(String) }
             attr_accessor :ticker
 
+            # Use `ticker` to identify a publicly traded company.
             sig { returns(Symbol) }
             attr_accessor :type
 
@@ -292,6 +297,7 @@ module ContextDev
               # Stock exchange the ticker trades on, used to disambiguate tickers listed on
               # multiple exchanges.
               exchange: nil,
+              # Use `ticker` to identify a publicly traded company.
               type: :ticker
             )
             end
@@ -709,6 +715,7 @@ module ContextDev
             sig { returns(String) }
             attr_accessor :isin
 
+            # Use `isin` to identify the company by its securities identifier.
             sig { returns(Symbol) }
             attr_accessor :type
 
@@ -717,6 +724,7 @@ module ContextDev
             def self.new(
               # International Securities Identification Number.
               isin:,
+              # Use `isin` to identify the company by its securities identifier.
               type: :isin
             )
             end

data/rbi/context_dev/models/news_search_response.rbi

@@ -33,12 +33,12 @@ module ContextDev
       sig { returns(T.nilable(String)) }
       attr_accessor :next_cursor
 
-      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      # it when contacting support about a failed request.
+      # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+      # support.
       sig { returns(String) }
       attr_accessor :request_id
 
-      # Credit usage, included whenever a valid API key is provided.
+      # Credits this request used and your remaining balance.
       sig do
         returns(T.nilable(ContextDev::Models::NewsSearchResponse::KeyMetadata))
       end
@@ -73,10 +73,10 @@ module ContextDev
         # Pass as cursor in the next request to fetch the following page. Null when there
         # are no more results.
         next_cursor:,
-        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-        # it when contacting support about a failed request.
+        # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+        # support.
         request_id:,
-        # Credit usage, included whenever a valid API key is provided.
+        # Credits this request used and your remaining balance.
         key_metadata: nil
       )
       end
@@ -461,7 +461,7 @@ module ContextDev
             )
           end
 
-        # Credits used by this request.
+        # Credits charged for this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
@@ -469,14 +469,14 @@ module ContextDev
         sig { returns(Integer) }
         attr_accessor :credits_remaining
 
-        # Credit usage, included whenever a valid API key is provided.
+        # 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 used by this request.
+          # Credits charged for this request.
           credits_consumed:,
           # Credits remaining for your organization.
           credits_remaining:

data/rbi/context_dev/models/parse_handle_params.rbi

@@ -49,11 +49,7 @@ module ContextDev
       sig { params(include_links: T::Boolean).void }
       attr_writer :include_links
 
-      # When true for PDF inputs, OCR the selected pages that have no usable text layer
-      # (scans), replacing each recovered page's text with the OCR result while pages
-      # with a real text layer keep it. pdf.start/pdf.end limit the inclusive page
-      # range. Billed at 1 credit per page OCR actually recovered, on top of the base
-      # request cost. When false, no OCR runs.
+      # Read text from images and scanned PDF pages. PDF page ranges still apply.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :ocr
 
@@ -74,8 +70,7 @@ module ContextDev
       sig { params(shorten_base64_images: T::Boolean).void }
       attr_writer :shorten_base64_images
 
-      # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-      # characters.
+      # Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :tags
 
@@ -89,11 +84,8 @@ module ContextDev
       sig { params(use_main_content_only: T::Boolean).void }
       attr_writer :use_main_content_only
 
-      # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      # omitted. Requires zero data retention to be enabled for your organization
-      # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-      # Successful ZDR responses include X-Context-ZDR: true.
+      # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+      # your organization has ZDR.
       sig { returns(T.nilable(ContextDev::ParseHandleParams::Zdr::OrSymbol)) }
       attr_reader :zdr
 
@@ -127,26 +119,18 @@ module ContextDev
         include_images: nil,
         # Preserve hyperlinks in Markdown output
         include_links: nil,
-        # When true for PDF inputs, OCR the selected pages that have no usable text layer
-        # (scans), replacing each recovered page's text with the OCR result while pages
-        # with a real text layer keep it. pdf.start/pdf.end limit the inclusive page
-        # range. Billed at 1 credit per page OCR actually recovered, on top of the base
-        # request cost. When false, no OCR runs.
+        # Read text from images and scanned PDF pages. PDF page ranges still apply.
         ocr: nil,
         # PDF page-range options as a JSON object, e.g. {"start": 2, "end": 5}.
         pdf: nil,
         # Shorten base64-encoded image data in the Markdown output
         shorten_base64_images: nil,
-        # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-        # characters.
+        # Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
         tags: nil,
         # Extract only the main content from HTML-like inputs
         use_main_content_only: nil,
-        # Set to enabled to bypass shared caches and omit request and response content
-        # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-        # omitted. Requires zero data retention to be enabled for your organization
-        # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-        # Successful ZDR responses include X-Context-ZDR: true.
+        # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+        # your organization has ZDR.
         zdr: nil,
         request_options: {}
       )
@@ -371,11 +355,8 @@ module ContextDev
         end
       end
 
-      # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      # omitted. Requires zero data retention to be enabled for your organization
-      # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-      # Successful ZDR responses include X-Context-ZDR: true.
+      # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+      # your organization has ZDR.
       module Zdr
         extend ContextDev::Internal::Type::Enum
 

data/rbi/context_dev/models/parse_handle_response.rbi

@@ -15,8 +15,8 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :markdown
 
-      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      # it when contacting support about a failed request.
+      # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+      # support.
       sig { returns(String) }
       attr_accessor :request_id
 
@@ -32,7 +32,7 @@ module ContextDev
       end
       attr_accessor :type
 
-      # Credit usage, included whenever a valid API key is provided.
+      # Credits this request used and your remaining balance.
       sig do
         returns(T.nilable(ContextDev::Models::ParseHandleResponse::KeyMetadata))
       end
@@ -59,14 +59,14 @@ module ContextDev
       def self.new(
         # Input bytes converted to GitHub Flavored Markdown
         markdown:,
-        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-        # it when contacting support about a failed request.
+        # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+        # support.
         request_id:,
         # Indicates success
         success:,
         # Detected content type used for parsing
         type:,
-        # Credit usage, included whenever a valid API key is provided.
+        # Credits this request used and your remaining balance.
         key_metadata: nil
       )
       end
@@ -349,7 +349,7 @@ module ContextDev
             )
           end
 
-        # Credits used by this request.
+        # Credits charged for this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
@@ -357,14 +357,14 @@ module ContextDev
         sig { returns(Integer) }
         attr_accessor :credits_remaining
 
-        # Credit usage, included whenever a valid API key is provided.
+        # 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 used by this request.
+          # Credits charged for this request.
           credits_consumed:,
           # Credits remaining for your organization.
           credits_remaining:

data/rbi/context_dev/models/person_enrich_params.rbi

@@ -11,6 +11,7 @@ module ContextDev
           T.any(ContextDev::PersonEnrichParams, ContextDev::Internal::AnyHash)
         end
 
+      # Company context to help identify the person. Provide a name or domain.
       sig { returns(T.nilable(ContextDev::PersonEnrichParams::Company)) }
       attr_reader :company
 
@@ -19,6 +20,7 @@ module ContextDev
       end
       attr_writer :company
 
+      # Education history to help distinguish people with similar names.
       sig do
         returns(T.nilable(T::Array[ContextDev::PersonEnrichParams::Education]))
       end
@@ -31,12 +33,15 @@ module ContextDev
       end
       attr_writer :education
 
+      # Email address of the person to find.
       sig { returns(T.nilable(String)) }
       attr_reader :email
 
       sig { params(email: String).void }
       attr_writer :email
 
+      # Location context to help identify the person. Provide a city, region, or
+      # country.
       sig { returns(T.nilable(ContextDev::PersonEnrichParams::Location)) }
       attr_reader :location
 
@@ -45,28 +50,30 @@ module ContextDev
       end
       attr_writer :location
 
+      # Person name. Without an email or person-profile URL, provide both first and last
+      # name plus company, education, or location.
       sig { returns(T.nilable(ContextDev::PersonEnrichParams::Name)) }
       attr_reader :name
 
       sig { params(name: ContextDev::PersonEnrichParams::Name::OrHash).void }
       attr_writer :name
 
+      # Public profile URLs for the person. A person-profile URL can identify the person
+      # without a name.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :social_urls
 
       sig { params(social_urls: T::Array[String]).void }
       attr_writer :social_urls
 
-      # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      # Labels for filtering usage in the dashboard.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :tags
 
       sig { params(tags: T::Array[String]).void }
       attr_writer :tags
 
-      # Optional request deadline and behavior on timeout. For GET requests, use
-      # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-      # timeoutOpts object.
+      # Request deadline and what to return when it passes.
       sig { returns(T.nilable(ContextDev::PersonEnrichParams::TimeoutOpts)) }
       attr_reader :timeout_opts
 
@@ -77,11 +84,8 @@ module ContextDev
       end
       attr_writer :timeout_opts
 
-      # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      # omitted. Requires zero data retention to be enabled for your organization
-      # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-      # Successful ZDR responses include X-Context-ZDR: true.
+      # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+      # your organization has ZDR.
       sig { returns(T.nilable(ContextDev::PersonEnrichParams::Zdr::OrSymbol)) }
       attr_reader :zdr
 
@@ -104,23 +108,27 @@ module ContextDev
         ).returns(T.attached_class)
       end
       def self.new(
+        # Company context to help identify the person. Provide a name or domain.
         company: nil,
+        # Education history to help distinguish people with similar names.
         education: nil,
+        # Email address of the person to find.
         email: nil,
+        # Location context to help identify the person. Provide a city, region, or
+        # country.
         location: nil,
+        # Person name. Without an email or person-profile URL, provide both first and last
+        # name plus company, education, or location.
         name: nil,
+        # Public profile URLs for the person. A person-profile URL can identify the person
+        # without a name.
         social_urls: nil,
-        # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+        # Labels for filtering usage in the dashboard.
         tags: nil,
-        # Optional request deadline and behavior on timeout. For GET requests, use
-        # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-        # timeoutOpts object.
+        # Request deadline and what to return when it passes.
         timeout_opts: nil,
-        # Set to enabled to bypass shared caches and omit request and response content
-        # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-        # omitted. Requires zero data retention to be enabled for your organization
-        # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-        # Successful ZDR responses include X-Context-ZDR: true.
+        # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+        # your organization has ZDR.
         zdr: nil,
         request_options: {}
       )
@@ -154,20 +162,28 @@ module ContextDev
             )
           end
 
+        # Website domain of a company associated with the person.
         sig { returns(T.nilable(String)) }
         attr_reader :domain
 
         sig { params(domain: String).void }
         attr_writer :domain
 
+        # Name of a company associated with the person.
         sig { returns(T.nilable(String)) }
         attr_reader :name
 
         sig { params(name: String).void }
         attr_writer :name
 
+        # Company context to help identify the person. Provide a name or domain.
         sig { params(domain: String, name: String).returns(T.attached_class) }
-        def self.new(domain: nil, name: nil)
+        def self.new(
+          # Website domain of a company associated with the person.
+          domain: nil,
+          # Name of a company associated with the person.
+          name: nil
+        )
         end
 
         sig { override.returns({ domain: String, name: String }) }
@@ -184,24 +200,28 @@ module ContextDev
             )
           end
 
+        # Degree or qualification earned.
         sig { returns(T.nilable(String)) }
         attr_reader :degree
 
         sig { params(degree: String).void }
         attr_writer :degree
 
+        # Subject or major studied.
         sig { returns(T.nilable(String)) }
         attr_reader :field_of_study
 
         sig { params(field_of_study: String).void }
         attr_writer :field_of_study
 
+        # Four-digit graduation year.
         sig { returns(T.nilable(Integer)) }
         attr_reader :graduation_year
 
         sig { params(graduation_year: Integer).void }
         attr_writer :graduation_year
 
+        # School or university, identified by name or domain.
         sig do
           returns(
             T.nilable(ContextDev::PersonEnrichParams::Education::Institution)
@@ -227,9 +247,13 @@ module ContextDev
           ).returns(T.attached_class)
         end
         def self.new(
+          # Degree or qualification earned.
           degree: nil,
+          # Subject or major studied.
           field_of_study: nil,
+          # Four-digit graduation year.
           graduation_year: nil,
+          # School or university, identified by name or domain.
           institution: nil
         )
         end
@@ -257,20 +281,28 @@ module ContextDev
               )
             end
 
+          # Website domain of the school or university.
           sig { returns(T.nilable(String)) }
           attr_reader :domain
 
           sig { params(domain: String).void }
           attr_writer :domain
 
+          # Name of the school or university.
           sig { returns(T.nilable(String)) }
           attr_reader :name
 
           sig { params(name: String).void }
           attr_writer :name
 
+          # School or university, identified by name or domain.
           sig { params(domain: String, name: String).returns(T.attached_class) }
-          def self.new(domain: nil, name: nil)
+          def self.new(
+            # Website domain of the school or university.
+            domain: nil,
+            # Name of the school or university.
+            name: nil
+          )
           end
 
           sig { override.returns({ domain: String, name: String }) }
@@ -288,30 +320,42 @@ module ContextDev
             )
           end
 
+        # City associated with the person.
         sig { returns(T.nilable(String)) }
         attr_reader :city
 
         sig { params(city: String).void }
         attr_writer :city
 
+        # Country associated with the person.
         sig { returns(T.nilable(String)) }
         attr_reader :country
 
         sig { params(country: String).void }
         attr_writer :country
 
+        # State, province, or region associated with the person.
         sig { returns(T.nilable(String)) }
         attr_reader :region
 
         sig { params(region: String).void }
         attr_writer :region
 
+        # Location context to help identify the person. Provide a city, region, or
+        # country.
         sig do
           params(city: String, country: String, region: String).returns(
             T.attached_class
           )
         end
-        def self.new(city: nil, country: nil, region: nil)
+        def self.new(
+          # City associated with the person.
+          city: nil,
+          # Country associated with the person.
+          country: nil,
+          # State, province, or region associated with the person.
+          region: nil
+        )
         end
 
         sig do
@@ -330,20 +374,29 @@ module ContextDev
             )
           end
 
+        # First or given name.
         sig { returns(T.nilable(String)) }
         attr_reader :first
 
         sig { params(first: String).void }
         attr_writer :first
 
+        # Last or family name.
         sig { returns(T.nilable(String)) }
         attr_reader :last
 
         sig { params(last: String).void }
         attr_writer :last
 
+        # Person name. Without an email or person-profile URL, provide both first and last
+        # name plus company, education, or location.
         sig { params(first: String, last: String).returns(T.attached_class) }
-        def self.new(first: nil, last: nil)
+        def self.new(
+          # First or given name.
+          first: nil,
+          # Last or family name.
+          last: nil
+        )
         end
 
         sig { override.returns({ first: String, last: String }) }
@@ -360,14 +413,12 @@ module ContextDev
             )
           end
 
-        # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        # Deadline in milliseconds.
         sig { returns(Integer) }
         attr_accessor :milliseconds
 
-        # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        # credits. "return-partial" returns usable results collected so far; if none are
-        # available, the request still fails without charging credits. Partial results are
-        # not cached as complete results.
+        # "fail" returns 408 at the deadline. "return-partial" returns available results;
+        # inspect the response’s partial flag.
         sig do
           returns(
             T.nilable(
@@ -385,9 +436,7 @@ module ContextDev
         end
         attr_writer :behavior
 
-        # Optional request deadline and behavior on timeout. For GET requests, use
-        # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-        # timeoutOpts object.
+        # Request deadline and what to return when it passes.
         sig do
           params(
             milliseconds: Integer,
@@ -396,12 +445,10 @@ module ContextDev
           ).returns(T.attached_class)
         end
         def self.new(
-          # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+          # Deadline in milliseconds.
           milliseconds:,
-          # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-          # credits. "return-partial" returns usable results collected so far; if none are
-          # available, the request still fails without charging credits. Partial results are
-          # not cached as complete results.
+          # "fail" returns 408 at the deadline. "return-partial" returns available results;
+          # inspect the response’s partial flag.
           behavior: nil
         )
         end
@@ -418,10 +465,8 @@ module ContextDev
         def to_hash
         end
 
-        # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        # credits. "return-partial" returns usable results collected so far; if none are
-        # available, the request still fails without charging credits. Partial results are
-        # not cached as complete results.
+        # "fail" returns 408 at the deadline. "return-partial" returns available results;
+        # inspect the response’s partial flag.
         module Behavior
           extend ContextDev::Internal::Type::Enum
 
@@ -457,11 +502,8 @@ module ContextDev
         end
       end
 
-      # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      # omitted. Requires zero data retention to be enabled for your organization
-      # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-      # Successful ZDR responses include X-Context-ZDR: true.
+      # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+      # your organization has ZDR.
       module Zdr
         extend ContextDev::Internal::Type::Enum