Skip to content

Commit 59f1ab0

Browse files
fix: label optional keyword arguments in *.rbs type definitions (#41)
1 parent e2cca18 commit 59f1ab0

File tree

281 files changed

+1329
-1314
lines changed

Some content is hidden

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

281 files changed

+1329
-1314
lines changed

sig/openai/base_client.rbs

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,14 @@ module OpenAI
5353

5454
def initialize: (
5555
base_url: String,
56-
timeout: Float,
57-
max_retries: Integer,
58-
initial_retry_delay: Float,
59-
max_retry_delay: Float,
60-
headers: ::Hash[String, (String
56+
?timeout: Float,
57+
?max_retries: Integer,
58+
?initial_retry_delay: Float,
59+
?max_retry_delay: Float,
60+
?headers: ::Hash[String, (String
6161
| Integer
6262
| ::Array[(String | Integer)?])?],
63-
idempotency_header: String?
63+
?idempotency_header: String?
6464
) -> void
6565

6666
private def auth_headers: -> ::Hash[String, String]
@@ -88,16 +88,16 @@ module OpenAI
8888
(
8989
Symbol method,
9090
String | ::Array[String] path,
91-
query: ::Hash[String, (::Array[String] | String)?]?,
92-
headers: ::Hash[String, (String
91+
?query: ::Hash[String, (::Array[String] | String)?]?,
92+
?headers: ::Hash[String, (String
9393
| Integer
9494
| ::Array[(String | Integer)?])?]?,
95-
body: top?,
96-
unwrap: Symbol?,
97-
page: Class?,
98-
stream: Class?,
99-
model: OpenAI::Converter::input?,
100-
options: OpenAI::request_opts?
95+
?body: top?,
96+
?unwrap: Symbol?,
97+
?page: Class?,
98+
?stream: Class?,
99+
?model: OpenAI::Converter::input?,
100+
?options: OpenAI::request_opts?
101101
) -> top
102102
| (OpenAI::BaseClient::request_components req) -> top
103103

sig/openai/client.rbs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ module OpenAI
4545
private def auth_headers: -> ::Hash[String, String]
4646

4747
def initialize: (
48-
base_url: String?,
49-
api_key: String?,
50-
organization: String?,
51-
project: String?,
52-
max_retries: Integer,
53-
timeout: Float,
54-
initial_retry_delay: Float,
55-
max_retry_delay: Float
48+
?base_url: String?,
49+
?api_key: String?,
50+
?organization: String?,
51+
?project: String?,
52+
?max_retries: Integer,
53+
?timeout: Float,
54+
?initial_retry_delay: Float,
55+
?max_retry_delay: Float
5656
) -> void
5757
end
5858
end

sig/openai/errors.rbs

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,33 +21,33 @@ module OpenAI
2121

2222
def initialize: (
2323
url: URI::Generic,
24-
status: Integer?,
25-
body: Object?,
26-
request: nil,
27-
response: nil,
28-
message: String?
24+
?status: Integer?,
25+
?body: Object?,
26+
?request: nil,
27+
?response: nil,
28+
?message: String?
2929
) -> void
3030
end
3131

3232
class APIConnectionError < OpenAI::APIError
3333
def initialize: (
3434
url: URI::Generic,
35-
status: nil,
36-
body: nil,
37-
request: nil,
38-
response: nil,
39-
message: String?
35+
?status: nil,
36+
?body: nil,
37+
?request: nil,
38+
?response: nil,
39+
?message: String?
4040
) -> void
4141
end
4242

4343
class APITimeoutError < OpenAI::APIConnectionError
4444
def initialize: (
4545
url: URI::Generic,
46-
status: nil,
47-
body: nil,
48-
request: nil,
49-
response: nil,
50-
message: String?
46+
?status: nil,
47+
?body: nil,
48+
?request: nil,
49+
?response: nil,
50+
?message: String?
5151
) -> void
5252
end
5353

@@ -58,7 +58,7 @@ module OpenAI
5858
body: Object?,
5959
request: nil,
6060
response: nil,
61-
message: String?
61+
?message: String?
6262
) -> instance
6363

6464
def initialize: (
@@ -67,7 +67,7 @@ module OpenAI
6767
body: Object?,
6868
request: nil,
6969
response: nil,
70-
message: String?
70+
?message: String?
7171
) -> void
7272
end
7373

sig/openai/models/audio/speech_create_params.rbs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ module OpenAI
3636
input: String,
3737
model: OpenAI::Models::Audio::SpeechCreateParams::model,
3838
voice: OpenAI::Models::Audio::SpeechCreateParams::voice,
39-
response_format: OpenAI::Models::Audio::SpeechCreateParams::response_format,
40-
speed: Float,
41-
request_options: OpenAI::request_opts
39+
?response_format: OpenAI::Models::Audio::SpeechCreateParams::response_format,
40+
?speed: Float,
41+
?request_options: OpenAI::request_opts
4242
) -> void
4343
| (
4444
?OpenAI::Models::Audio::speech_create_params

sig/openai/models/audio/transcription_create_params.rbs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,12 @@ module OpenAI
4949
(
5050
file: IO | StringIO,
5151
model: OpenAI::Models::Audio::TranscriptionCreateParams::model,
52-
language: String,
53-
prompt: String,
54-
response_format: OpenAI::Models::audio_response_format,
55-
temperature: Float,
56-
timestamp_granularities: ::Array[OpenAI::Models::Audio::TranscriptionCreateParams::timestamp_granularity],
57-
request_options: OpenAI::request_opts
52+
?language: String,
53+
?prompt: String,
54+
?response_format: OpenAI::Models::audio_response_format,
55+
?temperature: Float,
56+
?timestamp_granularities: ::Array[OpenAI::Models::Audio::TranscriptionCreateParams::timestamp_granularity],
57+
?request_options: OpenAI::request_opts
5858
) -> void
5959
| (
6060
?OpenAI::Models::Audio::transcription_create_params

sig/openai/models/audio/transcription_verbose.rbs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ module OpenAI
3434
duration: Float,
3535
language: String,
3636
text: String,
37-
segments: ::Array[OpenAI::Models::Audio::TranscriptionSegment],
38-
words: ::Array[OpenAI::Models::Audio::TranscriptionWord]
37+
?segments: ::Array[OpenAI::Models::Audio::TranscriptionSegment],
38+
?words: ::Array[OpenAI::Models::Audio::TranscriptionWord]
3939
) -> void
4040
| (
4141
?OpenAI::Models::Audio::transcription_verbose

sig/openai/models/audio/translation_create_params.rbs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ module OpenAI
3737
(
3838
file: IO | StringIO,
3939
model: OpenAI::Models::Audio::TranslationCreateParams::model,
40-
prompt: String,
41-
response_format: OpenAI::Models::audio_response_format,
42-
temperature: Float,
43-
request_options: OpenAI::request_opts
40+
?prompt: String,
41+
?response_format: OpenAI::Models::audio_response_format,
42+
?temperature: Float,
43+
?request_options: OpenAI::request_opts
4444
) -> void
4545
| (
4646
?OpenAI::Models::Audio::translation_create_params

sig/openai/models/audio/translation_verbose.rbs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ module OpenAI
2727
duration: Float,
2828
language: String,
2929
text: String,
30-
segments: ::Array[OpenAI::Models::Audio::TranscriptionSegment]
30+
?segments: ::Array[OpenAI::Models::Audio::TranscriptionSegment]
3131
) -> void
3232
| (
3333
?OpenAI::Models::Audio::translation_verbose | OpenAI::BaseModel data

sig/openai/models/auto_file_chunking_strategy_param.rbs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ module OpenAI
66
attr_accessor type: :auto
77

88
def initialize:
9-
(type: :auto) -> void
9+
(?type: :auto) -> void
1010
| (
1111
?OpenAI::Models::auto_file_chunking_strategy_param
1212
| OpenAI::BaseModel data

sig/openai/models/batch.rbs

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -101,20 +101,20 @@ module OpenAI
101101
endpoint: String,
102102
input_file_id: String,
103103
status: OpenAI::Models::Batch::status,
104-
cancelled_at: Integer,
105-
cancelling_at: Integer,
106-
completed_at: Integer,
107-
error_file_id: String,
108-
errors: OpenAI::Models::Batch::Errors,
109-
expired_at: Integer,
110-
expires_at: Integer,
111-
failed_at: Integer,
112-
finalizing_at: Integer,
113-
in_progress_at: Integer,
114-
metadata: OpenAI::Models::metadata?,
115-
output_file_id: String,
116-
request_counts: OpenAI::Models::BatchRequestCounts,
117-
object: :batch
104+
?cancelled_at: Integer,
105+
?cancelling_at: Integer,
106+
?completed_at: Integer,
107+
?error_file_id: String,
108+
?errors: OpenAI::Models::Batch::Errors,
109+
?expired_at: Integer,
110+
?expires_at: Integer,
111+
?failed_at: Integer,
112+
?finalizing_at: Integer,
113+
?in_progress_at: Integer,
114+
?metadata: OpenAI::Models::metadata?,
115+
?output_file_id: String,
116+
?request_counts: OpenAI::Models::BatchRequestCounts,
117+
?object: :batch
118118
) -> void
119119
| (?OpenAI::Models::batch | OpenAI::BaseModel data) -> void
120120

@@ -158,7 +158,7 @@ module OpenAI
158158
def object=: (String) -> String
159159

160160
def initialize:
161-
(data: ::Array[OpenAI::Models::BatchError], object: String) -> void
161+
(?data: ::Array[OpenAI::Models::BatchError], ?object: String) -> void
162162
| (?OpenAI::Models::Batch::errors | OpenAI::BaseModel data) -> void
163163

164164
def to_hash: -> OpenAI::Models::Batch::errors

0 commit comments

Comments
 (0)