Skip to content

Commit eb1ea1f

Browse files
stainless-app[bot]stainless-app[bot]
committed
chore: switch to prettier looking sorbet annotations (#59)
1 parent 001f047 commit eb1ea1f

File tree

274 files changed

+2972
-11549
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

274 files changed

+2972
-11549
lines changed

‎rbi/lib/openai/base_client.rbi‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,9 @@ module OpenAI
8383
end
8484
end
8585

86+
# @api private
8687
sig { returns(T.anything) }
87-
def requester
88-
end
89-
90-
sig { params(_: T.anything).returns(T.anything) }
91-
def requester=(_)
92-
end
88+
attr_accessor :requester
9389

9490
# @api private
9591
sig do

‎rbi/lib/openai/client.rbi‎

Lines changed: 17 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -11,72 +11,55 @@ module OpenAI
1111
DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
1212

1313
sig { returns(String) }
14-
def api_key
15-
end
14+
attr_reader :api_key
1615

1716
sig { returns(T.nilable(String)) }
18-
def organization
19-
end
17+
attr_reader :organization
2018

2119
sig { returns(T.nilable(String)) }
22-
def project
23-
end
20+
attr_reader :project
2421

2522
sig { returns(OpenAI::Resources::Completions) }
26-
def completions
27-
end
23+
attr_reader :completions
2824

2925
sig { returns(OpenAI::Resources::Chat) }
30-
def chat
31-
end
26+
attr_reader :chat
3227

3328
sig { returns(OpenAI::Resources::Embeddings) }
34-
def embeddings
35-
end
29+
attr_reader :embeddings
3630

3731
sig { returns(OpenAI::Resources::Files) }
38-
def files
39-
end
32+
attr_reader :files
4033

4134
sig { returns(OpenAI::Resources::Images) }
42-
def images
43-
end
35+
attr_reader :images
4436

4537
sig { returns(OpenAI::Resources::Audio) }
46-
def audio
47-
end
38+
attr_reader :audio
4839

4940
sig { returns(OpenAI::Resources::Moderations) }
50-
def moderations
51-
end
41+
attr_reader :moderations
5242

5343
sig { returns(OpenAI::Resources::Models) }
54-
def models
55-
end
44+
attr_reader :models
5645

5746
sig { returns(OpenAI::Resources::FineTuning) }
58-
def fine_tuning
59-
end
47+
attr_reader :fine_tuning
6048

6149
sig { returns(OpenAI::Resources::VectorStores) }
62-
def vector_stores
63-
end
50+
attr_reader :vector_stores
6451

6552
sig { returns(OpenAI::Resources::Beta) }
66-
def beta
67-
end
53+
attr_reader :beta
6854

6955
sig { returns(OpenAI::Resources::Batches) }
70-
def batches
71-
end
56+
attr_reader :batches
7257

7358
sig { returns(OpenAI::Resources::Uploads) }
74-
def uploads
75-
end
59+
attr_reader :uploads
7660

7761
sig { returns(OpenAI::Resources::Responses) }
78-
def responses
79-
end
62+
attr_reader :responses
8063

8164
# @api private
8265
sig { override.returns(T::Hash[String, String]) }

‎rbi/lib/openai/cursor_page.rbi‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,10 @@ module OpenAI
77
Elem = type_member
88

99
sig { returns(T.nilable(T::Array[Elem])) }
10-
def data
11-
end
12-
13-
sig { params(_: T.nilable(T::Array[Elem])).returns(T.nilable(T::Array[Elem])) }
14-
def data=(_)
15-
end
10+
attr_accessor :data
1611

1712
sig { returns(T::Boolean) }
18-
def has_more
19-
end
20-
21-
sig { params(_: T::Boolean).returns(T::Boolean) }
22-
def has_more=(_)
23-
end
13+
attr_accessor :has_more
2414

2515
sig { returns(String) }
2616
def inspect

‎rbi/lib/openai/errors.rbi‎

Lines changed: 16 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -3,65 +3,30 @@
33
module OpenAI
44
class Error < StandardError
55
sig { returns(T.nilable(StandardError)) }
6-
def cause
7-
end
8-
9-
sig { params(_: T.nilable(StandardError)).returns(T.nilable(StandardError)) }
10-
def cause=(_)
11-
end
6+
attr_accessor :cause
127
end
138

149
class ConversionError < OpenAI::Error
1510
end
1611

1712
class APIError < OpenAI::Error
1813
sig { returns(URI::Generic) }
19-
def url
20-
end
21-
22-
sig { params(_: URI::Generic).returns(URI::Generic) }
23-
def url=(_)
24-
end
14+
attr_accessor :url
2515

2616
sig { returns(T.nilable(Integer)) }
27-
def status
28-
end
29-
30-
sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) }
31-
def status=(_)
32-
end
17+
attr_accessor :status
3318

3419
sig { returns(T.nilable(T.anything)) }
35-
def body
36-
end
37-
38-
sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) }
39-
def body=(_)
40-
end
20+
attr_accessor :body
4121

4222
sig { returns(T.nilable(String)) }
43-
def code
44-
end
45-
46-
sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
47-
def code=(_)
48-
end
23+
attr_accessor :code
4924

5025
sig { returns(T.nilable(String)) }
51-
def param
52-
end
53-
54-
sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
55-
def param=(_)
56-
end
26+
attr_accessor :param
5727

5828
sig { returns(T.nilable(String)) }
59-
def type
60-
end
61-
62-
sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
63-
def type=(_)
64-
end
29+
attr_accessor :type
6530

6631
# @api private
6732
sig do
@@ -81,44 +46,19 @@ module OpenAI
8146

8247
class APIConnectionError < OpenAI::APIError
8348
sig { void }
84-
def status
85-
end
86-
87-
sig { params(_: NilClass).void }
88-
def status=(_)
89-
end
49+
attr_accessor :status
9050

9151
sig { void }
92-
def body
93-
end
94-
95-
sig { params(_: NilClass).void }
96-
def body=(_)
97-
end
52+
attr_accessor :body
9853

9954
sig { void }
100-
def code
101-
end
102-
103-
sig { params(_: NilClass).void }
104-
def code=(_)
105-
end
55+
attr_accessor :code
10656

10757
sig { void }
108-
def param
109-
end
110-
111-
sig { params(_: NilClass).void }
112-
def param=(_)
113-
end
58+
attr_accessor :param
11459

11560
sig { void }
116-
def type
117-
end
118-
119-
sig { params(_: NilClass).void }
120-
def type=(_)
121-
end
61+
attr_accessor :type
12262

12363
# @api private
12464
sig do
@@ -170,36 +110,16 @@ module OpenAI
170110
end
171111

172112
sig { returns(Integer) }
173-
def status
174-
end
175-
176-
sig { params(_: Integer).returns(Integer) }
177-
def status=(_)
178-
end
113+
attr_accessor :status
179114

180115
sig { returns(T.nilable(String)) }
181-
def code
182-
end
183-
184-
sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
185-
def code=(_)
186-
end
116+
attr_accessor :code
187117

188118
sig { returns(T.nilable(String)) }
189-
def param
190-
end
191-
192-
sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
193-
def param=(_)
194-
end
119+
attr_accessor :param
195120

196121
sig { returns(T.nilable(String)) }
197-
def type
198-
end
199-
200-
sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
201-
def type=(_)
202-
end
122+
attr_accessor :type
203123

204124
# @api private
205125
sig do

‎rbi/lib/openai/models/audio/speech_create_params.rbi‎

Lines changed: 12 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -9,73 +9,43 @@ module OpenAI
99

1010
# The text to generate audio for. The maximum length is 4096 characters.
1111
sig { returns(String) }
12-
def input
13-
end
14-
15-
sig { params(_: String).returns(String) }
16-
def input=(_)
17-
end
12+
attr_accessor :input
1813

1914
# One of the available [TTS models](https://platform.openai.com/docs/models#tts):
2015
# `tts-1`, `tts-1-hd` or `gpt-4o-mini-tts`.
2116
sig { returns(T.any(String, OpenAI::Models::Audio::SpeechModel::OrSymbol)) }
22-
def model
23-
end
24-
25-
sig do
26-
params(_: T.any(String, OpenAI::Models::Audio::SpeechModel::OrSymbol))
27-
.returns(T.any(String, OpenAI::Models::Audio::SpeechModel::OrSymbol))
28-
end
29-
def model=(_)
30-
end
17+
attr_accessor :model
3118

3219
# The voice to use when generating the audio. Supported voices are `alloy`, `ash`,
3320
# `coral`, `echo`, `fable`, `onyx`, `nova`, `sage` and `shimmer`. Previews of the
3421
# voices are available in the
3522
# [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).
3623
sig { returns(OpenAI::Models::Audio::SpeechCreateParams::Voice::OrSymbol) }
37-
def voice
38-
end
39-
40-
sig do
41-
params(_: OpenAI::Models::Audio::SpeechCreateParams::Voice::OrSymbol)
42-
.returns(OpenAI::Models::Audio::SpeechCreateParams::Voice::OrSymbol)
43-
end
44-
def voice=(_)
45-
end
24+
attr_accessor :voice
4625

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

53-
sig { params(_: String).returns(String) }
54-
def instructions=(_)
55-
end
31+
sig { params(instructions: String).void }
32+
attr_writer :instructions
5633

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

63-
sig do
64-
params(_: OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat::OrSymbol)
65-
.returns(OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat::OrSymbol)
66-
end
67-
def response_format=(_)
68-
end
39+
sig { params(response_format: OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat::OrSymbol).void }
40+
attr_writer :response_format
6941

7042
# The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
7143
# the default.
7244
sig { returns(T.nilable(Float)) }
73-
def speed
74-
end
45+
attr_reader :speed
7546

76-
sig { params(_: Float).returns(Float) }
77-
def speed=(_)
78-
end
47+
sig { params(speed: Float).void }
48+
attr_writer :speed
7949

8050
sig do
8151
params(

0 commit comments

Comments
 (0)