Module: Cerca::Models::ThreadStreamEvent::ThreadStreamContentMessage::Message::Content

Extended by:
Internal::Type::Union
Defined in:
lib/cerca/models/thread_stream_event.rb

Defined Under Namespace

Classes: ServerToolUse, Text, ToolResult, ToolUse, WebSearchToolResult

Instance Method Summary collapse

Methods included from Internal::Type::Union

==, ===, coerce, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Instance Method Details

#initialize(id:, input:, name:, provider_metadata: nil, type: :server_tool_use) ⇒ Object

Some parameter documentations has been truncated, see ServerToolUse for more details.

Parameters:

  • id (String)
  • input (String) —

    JSON-serialized tool input payload. Parse as JSON before reading tool-specific f

  • name (String)
  • provider_metadata (Hash{Symbol=>Hash{Symbol=>String}}) (defaults to: nil)
  • type (Symbol, :server_tool_use) (defaults to: :server_tool_use) 


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/cerca/models/thread_stream_event.rb', line 151

module Content
  extend Cerca::Internal::Type::Union

  discriminator :type

  variant :text, -> { Cerca::ThreadStreamEvent::ThreadStreamContentMessage::Message::Content::Text }

  variant :tool_use, -> { Cerca::ThreadStreamEvent::ThreadStreamContentMessage::Message::Content::ToolUse }

  variant :tool_result,
          -> { Cerca::ThreadStreamEvent::ThreadStreamContentMessage::Message::Content::ToolResult }

  variant :server_tool_use,
          -> { Cerca::ThreadStreamEvent::ThreadStreamContentMessage::Message::Content::ServerToolUse }

  variant :web_search_tool_result,
          -> { Cerca::ThreadStreamEvent::ThreadStreamContentMessage::Message::Content::WebSearchToolResult }

  class Text < Cerca::Internal::Type::BaseModel
    # @!attribute text
    #
    #   @return [String]
    required :text, String

    # @!attribute type
    #
    #   @return [Symbol, :text]
    required :type, const: :text

    # @!attribute provider_metadata
    #
    #   @return [Hash{Symbol=>Hash{Symbol=>String}}, nil]
    optional :provider_metadata,
             Cerca::Internal::Type::HashOf[Cerca::Internal::Type::HashOf[String]],
             api_name: :providerMetadata

    # @!method initialize(text:, provider_metadata: nil, type: :text)
    #   @param text [String]
    #   @param provider_metadata [Hash{Symbol=>Hash{Symbol=>String}}]
    #   @param type [Symbol, :text]
  end

  class ToolUse < Cerca::Internal::Type::BaseModel
    # @!attribute id
    #
    #   @return [String]
    required :id, String

    # @!attribute input
    #   JSON-serialized tool input payload. Parse as JSON before reading tool-specific
    #   fields.
    #
    #   @return [String]
    required :input, String

    # @!attribute name
    #
    #   @return [Symbol, Cerca::Models::ToolName]
    required :name, enum: -> { Cerca::ToolName }

    # @!attribute type
    #
    #   @return [Symbol, :tool_use]
    required :type, const: :tool_use

    # @!attribute provider_metadata
    #
    #   @return [Hash{Symbol=>Hash{Symbol=>String}}, nil]
    optional :provider_metadata,
             Cerca::Internal::Type::HashOf[Cerca::Internal::Type::HashOf[String]],
             api_name: :providerMetadata

    # @!method initialize(id:, input:, name:, provider_metadata: nil, type: :tool_use)
    #   Some parameter documentations has been truncated, see
    #   {Cerca::Models::ThreadStreamEvent::ThreadStreamContentMessage::Message::Content::ToolUse}
    #   for more details.
    #
    #   @param id [String]
    #
    #   @param input [String] JSON-serialized tool input payload. Parse as JSON before reading tool-specific f
    #
    #   @param name [Symbol, Cerca::Models::ToolName]
    #
    #   @param provider_metadata [Hash{Symbol=>Hash{Symbol=>String}}]
    #
    #   @param type [Symbol, :tool_use]
  end

  class ToolResult < Cerca::Internal::Type::BaseModel
    # @!attribute content
    #
    #   @return [String]
    required :content, String

    # @!attribute is_error
    #
    #   @return [Boolean]
    required :is_error, Cerca::Internal::Type::Boolean, api_name: :isError

    # @!attribute tool_use_id
    #
    #   @return [String]
    required :tool_use_id, String, api_name: :toolUseId

    # @!attribute type
    #
    #   @return [Symbol, :tool_result]
    required :type, const: :tool_result

    # @!attribute denied_by_user
    #
    #   @return [Boolean, nil]
    optional :denied_by_user, Cerca::Internal::Type::Boolean, api_name: :deniedByUser

    # @!attribute provider_metadata
    #
    #   @return [Hash{Symbol=>Hash{Symbol=>String}}, nil]
    optional :provider_metadata,
             Cerca::Internal::Type::HashOf[Cerca::Internal::Type::HashOf[String]],
             api_name: :providerMetadata

    # @!method initialize(content:, is_error:, tool_use_id:, denied_by_user: nil, provider_metadata: nil, type: :tool_result)
    #   @param content [String]
    #   @param is_error [Boolean]
    #   @param tool_use_id [String]
    #   @param denied_by_user [Boolean]
    #   @param provider_metadata [Hash{Symbol=>Hash{Symbol=>String}}]
    #   @param type [Symbol, :tool_result]
  end

  class ServerToolUse < Cerca::Internal::Type::BaseModel
    # @!attribute id
    #
    #   @return [String]
    required :id, String

    # @!attribute input
    #   JSON-serialized tool input payload. Parse as JSON before reading tool-specific
    #   fields.
    #
    #   @return [String]
    required :input, String

    # @!attribute name
    #
    #   @return [String]
    required :name, String

    # @!attribute type
    #
    #   @return [Symbol, :server_tool_use]
    required :type, const: :server_tool_use

    # @!attribute provider_metadata
    #
    #   @return [Hash{Symbol=>Hash{Symbol=>String}}, nil]
    optional :provider_metadata,
             Cerca::Internal::Type::HashOf[Cerca::Internal::Type::HashOf[String]],
             api_name: :providerMetadata

    # @!method initialize(id:, input:, name:, provider_metadata: nil, type: :server_tool_use)
    #   Some parameter documentations has been truncated, see
    #   {Cerca::Models::ThreadStreamEvent::ThreadStreamContentMessage::Message::Content::ServerToolUse}
    #   for more details.
    #
    #   @param id [String]
    #
    #   @param input [String] JSON-serialized tool input payload. Parse as JSON before reading tool-specific f
    #
    #   @param name [String]
    #
    #   @param provider_metadata [Hash{Symbol=>Hash{Symbol=>String}}]
    #
    #   @param type [Symbol, :server_tool_use]
  end

  class WebSearchToolResult < Cerca::Internal::Type::BaseModel
    # @!attribute content
    #   Web search result payload. The runtime returns either an array of web search
    #   results or an error object.
    #
    #   @return [Object]
    required :content, Cerca::Internal::Type::Unknown

    # @!attribute tool_use_id
    #
    #   @return [String]
    required :tool_use_id, String, api_name: :toolUseId

    # @!attribute type
    #
    #   @return [Symbol, :web_search_tool_result]
    required :type, const: :web_search_tool_result

    # @!method initialize(content:, tool_use_id:, type: :web_search_tool_result)
    #   Some parameter documentations has been truncated, see
    #   {Cerca::Models::ThreadStreamEvent::ThreadStreamContentMessage::Message::Content::WebSearchToolResult}
    #   for more details.
    #
    #   @param content [Object] Web search result payload. The runtime returns either an array of web search res
    #
    #   @param tool_use_id [String]
    #
    #   @param type [Symbol, :web_search_tool_result]
  end

  # @!method self.variants
  #   @return [Array(Cerca::Models::ThreadStreamEvent::ThreadStreamContentMessage::Message::Content::Text, Cerca::Models::ThreadStreamEvent::ThreadStreamContentMessage::Message::Content::ToolUse, Cerca::Models::ThreadStreamEvent::ThreadStreamContentMessage::Message::Content::ToolResult, Cerca::Models::ThreadStreamEvent::ThreadStreamContentMessage::Message::Content::ServerToolUse, Cerca::Models::ThreadStreamEvent::ThreadStreamContentMessage::Message::Content::WebSearchToolResult)]
end