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

Included in:: Models::Admin::Organization::AdminAPIKeyCreateParams, Models::Admin::Organization::AdminAPIKeyDeleteParams, Models::Admin::Organization::AdminAPIKeyListParams, Models::Admin::Organization::AdminAPIKeyRetrieveParams, Models::Admin::Organization::AuditLogListParams, Models::Admin::Organization::CertificateActivateParams, Models::Admin::Organization::CertificateCreateParams, Models::Admin::Organization::CertificateDeactivateParams, Models::Admin::Organization::CertificateDeleteParams, Models::Admin::Organization::CertificateListParams, Models::Admin::Organization::CertificateRetrieveParams, Models::Admin::Organization::CertificateUpdateParams, Models::Admin::Organization::GroupCreateParams, Models::Admin::Organization::GroupDeleteParams, Models::Admin::Organization::GroupListParams, Models::Admin::Organization::GroupUpdateParams, Models::Admin::Organization::Groups::RoleCreateParams, Models::Admin::Organization::Groups::RoleDeleteParams, Models::Admin::Organization::Groups::RoleListParams, Models::Admin::Organization::Groups::UserCreateParams, Models::Admin::Organization::Groups::UserDeleteParams, Models::Admin::Organization::Groups::UserListParams, Models::Admin::Organization::InviteCreateParams, Models::Admin::Organization::InviteDeleteParams, Models::Admin::Organization::InviteListParams, Models::Admin::Organization::InviteRetrieveParams, Models::Admin::Organization::ProjectArchiveParams, Models::Admin::Organization::ProjectCreateParams, Models::Admin::Organization::ProjectListParams, Models::Admin::Organization::ProjectRetrieveParams, Models::Admin::Organization::ProjectUpdateParams, Models::Admin::Organization::Projects::APIKeyDeleteParams, Models::Admin::Organization::Projects::APIKeyListParams, Models::Admin::Organization::Projects::APIKeyRetrieveParams, Models::Admin::Organization::Projects::CertificateActivateParams, Models::Admin::Organization::Projects::CertificateDeactivateParams, Models::Admin::Organization::Projects::CertificateListParams, Models::Admin::Organization::Projects::GroupCreateParams, Models::Admin::Organization::Projects::GroupDeleteParams, Models::Admin::Organization::Projects::GroupListParams, Models::Admin::Organization::Projects::Groups::RoleCreateParams, Models::Admin::Organization::Projects::Groups::RoleDeleteParams, Models::Admin::Organization::Projects::Groups::RoleListParams, Models::Admin::Organization::Projects::RateLimitListRateLimitsParams, Models::Admin::Organization::Projects::RateLimitUpdateRateLimitParams, Models::Admin::Organization::Projects::RoleCreateParams, Models::Admin::Organization::Projects::RoleDeleteParams, Models::Admin::Organization::Projects::RoleListParams, Models::Admin::Organization::Projects::RoleUpdateParams, Models::Admin::Organization::Projects::ServiceAccountCreateParams, Models::Admin::Organization::Projects::ServiceAccountDeleteParams, Models::Admin::Organization::Projects::ServiceAccountListParams, Models::Admin::Organization::Projects::ServiceAccountRetrieveParams, Models::Admin::Organization::Projects::UserCreateParams, Models::Admin::Organization::Projects::UserDeleteParams, Models::Admin::Organization::Projects::UserListParams, Models::Admin::Organization::Projects::UserRetrieveParams, Models::Admin::Organization::Projects::UserUpdateParams, Models::Admin::Organization::Projects::Users::RoleCreateParams, Models::Admin::Organization::Projects::Users::RoleDeleteParams, Models::Admin::Organization::Projects::Users::RoleListParams, Models::Admin::Organization::RoleCreateParams, Models::Admin::Organization::RoleDeleteParams, Models::Admin::Organization::RoleListParams, Models::Admin::Organization::RoleUpdateParams, Models::Admin::Organization::UsageAudioSpeechesParams, Models::Admin::Organization::UsageAudioTranscriptionsParams, Models::Admin::Organization::UsageCodeInterpreterSessionsParams, Models::Admin::Organization::UsageCompletionsParams, Models::Admin::Organization::UsageCostsParams, Models::Admin::Organization::UsageEmbeddingsParams, Models::Admin::Organization::UsageImagesParams, Models::Admin::Organization::UsageModerationsParams, Models::Admin::Organization::UsageVectorStoresParams, Models::Admin::Organization::UserDeleteParams, Models::Admin::Organization::UserListParams, Models::Admin::Organization::UserRetrieveParams, Models::Admin::Organization::UserUpdateParams, Models::Admin::Organization::Users::RoleCreateParams, Models::Admin::Organization::Users::RoleDeleteParams, Models::Admin::Organization::Users::RoleListParams, 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::ChatKit::SessionCancelParams, Models::Beta::ChatKit::SessionCreateParams, Models::Beta::ChatKit::ThreadDeleteParams, Models::Beta::ChatKit::ThreadListItemsParams, Models::Beta::ChatKit::ThreadListParams, Models::Beta::ChatKit::ThreadRetrieveParams, 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::Conversations::ConversationCreateParams, Models::Conversations::ConversationDeleteParams, Models::Conversations::ConversationRetrieveParams, Models::Conversations::ConversationUpdateParams, Models::Conversations::ItemCreateParams, Models::Conversations::ItemDeleteParams, Models::Conversations::ItemListParams, Models::Conversations::ItemRetrieveParams, 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::PermissionListParams, 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::Realtime::CallAcceptParams, Models::Realtime::CallHangupParams, Models::Realtime::CallReferParams, Models::Realtime::CallRejectParams, Models::Realtime::ClientSecretCreateParams, Models::Responses::InputItemListParams, Models::Responses::InputTokenCountParams, Models::Responses::ResponseCancelParams, Models::Responses::ResponseCompactParams, Models::Responses::ResponseCreateParams, Models::Responses::ResponseDeleteParams, Models::Responses::ResponseRetrieveParams, Models::SkillCreateParams, Models::SkillDeleteParams, Models::SkillListParams, Models::SkillRetrieveParams, Models::SkillUpdateParams, Models::Skills::ContentRetrieveParams, Models::Skills::VersionCreateParams, Models::Skills::VersionDeleteParams, Models::Skills::VersionListParams, Models::Skills::VersionRetrieveParams, Models::Skills::Versions::ContentRetrieveParams, 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, Models::VideoCreateCharacterParams, Models::VideoCreateParams, Models::VideoDeleteParams, Models::VideoDownloadContentParams, Models::VideoEditParams, Models::VideoExtendParams, Models::VideoGetCharacterParams, Models::VideoListParams, Models::VideoRemixParams, Models::VideoRetrieveParams, Models::Webhooks::WebhookUnwrapParams

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

#request_options ⇒ Object

Options to specify HTTP behaviour for this request.

Class Method Summary collapse

.included(mod) ⇒ Object private

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)

# 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