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‎

Lines changed: 1 addition & 0 deletions
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‎

Lines changed: 1 addition & 0 deletions
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‎

Lines changed: 1 addition & 0 deletions
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‎

Lines changed: 1 addition & 0 deletions
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‎

Lines changed: 2 additions & 2 deletions
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‎

Lines changed: 1 addition & 1 deletion
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‎

Lines changed: 2 additions & 0 deletions
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‎

Lines changed: 1 addition & 1 deletion
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‎

Lines changed: 2 additions & 2 deletions
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‎

Lines changed: 1 addition & 1 deletion
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

0 commit comments

Comments
 (0)