context.dev 2.2.0 → 2.4.0

data/rbi/context_dev/models/parse_handle_params.rbi

@@ -0,0 +1,339 @@
+# 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 file extension hint. Case-insensitive; a leading dot is accepted (e.g.
+      # ".pdf").
+      sig do
+        returns(T.nilable(ContextDev::ParseHandleParams::Extension::OrSymbol))
+      end
+      attr_reader :extension
+
+      sig do
+        params(
+          extension: ContextDev::ParseHandleParams::Extension::OrSymbol
+        ).void
+      end
+      attr_writer :extension
+
+      # 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
+
+      # Gates all OCR. When true, PDFs get embedded-image OCR (recognized text inserted
+      # at each image's position in page reading order, preserving the text layer;
+      # pdf.start/pdf.end limit the page range), scanned PDFs with no text layer get
+      # full-document OCR, and raster images get their visible text transcribed. When
+      # false, no OCR runs: scanned PDFs may yield no content and images return only
+      # format/dimension metadata. Calls where OCR actually runs cost 5 credits instead
+      # of 1.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :ocr
+
+      sig { params(ocr: T::Boolean).void }
+      attr_writer :ocr
+
+      # PDF page-range controls. Use start/end to limit parsing (and OCR when ocr=true)
+      # to an inclusive 1-based page range.
+      sig { returns(T.nilable(ContextDev::ParseHandleParams::Pdf)) }
+      attr_reader :pdf
+
+      sig { params(pdf: ContextDev::ParseHandleParams::Pdf::OrHash).void }
+      attr_writer :pdf
+
+      # 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,
+          extension: ContextDev::ParseHandleParams::Extension::OrSymbol,
+          include_images: T::Boolean,
+          include_links: T::Boolean,
+          ocr: T::Boolean,
+          pdf: ContextDev::ParseHandleParams::Pdf::OrHash,
+          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 file extension hint. Case-insensitive; a leading dot is accepted (e.g.
+        # ".pdf").
+        extension: nil,
+        # Include image references in Markdown output
+        include_images: nil,
+        # Preserve hyperlinks in Markdown output
+        include_links: nil,
+        # Gates all OCR. When true, PDFs get embedded-image OCR (recognized text inserted
+        # at each image's position in page reading order, preserving the text layer;
+        # pdf.start/pdf.end limit the page range), scanned PDFs with no text layer get
+        # full-document OCR, and raster images get their visible text transcribed. When
+        # false, no OCR runs: scanned PDFs may yield no content and images return only
+        # format/dimension metadata. Calls where OCR actually runs cost 5 credits instead
+        # of 1.
+        ocr: nil,
+        # PDF page-range controls. Use start/end to limit parsing (and OCR when ocr=true)
+        # to an inclusive 1-based page range.
+        pdf: 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,
+            extension: ContextDev::ParseHandleParams::Extension::OrSymbol,
+            include_images: T::Boolean,
+            include_links: T::Boolean,
+            ocr: T::Boolean,
+            pdf: ContextDev::ParseHandleParams::Pdf,
+            shorten_base64_images: T::Boolean,
+            use_main_content_only: T::Boolean,
+            request_options: ContextDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Optional file extension hint. Case-insensitive; a leading dot is accepted (e.g.
+      # ".pdf").
+      module Extension
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ContextDev::ParseHandleParams::Extension)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TXT =
+          T.let(:txt, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        TEXT =
+          T.let(:text, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        MD = T.let(:md, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        MARKDOWN =
+          T.let(
+            :markdown,
+            ContextDev::ParseHandleParams::Extension::TaggedSymbol
+          )
+        HTML =
+          T.let(:html, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        HTM =
+          T.let(:htm, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        XHTML =
+          T.let(:xhtml, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        XML =
+          T.let(:xml, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        RSS =
+          T.let(:rss, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        ATOM =
+          T.let(:atom, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        CSV =
+          T.let(:csv, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        TSV =
+          T.let(:tsv, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        YAML =
+          T.let(:yaml, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        YML =
+          T.let(:yml, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        PY = T.let(:py, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        JAVA =
+          T.let(:java, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        JS = T.let(:js, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        JSX =
+          T.let(:jsx, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        MJS =
+          T.let(:mjs, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        CJS =
+          T.let(:cjs, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        JSON =
+          T.let(:json, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        JSONL =
+          T.let(:jsonl, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        NDJSON =
+          T.let(:ndjson, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        PHP =
+          T.let(:php, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        SH = T.let(:sh, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        BASH =
+          T.let(:bash, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        ZSH =
+          T.let(:zsh, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        FISH =
+          T.let(:fish, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        RB = T.let(:rb, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        TS = T.let(:ts, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        TSX =
+          T.let(:tsx, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        RTF =
+          T.let(:rtf, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        SRT =
+          T.let(:srt, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        CSS =
+          T.let(:css, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        SCSS =
+          T.let(:scss, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        LESS =
+          T.let(:less, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        STYL =
+          T.let(:styl, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        SASS =
+          T.let(:sass, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        SVG =
+          T.let(:svg, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        PDF =
+          T.let(:pdf, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        DOCX =
+          T.let(:docx, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        DOC =
+          T.let(:doc, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        XLSX =
+          T.let(:xlsx, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        XLSM =
+          T.let(:xlsm, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        XLSB =
+          T.let(:xlsb, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        XLTX =
+          T.let(:xltx, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        XLTM =
+          T.let(:xltm, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        XLS =
+          T.let(:xls, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        PPTX =
+          T.let(:pptx, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        PPTM =
+          T.let(:pptm, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        PPSX =
+          T.let(:ppsx, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        PPSM =
+          T.let(:ppsm, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        POTX =
+          T.let(:potx, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        POTM =
+          T.let(:potm, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        PPT =
+          T.let(:ppt, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        PPS =
+          T.let(:pps, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        POT =
+          T.let(:pot, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        JPG =
+          T.let(:jpg, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        JPEG =
+          T.let(:jpeg, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        JPE =
+          T.let(:jpe, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        PNG =
+          T.let(:png, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        GIF =
+          T.let(:gif, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        BMP =
+          T.let(:bmp, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        TIFF =
+          T.let(:tiff, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        TIF =
+          T.let(:tif, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        WEBP =
+          T.let(:webp, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        PPM =
+          T.let(:ppm, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        PBM =
+          T.let(:pbm, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        PGM =
+          T.let(:pgm, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+        PNM =
+          T.let(:pnm, ContextDev::ParseHandleParams::Extension::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::ParseHandleParams::Extension::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Pdf < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::ParseHandleParams::Pdf,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
+        # Must be greater than or equal to start when both are provided.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :end_
+
+        sig { params(end_: Integer).void }
+        attr_writer :end_
+
+        # First 1-based PDF page to parse. When omitted, parsing starts at the first page.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :start
+
+        sig { params(start: Integer).void }
+        attr_writer :start
+
+        # PDF page-range controls. Use start/end to limit parsing (and OCR when ocr=true)
+        # to an inclusive 1-based page range.
+        sig { params(end_: Integer, start: Integer).returns(T.attached_class) }
+        def self.new(
+          # Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
+          # Must be greater than or equal to start when both are provided.
+          end_: nil,
+          # First 1-based PDF page to parse. When omitted, parsing starts at the first page.
+          start: nil
+        )
+        end
+
+        sig { override.returns({ end_: Integer, start: Integer }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/parse_handle_response.rbi

@@ -0,0 +1,377 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class ParseHandleResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::ParseHandleResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # Input bytes converted to GitHub Flavored Markdown
+      sig { returns(String) }
+      attr_accessor :markdown
+
+      # Indicates success
+      sig do
+        returns(ContextDev::Models::ParseHandleResponse::Success::TaggedBoolean)
+      end
+      attr_accessor :success
+
+      # Detected content type used for parsing
+      sig do
+        returns(ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol)
+      end
+      attr_accessor :type
+
+      # Metadata about the API key used for the request. Included in every response
+      # whenever a valid API key is provided, even when the response status is not 200.
+      sig do
+        returns(T.nilable(ContextDev::Models::ParseHandleResponse::KeyMetadata))
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::ParseHandleResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
+      sig do
+        params(
+          markdown: String,
+          success: ContextDev::Models::ParseHandleResponse::Success::OrBoolean,
+          type: ContextDev::Models::ParseHandleResponse::Type::OrSymbol,
+          key_metadata:
+            ContextDev::Models::ParseHandleResponse::KeyMetadata::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Input bytes converted to GitHub Flavored Markdown
+        markdown:,
+        # Indicates success
+        success:,
+        # Detected content type used for parsing
+        type:,
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        key_metadata: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            markdown: String,
+            success:
+              ContextDev::Models::ParseHandleResponse::Success::TaggedBoolean,
+            type: ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol,
+            key_metadata: ContextDev::Models::ParseHandleResponse::KeyMetadata
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Indicates success
+      module Success
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedBoolean =
+          T.type_alias do
+            T.all(T::Boolean, ContextDev::Models::ParseHandleResponse::Success)
+          end
+        OrBoolean = T.type_alias { T::Boolean }
+
+        TRUE =
+          T.let(
+            true,
+            ContextDev::Models::ParseHandleResponse::Success::TaggedBoolean
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::ParseHandleResponse::Success::TaggedBoolean
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Detected content type used for parsing
+      module Type
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ContextDev::Models::ParseHandleResponse::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        HTML =
+          T.let(
+            :html,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        XML =
+          T.let(
+            :xml,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        JSON =
+          T.let(
+            :json,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        JSONL =
+          T.let(
+            :jsonl,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        TEXT =
+          T.let(
+            :text,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        CSV =
+          T.let(
+            :csv,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        TSV =
+          T.let(
+            :tsv,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        MARKDOWN =
+          T.let(
+            :markdown,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        YAML =
+          T.let(
+            :yaml,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        PYTHON =
+          T.let(
+            :python,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        JAVA =
+          T.let(
+            :java,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        JAVASCRIPT =
+          T.let(
+            :javascript,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        PHP =
+          T.let(
+            :php,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        SHELL =
+          T.let(
+            :shell,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        RUBY =
+          T.let(
+            :ruby,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        TYPESCRIPT =
+          T.let(
+            :typescript,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        RTF =
+          T.let(
+            :rtf,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        SRT =
+          T.let(
+            :srt,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        CSS =
+          T.let(
+            :css,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        SCSS =
+          T.let(
+            :scss,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        LESS =
+          T.let(
+            :less,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        STYLUS =
+          T.let(
+            :stylus,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        SASS =
+          T.let(
+            :sass,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        SVG =
+          T.let(
+            :svg,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        PDF =
+          T.let(
+            :pdf,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        DOCX =
+          T.let(
+            :docx,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        DOC =
+          T.let(
+            :doc,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        XLSX =
+          T.let(
+            :xlsx,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        XLS =
+          T.let(
+            :xls,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        PPTX =
+          T.let(
+            :pptx,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        PPT =
+          T.let(
+            :ppt,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        JPG =
+          T.let(
+            :jpg,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        PNG =
+          T.let(
+            :png,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        GIF =
+          T.let(
+            :gif,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        BMP =
+          T.let(
+            :bmp,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        TIFF =
+          T.let(
+            :tiff,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        WEBP =
+          T.let(
+            :webp,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        PPM =
+          T.let(
+            :ppm,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        PBM =
+          T.let(
+            :pbm,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        PGM =
+          T.let(
+            :pgm,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+        PNM =
+          T.let(
+            :pnm,
+            ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::ParseHandleResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The number of credits consumed by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # The number of credits remaining for your organization after this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The number of credits consumed by this request.
+          credits_consumed:,
+          # The number of credits remaining for your organization after this request.
+          credits_remaining:
+        )
+        end
+
+        sig do
+          override.returns(
+            { credits_consumed: Integer, credits_remaining: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end