openai 0.113.0 → 0.114.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +18 -0
  3. data/README.md +1 -1
  4. data/lib/openai/auth/subject_token_providers/azure_managed_identity_token_provider.rb +10 -8
  5. data/lib/openai/auth/subject_token_providers/gcp_id_token_provider.rb +8 -7
  6. data/lib/openai/models/beta/beta_response_input_file.rb +9 -9
  7. data/lib/openai/models/beta/beta_response_input_file_content.rb +9 -9
  8. data/lib/openai/models/beta/beta_response_input_image.rb +9 -9
  9. data/lib/openai/models/beta/beta_response_input_image_content.rb +9 -9
  10. data/lib/openai/models/beta/beta_response_input_text.rb +9 -9
  11. data/lib/openai/models/beta/beta_response_input_text_content.rb +9 -9
  12. data/lib/openai/models/beta/beta_response_item.rb +9 -9
  13. data/lib/openai/models/beta/beta_response_output_item.rb +9 -9
  14. data/lib/openai/models/chat/chat_completion_content_part.rb +9 -9
  15. data/lib/openai/models/chat/chat_completion_content_part_image.rb +9 -9
  16. data/lib/openai/models/chat/chat_completion_content_part_input_audio.rb +9 -9
  17. data/lib/openai/models/chat/chat_completion_content_part_text.rb +9 -9
  18. data/lib/openai/models/conversations/computer_screenshot_content.rb +9 -9
  19. data/lib/openai/models/responses/response_input_file.rb +9 -9
  20. data/lib/openai/models/responses/response_input_file_content.rb +9 -9
  21. data/lib/openai/models/responses/response_input_image.rb +9 -9
  22. data/lib/openai/models/responses/response_input_image_content.rb +9 -9
  23. data/lib/openai/models/responses/response_input_text.rb +9 -9
  24. data/lib/openai/models/responses/response_input_text_content.rb +9 -9
  25. data/lib/openai/version.rb +1 -1
  26. data/rbi/openai/models/beta/beta_response_input_file.rbi +9 -9
  27. data/rbi/openai/models/beta/beta_response_input_file_content.rbi +9 -9
  28. data/rbi/openai/models/beta/beta_response_input_image.rbi +9 -9
  29. data/rbi/openai/models/beta/beta_response_input_image_content.rbi +9 -9
  30. data/rbi/openai/models/beta/beta_response_input_text.rbi +9 -9
  31. data/rbi/openai/models/beta/beta_response_input_text_content.rbi +9 -9
  32. data/rbi/openai/models/beta/beta_response_item.rbi +9 -9
  33. data/rbi/openai/models/beta/beta_response_output_item.rbi +9 -9
  34. data/rbi/openai/models/chat/chat_completion_content_part.rbi +9 -9
  35. data/rbi/openai/models/chat/chat_completion_content_part_image.rbi +9 -9
  36. data/rbi/openai/models/chat/chat_completion_content_part_input_audio.rbi +9 -9
  37. data/rbi/openai/models/chat/chat_completion_content_part_text.rbi +9 -9
  38. data/rbi/openai/models/conversations/computer_screenshot_content.rbi +9 -9
  39. data/rbi/openai/models/responses/response_input_file.rbi +9 -9
  40. data/rbi/openai/models/responses/response_input_file_content.rbi +9 -9
  41. data/rbi/openai/models/responses/response_input_image.rbi +9 -9
  42. data/rbi/openai/models/responses/response_input_image_content.rbi +9 -9
  43. data/rbi/openai/models/responses/response_input_text.rbi +9 -9
  44. data/rbi/openai/models/responses/response_input_text_content.rbi +9 -9
  45. data/sig/openai/models/beta/beta_response_input_file.rbs +9 -9
  46. data/sig/openai/models/beta/beta_response_input_file_content.rbs +6 -6
  47. data/sig/openai/models/beta/beta_response_input_image.rbs +9 -9
  48. data/sig/openai/models/beta/beta_response_input_image_content.rbs +6 -6
  49. data/sig/openai/models/beta/beta_response_input_text.rbs +9 -9
  50. data/sig/openai/models/beta/beta_response_input_text_content.rbs +6 -6
  51. data/sig/openai/models/beta/beta_response_item.rbs +9 -9
  52. data/sig/openai/models/beta/beta_response_output_item.rbs +9 -9
  53. data/sig/openai/models/chat/chat_completion_content_part.rbs +9 -9
  54. data/sig/openai/models/chat/chat_completion_content_part_image.rbs +9 -9
  55. data/sig/openai/models/chat/chat_completion_content_part_input_audio.rbs +9 -9
  56. data/sig/openai/models/chat/chat_completion_content_part_text.rbs +9 -9
  57. data/sig/openai/models/conversations/computer_screenshot_content.rbs +9 -9
  58. data/sig/openai/models/responses/response_input_file.rbs +9 -9
  59. data/sig/openai/models/responses/response_input_file_content.rbs +6 -6
  60. data/sig/openai/models/responses/response_input_image.rbs +9 -9
  61. data/sig/openai/models/responses/response_input_image_content.rbs +6 -6
  62. data/sig/openai/models/responses/response_input_text.rbs +9 -9
  63. data/sig/openai/models/responses/response_input_text_content.rbs +6 -6
  64. metadata +1 -1
@@ -38,9 +38,9 @@ module OpenAI
38
38
  sig { returns(Symbol) }
39
39
  attr_accessor :type
40
40
 
41
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
42
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
43
- # token block.
41
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
42
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
43
+ # not rounded to a token block.
44
44
  sig { returns(T.nilable(OpenAI::Chat::ChatCompletionContentPart::File::PromptCacheBreakpoint)) }
45
45
  attr_reader :prompt_cache_breakpoint
46
46
 
@@ -69,9 +69,9 @@ module OpenAI
69
69
 
70
70
  file:,
71
71
 
72
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
73
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
74
- # token block.
72
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
73
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
74
+ # not rounded to a token block.
75
75
  prompt_cache_breakpoint: nil,
76
76
 
77
77
  # The type of the content part. Always `file`.
@@ -181,9 +181,9 @@ module OpenAI
181
181
  }
182
182
  attr_writer :ttl
183
183
 
184
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
185
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
186
- # token block.
184
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
185
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
186
+ # not rounded to a token block.
187
187
  sig do
188
188
  params(
189
189
 
@@ -26,9 +26,9 @@ module OpenAI
26
26
  sig { returns(Symbol) }
27
27
  attr_accessor :type
28
28
 
29
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
30
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
31
- # token block.
29
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
30
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
31
+ # not rounded to a token block.
32
32
  sig { returns(T.nilable(OpenAI::Chat::ChatCompletionContentPartImage::PromptCacheBreakpoint)) }
33
33
  attr_reader :prompt_cache_breakpoint
34
34
 
@@ -55,9 +55,9 @@ module OpenAI
55
55
 
56
56
  image_url:,
57
57
 
58
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
59
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
60
- # token block.
58
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
59
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
60
+ # not rounded to a token block.
61
61
  prompt_cache_breakpoint: nil,
62
62
 
63
63
  # The type of the content part.
@@ -171,9 +171,9 @@ module OpenAI
171
171
  sig { params(ttl: OpenAI::Chat::ChatCompletionContentPartImage::PromptCacheBreakpoint::Ttl::OrSymbol).void }
172
172
  attr_writer :ttl
173
173
 
174
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
175
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
176
- # token block.
174
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
175
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
176
+ # not rounded to a token block.
177
177
  sig do
178
178
  params(
179
179
 
@@ -26,9 +26,9 @@ module OpenAI
26
26
  sig { returns(Symbol) }
27
27
  attr_accessor :type
28
28
 
29
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
30
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
31
- # token block.
29
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
30
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
31
+ # not rounded to a token block.
32
32
  sig { returns(T.nilable(OpenAI::Chat::ChatCompletionContentPartInputAudio::PromptCacheBreakpoint)) }
33
33
  attr_reader :prompt_cache_breakpoint
34
34
 
@@ -56,9 +56,9 @@ module OpenAI
56
56
 
57
57
  input_audio:,
58
58
 
59
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
60
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
61
- # token block.
59
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
60
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
61
+ # not rounded to a token block.
62
62
  prompt_cache_breakpoint: nil,
63
63
 
64
64
  # The type of the content part. Always `input_audio`.
@@ -168,9 +168,9 @@ module OpenAI
168
168
  }
169
169
  attr_writer :ttl
170
170
 
171
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
172
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
173
- # token block.
171
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
172
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
173
+ # not rounded to a token block.
174
174
  sig do
175
175
  params(
176
176
 
@@ -24,9 +24,9 @@ module OpenAI
24
24
  sig { returns(Symbol) }
25
25
  attr_accessor :type
26
26
 
27
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
28
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
29
- # token block.
27
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
28
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
29
+ # not rounded to a token block.
30
30
  sig { returns(T.nilable(OpenAI::Chat::ChatCompletionContentPartText::PromptCacheBreakpoint)) }
31
31
  attr_reader :prompt_cache_breakpoint
32
32
 
@@ -53,9 +53,9 @@ module OpenAI
53
53
  # The text content.
54
54
  text:,
55
55
 
56
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
57
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
58
- # token block.
56
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
57
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
58
+ # not rounded to a token block.
59
59
  prompt_cache_breakpoint: nil,
60
60
 
61
61
  # The type of the content part.
@@ -95,9 +95,9 @@ module OpenAI
95
95
  sig { params(ttl: OpenAI::Chat::ChatCompletionContentPartText::PromptCacheBreakpoint::Ttl::OrSymbol).void }
96
96
  attr_writer :ttl
97
97
 
98
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
99
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
100
- # token block.
98
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
99
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
100
+ # not rounded to a token block.
101
101
  sig do
102
102
  params(
103
103
 
@@ -32,9 +32,9 @@ module OpenAI
32
32
  sig { returns(Symbol) }
33
33
  attr_accessor :type
34
34
 
35
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
36
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
37
- # token block.
35
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
36
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
37
+ # not rounded to a token block.
38
38
  sig { returns(T.nilable(OpenAI::Conversations::ComputerScreenshotContent::PromptCacheBreakpoint)) }
39
39
  attr_reader :prompt_cache_breakpoint
40
40
 
@@ -74,9 +74,9 @@ module OpenAI
74
74
  # The URL of the screenshot image.
75
75
  image_url:,
76
76
 
77
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
78
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
79
- # token block.
77
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
78
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
79
+ # not rounded to a token block.
80
80
  prompt_cache_breakpoint: nil,
81
81
 
82
82
  # Specifies the event type. For a computer screenshot, this property is always set
@@ -143,9 +143,9 @@ module OpenAI
143
143
  }
144
144
  attr_writer :ttl
145
145
 
146
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
147
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
148
- # token block.
146
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
147
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
148
+ # not rounded to a token block.
149
149
  sig do
150
150
  params(
151
151
 
@@ -54,9 +54,9 @@ module OpenAI
54
54
  sig { params(filename: String).void }
55
55
  attr_writer :filename
56
56
 
57
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
58
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
59
- # token block.
57
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
58
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
59
+ # not rounded to a token block.
60
60
  sig { returns(T.nilable(OpenAI::Responses::ResponseInputFile::PromptCacheBreakpoint)) }
61
61
  attr_reader :prompt_cache_breakpoint
62
62
 
@@ -106,9 +106,9 @@ module OpenAI
106
106
  # The name of the file to be sent to the model.
107
107
  filename: nil,
108
108
 
109
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
110
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
111
- # token block.
109
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
110
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
111
+ # not rounded to a token block.
112
112
  prompt_cache_breakpoint: nil,
113
113
 
114
114
  # The type of the input item. Always `input_file`.
@@ -172,9 +172,9 @@ module OpenAI
172
172
  sig { params(ttl: OpenAI::Responses::ResponseInputFile::PromptCacheBreakpoint::Ttl::OrSymbol).void }
173
173
  attr_writer :ttl
174
174
 
175
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
176
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
177
- # token block.
175
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
176
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
177
+ # not rounded to a token block.
178
178
  sig do
179
179
  params(
180
180
 
@@ -45,9 +45,9 @@ module OpenAI
45
45
  sig { returns(T.nilable(String)) }
46
46
  attr_accessor :filename
47
47
 
48
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
49
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
50
- # token block.
48
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
49
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
50
+ # not rounded to a token block.
51
51
  sig { returns(T.nilable(OpenAI::Responses::ResponseInputFileContent::PromptCacheBreakpoint)) }
52
52
  attr_reader :prompt_cache_breakpoint
53
53
 
@@ -104,9 +104,9 @@ module OpenAI
104
104
  # The name of the file to be sent to the model.
105
105
  filename: nil,
106
106
 
107
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
108
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
109
- # token block.
107
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
108
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
109
+ # not rounded to a token block.
110
110
  prompt_cache_breakpoint: nil,
111
111
 
112
112
  # The type of the input item. Always `input_file`.
@@ -170,9 +170,9 @@ module OpenAI
170
170
  sig { params(ttl: OpenAI::Responses::ResponseInputFileContent::PromptCacheBreakpoint::Ttl::OrSymbol).void }
171
171
  attr_writer :ttl
172
172
 
173
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
174
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
175
- # token block.
173
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
174
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
175
+ # not rounded to a token block.
176
176
  sig do
177
177
  params(
178
178
 
@@ -32,9 +32,9 @@ module OpenAI
32
32
  sig { returns(T.nilable(String)) }
33
33
  attr_accessor :image_url
34
34
 
35
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
36
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
37
- # token block.
35
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
36
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
37
+ # not rounded to a token block.
38
38
  sig { returns(T.nilable(OpenAI::Responses::ResponseInputImage::PromptCacheBreakpoint)) }
39
39
  attr_reader :prompt_cache_breakpoint
40
40
 
@@ -73,9 +73,9 @@ module OpenAI
73
73
  # encoded image in a data URL.
74
74
  image_url: nil,
75
75
 
76
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
77
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
78
- # token block.
76
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
77
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
78
+ # not rounded to a token block.
79
79
  prompt_cache_breakpoint: nil,
80
80
 
81
81
  # The type of the input item. Always `input_image`.
@@ -135,9 +135,9 @@ module OpenAI
135
135
  sig { params(ttl: OpenAI::Responses::ResponseInputImage::PromptCacheBreakpoint::Ttl::OrSymbol).void }
136
136
  attr_writer :ttl
137
137
 
138
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
139
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
140
- # token block.
138
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
139
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
140
+ # not rounded to a token block.
141
141
  sig do
142
142
  params(
143
143
 
@@ -32,9 +32,9 @@ module OpenAI
32
32
  sig { returns(T.nilable(String)) }
33
33
  attr_accessor :image_url
34
34
 
35
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
36
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
37
- # token block.
35
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
36
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
37
+ # not rounded to a token block.
38
38
  sig { returns(T.nilable(OpenAI::Responses::ResponseInputImageContent::PromptCacheBreakpoint)) }
39
39
  attr_reader :prompt_cache_breakpoint
40
40
 
@@ -80,9 +80,9 @@ module OpenAI
80
80
  # encoded image in a data URL.
81
81
  image_url: nil,
82
82
 
83
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
84
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
85
- # token block.
83
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
84
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
85
+ # not rounded to a token block.
86
86
  prompt_cache_breakpoint: nil,
87
87
 
88
88
  # The type of the input item. Always `input_image`.
@@ -144,9 +144,9 @@ module OpenAI
144
144
  sig { params(ttl: OpenAI::Responses::ResponseInputImageContent::PromptCacheBreakpoint::Ttl::OrSymbol).void }
145
145
  attr_writer :ttl
146
146
 
147
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
148
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
149
- # token block.
147
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
148
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
149
+ # not rounded to a token block.
150
150
  sig do
151
151
  params(
152
152
 
@@ -22,9 +22,9 @@ module OpenAI
22
22
  sig { returns(Symbol) }
23
23
  attr_accessor :type
24
24
 
25
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
26
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
27
- # token block.
25
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
26
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
27
+ # not rounded to a token block.
28
28
  sig { returns(T.nilable(OpenAI::Responses::ResponseInputText::PromptCacheBreakpoint)) }
29
29
  attr_reader :prompt_cache_breakpoint
30
30
 
@@ -50,9 +50,9 @@ module OpenAI
50
50
  # The text input to the model.
51
51
  text:,
52
52
 
53
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
54
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
55
- # token block.
53
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
54
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
55
+ # not rounded to a token block.
56
56
  prompt_cache_breakpoint: nil,
57
57
 
58
58
  # The type of the input item. Always `input_text`.
@@ -92,9 +92,9 @@ module OpenAI
92
92
  sig { params(ttl: OpenAI::Responses::ResponseInputText::PromptCacheBreakpoint::Ttl::OrSymbol).void }
93
93
  attr_writer :ttl
94
94
 
95
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
96
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
97
- # token block.
95
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
96
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
97
+ # not rounded to a token block.
98
98
  sig do
99
99
  params(
100
100
 
@@ -22,9 +22,9 @@ module OpenAI
22
22
  sig { returns(Symbol) }
23
23
  attr_accessor :type
24
24
 
25
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
26
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
27
- # token block.
25
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
26
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
27
+ # not rounded to a token block.
28
28
  sig { returns(T.nilable(OpenAI::Responses::ResponseInputTextContent::PromptCacheBreakpoint)) }
29
29
  attr_reader :prompt_cache_breakpoint
30
30
 
@@ -57,9 +57,9 @@ module OpenAI
57
57
  # The text input to the model.
58
58
  text:,
59
59
 
60
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
61
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
62
- # token block.
60
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
61
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
62
+ # not rounded to a token block.
63
63
  prompt_cache_breakpoint: nil,
64
64
 
65
65
  # The type of the input item. Always `input_text`.
@@ -99,9 +99,9 @@ module OpenAI
99
99
  sig { params(ttl: OpenAI::Responses::ResponseInputTextContent::PromptCacheBreakpoint::Ttl::OrSymbol).void }
100
100
  attr_writer :ttl
101
101
 
102
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
103
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
104
- # token block.
102
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
103
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
104
+ # not rounded to a token block.
105
105
  sig do
106
106
  params(
107
107
 
@@ -55,14 +55,14 @@ module OpenAI
55
55
  # The name of the file to be sent to the model.
56
56
  def filename=: (String) -> String
57
57
 
58
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
59
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
60
- # token block.
58
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
59
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
60
+ # not rounded to a token block.
61
61
  attr_reader prompt_cache_breakpoint: OpenAI::Beta::BetaResponseInputFile::PromptCacheBreakpoint?
62
62
 
63
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
64
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
65
- # token block.
63
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
64
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
65
+ # not rounded to a token block.
66
66
  def prompt_cache_breakpoint=: (
67
67
  OpenAI::Beta::BetaResponseInputFile::PromptCacheBreakpoint
68
68
  ) -> OpenAI::Beta::BetaResponseInputFile::PromptCacheBreakpoint
@@ -82,9 +82,9 @@ module OpenAI
82
82
  # @param filename
83
83
  # The name of the file to be sent to the model.
84
84
  # @param prompt_cache_breakpoint
85
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
86
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
87
- # token block.
85
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
86
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
87
+ # not rounded to a token block.
88
88
  # @param type
89
89
  # The type of the input item. Always `input_file`.
90
90
  def initialize: (
@@ -46,9 +46,9 @@ module OpenAI
46
46
  # The name of the file to be sent to the model.
47
47
  attr_accessor filename: String?
48
48
 
49
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
50
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
51
- # token block.
49
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
50
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
51
+ # not rounded to a token block.
52
52
  attr_accessor prompt_cache_breakpoint: OpenAI::Beta::BetaResponseInputFileContent::PromptCacheBreakpoint?
53
53
 
54
54
  # @param detail
@@ -66,9 +66,9 @@ module OpenAI
66
66
  # @param filename
67
67
  # The name of the file to be sent to the model.
68
68
  # @param prompt_cache_breakpoint
69
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
70
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
71
- # token block.
69
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
70
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
71
+ # not rounded to a token block.
72
72
  # @param type
73
73
  # The type of the input item. Always `input_file`.
74
74
  def initialize: (
@@ -27,14 +27,14 @@ module OpenAI
27
27
  # encoded image in a data URL.
28
28
  attr_accessor image_url: String?
29
29
 
30
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
31
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
32
- # token block.
30
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
31
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
32
+ # not rounded to a token block.
33
33
  attr_reader prompt_cache_breakpoint: OpenAI::Beta::BetaResponseInputImage::PromptCacheBreakpoint?
34
34
 
35
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
36
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
37
- # token block.
35
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
36
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
37
+ # not rounded to a token block.
38
38
  def prompt_cache_breakpoint=: (
39
39
  OpenAI::Beta::BetaResponseInputImage::PromptCacheBreakpoint
40
40
  ) -> OpenAI::Beta::BetaResponseInputImage::PromptCacheBreakpoint
@@ -48,9 +48,9 @@ module OpenAI
48
48
  # The URL of the image to be sent to the model. A fully qualified URL or base64
49
49
  # encoded image in a data URL.
50
50
  # @param prompt_cache_breakpoint
51
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
52
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
53
- # token block.
51
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
52
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
53
+ # not rounded to a token block.
54
54
  # @param type
55
55
  # The type of the input item. Always `input_image`.
56
56
  def initialize: (
@@ -27,9 +27,9 @@ module OpenAI
27
27
  # encoded image in a data URL.
28
28
  attr_accessor image_url: String?
29
29
 
30
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
31
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
32
- # token block.
30
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
31
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
32
+ # not rounded to a token block.
33
33
  attr_accessor prompt_cache_breakpoint: OpenAI::Beta::BetaResponseInputImageContent::PromptCacheBreakpoint?
34
34
 
35
35
  # @param detail
@@ -41,9 +41,9 @@ module OpenAI
41
41
  # The URL of the image to be sent to the model. A fully qualified URL or base64
42
42
  # encoded image in a data URL.
43
43
  # @param prompt_cache_breakpoint
44
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
45
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
46
- # token block.
44
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
45
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
46
+ # not rounded to a token block.
47
47
  # @param type
48
48
  # The type of the input item. Always `input_image`.
49
49
  def initialize: (
@@ -17,14 +17,14 @@ module OpenAI
17
17
  # The type of the input item. Always `input_text`.
18
18
  attr_accessor type: :input_text
19
19
 
20
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
21
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
22
- # token block.
20
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
21
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
22
+ # not rounded to a token block.
23
23
  attr_reader prompt_cache_breakpoint: OpenAI::Beta::BetaResponseInputText::PromptCacheBreakpoint?
24
24
 
25
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
26
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
27
- # token block.
25
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
26
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
27
+ # not rounded to a token block.
28
28
  def prompt_cache_breakpoint=: (
29
29
  OpenAI::Beta::BetaResponseInputText::PromptCacheBreakpoint
30
30
  ) -> OpenAI::Beta::BetaResponseInputText::PromptCacheBreakpoint
@@ -32,9 +32,9 @@ module OpenAI
32
32
  # @param text
33
33
  # The text input to the model.
34
34
  # @param prompt_cache_breakpoint
35
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
36
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
37
- # token block.
35
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
36
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
37
+ # not rounded to a token block.
38
38
  # @param type
39
39
  # The type of the input item. Always `input_text`.
40
40
  def initialize: (
@@ -17,17 +17,17 @@ module OpenAI
17
17
  # The type of the input item. Always `input_text`.
18
18
  attr_accessor type: :input_text
19
19
 
20
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
21
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
22
- # token block.
20
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
21
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
22
+ # not rounded to a token block.
23
23
  attr_accessor prompt_cache_breakpoint: OpenAI::Beta::BetaResponseInputTextContent::PromptCacheBreakpoint?
24
24
 
25
25
  # @param text
26
26
  # The text input to the model.
27
27
  # @param prompt_cache_breakpoint
28
- # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
29
- # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
30
- # token block.
28
+ # Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
29
+ # breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
30
+ # not rounded to a token block.
31
31
  # @param type
32
32
  # The type of the input item. Always `input_text`.
33
33
  def initialize: (