lib/anthropic/models/citation_page_location.rb


# frozen_string_literal: true

module Anthropic
  module Models
    class CitationPageLocation < Anthropic::Internal::Type::BaseModel
      # @!attribute cited_text
      #
      #   @return [String]
      required :cited_text, String

      # @!attribute document_index
      #
      #   @return [Integer]
      required :document_index, Integer

      # @!attribute document_title
      #
      #   @return [String, nil]
      required :document_title, String, nil?: true

      # @!attribute end_page_number
      #
      #   @return [Integer]
      required :end_page_number, Integer

      # @!attribute file_id
      #
      #   @return [String, nil]
      required :file_id, String, nil?: true

      # @!attribute start_page_number
      #
      #   @return [Integer]
      required :start_page_number, Integer

      # @!attribute type
      #
      #   @return [Symbol, :page_location]
      required :type, const: :page_location

      # @!method initialize(cited_text:, document_index:, document_title:, end_page_number:, file_id:, start_page_number:, type: :page_location)
      #   @param cited_text [String]
      #   @param document_index [Integer]
      #   @param document_title [String, nil]
      #   @param end_page_number [Integer]
      #   @param file_id [String, nil]
      #   @param start_page_number [Integer]
      #   @param type [Symbol, :page_location]
    end
  end
end