in rbi/lib/openai/resources/responses.rbi [81:319]
def create(
input:,
model:,
include: nil,
instructions: nil,
max_output_tokens: nil,
metadata: nil,
parallel_tool_calls: nil,
previous_response_id: nil,
reasoning: nil,
service_tier: nil,
store: nil,
temperature: nil,
text: nil,
tool_choice: nil,
tools: nil,
top_p: nil,
truncation: nil,
user: nil,
stream: false,
request_options: {}
); end
sig do
params(
input: T.any(
String,
T::Array[
T.any(
OpenAI::Models::Responses::EasyInputMessage,
OpenAI::Internal::AnyHash,
OpenAI::Models::Responses::ResponseInputItem::Message,
OpenAI::Models::Responses::ResponseOutputMessage,
OpenAI::Models::Responses::ResponseFileSearchToolCall,
OpenAI::Models::Responses::ResponseComputerToolCall,
OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput,
OpenAI::Models::Responses::ResponseFunctionWebSearch,
OpenAI::Models::Responses::ResponseFunctionToolCall,
OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput,
OpenAI::Models::Responses::ResponseReasoningItem,
OpenAI::Models::Responses::ResponseInputItem::ItemReference
)
]
),
model: T.any(
String,
OpenAI::Models::ChatModel::OrSymbol,
OpenAI::Models::ResponsesModel::ResponsesOnlyModel::OrSymbol
),
include: T.nilable(T::Array[OpenAI::Models::Responses::ResponseIncludable::OrSymbol]),
instructions: T.nilable(String),
max_output_tokens: T.nilable(Integer),
metadata: T.nilable(T::Hash[Symbol, String]),
parallel_tool_calls: T.nilable(T::Boolean),
previous_response_id: T.nilable(String),
reasoning: T.nilable(T.any(OpenAI::Models::Reasoning, OpenAI::Internal::AnyHash)),
service_tier: T.nilable(OpenAI::Models::Responses::ResponseCreateParams::ServiceTier::OrSymbol),
store: T.nilable(T::Boolean),
temperature: T.nilable(Float),
text: T.any(OpenAI::Models::Responses::ResponseTextConfig, OpenAI::Internal::AnyHash),
tool_choice: T.any(
OpenAI::Models::Responses::ToolChoiceOptions::OrSymbol,
OpenAI::Models::Responses::ToolChoiceTypes,
OpenAI::Internal::AnyHash,
OpenAI::Models::Responses::ToolChoiceFunction
),
tools: T::Array[
T.any(
OpenAI::Models::Responses::FileSearchTool,
OpenAI::Internal::AnyHash,
OpenAI::Models::Responses::FunctionTool,
OpenAI::Models::Responses::ComputerTool,
OpenAI::Models::Responses::WebSearchTool
)
],
top_p: T.nilable(Float),
truncation: T.nilable(OpenAI::Models::Responses::ResponseCreateParams::Truncation::OrSymbol),
user: String,
stream: T.noreturn,
request_options: T.nilable(T.any(OpenAI::RequestOptions, OpenAI::Internal::AnyHash))
)
.returns(
OpenAI::Internal::Stream[
T.any(
OpenAI::Models::Responses::ResponseAudioDeltaEvent,
OpenAI::Models::Responses::ResponseAudioDoneEvent,
OpenAI::Models::Responses::ResponseAudioTranscriptDeltaEvent,
OpenAI::Models::Responses::ResponseAudioTranscriptDoneEvent,
OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent,
OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDoneEvent,
OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent,
OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent,
OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent,
OpenAI::Models::Responses::ResponseCompletedEvent,
OpenAI::Models::Responses::ResponseContentPartAddedEvent,
OpenAI::Models::Responses::ResponseContentPartDoneEvent,
OpenAI::Models::Responses::ResponseCreatedEvent,
OpenAI::Models::Responses::ResponseErrorEvent,
OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent,
OpenAI::Models::Responses::ResponseFileSearchCallInProgressEvent,
OpenAI::Models::Responses::ResponseFileSearchCallSearchingEvent,
OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent,
OpenAI::Models::Responses::ResponseFunctionCallArgumentsDoneEvent,
OpenAI::Models::Responses::ResponseInProgressEvent,
OpenAI::Models::Responses::ResponseFailedEvent,
OpenAI::Models::Responses::ResponseIncompleteEvent,
OpenAI::Models::Responses::ResponseOutputItemAddedEvent,
OpenAI::Models::Responses::ResponseOutputItemDoneEvent,
OpenAI::Models::Responses::ResponseRefusalDeltaEvent,
OpenAI::Models::Responses::ResponseRefusalDoneEvent,
OpenAI::Models::Responses::ResponseTextAnnotationDeltaEvent,
OpenAI::Models::Responses::ResponseTextDeltaEvent,
OpenAI::Models::Responses::ResponseTextDoneEvent,
OpenAI::Models::Responses::ResponseWebSearchCallCompletedEvent,
OpenAI::Models::Responses::ResponseWebSearchCallInProgressEvent,
OpenAI::Models::Responses::ResponseWebSearchCallSearchingEvent
)
]
)
end