Class: Telnyx::Models::AI::OpenAICreateResponseParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/ai/openai_create_response_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(conversation: nil, input: nil, instructions: nil, model: nil, stream: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::AI::OpenAICreateResponseParams for more details.

Parameters:

  • conversation (String) (defaults to: nil) —

    Optional Telnyx Conversation ID from ‘POST /ai/conversations`. When provided, Te

  • input (Object) (defaults to: nil) —

    The input items for this turn, using the OpenAI Responses API input format.

  • instructions (String) (defaults to: nil) —

    Optional system/developer instructions for the model. When used with a persisted

  • model (String) (defaults to: nil) —

    Model identifier to use for the response, for example ‘zai-org/GLM-5.1-FP8` or a

  • stream (Boolean) (defaults to: nil) —

    Set to ‘true` to stream Server-Sent Events, matching OpenAI’s Responses streamin

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/telnyx/models/ai/openai_create_response_params.rb', line 48

Instance Attribute Details

#conversation ⇒ String?

Optional Telnyx Conversation ID from ‘POST /ai/conversations`. When provided, Telnyx stores this turn on that conversation and uses the conversation’s prior messages as context. Reuse the same ID for subsequent turns and tool-result followups. Omit it for a non-persisted, stateless response.

Returns:

  • (String, nil) 


18
 
# File 'lib/telnyx/models/ai/openai_create_response_params.rb', line 18

optional :conversation, String

#input ⇒ Object?

The input items for this turn, using the OpenAI Responses API input format.

Returns:

  • (Object, nil) 


24
 
# File 'lib/telnyx/models/ai/openai_create_response_params.rb', line 24

optional :input, Telnyx::Internal::Type::Unknown

#instructions ⇒ String?

Optional system/developer instructions for the model. When used with a persisted ‘conversation`, send these on the first request that creates the thread; subsequent turns can rely on the stored history.

Returns:

  • (String, nil) 


32
 
# File 'lib/telnyx/models/ai/openai_create_response_params.rb', line 32

optional :instructions, String

#model ⇒ String?

Model identifier to use for the response, for example ‘zai-org/GLM-5.1-FP8` or another model available from the Telnyx OpenAI-compatible models endpoint.

Returns:

  • (String, nil) 


39
 
# File 'lib/telnyx/models/ai/openai_create_response_params.rb', line 39

optional :model, String

#stream ⇒ Boolean?

Set to ‘true` to stream Server-Sent Events, matching OpenAI’s Responses streaming format.

Returns:

  • (Boolean, nil) 


46
 
# File 'lib/telnyx/models/ai/openai_create_response_params.rb', line 46

optional :stream, Telnyx::Internal::Type::Boolean