Class: OpenAI::Internal::Page

Inherits:
Object
  • Object
show all
Includes:
Type::BasePage
Defined in:
lib/openai/internal/page.rb

Overview

Examples:

if page.has_next?
  page = page.next_page
end
page.auto_paging_each do |model|
  puts(model)
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Type::BasePage

#to_enum

Constructor Details

#initialize(client:, req:, headers:, page_data:) ⇒ Page

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Page.

Parameters:



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/openai/internal/page.rb', line 59

def initialize(client:, req:, headers:, page_data:)
  super

  case page_data
  in {data: Array => data}
    @data = data.map { OpenAI::Internal::Type::Converter.coerce(@model, _1) }
  else
  end
  @object = page_data[:object]
end

Instance Attribute Details

#data ⇒ Array<generic<Elem>>?

Returns:

  • (Array<generic<Elem>>, nil) 


20
21
22
 
# File 'lib/openai/internal/page.rb', line 20

def data
  @data
end

#object ⇒ String

Returns:

  • (String) 


23
24
25
 
# File 'lib/openai/internal/page.rb', line 23

def object
  @object
end

Instance Method Details

#auto_paging_each(&blk) {|| ... } ⇒ Object

Parameters:

  • blk (Proc)

Yield Parameters:

  • (generic<Elem>) 


39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/openai/internal/page.rb', line 39

def auto_paging_each(&blk)
  unless block_given?
    raise ArgumentError.new("A block must be given to ##{__method__}")
  end

  page = self
  loop do
    page.data&.each(&blk)

    break unless page.next_page?
    page = page.next_page
  end
end

#inspect ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (String) 


73
74
75
76
77
 
# File 'lib/openai/internal/page.rb', line 73

def inspect
  model = OpenAI::Internal::Type::Converter.inspect(@model, depth: 1)

  "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)} object=#{object.inspect}>"
end

#next_page ⇒ self

Returns:

  • (self)

Raises:

  • (OpenAI::HTTP::Error) 


32
33
34
 
# File 'lib/openai/internal/page.rb', line 32

def next_page
  RuntimeError.new("No more pages available.")
end

#next_page? ⇒ Boolean

Returns:



26
27
28
 
# File 'lib/openai/internal/page.rb', line 26

def next_page?
  false
end