Skip to content

Commit adead66

Browse files
fix(api): fix nullability of logprobs
Makes ResponseOutputText.logprobs nullable, matching with 2.6.1. While this is always present in the server response, this inadvertently affected params and some constructors
1 parent 6c66a9f commit adead66

File tree

4 files changed

+40
-27
lines changed

4 files changed

+40
-27
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 135
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-3c5d1593d7c6f2b38a7d78d7906041465ee9d6e9022f0651e1da194654488108.yml
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-eeba8addf3a5f412e5ce8d22031e60c61650cee3f5d9e587a2533f6818a249ea.yml
33
openapi_spec_hash: 0a4d8ad2469823ce24a3fd94f23f1c2b
4-
config_hash: 032995825500a503a76da119f5354905
4+
config_hash: 0bb1941a78ece0b610a2fbba7d74a84c

lib/openai/models/responses/response_output_text.rb

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,6 @@ class ResponseOutputText < OpenAI::Internal::Type::BaseModel
1111
required :annotations,
1212
-> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseOutputText::Annotation] }
1313

14-
# @!attribute logprobs
15-
#
16-
# @return [Array<OpenAI::Models::Responses::ResponseOutputText::Logprob>]
17-
required :logprobs, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseOutputText::Logprob] }
18-
1914
# @!attribute text
2015
# The text output from the model.
2116
#
@@ -36,15 +31,20 @@ class ResponseOutputText < OpenAI::Internal::Type::BaseModel
3631
# @return [Symbol, :output_text]
3732
required :type, const: :output_text
3833

39-
# @!method initialize(annotations:, logprobs:, text:, type: :output_text)
34+
# @!attribute logprobs
35+
#
36+
# @return [Array<OpenAI::Models::Responses::ResponseOutputText::Logprob>, nil]
37+
optional :logprobs, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseOutputText::Logprob] }
38+
39+
# @!method initialize(annotations:, text:, logprobs: nil, type: :output_text)
4040
# A text output from the model.
4141
#
4242
# @param annotations [Array<OpenAI::Models::Responses::ResponseOutputText::Annotation::FileCitation, OpenAI::Models::Responses::ResponseOutputText::Annotation::URLCitation, OpenAI::Models::Responses::ResponseOutputText::Annotation::ContainerFileCitation, OpenAI::Models::Responses::ResponseOutputText::Annotation::FilePath>] The annotations of the text output.
4343
#
44-
# @param logprobs [Array<OpenAI::Models::Responses::ResponseOutputText::Logprob>]
45-
#
4644
# @param text [String] The text output from the model.
4745
#
46+
# @param logprobs [Array<OpenAI::Models::Responses::ResponseOutputText::Logprob>]
47+
#
4848
# @param type [Symbol, :output_text] The type of the output text. Always `output_text`.
4949

5050
# A citation to a file.

rbi/openai/models/responses/response_output_text.rbi

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,6 @@ module OpenAI
2727
end
2828
attr_accessor :annotations
2929

30-
sig do
31-
returns(T::Array[OpenAI::Responses::ResponseOutputText::Logprob])
32-
end
33-
attr_accessor :logprobs
34-
3530
# The text output from the model.
3631
sig { returns(String) }
3732
attr_accessor :text
@@ -44,6 +39,21 @@ module OpenAI
4439
sig { returns(Symbol) }
4540
attr_accessor :type
4641

42+
sig do
43+
returns(
44+
T.nilable(T::Array[OpenAI::Responses::ResponseOutputText::Logprob])
45+
)
46+
end
47+
attr_reader :logprobs
48+
49+
sig do
50+
params(
51+
logprobs:
52+
T::Array[OpenAI::Responses::ResponseOutputText::Logprob::OrHash]
53+
).void
54+
end
55+
attr_writer :logprobs
56+
4757
# A text output from the model.
4858
sig do
4959
params(
@@ -56,18 +66,18 @@ module OpenAI
5666
OpenAI::Responses::ResponseOutputText::Annotation::FilePath::OrHash
5767
)
5868
],
69+
text: String,
5970
logprobs:
6071
T::Array[OpenAI::Responses::ResponseOutputText::Logprob::OrHash],
61-
text: String,
6272
type: Symbol
6373
).returns(T.attached_class)
6474
end
6575
def self.new(
6676
# The annotations of the text output.
6777
annotations:,
68-
logprobs:,
6978
# The text output from the model.
7079
text:,
80+
logprobs: nil,
7181
# The type of the output text. Always `output_text`.
7282
type: :output_text
7383
)
@@ -85,10 +95,9 @@ module OpenAI
8595
OpenAI::Responses::ResponseOutputText::Annotation::FilePath
8696
)
8797
],
88-
logprobs:
89-
T::Array[OpenAI::Responses::ResponseOutputText::Logprob],
9098
text: String,
91-
type: Symbol
99+
type: Symbol,
100+
logprobs: T::Array[OpenAI::Responses::ResponseOutputText::Logprob]
92101
}
93102
)
94103
end

sig/openai/models/responses/response_output_text.rbs

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,36 @@ module OpenAI
44
type response_output_text =
55
{
66
annotations: ::Array[OpenAI::Models::Responses::ResponseOutputText::annotation],
7-
logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob],
87
text: String,
9-
type: :output_text
8+
type: :output_text,
9+
logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob]
1010
}
1111

1212
class ResponseOutputText < OpenAI::Internal::Type::BaseModel
1313
attr_accessor annotations: ::Array[OpenAI::Models::Responses::ResponseOutputText::annotation]
1414

15-
attr_accessor logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob]
16-
1715
attr_accessor text: String
1816

1917
attr_accessor type: :output_text
2018

19+
attr_reader logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob]?
20+
21+
def logprobs=: (
22+
::Array[OpenAI::Responses::ResponseOutputText::Logprob]
23+
) -> ::Array[OpenAI::Responses::ResponseOutputText::Logprob]
24+
2125
def initialize: (
2226
annotations: ::Array[OpenAI::Models::Responses::ResponseOutputText::annotation],
23-
logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob],
2427
text: String,
28+
?logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob],
2529
?type: :output_text
2630
) -> void
2731

2832
def to_hash: -> {
2933
annotations: ::Array[OpenAI::Models::Responses::ResponseOutputText::annotation],
30-
logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob],
3134
text: String,
32-
type: :output_text
35+
type: :output_text,
36+
logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob]
3337
}
3438

3539
type annotation =

0 commit comments

Comments
 (0)