openai 0.121.0 → 0.122.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ce7067efbf60066bd6974ff82a38884ef04c19d4721f00611d54dc1b1875a4b3
4
- data.tar.gz: 4068623e1e610b9b5c8ba531082c2a8be68e120a8e40281ab8a712700de55b93
3
+ metadata.gz: e626227e1b39d49f4cd4a67ca94f7620f6f9754869c3c0dc0d49d0ae4bee5112
4
+ data.tar.gz: ecea01c3956430baa9b93d1a303ccd6f13e005ccadd9187700d9e1952dc5057d
5
5
  SHA512:
6
- metadata.gz: ab69834a768a327fdc77f87b33d15842b5d8e1c467cf1c00b5ebdeea655dda7e46b823ad4dfc5dd9ef829445a7fbeec866cbb854c24b8f5cec4ca55473582637
7
- data.tar.gz: c3da784e892417ca10617d6b590fdecce3657f6dbf0468fef0942a144dda638b7e468c98fd3fdd7b4b0a54fdf1cc9e90e09a665bdb627804eba62fe64161314a
6
+ metadata.gz: 9c1d4813c21265f186456dde40358658eb9ea44bc70eb26b13831de047c7dbd40183b99761d173367d3c4b3ac4dffe944ed0e74041b810a66a87225c17691b55
7
+ data.tar.gz: a3acd477371f52e953e0768c2ca35942d09bd71ac7a2c413ebfdf65fb2d4926597425734a817676f68e5b50b50f808f18db48b94b50289094c8b8e524e01f678
data/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.122.0](https://github.com/openai/openai-ruby/compare/v0.121.0...v0.122.0) (2026-11-10)
4
+
5
+
6
+ ### Features
7
+
8
+ * **api:** typed async fields for Managed Agents function tools ([#1052](https://github.com/openai/openai-ruby/issues/1052)) ([80ebb2c](https://github.com/openai/openai-ruby/commit/80ebb2cde00f39e19fe962fd2c54380af2068116))
9
+
3
10
  ## [0.121.0](https://github.com/openai/openai-ruby/compare/v0.120.0...v0.121.0) (2026-11-07)
4
11
 
5
12
 
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "openai", "~> 0.121.0"
18
+ gem "openai", "~> 0.122.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -58,7 +58,13 @@ module OpenAI
58
58
  # @return [Symbol, :function]
59
59
  required :type, const: :function
60
60
 
61
- # @!method initialize(defer_loading:, description:, name:, parameters:, type: :function)
61
+ # @!attribute async
62
+ # Whether the agent continues without waiting for the function result.
63
+ #
64
+ # @return [Boolean, nil]
65
+ optional :async, OpenAI::Internal::Type::Boolean
66
+
67
+ # @!method initialize(defer_loading:, description:, name:, parameters:, async: nil, type: :function)
62
68
  # A function defined by the application.
63
69
  #
64
70
  # @param defer_loading [Boolean]
@@ -73,6 +79,9 @@ module OpenAI
73
79
  # @param parameters [Hash{Symbol=>Object}]
74
80
  # A JSON Schema object describing the function's arguments.
75
81
  #
82
+ # @param async [Boolean]
83
+ # Whether the agent continues without waiting for the function result.
84
+ #
76
85
  # @param type [Symbol, :function]
77
86
  # The type of the object. Always `function`.
78
87
  end
@@ -55,6 +55,13 @@ module OpenAI
55
55
  # @return [Symbol, :function]
56
56
  required :type, const: :function
57
57
 
58
+ # @!attribute async
59
+ # Whether the agent continues without waiting for the function result. Defaults to
60
+ # `false`.
61
+ #
62
+ # @return [Boolean, nil]
63
+ optional :async, OpenAI::Internal::Type::Boolean
64
+
58
65
  # @!attribute defer_loading
59
66
  # Whether this function is deferred and discovered through tool search. Defaults
60
67
  # to `false`.
@@ -62,7 +69,7 @@ module OpenAI
62
69
  # @return [Boolean, nil]
63
70
  optional :defer_loading, OpenAI::Internal::Type::Boolean
64
71
 
65
- # @!method initialize(description:, name:, parameters:, defer_loading: nil, type: :function)
72
+ # @!method initialize(description:, name:, parameters:, async: nil, defer_loading: nil, type: :function)
66
73
  # A function defined by the application.
67
74
  #
68
75
  # @param description [String]
@@ -74,6 +81,10 @@ module OpenAI
74
81
  # @param parameters [Hash{Symbol=>Object}]
75
82
  # A JSON Schema object describing the function's arguments.
76
83
  #
84
+ # @param async [Boolean]
85
+ # Whether the agent continues without waiting for the function result. Defaults to
86
+ # `false`.
87
+ #
77
88
  # @param defer_loading [Boolean]
78
89
  # Whether this function is deferred and discovered through tool search. Defaults
79
90
  # to `false`.
@@ -61,7 +61,13 @@ module OpenAI
61
61
  # @return [Symbol, :function]
62
62
  required :type, const: :function
63
63
 
64
- # @!method initialize(defer_loading:, description:, name:, parameters:, type: :function)
64
+ # @!attribute async
65
+ # Whether the agent continues without waiting for the function result.
66
+ #
67
+ # @return [Boolean, nil]
68
+ optional :async, OpenAI::Internal::Type::Boolean
69
+
70
+ # @!method initialize(defer_loading:, description:, name:, parameters:, async: nil, type: :function)
65
71
  # A function defined by the application.
66
72
  #
67
73
  # @param defer_loading [Boolean]
@@ -76,6 +82,9 @@ module OpenAI
76
82
  # @param parameters [Hash{Symbol=>Object}]
77
83
  # A JSON Schema object describing the function's arguments.
78
84
  #
85
+ # @param async [Boolean]
86
+ # Whether the agent continues without waiting for the function result.
87
+ #
79
88
  # @param type [Symbol, :function]
80
89
  # The type of the object. Always `function`.
81
90
  end
@@ -55,6 +55,13 @@ module OpenAI
55
55
  # @return [Symbol, :function]
56
56
  required :type, const: :function
57
57
 
58
+ # @!attribute async
59
+ # Whether the agent continues without waiting for the function result. Defaults to
60
+ # `false`.
61
+ #
62
+ # @return [Boolean, nil]
63
+ optional :async, OpenAI::Internal::Type::Boolean
64
+
58
65
  # @!attribute defer_loading
59
66
  # Whether this function is deferred and discovered through tool search. Defaults
60
67
  # to `false`.
@@ -62,7 +69,7 @@ module OpenAI
62
69
  # @return [Boolean, nil]
63
70
  optional :defer_loading, OpenAI::Internal::Type::Boolean
64
71
 
65
- # @!method initialize(description:, name:, parameters:, defer_loading: nil, type: :function)
72
+ # @!method initialize(description:, name:, parameters:, async: nil, defer_loading: nil, type: :function)
66
73
  # A function defined by the application.
67
74
  #
68
75
  # @param description [String]
@@ -74,6 +81,10 @@ module OpenAI
74
81
  # @param parameters [Hash{Symbol=>Object}]
75
82
  # A JSON Schema object describing the function's arguments.
76
83
  #
84
+ # @param async [Boolean]
85
+ # Whether the agent continues without waiting for the function result. Defaults to
86
+ # `false`.
87
+ #
77
88
  # @param defer_loading [Boolean]
78
89
  # Whether this function is deferred and discovered through tool search. Defaults
79
90
  # to `false`.
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module OpenAI
4
- VERSION = "0.121.0"
4
+ VERSION = "0.122.0"
5
5
  end
@@ -48,6 +48,13 @@ module OpenAI
48
48
  sig { returns(Symbol) }
49
49
  attr_accessor :type
50
50
 
51
+ # Whether the agent continues without waiting for the function result.
52
+ sig { returns(T.nilable(T::Boolean)) }
53
+ attr_reader :async
54
+
55
+ sig { params(async: T::Boolean).void }
56
+ attr_writer :async
57
+
51
58
  # A function defined by the application.
52
59
  sig do
53
60
  params(
@@ -60,6 +67,8 @@ module OpenAI
60
67
 
61
68
  parameters: T::Hash[Symbol, T.anything],
62
69
 
70
+ async: T::Boolean,
71
+
63
72
  type: Symbol
64
73
  )
65
74
  .returns(T.attached_class)
@@ -78,6 +87,9 @@ module OpenAI
78
87
  # A JSON Schema object describing the function's arguments.
79
88
  parameters:,
80
89
 
90
+ # Whether the agent continues without waiting for the function result.
91
+ async: nil,
92
+
81
93
  # The type of the object. Always `function`.
82
94
 
83
95
  type: :function
@@ -91,7 +103,8 @@ module OpenAI
91
103
  description: String,
92
104
  name: String,
93
105
  parameters: T::Hash[Symbol, T.anything],
94
- type: Symbol
106
+ type: Symbol,
107
+ async: T::Boolean
95
108
  }
96
109
  )
97
110
  end
@@ -45,6 +45,14 @@ module OpenAI
45
45
  sig { returns(Symbol) }
46
46
  attr_accessor :type
47
47
 
48
+ # Whether the agent continues without waiting for the function result. Defaults to
49
+ # `false`.
50
+ sig { returns(T.nilable(T::Boolean)) }
51
+ attr_reader :async
52
+
53
+ sig { params(async: T::Boolean).void }
54
+ attr_writer :async
55
+
48
56
  # Whether this function is deferred and discovered through tool search. Defaults
49
57
  # to `false`.
50
58
  sig { returns(T.nilable(T::Boolean)) }
@@ -63,6 +71,8 @@ module OpenAI
63
71
 
64
72
  parameters: T::Hash[Symbol, T.anything],
65
73
 
74
+ async: T::Boolean,
75
+
66
76
  defer_loading: T::Boolean,
67
77
 
68
78
  type: Symbol
@@ -80,6 +90,10 @@ module OpenAI
80
90
  # A JSON Schema object describing the function's arguments.
81
91
  parameters:,
82
92
 
93
+ # Whether the agent continues without waiting for the function result. Defaults to
94
+ # `false`.
95
+ async: nil,
96
+
83
97
  # Whether this function is deferred and discovered through tool search. Defaults
84
98
  # to `false`.
85
99
  defer_loading: nil,
@@ -97,6 +111,7 @@ module OpenAI
97
111
  name: String,
98
112
  parameters: T::Hash[Symbol, T.anything],
99
113
  type: Symbol,
114
+ async: T::Boolean,
100
115
  defer_loading: T::Boolean
101
116
  }
102
117
  )
@@ -49,6 +49,13 @@ module OpenAI
49
49
  sig { returns(Symbol) }
50
50
  attr_accessor :type
51
51
 
52
+ # Whether the agent continues without waiting for the function result.
53
+ sig { returns(T.nilable(T::Boolean)) }
54
+ attr_reader :async
55
+
56
+ sig { params(async: T::Boolean).void }
57
+ attr_writer :async
58
+
52
59
  # A function defined by the application.
53
60
  sig do
54
61
  params(
@@ -61,6 +68,8 @@ module OpenAI
61
68
 
62
69
  parameters: T::Hash[Symbol, T.anything],
63
70
 
71
+ async: T::Boolean,
72
+
64
73
  type: Symbol
65
74
  )
66
75
  .returns(T.attached_class)
@@ -79,6 +88,9 @@ module OpenAI
79
88
  # A JSON Schema object describing the function's arguments.
80
89
  parameters:,
81
90
 
91
+ # Whether the agent continues without waiting for the function result.
92
+ async: nil,
93
+
82
94
  # The type of the object. Always `function`.
83
95
 
84
96
  type: :function
@@ -92,7 +104,8 @@ module OpenAI
92
104
  description: String,
93
105
  name: String,
94
106
  parameters: T::Hash[Symbol, T.anything],
95
- type: Symbol
107
+ type: Symbol,
108
+ async: T::Boolean
96
109
  }
97
110
  )
98
111
  end
@@ -45,6 +45,14 @@ module OpenAI
45
45
  sig { returns(Symbol) }
46
46
  attr_accessor :type
47
47
 
48
+ # Whether the agent continues without waiting for the function result. Defaults to
49
+ # `false`.
50
+ sig { returns(T.nilable(T::Boolean)) }
51
+ attr_reader :async
52
+
53
+ sig { params(async: T::Boolean).void }
54
+ attr_writer :async
55
+
48
56
  # Whether this function is deferred and discovered through tool search. Defaults
49
57
  # to `false`.
50
58
  sig { returns(T.nilable(T::Boolean)) }
@@ -63,6 +71,8 @@ module OpenAI
63
71
 
64
72
  parameters: T::Hash[Symbol, T.anything],
65
73
 
74
+ async: T::Boolean,
75
+
66
76
  defer_loading: T::Boolean,
67
77
 
68
78
  type: Symbol
@@ -80,6 +90,10 @@ module OpenAI
80
90
  # A JSON Schema object describing the function's arguments.
81
91
  parameters:,
82
92
 
93
+ # Whether the agent continues without waiting for the function result. Defaults to
94
+ # `false`.
95
+ async: nil,
96
+
83
97
  # Whether this function is deferred and discovered through tool search. Defaults
84
98
  # to `false`.
85
99
  defer_loading: nil,
@@ -97,6 +111,7 @@ module OpenAI
97
111
  name: String,
98
112
  parameters: T::Hash[Symbol, T.anything],
99
113
  type: Symbol,
114
+ async: T::Boolean,
100
115
  defer_loading: T::Boolean
101
116
  }
102
117
  )
@@ -18,7 +18,8 @@ module OpenAI
18
18
  description: String,
19
19
  name: String,
20
20
  parameters: ::Hash[Symbol, top],
21
- ?type: :function
21
+ ?type: :function,
22
+ ?async: bool
22
23
  }
23
24
 
24
25
  class Function < OpenAI::Internal::Type::BaseModel
@@ -37,6 +38,12 @@ module OpenAI
37
38
  # The type of the object. Always `function`.
38
39
  attr_accessor type: :function
39
40
 
41
+ # Whether the agent continues without waiting for the function result.
42
+ attr_reader async: bool?
43
+
44
+ # Whether the agent continues without waiting for the function result.
45
+ def async=: (bool) -> bool
46
+
40
47
  # @param defer_loading
41
48
  # Whether the function is deferred and discovered through tool search.
42
49
  # @param description
@@ -45,6 +52,8 @@ module OpenAI
45
52
  # The name of the function.
46
53
  # @param parameters
47
54
  # A JSON Schema object describing the function's arguments.
55
+ # @param async
56
+ # Whether the agent continues without waiting for the function result.
48
57
  # @param type
49
58
  # The type of the object. Always `function`.
50
59
  def initialize: (
@@ -52,6 +61,7 @@ module OpenAI
52
61
  description: String,
53
62
  name: String,
54
63
  parameters: ::Hash[Symbol, top],
64
+ ?async: bool,
55
65
  ?type: :function
56
66
  ) -> void
57
67
 
@@ -60,7 +70,8 @@ module OpenAI
60
70
  description: String,
61
71
  name: String,
62
72
  parameters: ::Hash[Symbol, top],
63
- ?type: :function
73
+ ?type: :function,
74
+ ?async: bool
64
75
  }
65
76
  end
66
77
 
@@ -19,6 +19,7 @@ module OpenAI
19
19
  name: String,
20
20
  parameters: ::Hash[Symbol, top],
21
21
  ?type: :function,
22
+ ?async: bool,
22
23
  ?defer_loading: bool
23
24
  }
24
25
 
@@ -35,6 +36,14 @@ module OpenAI
35
36
  # The type of the object. Always `function`.
36
37
  attr_accessor type: :function
37
38
 
39
+ # Whether the agent continues without waiting for the function result. Defaults to
40
+ # `false`.
41
+ attr_reader async: bool?
42
+
43
+ # Whether the agent continues without waiting for the function result. Defaults to
44
+ # `false`.
45
+ def async=: (bool) -> bool
46
+
38
47
  # Whether this function is deferred and discovered through tool search. Defaults
39
48
  # to `false`.
40
49
  attr_reader defer_loading: bool?
@@ -49,6 +58,9 @@ module OpenAI
49
58
  # The name of the function.
50
59
  # @param parameters
51
60
  # A JSON Schema object describing the function's arguments.
61
+ # @param async
62
+ # Whether the agent continues without waiting for the function result. Defaults to
63
+ # `false`.
52
64
  # @param defer_loading
53
65
  # Whether this function is deferred and discovered through tool search. Defaults
54
66
  # to `false`.
@@ -58,6 +70,7 @@ module OpenAI
58
70
  description: String,
59
71
  name: String,
60
72
  parameters: ::Hash[Symbol, top],
73
+ ?async: bool,
61
74
  ?defer_loading: bool,
62
75
  ?type: :function
63
76
  ) -> void
@@ -67,6 +80,7 @@ module OpenAI
67
80
  name: String,
68
81
  parameters: ::Hash[Symbol, top],
69
82
  ?type: :function,
83
+ ?async: bool,
70
84
  ?defer_loading: bool
71
85
  }
72
86
  end
@@ -19,7 +19,8 @@ module OpenAI
19
19
  description: String,
20
20
  name: String,
21
21
  parameters: ::Hash[Symbol, top],
22
- ?type: :function
22
+ ?type: :function,
23
+ ?async: bool
23
24
  }
24
25
 
25
26
  class Function < OpenAI::Internal::Type::BaseModel
@@ -38,6 +39,12 @@ module OpenAI
38
39
  # The type of the object. Always `function`.
39
40
  attr_accessor type: :function
40
41
 
42
+ # Whether the agent continues without waiting for the function result.
43
+ attr_reader async: bool?
44
+
45
+ # Whether the agent continues without waiting for the function result.
46
+ def async=: (bool) -> bool
47
+
41
48
  # @param defer_loading
42
49
  # Whether the function is deferred and discovered through tool search.
43
50
  # @param description
@@ -46,6 +53,8 @@ module OpenAI
46
53
  # The name of the function.
47
54
  # @param parameters
48
55
  # A JSON Schema object describing the function's arguments.
56
+ # @param async
57
+ # Whether the agent continues without waiting for the function result.
49
58
  # @param type
50
59
  # The type of the object. Always `function`.
51
60
  def initialize: (
@@ -53,6 +62,7 @@ module OpenAI
53
62
  description: String,
54
63
  name: String,
55
64
  parameters: ::Hash[Symbol, top],
65
+ ?async: bool,
56
66
  ?type: :function
57
67
  ) -> void
58
68
 
@@ -61,7 +71,8 @@ module OpenAI
61
71
  description: String,
62
72
  name: String,
63
73
  parameters: ::Hash[Symbol, top],
64
- ?type: :function
74
+ ?type: :function,
75
+ ?async: bool
65
76
  }
66
77
  end
67
78
 
@@ -19,6 +19,7 @@ module OpenAI
19
19
  name: String,
20
20
  parameters: ::Hash[Symbol, top],
21
21
  ?type: :function,
22
+ ?async: bool,
22
23
  ?defer_loading: bool
23
24
  }
24
25
 
@@ -35,6 +36,14 @@ module OpenAI
35
36
  # The type of the object. Always `function`.
36
37
  attr_accessor type: :function
37
38
 
39
+ # Whether the agent continues without waiting for the function result. Defaults to
40
+ # `false`.
41
+ attr_reader async: bool?
42
+
43
+ # Whether the agent continues without waiting for the function result. Defaults to
44
+ # `false`.
45
+ def async=: (bool) -> bool
46
+
38
47
  # Whether this function is deferred and discovered through tool search. Defaults
39
48
  # to `false`.
40
49
  attr_reader defer_loading: bool?
@@ -49,6 +58,9 @@ module OpenAI
49
58
  # The name of the function.
50
59
  # @param parameters
51
60
  # A JSON Schema object describing the function's arguments.
61
+ # @param async
62
+ # Whether the agent continues without waiting for the function result. Defaults to
63
+ # `false`.
52
64
  # @param defer_loading
53
65
  # Whether this function is deferred and discovered through tool search. Defaults
54
66
  # to `false`.
@@ -58,6 +70,7 @@ module OpenAI
58
70
  description: String,
59
71
  name: String,
60
72
  parameters: ::Hash[Symbol, top],
73
+ ?async: bool,
61
74
  ?defer_loading: bool,
62
75
  ?type: :function
63
76
  ) -> void
@@ -67,6 +80,7 @@ module OpenAI
67
80
  name: String,
68
81
  parameters: ::Hash[Symbol, top],
69
82
  ?type: :function,
83
+ ?async: bool,
70
84
  ?defer_loading: bool
71
85
  }
72
86
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: openai
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.121.0
4
+ version: 0.122.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - OpenAI