Skip to content

Commit 4918836

Browse files
stainless-app[bot]stainless-app[bot]
committed
chore(internal): annotate request options with type aliases in sorbet
1 parent 04b111d commit 4918836

Some content is hidden

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

41 files changed

+115
-265
lines changed

‎lib/openai/models/function_parameters.rb

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
module OpenAI
44
module Models
5+
# @type [OpenAI::Internal::Type::Converter]
56
FunctionParameters = OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]
67
end
78
end

‎lib/openai/models/metadata.rb

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
module OpenAI
44
module Models
5+
# @type [OpenAI::Internal::Type::Converter]
56
Metadata = OpenAI::Internal::Type::HashOf[String]
67
end
78
end

‎lib/openai/models/responses/response_input.rb

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
module OpenAI
44
module Models
55
module Responses
6+
# @type [OpenAI::Internal::Type::Converter]
67
ResponseInput =
78
OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Models::Responses::ResponseInputItem }]
89
end

‎lib/openai/models/responses/response_input_message_content_list.rb

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
module OpenAI
44
module Models
55
module Responses
6+
# @type [OpenAI::Internal::Type::Converter]
67
ResponseInputMessageContentList =
78
OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Models::Responses::ResponseInputContent }]
89
end

‎rbi/openai/internal/transport/base_client.rbi

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ module OpenAI
3838
OpenAI::Internal::Type::BaseModel]]
3939
),
4040
model: T.nilable(OpenAI::Internal::Type::Converter::Input),
41-
options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
41+
options: T.nilable(OpenAI::RequestOpts)
4242
}
4343
end
4444

@@ -194,7 +194,7 @@ module OpenAI
194194
OpenAI::Internal::Type::BaseModel]]
195195
),
196196
model: T.nilable(OpenAI::Internal::Type::Converter::Input),
197-
options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
197+
options: T.nilable(OpenAI::RequestOpts)
198198
)
199199
.returns(T.anything)
200200
end

‎rbi/openai/internal/type/request_parameters.rbi

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ module OpenAI
66
# @api private
77
module RequestParameters
88
# Options to specify HTTP behaviour for this request.
9-
sig { returns(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash)) }
9+
sig { returns(OpenAI::RequestOpts) }
1010
attr_accessor :request_options
1111

1212
# @api private

‎rbi/openai/request_options.rbi

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# typed: strong
22

33
module OpenAI
4+
RequestOpts = T.type_alias { T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash) }
5+
46
# Specify HTTP behaviour to use for a specific request. These options supplement
57
# or override those provided at the client level.
68
#

‎rbi/openai/resources/audio/speech.rbi

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ module OpenAI
1313
instructions: String,
1414
response_format: OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat::OrSymbol,
1515
speed: Float,
16-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
16+
request_options: OpenAI::RequestOpts
1717
)
1818
.returns(StringIO)
1919
end

‎rbi/openai/resources/audio/transcriptions.rbi

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ module OpenAI
1919
temperature: Float,
2020
timestamp_granularities: T::Array[OpenAI::Models::Audio::TranscriptionCreateParams::TimestampGranularity::OrSymbol],
2121
stream: T.noreturn,
22-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
22+
request_options: OpenAI::RequestOpts
2323
)
2424
.returns(T.any(OpenAI::Models::Audio::Transcription, OpenAI::Models::Audio::TranscriptionVerbose))
2525
end
@@ -82,7 +82,7 @@ module OpenAI
8282
temperature: Float,
8383
timestamp_granularities: T::Array[OpenAI::Models::Audio::TranscriptionCreateParams::TimestampGranularity::OrSymbol],
8484
stream: T.noreturn,
85-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
85+
request_options: OpenAI::RequestOpts
8686
)
8787
.returns(
8888
OpenAI::Internal::Stream[

‎rbi/openai/resources/audio/translations.rbi

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ module OpenAI
1212
prompt: String,
1313
response_format: OpenAI::Models::Audio::TranslationCreateParams::ResponseFormat::OrSymbol,
1414
temperature: Float,
15-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
15+
request_options: OpenAI::RequestOpts
1616
)
1717
.returns(T.any(OpenAI::Models::Audio::Translation, OpenAI::Models::Audio::TranslationVerbose))
1818
end

‎rbi/openai/resources/batches.rbi

+4-20
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ module OpenAI
1010
endpoint: OpenAI::Models::BatchCreateParams::Endpoint::OrSymbol,
1111
input_file_id: String,
1212
metadata: T.nilable(T::Hash[Symbol, String]),
13-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
13+
request_options: OpenAI::RequestOpts
1414
)
1515
.returns(OpenAI::Models::Batch)
1616
end
@@ -43,25 +43,15 @@ module OpenAI
4343
request_options: {}
4444
); end
4545
# Retrieves a batch.
46-
sig do
47-
params(
48-
batch_id: String,
49-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
50-
)
51-
.returns(OpenAI::Models::Batch)
52-
end
46+
sig { params(batch_id: String, request_options: OpenAI::RequestOpts).returns(OpenAI::Models::Batch) }
5347
def retrieve(
5448
# The ID of the batch to retrieve.
5549
batch_id,
5650
request_options: {}
5751
); end
5852
# List your organization's batches.
5953
sig do
60-
params(
61-
after: String,
62-
limit: Integer,
63-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
64-
)
54+
params(after: String, limit: Integer, request_options: OpenAI::RequestOpts)
6555
.returns(OpenAI::Internal::CursorPage[OpenAI::Models::Batch])
6656
end
6757
def list(
@@ -78,13 +68,7 @@ module OpenAI
7868
# Cancels an in-progress batch. The batch will be in status `cancelling` for up to
7969
# 10 minutes, before changing to `cancelled`, where it will have partial results
8070
# (if any) available in the output file.
81-
sig do
82-
params(
83-
batch_id: String,
84-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
85-
)
86-
.returns(OpenAI::Models::Batch)
87-
end
71+
sig { params(batch_id: String, request_options: OpenAI::RequestOpts).returns(OpenAI::Models::Batch) }
8872
def cancel(
8973
# The ID of the batch to cancel.
9074
batch_id,

‎rbi/openai/resources/beta/assistants.rbi

+5-12
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ module OpenAI
3333
)
3434
],
3535
top_p: T.nilable(Float),
36-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
36+
request_options: OpenAI::RequestOpts
3737
)
3838
.returns(OpenAI::Models::Beta::Assistant)
3939
end
@@ -109,11 +109,7 @@ module OpenAI
109109
); end
110110
# Retrieves an assistant.
111111
sig do
112-
params(
113-
assistant_id: String,
114-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
115-
)
116-
.returns(OpenAI::Models::Beta::Assistant)
112+
params(assistant_id: String, request_options: OpenAI::RequestOpts).returns(OpenAI::Models::Beta::Assistant)
117113
end
118114
def retrieve(
119115
# The ID of the assistant to retrieve.
@@ -150,7 +146,7 @@ module OpenAI
150146
)
151147
],
152148
top_p: T.nilable(Float),
153-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
149+
request_options: OpenAI::RequestOpts
154150
)
155151
.returns(OpenAI::Models::Beta::Assistant)
156152
end
@@ -233,7 +229,7 @@ module OpenAI
233229
before: String,
234230
limit: Integer,
235231
order: OpenAI::Models::Beta::AssistantListParams::Order::OrSymbol,
236-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
232+
request_options: OpenAI::RequestOpts
237233
)
238234
.returns(OpenAI::Internal::CursorPage[OpenAI::Models::Beta::Assistant])
239235
end
@@ -258,10 +254,7 @@ module OpenAI
258254
); end
259255
# Delete an assistant.
260256
sig do
261-
params(
262-
assistant_id: String,
263-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
264-
)
257+
params(assistant_id: String, request_options: OpenAI::RequestOpts)
265258
.returns(OpenAI::Models::Beta::AssistantDeleted)
266259
end
267260
def delete(

‎rbi/openai/resources/beta/threads.rbi

+6-15
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ module OpenAI
1616
messages: T::Array[T.any(OpenAI::Models::Beta::ThreadCreateParams::Message, OpenAI::Internal::AnyHash)],
1717
metadata: T.nilable(T::Hash[Symbol, String]),
1818
tool_resources: T.nilable(T.any(OpenAI::Models::Beta::ThreadCreateParams::ToolResources, OpenAI::Internal::AnyHash)),
19-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
19+
request_options: OpenAI::RequestOpts
2020
)
2121
.returns(OpenAI::Models::Beta::Thread)
2222
end
@@ -39,13 +39,7 @@ module OpenAI
3939
request_options: {}
4040
); end
4141
# Retrieves a thread.
42-
sig do
43-
params(
44-
thread_id: String,
45-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
46-
)
47-
.returns(OpenAI::Models::Beta::Thread)
48-
end
42+
sig { params(thread_id: String, request_options: OpenAI::RequestOpts).returns(OpenAI::Models::Beta::Thread) }
4943
def retrieve(
5044
# The ID of the thread to retrieve.
5145
thread_id,
@@ -57,7 +51,7 @@ module OpenAI
5751
thread_id: String,
5852
metadata: T.nilable(T::Hash[Symbol, String]),
5953
tool_resources: T.nilable(T.any(OpenAI::Models::Beta::ThreadUpdateParams::ToolResources, OpenAI::Internal::AnyHash)),
60-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
54+
request_options: OpenAI::RequestOpts
6155
)
6256
.returns(OpenAI::Models::Beta::Thread)
6357
end
@@ -80,10 +74,7 @@ module OpenAI
8074
); end
8175
# Delete a thread.
8276
sig do
83-
params(
84-
thread_id: String,
85-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
86-
)
77+
params(thread_id: String, request_options: OpenAI::RequestOpts)
8778
.returns(OpenAI::Models::Beta::ThreadDeleted)
8879
end
8980
def delete(
@@ -137,7 +128,7 @@ module OpenAI
137128
T.any(OpenAI::Models::Beta::ThreadCreateAndRunParams::TruncationStrategy, OpenAI::Internal::AnyHash)
138129
),
139130
stream: T.noreturn,
140-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
131+
request_options: OpenAI::RequestOpts
141132
)
142133
.returns(OpenAI::Models::Beta::Threads::Run)
143134
end
@@ -282,7 +273,7 @@ module OpenAI
282273
T.any(OpenAI::Models::Beta::ThreadCreateAndRunParams::TruncationStrategy, OpenAI::Internal::AnyHash)
283274
),
284275
stream: T.noreturn,
285-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
276+
request_options: OpenAI::RequestOpts
286277
)
287278
.returns(
288279
OpenAI::Internal::Stream[

‎rbi/openai/resources/beta/threads/messages.rbi

+5-13
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ module OpenAI
2525
T::Array[T.any(OpenAI::Models::Beta::Threads::MessageCreateParams::Attachment, OpenAI::Internal::AnyHash)]
2626
),
2727
metadata: T.nilable(T::Hash[Symbol, String]),
28-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
28+
request_options: OpenAI::RequestOpts
2929
)
3030
.returns(OpenAI::Models::Beta::Threads::Message)
3131
end
@@ -55,11 +55,7 @@ module OpenAI
5555
); end
5656
# Retrieve a message.
5757
sig do
58-
params(
59-
message_id: String,
60-
thread_id: String,
61-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
62-
)
58+
params(message_id: String, thread_id: String, request_options: OpenAI::RequestOpts)
6359
.returns(OpenAI::Models::Beta::Threads::Message)
6460
end
6561
def retrieve(
@@ -76,7 +72,7 @@ module OpenAI
7672
message_id: String,
7773
thread_id: String,
7874
metadata: T.nilable(T::Hash[Symbol, String]),
79-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
75+
request_options: OpenAI::RequestOpts
8076
)
8177
.returns(OpenAI::Models::Beta::Threads::Message)
8278
end
@@ -103,7 +99,7 @@ module OpenAI
10399
limit: Integer,
104100
order: OpenAI::Models::Beta::Threads::MessageListParams::Order::OrSymbol,
105101
run_id: String,
106-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
102+
request_options: OpenAI::RequestOpts
107103
)
108104
.returns(OpenAI::Internal::CursorPage[OpenAI::Models::Beta::Threads::Message])
109105
end
@@ -133,11 +129,7 @@ module OpenAI
133129
); end
134130
# Deletes a message.
135131
sig do
136-
params(
137-
message_id: String,
138-
thread_id: String,
139-
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
140-
)
132+
params(message_id: String, thread_id: String, request_options: OpenAI::RequestOpts)
141133
.returns(OpenAI::Models::Beta::Threads::MessageDeleted)
142134
end
143135
def delete(

0 commit comments

Comments
 (0)