Skip to content

chore: switch to prettier looking sorbet annotations #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 21, 2025
Merged

chore: switch to prettier looking sorbet annotations #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions rbi/lib/openai/base_client.rbi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,13 +83,9 @@ module OpenAI
end
end

# @api private
sig { returns(T.anything) }
def requester
end

sig { params(_: T.anything).returns(T.anything) }
def requester=(_)
end
attr_accessor :requester

# @api private
sig do
Expand Down
51 changes: 17 additions & 34 deletions rbi/lib/openai/client.rbi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,72 +11,55 @@ module OpenAI
DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)

sig { returns(String) }
def api_key
end
attr_reader :api_key

sig { returns(T.nilable(String)) }
def organization
end
attr_reader :organization

sig { returns(T.nilable(String)) }
def project
end
attr_reader :project

sig { returns(OpenAI::Resources::Completions) }
def completions
end
attr_reader :completions

sig { returns(OpenAI::Resources::Chat) }
def chat
end
attr_reader :chat

sig { returns(OpenAI::Resources::Embeddings) }
def embeddings
end
attr_reader :embeddings

sig { returns(OpenAI::Resources::Files) }
def files
end
attr_reader :files

sig { returns(OpenAI::Resources::Images) }
def images
end
attr_reader :images

sig { returns(OpenAI::Resources::Audio) }
def audio
end
attr_reader :audio

sig { returns(OpenAI::Resources::Moderations) }
def moderations
end
attr_reader :moderations

sig { returns(OpenAI::Resources::Models) }
def models
end
attr_reader :models

sig { returns(OpenAI::Resources::FineTuning) }
def fine_tuning
end
attr_reader :fine_tuning

sig { returns(OpenAI::Resources::VectorStores) }
def vector_stores
end
attr_reader :vector_stores

sig { returns(OpenAI::Resources::Beta) }
def beta
end
attr_reader :beta

sig { returns(OpenAI::Resources::Batches) }
def batches
end
attr_reader :batches

sig { returns(OpenAI::Resources::Uploads) }
def uploads
end
attr_reader :uploads

sig { returns(OpenAI::Resources::Responses) }
def responses
end
attr_reader :responses

# @api private
sig { override.returns(T::Hash[String, String]) }
Expand Down
14 changes: 2 additions & 12 deletions rbi/lib/openai/cursor_page.rbi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,10 @@ module OpenAI
Elem = type_member

sig { returns(T.nilable(T::Array[Elem])) }
def data
end

sig { params(_: T.nilable(T::Array[Elem])).returns(T.nilable(T::Array[Elem])) }
def data=(_)
end
attr_accessor :data

sig { returns(T::Boolean) }
def has_more
end

sig { params(_: T::Boolean).returns(T::Boolean) }
def has_more=(_)
end
attr_accessor :has_more

sig { returns(String) }
def inspect
Expand Down
112 changes: 16 additions & 96 deletions rbi/lib/openai/errors.rbi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,65 +3,30 @@
module OpenAI
class Error < StandardError
sig { returns(T.nilable(StandardError)) }
def cause
end

sig { params(_: T.nilable(StandardError)).returns(T.nilable(StandardError)) }
def cause=(_)
end
attr_accessor :cause
end

class ConversionError < OpenAI::Error
end

class APIError < OpenAI::Error
sig { returns(URI::Generic) }
def url
end

sig { params(_: URI::Generic).returns(URI::Generic) }
def url=(_)
end
attr_accessor :url

sig { returns(T.nilable(Integer)) }
def status
end

sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
def status=(_)
end
attr_accessor :status

sig { returns(T.nilable(T.anything)) }
def body
end

sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) }
def body=(_)
end
attr_accessor :body

sig { returns(T.nilable(String)) }
def code
end

sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
def code=(_)
end
attr_accessor :code

sig { returns(T.nilable(String)) }
def param
end

sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
def param=(_)
end
attr_accessor :param

sig { returns(T.nilable(String)) }
def type
end

sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
def type=(_)
end
attr_accessor :type

# @api private
sig do
Expand All @@ -81,44 +46,19 @@ module OpenAI

class APIConnectionError < OpenAI::APIError
sig { void }
def status
end

sig { params(_: NilClass).void }
def status=(_)
end
attr_accessor :status

sig { void }
def body
end

sig { params(_: NilClass).void }
def body=(_)
end
attr_accessor :body

sig { void }
def code
end

sig { params(_: NilClass).void }
def code=(_)
end
attr_accessor :code

sig { void }
def param
end

sig { params(_: NilClass).void }
def param=(_)
end
attr_accessor :param

sig { void }
def type
end

sig { params(_: NilClass).void }
def type=(_)
end
attr_accessor :type

# @api private
sig do
Expand Down Expand Up @@ -170,36 +110,16 @@ module OpenAI
end

sig { returns(Integer) }
def status
end

sig { params(_: Integer).returns(Integer) }
def status=(_)
end
attr_accessor :status

sig { returns(T.nilable(String)) }
def code
end

sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
def code=(_)
end
attr_accessor :code

sig { returns(T.nilable(String)) }
def param
end

sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
def param=(_)
end
attr_accessor :param

sig { returns(T.nilable(String)) }
def type
end

sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
def type=(_)
end
attr_accessor :type

# @api private
sig do
Expand Down
54 changes: 12 additions & 42 deletions rbi/lib/openai/models/audio/speech_create_params.rbi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,73 +9,43 @@ module OpenAI

# The text to generate audio for. The maximum length is 4096 characters.
sig { returns(String) }
def input
end

sig { params(_: String).returns(String) }
def input=(_)
end
attr_accessor :input

# One of the available [TTS models](https://platform.openai.com/docs/models#tts):
# `tts-1`, `tts-1-hd` or `gpt-4o-mini-tts`.
sig { returns(T.any(String, OpenAI::Models::Audio::SpeechModel::OrSymbol)) }
def model
end

sig do
params(_: T.any(String, OpenAI::Models::Audio::SpeechModel::OrSymbol))
.returns(T.any(String, OpenAI::Models::Audio::SpeechModel::OrSymbol))
end
def model=(_)
end
attr_accessor :model

# The voice to use when generating the audio. Supported voices are `alloy`, `ash`,
# `coral`, `echo`, `fable`, `onyx`, `nova`, `sage` and `shimmer`. Previews of the
# voices are available in the
# [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).
sig { returns(OpenAI::Models::Audio::SpeechCreateParams::Voice::OrSymbol) }
def voice
end

sig do
params(_: OpenAI::Models::Audio::SpeechCreateParams::Voice::OrSymbol)
.returns(OpenAI::Models::Audio::SpeechCreateParams::Voice::OrSymbol)
end
def voice=(_)
end
attr_accessor :voice

# Control the voice of your generated audio with additional instructions. Does not
# work with `tts-1` or `tts-1-hd`.
sig { returns(T.nilable(String)) }
def instructions
end
attr_reader :instructions

sig { params(_: String).returns(String) }
def instructions=(_)
end
sig { params(instructions: String).void }
attr_writer :instructions

# The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`,
# `wav`, and `pcm`.
sig { returns(T.nilable(OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat::OrSymbol)) }
def response_format
end
attr_reader :response_format

sig do
params(_: OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat::OrSymbol)
.returns(OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat::OrSymbol)
end
def response_format=(_)
end
sig { params(response_format: OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat::OrSymbol).void }
attr_writer :response_format

# The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
# the default.
sig { returns(T.nilable(Float)) }
def speed
end
attr_reader :speed

sig { params(_: Float).returns(Float) }
def speed=(_)
end
sig { params(speed: Float).void }
attr_writer :speed

sig do
params(
Expand Down
Loading