Class: OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/chatkit/chatkit_response_output_text.rb

Defined Under Namespace

Modules: Annotation

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

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

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

#initialize(annotations: , text: , type: :output_text) ⇒ Object

Assistant response text accompanied by optional annotations.

Parameters:




# File 'lib/openai/models/beta/chatkit/chatkit_response_output_text.rb', line 27

Instance Attribute Details

#annotations ⇒ Array<OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File, OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL>

Ordered list of annotations attached to the response text.

Returns:



12
13
 
# File 'lib/openai/models/beta/chatkit/chatkit_response_output_text.rb', line 12

required :annotations,
-> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation] }

#text ⇒ String

Assistant generated text.

Returns:

  • (String) 


19
 
# File 'lib/openai/models/beta/chatkit/chatkit_response_output_text.rb', line 19

required :text, String

#type ⇒ Symbol, :output_text

Type discriminator that is always ‘output_text`.

Returns:

  • (Symbol, :output_text) 


25
 
# File 'lib/openai/models/beta/chatkit/chatkit_response_output_text.rb', line 25

required :type, const: :output_text