Module: OpenAI::Internal::Type::BasePage Private

Included in:

CursorPage, Page

Defined in:

lib/openai/internal/type/base_page.rb

Overview

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

This module provides a base implementation for paginated responses in the SDK.

Instance Method Summary

• #auto_paging_each(&blk) {|| ... } ⇒ void
• #initialize(client:, req:, headers:, page_data:) ⇒ Object private
• #next_page ⇒ self
• #next_page? ⇒ Boolean
• #to_enum ⇒ Enumerable<generic<Elem>> (also: #enum_for) private

Instance Method Details

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

This method returns an undefined value.

Parameters:

• blk (Proc)

Yield Parameters:

• (generic<Elem>)

# File 'lib/openai/internal/type/base_page.rb', line 31

def auto_paging_each(&blk) = (raise NotImplementedError)

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

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.

Parameters:

• client (OpenAI::Internal::Transport::BaseClient)
• req (Hash{Symbol=>Object})
• headers (Hash{String=>String}, Net::HTTPHeader)
• page_data (Object)

# File 'lib/openai/internal/type/base_page.rb', line 44

def initialize(client:, req:, headers:, page_data:)
  @client = client
  @req = req
  @model = req.fetch(:model)
  super()
end

#next_page ⇒ self

Returns:

• (self)

Raises:

• (OpenAI::Errors::APIError)

# File 'lib/openai/internal/type/base_page.rb', line 23

def next_page = (raise NotImplementedError)

#next_page? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/openai/internal/type/base_page.rb', line 17

def next_page? = (raise NotImplementedError)

#to_enum ⇒ Enumerable<generic<Elem>> Also known as: enum_for

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:

• (Enumerable<generic<Elem>>)

# File 'lib/openai/internal/type/base_page.rb', line 34

def to_enum = super(:auto_paging_each)