Module: OpenAI::Internal::Type::RequestParameters Private

Included in:
Models::Audio::SpeechCreateParams, Models::Audio::TranscriptionCreateParams, Models::Audio::TranslationCreateParams, Models::BatchCancelParams, Models::BatchCreateParams, Models::BatchListParams, Models::BatchRetrieveParams, Models::Beta::AssistantCreateParams, Models::Beta::AssistantDeleteParams, Models::Beta::AssistantListParams, Models::Beta::AssistantRetrieveParams, Models::Beta::AssistantUpdateParams, Models::Beta::ThreadCreateAndRunParams, Models::Beta::ThreadCreateParams, Models::Beta::ThreadDeleteParams, Models::Beta::ThreadRetrieveParams, Models::Beta::ThreadUpdateParams, Models::Beta::Threads::MessageCreateParams, Models::Beta::Threads::MessageDeleteParams, Models::Beta::Threads::MessageListParams, Models::Beta::Threads::MessageRetrieveParams, Models::Beta::Threads::MessageUpdateParams, Models::Beta::Threads::RunCancelParams, Models::Beta::Threads::RunCreateParams, Models::Beta::Threads::RunListParams, Models::Beta::Threads::RunRetrieveParams, Models::Beta::Threads::RunSubmitToolOutputsParams, Models::Beta::Threads::RunUpdateParams, Models::Beta::Threads::Runs::StepListParams, Models::Beta::Threads::Runs::StepRetrieveParams, Models::Chat::CompletionCreateParams, Models::Chat::CompletionDeleteParams, Models::Chat::CompletionListParams, Models::Chat::CompletionRetrieveParams, Models::Chat::CompletionUpdateParams, Models::Chat::Completions::MessageListParams, Models::CompletionCreateParams, Models::ContainerCreateParams, Models::ContainerDeleteParams, Models::ContainerListParams, Models::ContainerRetrieveParams, Models::Containers::FileCreateParams, Models::Containers::FileDeleteParams, Models::Containers::FileListParams, Models::Containers::FileRetrieveParams, Models::Containers::Files::ContentRetrieveParams, Models::EmbeddingCreateParams, Models::EvalCreateParams, Models::EvalDeleteParams, Models::EvalListParams, Models::EvalRetrieveParams, Models::EvalUpdateParams, Models::Evals::RunCancelParams, Models::Evals::RunCreateParams, Models::Evals::RunDeleteParams, Models::Evals::RunListParams, Models::Evals::RunRetrieveParams, Models::Evals::Runs::OutputItemListParams, Models::Evals::Runs::OutputItemRetrieveParams, Models::FileContentParams, Models::FileCreateParams, Models::FileDeleteParams, Models::FileListParams, Models::FileRetrieveParams, Models::FineTuning::Alpha::GraderRunParams, Models::FineTuning::Alpha::GraderValidateParams, Models::FineTuning::Checkpoints::PermissionCreateParams, Models::FineTuning::Checkpoints::PermissionDeleteParams, Models::FineTuning::Checkpoints::PermissionRetrieveParams, Models::FineTuning::JobCancelParams, Models::FineTuning::JobCreateParams, Models::FineTuning::JobListEventsParams, Models::FineTuning::JobListParams, Models::FineTuning::JobPauseParams, Models::FineTuning::JobResumeParams, Models::FineTuning::JobRetrieveParams, Models::FineTuning::Jobs::CheckpointListParams, Models::ImageCreateVariationParams, Models::ImageEditParams, Models::ImageGenerateParams, Models::ModelDeleteParams, Models::ModelListParams, Models::ModelRetrieveParams, Models::ModerationCreateParams, Models::Responses::InputItemListParams, Models::Responses::ResponseCancelParams, Models::Responses::ResponseCreateParams, Models::Responses::ResponseDeleteParams, Models::Responses::ResponseRetrieveParams, Models::UploadCancelParams, Models::UploadCompleteParams, Models::UploadCreateParams, Models::Uploads::PartCreateParams, Models::VectorStoreCreateParams, Models::VectorStoreDeleteParams, Models::VectorStoreListParams, Models::VectorStoreRetrieveParams, Models::VectorStoreSearchParams, Models::VectorStoreUpdateParams, Models::VectorStores::FileBatchCancelParams, Models::VectorStores::FileBatchCreateParams, Models::VectorStores::FileBatchListFilesParams, Models::VectorStores::FileBatchRetrieveParams, Models::VectorStores::FileContentParams, Models::VectorStores::FileCreateParams, Models::VectorStores::FileDeleteParams, Models::VectorStores::FileListParams, Models::VectorStores::FileRetrieveParams, Models::VectorStores::FileUpdateParams
Defined in:
lib/openai/internal/type/request_parameters.rb

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Defined Under Namespace

Modules: Converter

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#request_options ⇒ Object

Options to specify HTTP behaviour for this request.

@return [OpenAI::RequestOptions, Hash{Symbol=>Object}]




# File 'lib/openai/internal/type/request_parameters.rb', line 8

Class Method Details

.included(mod) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • mod (Module)

Raises:

  • (ArgumentError) 


14
15
16
17
18
 
# File 'lib/openai/internal/type/request_parameters.rb', line 14

def self.included(mod)
  raise ArgumentError.new(mod) unless mod <= OpenAI::Internal::Type::BaseModel

  mod.optional(:request_options, OpenAI::RequestOptions)
end