chore: explicitly mark apis public under Internal module

.yardopts

@@ -1,4 +1,5 @@
 --type-name-tag generic:Generic
+--default-return void
 --markup markdown
 --markup-provider redcarpet
 --exclude /rbi

lib/openai/client.rb

@@ -101,10 +101,10 @@ def initialize(
       organization: ENV["OPENAI_ORG_ID"],
       project: ENV["OPENAI_PROJECT_ID"],
       base_url: ENV["OPENAI_BASE_URL"],
-      max_retries: DEFAULT_MAX_RETRIES,
-      timeout: DEFAULT_TIMEOUT_IN_SECONDS,
-      initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
-      max_retry_delay: DEFAULT_MAX_RETRY_DELAY
+      max_retries: OpenAI::Client::DEFAULT_MAX_RETRIES,
+      timeout: OpenAI::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: OpenAI::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: OpenAI::Client::DEFAULT_MAX_RETRY_DELAY
     )
       base_url ||= "https://api.openai.com/v1"
 

lib/openai/internal.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module OpenAI
-  # @api private
   module Internal
     OMIT =
       Object.new.tap do

lib/openai/internal/type/array_of.rb

@@ -30,11 +30,15 @@ class ArrayOf
         #   @option spec [Boolean] :"nil?"
         def self.[](...) = new(...)
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
         def ===(other) = other.is_a?(Array) && other.all?(item_type)
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -44,6 +48,8 @@ def ==(other)
           # rubocop:enable Layout/LineLength
         end
 
+        # @api public
+        #
         # @return [Integer]
         def hash = [self.class, item_type].hash
 

lib/openai/internal/type/base_model.rb

@@ -159,22 +159,30 @@ def optional(name_sym, type_info, spec = {})
             @mode = nil
           end
 
+          # @api public
+          #
           # @param other [Object]
           #
           # @return [Boolean]
           def ==(other)
             other.is_a?(Class) && other <= OpenAI::Internal::Type::BaseModel && other.fields == fields
           end
 
+          # @api public
+          #
           # @return [Integer]
           def hash = fields.hash
         end
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
         def ==(other) = self.class == other.class && @data == other.to_h
 
+        # @api public
+        #
         # @return [Integer]
         def hash = [self.class, @data].hash
 
@@ -291,6 +299,8 @@ def dump(value, state:)
           end
         end
 
+        # @api public
+        #
         # Returns the raw value associated with the given key, if found. Otherwise, nil is
         # returned.
         #
@@ -309,6 +319,8 @@ def [](key)
           @data[key]
         end
 
+        # @api public
+        #
         # Returns a Hash of the data underlying this object. O(1)
         #
         # Keys are Symbols and values are the raw values from the response. The return
@@ -361,11 +373,15 @@ def walk(model)
           end
         end
 
+        # @api public
+        #
         # @param a [Object]
         #
         # @return [String]
         def to_json(*a) = OpenAI::Internal::Type::Converter.dump(self.class, self).to_json(*a)
 
+        # @api public
+        #
         # @param a [Object]
         #
         # @return [String]
@@ -407,7 +423,7 @@ def inspect(depth: 0)
           end
         end
 
-        # @api private
+        # @api public
         #
         # @return [String]
         def to_s = self.class.walk(@data).to_s

lib/openai/internal/type/base_page.rb

@@ -3,19 +3,27 @@
 module OpenAI
   module Internal
     module Type
+      # @api private
+      #
       # @generic Elem
       #
       # This module provides a base implementation for paginated responses in the SDK.
       module BasePage
         # rubocop:disable Lint/UnusedMethodArgument
 
+        # @api public
+        #
         # @return [Boolean]
         def next_page? = (raise NotImplementedError)
 
+        # @api public
+        #
         # @raise [OpenAI::Errors::APIError]
         # @return [OpenAI::Internal::Type::BasePage]
         def next_page = (raise NotImplementedError)
 
+        # @api public
+        #
         # @param blk [Proc]
         #
         # @yieldparam [generic<Elem>]

lib/openai/internal/type/base_stream.rb

@@ -3,6 +3,8 @@
 module OpenAI
   module Internal
     module Type
+      # @api private
+      #
       # @generic Elem
       #
       # This module provides a base implementation for streaming responses in the SDK.
@@ -26,6 +28,8 @@ class << self
           def defer_closing(stream) = ->(_id) { OpenAI::Internal::Util.close_fused!(stream) }
         end
 
+        # @api public
+        #
         # @return [void]
         def close = OpenAI::Internal::Util.close_fused!(@iterator)
 
@@ -34,6 +38,8 @@ def close = OpenAI::Internal::Util.close_fused!(@iterator)
         # @return [Enumerable<generic<Elem>>]
         private def iterator = (raise NotImplementedError)
 
+        # @api public
+        #
         # @param blk [Proc]
         #
         # @yieldparam [generic<Elem>]
@@ -45,6 +51,8 @@ def each(&blk)
           @iterator.each(&blk)
         end
 
+        # @api public
+        #
         # @return [Enumerator<generic<Elem>>]
         def to_enum = @iterator
 

lib/openai/internal/type/boolean.rb

@@ -13,11 +13,15 @@ class Boolean
 
         private_class_method :new
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
         def self.===(other) = other == true || other == false
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]

lib/openai/internal/type/enum.rb

@@ -48,11 +48,15 @@ module Enum
         # @return [Array<NilClass, Boolean, Integer, Float, Symbol>]
         def values = constants.map { const_get(_1) }
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
         def ===(other) = values.include?(other)
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -62,6 +66,8 @@ def ==(other)
           # rubocop:enable Style/CaseEquality
         end
 
+        # @api public
+        #
         # @return [Integer]
         def hash = values.to_set.hash
 

lib/openai/internal/type/hash_of.rb

@@ -30,6 +30,8 @@ class HashOf
         #   @option spec [Boolean] :"nil?"
         def self.[](...) = new(...)
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -50,6 +52,8 @@ def ===(other)
           end
         end
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -59,6 +63,8 @@ def ==(other)
           # rubocop:enable Layout/LineLength
         end
 
+        # @api public
+        #
         # @return [Integer]
         def hash = [self.class, item_type].hash
 

lib/openai/internal/type/io_like.rb

@@ -13,6 +13,8 @@ class IOLike
 
         private_class_method :new
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -25,6 +27,8 @@ def self.===(other)
           end
         end
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]

lib/openai/internal/type/union.rb

@@ -112,6 +112,8 @@ def variants = derefed_variants.map(&:last)
         # rubocop:disable Style/HashEachMethods
         # rubocop:disable Style/CaseEquality
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -121,13 +123,17 @@ def ===(other)
           end
         end
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
         def ==(other)
           OpenAI::Internal::Type::Union === other && other.derefed_variants == derefed_variants
         end
 
+        # @api public
+        #
         # @return [Integer]
         def hash = variants.hash
 

lib/openai/internal/type/unknown.rb

@@ -15,11 +15,15 @@ class Unknown
 
         private_class_method :new
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
         def self.===(other) = true
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]

lib/openai/models/chat/chat_completion_assistant_message_param.rb

@@ -27,6 +27,8 @@ class ChatCompletionAssistantMessageParam < OpenAI::Internal::Type::BaseModel
                  nil?: true
 
         # @!attribute function_call
+        #   @deprecated
+        #
         #   Deprecated and replaced by `tool_calls`. The name and arguments of a function
         #   that should be called, as generated by the model.
         #

lib/openai/models/chat/chat_completion_chunk.rb

@@ -141,6 +141,8 @@ class Delta < OpenAI::Internal::Type::BaseModel
             optional :content, String, nil?: true
 
             # @!attribute function_call
+            #   @deprecated
+            #
             #   Deprecated and replaced by `tool_calls`. The name and arguments of a function
             #   that should be called, as generated by the model.
             #

lib/openai/models/chat/chat_completion_message.rb

@@ -39,6 +39,8 @@ class ChatCompletionMessage < OpenAI::Internal::Type::BaseModel
         optional :audio, -> { OpenAI::Models::Chat::ChatCompletionAudio }, nil?: true
 
         # @!attribute function_call
+        #   @deprecated
+        #
         #   Deprecated and replaced by `tool_calls`. The name and arguments of a function
         #   that should be called, as generated by the model.
         #

lib/openai/models/chat/completion_create_params.rb

@@ -49,6 +49,8 @@ class CompletionCreateParams < OpenAI::Internal::Type::BaseModel
         optional :frequency_penalty, Float, nil?: true
 
         # @!attribute function_call
+        #   @deprecated
+        #
         #   Deprecated in favor of `tool_choice`.
         #
         #   Controls which (if any) function is called by the model.
@@ -68,6 +70,8 @@ class CompletionCreateParams < OpenAI::Internal::Type::BaseModel
         optional :function_call, union: -> { OpenAI::Models::Chat::CompletionCreateParams::FunctionCall }
 
         # @!attribute functions
+        #   @deprecated
+        #
         #   Deprecated in favor of `tools`.
         #
         #   A list of functions the model may generate JSON inputs for.
@@ -106,6 +110,8 @@ class CompletionCreateParams < OpenAI::Internal::Type::BaseModel
         optional :max_completion_tokens, Integer, nil?: true
 
         # @!attribute max_tokens
+        #   @deprecated
+        #
         #   The maximum number of [tokens](/tokenizer) that can be generated in the chat
         #   completion. This value can be used to control
         #   [costs](https://openai.com/api/pricing/) for text generated via API.

lib/openai/models/file_object.rb

@@ -43,6 +43,8 @@ class FileObject < OpenAI::Internal::Type::BaseModel
       required :purpose, enum: -> { OpenAI::Models::FileObject::Purpose }
 
       # @!attribute status
+      #   @deprecated
+      #
       #   Deprecated. The current status of the file, which can be either `uploaded`,
       #   `processed`, or `error`.
       #
@@ -56,6 +58,8 @@ class FileObject < OpenAI::Internal::Type::BaseModel
       optional :expires_at, Integer
 
       # @!attribute status_details
+      #   @deprecated
+      #
       #   Deprecated. For details on why a fine-tuning training file failed validation,
       #   see the `error` field on `fine_tuning.job`.
       #