From 58cb73a109e20f296f6a5f256a94d690b1203f70 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 6 May 2026 22:15:50 +0000 Subject: [PATCH 1/2] feat(api): api update --- .stats.yml | 4 +- .../models/web_web_scrape_images_params.rb | 69 +++++- .../models/web_web_scrape_images_response.rb | 109 +++++++-- lib/context_dev/resources/web.rb | 20 +- .../models/web_web_scrape_images_params.rbi | 116 ++++++++- .../models/web_web_scrape_images_response.rbi | 225 ++++++++++++++++-- rbi/context_dev/resources/web.rbi | 17 +- .../models/web_web_scrape_images_params.rbs | 61 ++++- .../models/web_web_scrape_images_response.rbs | 89 ++++++- sig/context_dev/resources/web.rbs | 2 + 10 files changed, 652 insertions(+), 60 deletions(-) diff --git a/.stats.yml b/.stats.yml index f435808d..66f8c277 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 22 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-4a46f38182c87694de28ad72b2ebb873d3004533dbe8db3276637d6d80cf9a33.yml -openapi_spec_hash: b10ee8536928665190a110738964fccb +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-bfa54d26b675d92a0b3db3e3c2147dc98250fb1e4cb82bb6bd6f9af544763506.yml +openapi_spec_hash: 7d834a5553262d0a2538bc066f39d549 config_hash: 70354330f92ce169beabc98696ebb9a3 diff --git a/lib/context_dev/models/web_web_scrape_images_params.rb b/lib/context_dev/models/web_web_scrape_images_params.rb index e33fe0f3..986a08c1 100644 --- a/lib/context_dev/models/web_web_scrape_images_params.rb +++ b/lib/context_dev/models/web_web_scrape_images_params.rb @@ -8,15 +8,78 @@ class WebWebScrapeImagesParams < ContextDev::Internal::Type::BaseModel include ContextDev::Internal::Type::RequestParameters # @!attribute url - # Full URL to scrape images from (must include http:// or https:// protocol) + # Page URL to inspect. Must include http:// or https://. # # @return [String] required :url, String - # @!method initialize(url:, request_options: {}) - # @param url [String] Full URL to scrape images from (must include http:// or https:// protocol) + # @!attribute enrichment + # Optional per-image processing, sent as deep-object query params such as + # enrichment[resolution]=true. + # + # @return [ContextDev::Models::WebWebScrapeImagesParams::Enrichment, nil] + optional :enrichment, -> { ContextDev::WebWebScrapeImagesParams::Enrichment } + + # @!attribute max_age_ms + # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 + # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days). + # + # @return [Integer, nil] + optional :max_age_ms, Integer + + # @!method initialize(url:, enrichment: nil, max_age_ms: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebWebScrapeImagesParams} for more details. + # + # @param url [String] Page URL to inspect. Must include http:// or https://. + # + # @param enrichment [ContextDev::Models::WebWebScrapeImagesParams::Enrichment] Optional per-image processing, sent as deep-object query params such as enrichme + # + # @param max_age_ms [Integer] Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 # # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}] + + class Enrichment < ContextDev::Internal::Type::BaseModel + # @!attribute classification + # Classify each image by visual asset type. + # + # @return [Boolean, nil] + optional :classification, ContextDev::Internal::Type::Boolean + + # @!attribute hosted_url + # Host materializable images on the Brand.dev CDN and return their URL and MIME + # type. + # + # @return [Boolean, nil] + optional :hosted_url, ContextDev::Internal::Type::Boolean, api_name: :hostedUrl + + # @!attribute max_time_per_ms + # Per-image enrichment timeout in milliseconds. Default: 6000. Maximum: 60000. + # + # @return [Integer, nil] + optional :max_time_per_ms, Integer, api_name: :maxTimePerMs + + # @!attribute resolution + # Measure image width and height when possible. + # + # @return [Boolean, nil] + optional :resolution, ContextDev::Internal::Type::Boolean + + # @!method initialize(classification: nil, hosted_url: nil, max_time_per_ms: nil, resolution: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebWebScrapeImagesParams::Enrichment} for more details. + # + # Optional per-image processing, sent as deep-object query params such as + # enrichment[resolution]=true. + # + # @param classification [Boolean] Classify each image by visual asset type. + # + # @param hosted_url [Boolean] Host materializable images on the Brand.dev CDN and return their URL and MIME ty + # + # @param max_time_per_ms [Integer] Per-image enrichment timeout in milliseconds. Default: 6000. Maximum: 60000. + # + # @param resolution [Boolean] Measure image width and height when possible. + end end end end diff --git a/lib/context_dev/models/web_web_scrape_images_response.rb b/lib/context_dev/models/web_web_scrape_images_response.rb index 7128ac1f..a732019c 100644 --- a/lib/context_dev/models/web_web_scrape_images_response.rb +++ b/lib/context_dev/models/web_web_scrape_images_response.rb @@ -5,66 +5,74 @@ module Models # @see ContextDev::Resources::Web#web_scrape_images class WebWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel # @!attribute images - # Array of scraped images + # Images found on the page. # # @return [Array] required :images, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebScrapeImagesResponse::Image] } # @!attribute success - # Indicates success + # Always true on success. # # @return [Boolean, ContextDev::Models::WebWebScrapeImagesResponse::Success] required :success, enum: -> { ContextDev::Models::WebWebScrapeImagesResponse::Success } # @!attribute url - # The URL that was scraped + # Page URL that was scraped. # # @return [String] required :url, String # @!method initialize(images:, success:, url:) - # @param images [Array] Array of scraped images + # @param images [Array] Images found on the page. # - # @param success [Boolean, ContextDev::Models::WebWebScrapeImagesResponse::Success] Indicates success + # @param success [Boolean, ContextDev::Models::WebWebScrapeImagesResponse::Success] Always true on success. # - # @param url [String] The URL that was scraped + # @param url [String] Page URL that was scraped. class Image < ContextDev::Internal::Type::BaseModel # @!attribute alt - # Alt text of the image, or null if not present + # Image alt text, or null when unavailable. # # @return [String, nil] required :alt, String, nil?: true # @!attribute element - # The HTML element the image was found in + # Where the image was found. # # @return [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Element] required :element, enum: -> { ContextDev::Models::WebWebScrapeImagesResponse::Image::Element } # @!attribute src - # The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI + # Original image value: URL, inline SVG or HTML, or base64 data URI. # # @return [String] required :src, String # @!attribute type - # The type/format of the src value + # Format of src. # # @return [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Type] required :type, enum: -> { ContextDev::Models::WebWebScrapeImagesResponse::Image::Type } - # @!method initialize(alt:, element:, src:, type:) - # @param alt [String, nil] Alt text of the image, or null if not present + # @!attribute enrichment + # Requested metadata for images that could be processed. # - # @param element [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Element] The HTML element the image was found in + # @return [ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment, nil] + optional :enrichment, -> { ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment } + + # @!method initialize(alt:, element:, src:, type:, enrichment: nil) + # @param alt [String, nil] Image alt text, or null when unavailable. + # + # @param element [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Element] Where the image was found. + # + # @param src [String] Original image value: URL, inline SVG or HTML, or base64 data URI. # - # @param src [String] The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI + # @param type [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Type] Format of src. # - # @param type [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Type] The type/format of the src value + # @param enrichment [ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment] Requested metadata for images that could be processed. - # The HTML element the image was found in + # Where the image was found. # # @see ContextDev::Models::WebWebScrapeImagesResponse::Image#element module Element @@ -84,7 +92,7 @@ module Element # @return [Array] end - # The type/format of the src value + # Format of src. # # @see ContextDev::Models::WebWebScrapeImagesResponse::Image#type module Type @@ -97,9 +105,74 @@ module Type # @!method self.values # @return [Array] end + + # @see ContextDev::Models::WebWebScrapeImagesResponse::Image#enrichment + class Enrichment < ContextDev::Internal::Type::BaseModel + # @!attribute height + # Image height in pixels, when measured. + # + # @return [Integer, nil] + optional :height, Integer + + # @!attribute mimetype + # Detected MIME type, when hosted. + # + # @return [String, nil] + optional :mimetype, String + + # @!attribute type + # Visual asset category, when classified. + # + # @return [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type, nil] + optional :type, enum: -> { ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type } + + # @!attribute url + # Brand.dev CDN URL, when hosted. + # + # @return [String, nil] + optional :url, String + + # @!attribute width + # Image width in pixels, when measured. + # + # @return [Integer, nil] + optional :width, Integer + + # @!method initialize(height: nil, mimetype: nil, type: nil, url: nil, width: nil) + # Requested metadata for images that could be processed. + # + # @param height [Integer] Image height in pixels, when measured. + # + # @param mimetype [String] Detected MIME type, when hosted. + # + # @param type [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type] Visual asset category, when classified. + # + # @param url [String] Brand.dev CDN URL, when hosted. + # + # @param width [Integer] Image width in pixels, when measured. + + # Visual asset category, when classified. + # + # @see ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment#type + module Type + extend ContextDev::Internal::Type::Enum + + PHOTOGRAPHY = :photography + ILLUSTRATION = :illustration + LOGO = :logo + WORDMARK = :wordmark + ICON = :icon + PATTERN = :pattern + GRAPHIC = :graphic + OTHER = :other + + # @!method self.values + # @return [Array] + end + end end - # Indicates success + # Always true on success. # # @see ContextDev::Models::WebWebScrapeImagesResponse#success module Success diff --git a/lib/context_dev/resources/web.rb b/lib/context_dev/resources/web.rb index c831ef6a..456810bd 100644 --- a/lib/context_dev/resources/web.rb +++ b/lib/context_dev/resources/web.rb @@ -183,13 +183,21 @@ def web_scrape_html(params) ) end - # Scrapes all images from the given URL. Extracts images from img, svg, - # picture/source, link, and video elements including inline SVGs, base64 data - # URIs, and standard URLs. + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebWebScrapeImagesParams} for more details. + # + # Extract image assets from a web page, including standard URLs, inline SVGs, data + # URIs, responsive image sources, metadata, CSS backgrounds, video posters, and + # embeds. The base request costs 1 credit; enrichment costs 1 credit per returned + # image. + # + # @overload web_scrape_images(url:, enrichment: nil, max_age_ms: nil, request_options: {}) + # + # @param url [String] Page URL to inspect. Must include http:// or https://. # - # @overload web_scrape_images(url:, request_options: {}) + # @param enrichment [ContextDev::Models::WebWebScrapeImagesParams::Enrichment] Optional per-image processing, sent as deep-object query params such as enrichme # - # @param url [String] Full URL to scrape images from (must include http:// or https:// protocol) + # @param max_age_ms [Integer] Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 # # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -202,7 +210,7 @@ def web_scrape_images(params) @client.request( method: :get, path: "web/scrape/images", - query: query, + query: query.transform_keys(max_age_ms: "maxAgeMs"), model: ContextDev::Models::WebWebScrapeImagesResponse, options: options ) diff --git a/rbi/context_dev/models/web_web_scrape_images_params.rbi b/rbi/context_dev/models/web_web_scrape_images_params.rbi index ec03311c..2fafcb03 100644 --- a/rbi/context_dev/models/web_web_scrape_images_params.rbi +++ b/rbi/context_dev/models/web_web_scrape_images_params.rbi @@ -14,30 +14,140 @@ module ContextDev ) end - # Full URL to scrape images from (must include http:// or https:// protocol) + # Page URL to inspect. Must include http:// or https://. sig { returns(String) } attr_accessor :url + # Optional per-image processing, sent as deep-object query params such as + # enrichment[resolution]=true. + sig do + returns(T.nilable(ContextDev::WebWebScrapeImagesParams::Enrichment)) + end + attr_reader :enrichment + + sig do + params( + enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment::OrHash + ).void + end + attr_writer :enrichment + + # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 + # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days). + sig { returns(T.nilable(Integer)) } + attr_reader :max_age_ms + + sig { params(max_age_ms: Integer).void } + attr_writer :max_age_ms + sig do params( url: String, + enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment::OrHash, + max_age_ms: Integer, request_options: ContextDev::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( - # Full URL to scrape images from (must include http:// or https:// protocol) + # Page URL to inspect. Must include http:// or https://. url:, + # Optional per-image processing, sent as deep-object query params such as + # enrichment[resolution]=true. + enrichment: nil, + # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 + # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days). + max_age_ms: nil, request_options: {} ) end sig do override.returns( - { url: String, request_options: ContextDev::RequestOptions } + { + url: String, + enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment, + max_age_ms: Integer, + request_options: ContextDev::RequestOptions + } ) end def to_hash end + + class Enrichment < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::WebWebScrapeImagesParams::Enrichment, + ContextDev::Internal::AnyHash + ) + end + + # Classify each image by visual asset type. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :classification + + sig { params(classification: T::Boolean).void } + attr_writer :classification + + # Host materializable images on the Brand.dev CDN and return their URL and MIME + # type. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :hosted_url + + sig { params(hosted_url: T::Boolean).void } + attr_writer :hosted_url + + # Per-image enrichment timeout in milliseconds. Default: 6000. Maximum: 60000. + sig { returns(T.nilable(Integer)) } + attr_reader :max_time_per_ms + + sig { params(max_time_per_ms: Integer).void } + attr_writer :max_time_per_ms + + # Measure image width and height when possible. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :resolution + + sig { params(resolution: T::Boolean).void } + attr_writer :resolution + + # Optional per-image processing, sent as deep-object query params such as + # enrichment[resolution]=true. + sig do + params( + classification: T::Boolean, + hosted_url: T::Boolean, + max_time_per_ms: Integer, + resolution: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Classify each image by visual asset type. + classification: nil, + # Host materializable images on the Brand.dev CDN and return their URL and MIME + # type. + hosted_url: nil, + # Per-image enrichment timeout in milliseconds. Default: 6000. Maximum: 60000. + max_time_per_ms: nil, + # Measure image width and height when possible. + resolution: nil + ) + end + + sig do + override.returns( + { + classification: T::Boolean, + hosted_url: T::Boolean, + max_time_per_ms: Integer, + resolution: T::Boolean + } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/web_web_scrape_images_response.rbi b/rbi/context_dev/models/web_web_scrape_images_response.rbi index 59d49ed9..9a427ca6 100644 --- a/rbi/context_dev/models/web_web_scrape_images_response.rbi +++ b/rbi/context_dev/models/web_web_scrape_images_response.rbi @@ -11,13 +11,13 @@ module ContextDev ) end - # Array of scraped images + # Images found on the page. sig do returns(T::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image]) end attr_accessor :images - # Indicates success + # Always true on success. sig do returns( ContextDev::Models::WebWebScrapeImagesResponse::Success::TaggedBoolean @@ -25,7 +25,7 @@ module ContextDev end attr_accessor :success - # The URL that was scraped + # Page URL that was scraped. sig { returns(String) } attr_accessor :url @@ -41,11 +41,11 @@ module ContextDev ).returns(T.attached_class) end def self.new( - # Array of scraped images + # Images found on the page. images:, - # Indicates success + # Always true on success. success:, - # The URL that was scraped + # Page URL that was scraped. url: ) end @@ -73,11 +73,11 @@ module ContextDev ) end - # Alt text of the image, or null if not present + # Image alt text, or null when unavailable. sig { returns(T.nilable(String)) } attr_accessor :alt - # The HTML element the image was found in + # Where the image was found. sig do returns( ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol @@ -85,11 +85,11 @@ module ContextDev end attr_accessor :element - # The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI + # Original image value: URL, inline SVG or HTML, or base64 data URI. sig { returns(String) } attr_accessor :src - # The type/format of the src value + # Format of src. sig do returns( ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol @@ -97,6 +97,24 @@ module ContextDev end attr_accessor :type + # Requested metadata for images that could be processed. + sig do + returns( + T.nilable( + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment + ) + ) + end + attr_reader :enrichment + + sig do + params( + enrichment: + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::OrHash + ).void + end + attr_writer :enrichment + sig do params( alt: T.nilable(String), @@ -104,18 +122,22 @@ module ContextDev ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::OrSymbol, src: String, type: - ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::OrSymbol + ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::OrSymbol, + enrichment: + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::OrHash ).returns(T.attached_class) end def self.new( - # Alt text of the image, or null if not present + # Image alt text, or null when unavailable. alt:, - # The HTML element the image was found in + # Where the image was found. element:, - # The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI + # Original image value: URL, inline SVG or HTML, or base64 data URI. src:, - # The type/format of the src value - type: + # Format of src. + type:, + # Requested metadata for images that could be processed. + enrichment: nil ) end @@ -127,14 +149,16 @@ module ContextDev ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol, src: String, type: - ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol + ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol, + enrichment: + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment } ) end def to_hash end - # The HTML element the image was found in + # Where the image was found. module Element extend ContextDev::Internal::Type::Enum @@ -204,7 +228,7 @@ module ContextDev end end - # The type/format of the src value + # Format of src. module Type extend ContextDev::Internal::Type::Enum @@ -243,9 +267,170 @@ module ContextDev def self.values end end + + class Enrichment < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment, + ContextDev::Internal::AnyHash + ) + end + + # Image height in pixels, when measured. + sig { returns(T.nilable(Integer)) } + attr_reader :height + + sig { params(height: Integer).void } + attr_writer :height + + # Detected MIME type, when hosted. + sig { returns(T.nilable(String)) } + attr_reader :mimetype + + sig { params(mimetype: String).void } + attr_writer :mimetype + + # Visual asset category, when classified. + sig do + returns( + T.nilable( + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + ) + end + attr_reader :type + + sig do + params( + type: + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::OrSymbol + ).void + end + attr_writer :type + + # Brand.dev CDN URL, when hosted. + sig { returns(T.nilable(String)) } + attr_reader :url + + sig { params(url: String).void } + attr_writer :url + + # Image width in pixels, when measured. + sig { returns(T.nilable(Integer)) } + attr_reader :width + + sig { params(width: Integer).void } + attr_writer :width + + # Requested metadata for images that could be processed. + sig do + params( + height: Integer, + mimetype: String, + type: + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::OrSymbol, + url: String, + width: Integer + ).returns(T.attached_class) + end + def self.new( + # Image height in pixels, when measured. + height: nil, + # Detected MIME type, when hosted. + mimetype: nil, + # Visual asset category, when classified. + type: nil, + # Brand.dev CDN URL, when hosted. + url: nil, + # Image width in pixels, when measured. + width: nil + ) + end + + sig do + override.returns( + { + height: Integer, + mimetype: String, + type: + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol, + url: String, + width: Integer + } + ) + end + def to_hash + end + + # Visual asset category, when classified. + module Type + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + PHOTOGRAPHY = + T.let( + :photography, + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + ILLUSTRATION = + T.let( + :illustration, + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + LOGO = + T.let( + :logo, + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + WORDMARK = + T.let( + :wordmark, + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + ICON = + T.let( + :icon, + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + PATTERN = + T.let( + :pattern, + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + GRAPHIC = + T.let( + :graphic, + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + OTHER = + T.let( + :other, + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end end - # Indicates success + # Always true on success. module Success extend ContextDev::Internal::Type::Enum diff --git a/rbi/context_dev/resources/web.rbi b/rbi/context_dev/resources/web.rbi index 2c820190..d9703072 100644 --- a/rbi/context_dev/resources/web.rbi +++ b/rbi/context_dev/resources/web.rbi @@ -180,18 +180,27 @@ module ContextDev ) end - # Scrapes all images from the given URL. Extracts images from img, svg, - # picture/source, link, and video elements including inline SVGs, base64 data - # URIs, and standard URLs. + # Extract image assets from a web page, including standard URLs, inline SVGs, data + # URIs, responsive image sources, metadata, CSS backgrounds, video posters, and + # embeds. The base request costs 1 credit; enrichment costs 1 credit per returned + # image. sig do params( url: String, + enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment::OrHash, + max_age_ms: Integer, request_options: ContextDev::RequestOptions::OrHash ).returns(ContextDev::Models::WebWebScrapeImagesResponse) end def web_scrape_images( - # Full URL to scrape images from (must include http:// or https:// protocol) + # Page URL to inspect. Must include http:// or https://. url:, + # Optional per-image processing, sent as deep-object query params such as + # enrichment[resolution]=true. + enrichment: nil, + # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 + # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days). + max_age_ms: nil, request_options: {} ) end diff --git a/sig/context_dev/models/web_web_scrape_images_params.rbs b/sig/context_dev/models/web_web_scrape_images_params.rbs index 1c62b6f5..9fea33f5 100644 --- a/sig/context_dev/models/web_web_scrape_images_params.rbs +++ b/sig/context_dev/models/web_web_scrape_images_params.rbs @@ -1,7 +1,12 @@ module ContextDev module Models type web_web_scrape_images_params = - { url: String } & ContextDev::Internal::Type::request_parameters + { + url: String, + enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment, + max_age_ms: Integer + } + & ContextDev::Internal::Type::request_parameters class WebWebScrapeImagesParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter @@ -9,15 +14,69 @@ module ContextDev attr_accessor url: String + attr_reader enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment? + + def enrichment=: ( + ContextDev::WebWebScrapeImagesParams::Enrichment + ) -> ContextDev::WebWebScrapeImagesParams::Enrichment + + attr_reader max_age_ms: Integer? + + def max_age_ms=: (Integer) -> Integer + def initialize: ( url: String, + ?enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment, + ?max_age_ms: Integer, ?request_options: ContextDev::request_opts ) -> void def to_hash: -> { url: String, + enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment, + max_age_ms: Integer, request_options: ContextDev::RequestOptions } + + type enrichment = + { + classification: bool, + hosted_url: bool, + max_time_per_ms: Integer, + resolution: bool + } + + class Enrichment < ContextDev::Internal::Type::BaseModel + attr_reader classification: bool? + + def classification=: (bool) -> bool + + attr_reader hosted_url: bool? + + def hosted_url=: (bool) -> bool + + attr_reader max_time_per_ms: Integer? + + def max_time_per_ms=: (Integer) -> Integer + + attr_reader resolution: bool? + + def resolution=: (bool) -> bool + + def initialize: ( + ?classification: bool, + ?hosted_url: bool, + ?max_time_per_ms: Integer, + ?resolution: bool + ) -> void + + def to_hash: -> { + classification: bool, + hosted_url: bool, + max_time_per_ms: Integer, + resolution: bool + } + end end end end diff --git a/sig/context_dev/models/web_web_scrape_images_response.rbs b/sig/context_dev/models/web_web_scrape_images_response.rbs index 87f64044..d75c586d 100644 --- a/sig/context_dev/models/web_web_scrape_images_response.rbs +++ b/sig/context_dev/models/web_web_scrape_images_response.rbs @@ -31,7 +31,8 @@ module ContextDev alt: String?, element: ContextDev::Models::WebWebScrapeImagesResponse::Image::element, src: String, - type: ContextDev::Models::WebWebScrapeImagesResponse::Image::type_ + type: ContextDev::Models::WebWebScrapeImagesResponse::Image::type_, + enrichment: ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment } class Image < ContextDev::Internal::Type::BaseModel @@ -43,18 +44,26 @@ module ContextDev attr_accessor type: ContextDev::Models::WebWebScrapeImagesResponse::Image::type_ + attr_reader enrichment: ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment? + + def enrichment=: ( + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment + ) -> ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment + def initialize: ( alt: String?, element: ContextDev::Models::WebWebScrapeImagesResponse::Image::element, src: String, - type: ContextDev::Models::WebWebScrapeImagesResponse::Image::type_ + type: ContextDev::Models::WebWebScrapeImagesResponse::Image::type_, + ?enrichment: ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment ) -> void def to_hash: -> { alt: String?, element: ContextDev::Models::WebWebScrapeImagesResponse::Image::element, src: String, - type: ContextDev::Models::WebWebScrapeImagesResponse::Image::type_ + type: ContextDev::Models::WebWebScrapeImagesResponse::Image::type_, + enrichment: ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment } type element = @@ -95,6 +104,80 @@ module ContextDev def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image::type_] end + + type enrichment = + { + height: Integer, + mimetype: String, + type: ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::type_, + url: String, + width: Integer + } + + class Enrichment < ContextDev::Internal::Type::BaseModel + attr_reader height: Integer? + + def height=: (Integer) -> Integer + + attr_reader mimetype: String? + + def mimetype=: (String) -> String + + attr_reader type: ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::type_? + + def type=: ( + ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::type_ + ) -> ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::type_ + + attr_reader url: String? + + def url=: (String) -> String + + attr_reader width: Integer? + + def width=: (Integer) -> Integer + + def initialize: ( + ?height: Integer, + ?mimetype: String, + ?type: ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::type_, + ?url: String, + ?width: Integer + ) -> void + + def to_hash: -> { + height: Integer, + mimetype: String, + type: ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::type_, + url: String, + width: Integer + } + + type type_ = + :photography + | :illustration + | :logo + | :wordmark + | :icon + | :pattern + | :graphic + | :other + + module Type + extend ContextDev::Internal::Type::Enum + + PHOTOGRAPHY: :photography + ILLUSTRATION: :illustration + LOGO: :logo + WORDMARK: :wordmark + ICON: :icon + PATTERN: :pattern + GRAPHIC: :graphic + OTHER: :other + + def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::type_] + end + end end type success = true diff --git a/sig/context_dev/resources/web.rbs b/sig/context_dev/resources/web.rbs index 1ddfca77..e4660a5e 100644 --- a/sig/context_dev/resources/web.rbs +++ b/sig/context_dev/resources/web.rbs @@ -50,6 +50,8 @@ module ContextDev def web_scrape_images: ( url: String, + ?enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment, + ?max_age_ms: Integer, ?request_options: ContextDev::request_opts ) -> ContextDev::Models::WebWebScrapeImagesResponse From e421b35bbe960036ade1c4834f8a4641ee0d21d8 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 6 May 2026 22:16:16 +0000 Subject: [PATCH 2/2] release: 1.14.0 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 8 ++++++++ Gemfile.lock | 2 +- README.md | 2 +- lib/context_dev/version.rb | 2 +- 5 files changed, 12 insertions(+), 4 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index f94eeca2..e72f1131 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "1.13.0" + ".": "1.14.0" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 099f6c3a..b32e385e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 1.14.0 (2026-05-06) + +Full Changelog: [v1.13.0...v1.14.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v1.13.0...v1.14.0) + +### Features + +* **api:** api update ([58cb73a](https://github.com/context-dot-dev/context-ruby-sdk/commit/58cb73a109e20f296f6a5f256a94d690b1203f70)) + ## 1.13.0 (2026-05-05) Full Changelog: [v1.12.0...v1.13.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v1.12.0...v1.13.0) diff --git a/Gemfile.lock b/Gemfile.lock index 3892857d..5e9cfd89 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - context.dev (1.13.0) + context.dev (1.14.0) cgi connection_pool diff --git a/README.md b/README.md index f474a228..449fc0db 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "context.dev", "~> 1.13.0" +gem "context.dev", "~> 1.14.0" ``` diff --git a/lib/context_dev/version.rb b/lib/context_dev/version.rb index 91674168..104c6ddb 100644 --- a/lib/context_dev/version.rb +++ b/lib/context_dev/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module ContextDev - VERSION = "1.13.0" + VERSION = "1.14.0" end