Documentation by YARD 0.9.37

Alphabetic Index

File Listing

Namespace Listing A-Z

  • D
    • Data (OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse)
    • DataSource (OpenAI::Models::Evals::RunCreateParams)
    • DataSource (OpenAI::Models::Evals::RunListResponse)
    • DataSource (OpenAI::Models::Evals::RunCancelResponse)
    • DataSource (OpenAI::Models::Evals::RunCreateResponse)
    • DataSource (OpenAI::Models::Evals::RunRetrieveResponse)
    • DataSourceConfig (OpenAI::Models::EvalCreateParams)
    • DataSourceConfig (OpenAI::Models::EvalListResponse)
    • DataSourceConfig (OpenAI::Models::EvalCreateResponse)
    • DataSourceConfig (OpenAI::Models::EvalUpdateResponse)
    • DataSourceConfig (OpenAI::Models::EvalRetrieveResponse)
    • Delta (OpenAI::Models::Chat::ChatCompletionChunk::Choice)
    • Detail (OpenAI::Models::Beta::Threads::ImageURL)
    • Detail (OpenAI::Models::Beta::Threads::ImageFile)
    • Detail (OpenAI::Models::Beta::Threads::ImageURLDelta)
    • Detail (OpenAI::Models::Beta::Threads::ImageFileDelta)
    • Detail (OpenAI::Models::Responses::ResponseInputImage)
    • Detail (OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL)
    • DoubleClick (OpenAI::Models::Responses::ResponseComputerToolCall::Action)
    • DpoHyperparameters (OpenAI::Models::FineTuning)
    • DpoMethod (OpenAI::Models::FineTuning)
    • Drag (OpenAI::Models::Responses::ResponseComputerToolCall::Action)
  • K
    • Keypress (OpenAI::Models::Responses::ResponseComputerToolCall::Action)
  • L
    • LabelModel (OpenAI::Models::EvalCreateParams::TestingCriterion)
    • LabelModelGrader (OpenAI::Models::Graders)
    • LastError (OpenAI::Models::Beta::Threads::Run)
    • LastError (OpenAI::Models::Beta::Threads::Runs::RunStep)
    • LastError (OpenAI::Models::VectorStores::VectorStoreFile)
    • LearningRateMultiplier (OpenAI::Models::FineTuning::FineTuningJob::Hyperparameters)
    • LearningRateMultiplier (OpenAI::Models::FineTuning::JobCreateParams::Hyperparameters)
    • LearningRateMultiplier (OpenAI::Models::FineTuning::DpoHyperparameters)
    • LearningRateMultiplier (OpenAI::Models::FineTuning::SupervisedHyperparameters)
    • LearningRateMultiplier (OpenAI::Models::FineTuning::ReinforcementHyperparameters)
    • Level (OpenAI::Models::FineTuning::FineTuningJobEvent)
    • LocalShell (OpenAI::Models::Responses::Tool)
    • LocalShellCall (OpenAI::Models::Responses::ResponseItem)
    • LocalShellCall (OpenAI::Models::Responses::ResponseInputItem)
    • LocalShellCall (OpenAI::Models::Responses::ResponseOutputItem)
    • LocalShellCallOutput (OpenAI::Models::Responses::ResponseItem)
    • LocalShellCallOutput (OpenAI::Models::Responses::ResponseInputItem)
    • Logprob (OpenAI::Models::Audio::Transcription)
    • Logprob (OpenAI::Models::Responses::ResponseOutputText)
    • Logprob (OpenAI::Models::Audio::TranscriptionTextDoneEvent)
    • Logprob (OpenAI::Models::Audio::TranscriptionTextDeltaEvent)
    • Logprobs (OpenAI::Models::CompletionChoice)
    • Logprobs (OpenAI::Models::Chat::ChatCompletion::Choice)
    • Logprobs (OpenAI::Models::Chat::ChatCompletionChunk::Choice)
    • Logs (OpenAI::Models::EvalCreateParams::DataSourceConfig)
    • Logs (OpenAI::Models::EvalListResponse::DataSourceConfig)
    • Logs (OpenAI::Models::EvalCreateResponse::DataSourceConfig)
    • Logs (OpenAI::Models::EvalUpdateResponse::DataSourceConfig)
    • Logs (OpenAI::Models::EvalRetrieveResponse::DataSourceConfig)
    • Logs (OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCall::CodeInterpreter::Output)
    • Logs (OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Result)
  • N
    • NEpochs (OpenAI::Models::FineTuning::FineTuningJob::Hyperparameters)
    • NEpochs (OpenAI::Models::FineTuning::JobCreateParams::Hyperparameters)
    • NEpochs (OpenAI::Models::FineTuning::DpoHyperparameters)
    • NEpochs (OpenAI::Models::FineTuning::SupervisedHyperparameters)
    • NEpochs (OpenAI::Models::FineTuning::ReinforcementHyperparameters)
    • Never (OpenAI::Models::Responses::Tool::Mcp::RequireApproval::McpToolApprovalFilter)
    • NotFoundError (OpenAI::Errors)
  • O
    • OpenAI
    • Operation (OpenAI::Models::Graders::StringCheckGrader)
    • Order (OpenAI::Models::EvalListParams)
    • Order (OpenAI::Models::FileListParams)
    • Order (OpenAI::Models::ContainerListParams)
    • Order (OpenAI::Models::Evals::RunListParams)
    • Order (OpenAI::Models::VectorStoreListParams)
    • Order (OpenAI::Models::Beta::AssistantListParams)
    • Order (OpenAI::Models::Chat::CompletionListParams)
    • Order (OpenAI::Models::Containers::FileListParams)
    • Order (OpenAI::Models::Beta::Threads::RunListParams)
    • Order (OpenAI::Models::VectorStores::FileListParams)
    • Order (OpenAI::Models::Beta::Threads::MessageListParams)
    • Order (OpenAI::Models::Responses::InputItemListParams)
    • Order (OpenAI::Models::Beta::Threads::Runs::StepListParams)
    • Order (OpenAI::Models::Evals::Runs::OutputItemListParams)
    • Order (OpenAI::Models::Chat::Completions::MessageListParams)
    • Order (OpenAI::Models::VectorStores::FileBatchListFilesParams)
    • Order (OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveParams)
    • OrderBy (OpenAI::Models::EvalListParams)
    • OtherFileChunkingStrategyObject (OpenAI::Models)
    • Output (OpenAI::Models::Evals::Runs::OutputItemListResponse::Sample)
    • Output (OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Sample)
    • Output (OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCall::CodeInterpreter)
    • Output (OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCallDelta::CodeInterpreter)
    • OutputFormat (OpenAI::Models::Responses::Tool::ImageGeneration)
    • OutputFormat (OpenAI::Models::ImageGenerateParams)
    • OutputItemListParams (OpenAI::Models::Evals::Runs)
    • OutputItemListResponse (OpenAI::Models::Evals::Runs)
    • OutputItemRetrieveParams (OpenAI::Models::Evals::Runs)
    • OutputItemRetrieveResponse (OpenAI::Models::Evals::Runs)
    • OutputItems (OpenAI::Resources::Evals::Runs)
    • OutputText (OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem::Content)
    • OutputText (OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem::Content)
    • OutputText (OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content)
    • OutputText (OpenAI::Models::Evals::RunCancelResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content)
    • OutputText (OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content)
    • OutputText (OpenAI::Models::Graders::LabelModelGrader::Input::Content)
    • OutputText (OpenAI::Models::Graders::ScoreModelGrader::Input::Content)
    • OutputText (OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content)
    • OutputText (OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Content)
    • OutputTokensDetails (OpenAI::Models::Responses::ResponseUsage)
  • Q
    • Quality (OpenAI::Models::Responses::Tool::ImageGeneration)
    • Quality (OpenAI::Models::ImageEditParams)
    • Quality (OpenAI::Models::ImageGenerateParams)
    • Query (OpenAI::Models::VectorStoreSearchParams)
  • S
    • Sample (OpenAI::Models::Evals::Runs::OutputItemListResponse)
    • Sample (OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse)
    • SamplingParams (OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource)
    • SamplingParams (OpenAI::Models::Evals::RunListResponse::DataSource::Responses)
    • SamplingParams (OpenAI::Models::Evals::RunCancelResponse::DataSource::Responses)
    • SamplingParams (OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses)
    • SamplingParams (OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses)
    • SamplingParams (OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource)
    • ScoreModel (OpenAI::Models::EvalCreateParams::TestingCriterion)
    • ScoreModelGrader (OpenAI::Models::Graders)
    • Screenshot (OpenAI::Models::Responses::ResponseComputerToolCall::Action)
    • Scroll (OpenAI::Models::Responses::ResponseComputerToolCall::Action)
    • SearchContextSize (OpenAI::Models::Responses::WebSearchTool)
    • SearchContextSize (OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions)
    • SelfHarm (OpenAI::Models::Moderation::CategoryAppliedInputTypes)
    • SelfHarmInstruction (OpenAI::Models::Moderation::CategoryAppliedInputTypes)
    • SelfHarmIntent (OpenAI::Models::Moderation::CategoryAppliedInputTypes)
    • ServiceTier (OpenAI::Models::Responses::Response)
    • ServiceTier (OpenAI::Models::Chat::ChatCompletion)
    • ServiceTier (OpenAI::Models::Chat::ChatCompletionChunk)
    • ServiceTier (OpenAI::Models::Chat::CompletionCreateParams)
    • ServiceTier (OpenAI::Models::Responses::ResponseCreateParams)
    • Sexual (OpenAI::Models::Moderation::CategoryAppliedInputTypes)
    • SexualMinor (OpenAI::Models::Moderation::CategoryAppliedInputTypes)
    • SimpleInputMessage (OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel::Input)
    • Size (OpenAI::Models::Responses::Tool::ImageGeneration)
    • Size (OpenAI::Models::ImageEditParams)
    • Size (OpenAI::Models::ImageGenerateParams)
    • Size (OpenAI::Models::ImageCreateVariationParams)
    • SorbetRuntimeSupport (OpenAI::Internal::Util)
    • Source (OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource)
    • Source (OpenAI::Models::Evals::RunListResponse::DataSource::Responses)
    • Source (OpenAI::Models::Evals::RunCancelResponse::DataSource::Responses)
    • Source (OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses)
    • Source (OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses)
    • Source (OpenAI::Models::Evals::CreateEvalJSONLRunDataSource)
    • Source (OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource)
    • Speech (OpenAI::Resources::Audio)
    • SpeechCreateParams (OpenAI::Models::Audio)
    • SpeechModel (OpenAI::Models::Audio)
    • Static (OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy)
    • Static (OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static)
    • Static (OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy)
    • Static (OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static)
    • Static (OpenAI::Models::Beta::ThreadCreateAndRunParams::Thread::ToolResources::FileSearch::VectorStore::ChunkingStrategy)
    • Static (OpenAI::Models::Beta::ThreadCreateAndRunParams::Thread::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static)
    • StaticFileChunkingStrategy (OpenAI::Models)
    • StaticFileChunkingStrategyObject (OpenAI::Models)
    • StaticFileChunkingStrategyObjectParam (OpenAI::Models)
    • Status (OpenAI::Models::Batch)
    • Status (OpenAI::Models::Upload)
    • Status (OpenAI::Models::FileObject)
    • Status (OpenAI::Models::VectorStore)
    • Status (OpenAI::Models::Beta::Threads::Message)
    • Status (OpenAI::Models::Evals::RunListParams)
    • Status (OpenAI::Models::Responses::ResponseItem::ImageGenerationCall)
    • Status (OpenAI::Models::Responses::ResponseItem::LocalShellCall)
    • Status (OpenAI::Models::Responses::ResponseItem::LocalShellCallOutput)
    • Status (OpenAI::Models::Beta::Threads::Runs::RunStep)
    • Status (OpenAI::Models::FineTuning::FineTuningJob)
    • Status (OpenAI::Models::Responses::ResponseInputItem::Message)
    • Status (OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput)
    • Status (OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput)
    • Status (OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall)
    • Status (OpenAI::Models::Responses::ResponseInputItem::LocalShellCall)
    • Status (OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput)
    • Status (OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall)
    • Status (OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall)
    • Status (OpenAI::Models::VectorStores::VectorStoreFile)
    • Status (OpenAI::Models::Responses::ResponseOutputMessage)
    • Status (OpenAI::Models::Responses::ResponseReasoningItem)
    • Status (OpenAI::Models::Evals::Runs::OutputItemListParams)
    • Status (OpenAI::Models::Responses::ResponseComputerToolCall)
    • Status (OpenAI::Models::Responses::ResponseFunctionToolCall)
    • Status (OpenAI::Models::Responses::ResponseInputMessageItem)
    • Status (OpenAI::Models::VectorStores::VectorStoreFileBatch)
    • Status (OpenAI::Models::Responses::ResponseFunctionWebSearch)
    • Status (OpenAI::Models::Responses::ResponseFileSearchToolCall)
    • Status (OpenAI::Models::Responses::ResponseCodeInterpreterToolCall)
    • Status (OpenAI::Models::Responses::ResponseComputerToolCallOutputItem)
    • Status (OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem)
    • StepDetails (OpenAI::Models::Beta::Threads::Runs::RunStep)
    • StepDetails (OpenAI::Models::Beta::Threads::Runs::RunStepDelta)
    • StepListParams (OpenAI::Models::Beta::Threads::Runs)
    • StepRetrieveParams (OpenAI::Models::Beta::Threads::Runs)
    • Steps (OpenAI::Resources::Beta::Threads::Runs)
    • Stop (OpenAI::Models::CompletionCreateParams)
    • Stop (OpenAI::Models::Chat::CompletionCreateParams)
    • StoredCompletions (OpenAI::Models::EvalCreateParams::DataSourceConfig)
    • StoredCompletions (OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::Source)
    • Stream (OpenAI::Internal)
    • StringCheckGrader (OpenAI::Models::Graders)
    • StructuredOutput (OpenAI::Helpers)
    • Style (OpenAI::Models::ImageGenerateParams)
    • SubmitToolOutputs (OpenAI::Models::Beta::Threads::Run::RequiredAction)
    • Summary (OpenAI::Models::Responses::ResponseReasoningItem)
    • Summary (OpenAI::Models::Reasoning)
    • SupervisedHyperparameters (OpenAI::Models::FineTuning)
    • SupervisedMethod (OpenAI::Models::FineTuning)
  • W
    • Wait (OpenAI::Models::Responses::ResponseComputerToolCall::Action)
    • Wandb (OpenAI::Models::FineTuning::JobCreateParams::Integration)
    • WebSearchOptions (OpenAI::Models::Chat::CompletionCreateParams)
    • WebSearchTool (OpenAI::Models::Responses)