Module: OpenAI::Models

Defined in:

lib/openai/models/batch.rb,
lib/openai/models/image.rb,
lib/openai/models/model.rb,
lib/openai/models/video.rb,
lib/openai/models/upload.rb,
lib/openai/models/metadata.rb,
lib/openai/models/embedding.rb,
lib/openai/models/reasoning.rb,
lib/openai/models/all_models.rb,
lib/openai/models/chat_model.rb,
lib/openai/models/completion.rb,
lib/openai/models/moderation.rb,
lib/openai/models/video_size.rb,
lib/openai/models/audio_model.rb,
lib/openai/models/batch_error.rb,
lib/openai/models/batch_usage.rb,
lib/openai/models/beta/thread.rb,
lib/openai/models/file_object.rb,
lib/openai/models/image_model.rb,
lib/openai/models/video_model.rb,
lib/openai/models/error_object.rb,
lib/openai/models/file_content.rb,
lib/openai/models/file_deleted.rb,
lib/openai/models/file_purpose.rb,
lib/openai/models/vector_store.rb,
lib/openai/models/model_deleted.rb,
lib/openai/models/video_seconds.rb,
lib/openai/models/beta/assistant.rb,
lib/openai/models/responses/tool.rb,
lib/openai/models/compound_filter.rb,
lib/openai/models/embedding_model.rb,
lib/openai/models/images_response.rb,
lib/openai/models/responses_model.rb,
lib/openai/models/beta/threads/run.rb,
lib/openai/models/completion_usage.rb,
lib/openai/models/eval_list_params.rb,
lib/openai/models/file_list_params.rb,
lib/openai/models/moderation_model.rb,
lib/openai/models/reasoning_effort.rb,
lib/openai/models/audio/translation.rb,
lib/openai/models/batch_list_params.rb,
lib/openai/models/beta/threads/text.rb,
lib/openai/models/comparison_filter.rb,
lib/openai/models/completion_choice.rb,
lib/openai/models/image_edit_params.rb,
lib/openai/models/model_list_params.rb,
lib/openai/models/video_list_params.rb,
lib/openai/models/audio/speech_model.rb,
lib/openai/models/beta/function_tool.rb,
lib/openai/models/eval_create_params.rb,
lib/openai/models/eval_delete_params.rb,
lib/openai/models/eval_list_response.rb,
lib/openai/models/eval_update_params.rb,
lib/openai/models/file_create_params.rb,
lib/openai/models/file_delete_params.rb,
lib/openai/models/responses/response.rb,
lib/openai/models/video_create_error.rb,
lib/openai/models/video_remix_params.rb,
lib/openai/models/audio/transcription.rb,
lib/openai/models/batch_cancel_params.rb,
lib/openai/models/batch_create_params.rb,
lib/openai/models/beta/assistant_tool.rb,
lib/openai/models/beta/thread_deleted.rb,
lib/openai/models/file_content_params.rb,
lib/openai/models/function_definition.rb,
lib/openai/models/function_parameters.rb,
lib/openai/models/model_delete_params.rb,
lib/openai/models/uploads/upload_part.rb,
lib/openai/models/video_create_params.rb,
lib/openai/models/video_delete_params.rb,
lib/openai/models/batch_request_counts.rb,
lib/openai/models/beta/threads/message.rb,
lib/openai/models/chat/chat_completion.rb,
lib/openai/models/eval_create_response.rb,
lib/openai/models/eval_delete_response.rb,
lib/openai/models/eval_retrieve_params.rb,
lib/openai/models/eval_update_response.rb,
lib/openai/models/evals/eval_api_error.rb,
lib/openai/models/file_retrieve_params.rb,
lib/openai/models/graders/multi_grader.rb,
lib/openai/models/response_format_text.rb,
lib/openai/models/upload_cancel_params.rb,
lib/openai/models/upload_create_params.rb,
lib/openai/models/vector_store_deleted.rb,
lib/openai/models/audio_response_format.rb,
lib/openai/models/batch_retrieve_params.rb,
lib/openai/models/beta/chatkit_workflow.rb,
lib/openai/models/beta/file_search_tool.rb,
lib/openai/models/beta/run_stream_event.rb,
lib/openai/models/container_list_params.rb,
lib/openai/models/conversations/message.rb,
lib/openai/models/evals/run_list_params.rb,
lib/openai/models/graders/python_grader.rb,
lib/openai/models/image_generate_params.rb,
lib/openai/models/model_retrieve_params.rb,
lib/openai/models/moderation_text_input.rb,
lib/openai/models/responses/custom_tool.rb,
lib/openai/models/video_delete_response.rb,
lib/openai/models/video_retrieve_params.rb,
lib/openai/models/beta/assistant_deleted.rb,
lib/openai/models/beta/threads/image_url.rb,
lib/openai/models/eval_retrieve_response.rb,
lib/openai/models/file_chunking_strategy.rb,
lib/openai/models/fine_tuning/dpo_method.rb,
lib/openai/models/image_gen_stream_event.rb,
lib/openai/models/upload_complete_params.rb,
lib/openai/models/beta/threads/annotation.rb,
lib/openai/models/beta/threads/image_file.rb,
lib/openai/models/beta/threads/run_status.rb,
lib/openai/models/beta/threads/text_delta.rb,
lib/openai/models/container_create_params.rb,
lib/openai/models/container_delete_params.rb,
lib/openai/models/container_list_response.rb,
lib/openai/models/embedding_create_params.rb,
lib/openai/models/evals/run_cancel_params.rb,
lib/openai/models/evals/run_create_params.rb,
lib/openai/models/evals/run_delete_params.rb,
lib/openai/models/evals/run_list_response.rb,
lib/openai/models/image_edit_stream_event.rb,
lib/openai/models/realtime/realtime_error.rb,
lib/openai/models/responses/computer_tool.rb,
lib/openai/models/responses/function_tool.rb,
lib/openai/models/responses/response_item.rb,
lib/openai/models/audio/transcription_word.rb,
lib/openai/models/beta/thread_stream_event.rb,
lib/openai/models/completion_create_params.rb,
lib/openai/models/custom_tool_input_format.rb,
lib/openai/models/moderation_create_params.rb,
lib/openai/models/responses/response_error.rb,
lib/openai/models/responses/response_input.rb,
lib/openai/models/responses/response_usage.rb,
lib/openai/models/vector_store_list_params.rb,
lib/openai/models/audio/translation_verbose.rb,
lib/openai/models/beta/chatkit/chat_session.rb,
lib/openai/models/beta/message_stream_event.rb,
lib/openai/models/beta/thread_create_params.rb,
lib/openai/models/beta/thread_delete_params.rb,
lib/openai/models/beta/thread_update_params.rb,
lib/openai/models/chat/chat_completion_role.rb,
lib/openai/models/chat/chat_completion_tool.rb,
lib/openai/models/container_create_response.rb,
lib/openai/models/container_retrieve_params.rb,
lib/openai/models/create_embedding_response.rb,
lib/openai/models/evals/run_cancel_response.rb,
lib/openai/models/evals/run_create_response.rb,
lib/openai/models/evals/run_delete_response.rb,
lib/openai/models/evals/run_retrieve_params.rb,
lib/openai/models/image_gen_completed_event.rb,
lib/openai/models/realtime/realtime_session.rb,
lib/openai/models/responses/response_prompt.rb,
lib/openai/models/responses/response_status.rb,
lib/openai/models/responses/tool_choice_mcp.rb,
lib/openai/models/responses/web_search_tool.rb,
lib/openai/models/audio/speech_create_params.rb,
lib/openai/models/beta/assistant_list_params.rb,
lib/openai/models/beta/assistant_tool_choice.rb,
lib/openai/models/beta/code_interpreter_tool.rb,
lib/openai/models/beta/run_step_stream_event.rb,
lib/openai/models/beta/threads/message_delta.rb,
lib/openai/models/beta/threads/runs/run_step.rb,
lib/openai/models/chat/chat_completion_audio.rb,
lib/openai/models/chat/chat_completion_chunk.rb,
lib/openai/models/conversations/conversation.rb,
lib/openai/models/conversations/text_content.rb,
lib/openai/models/graders/label_model_grader.rb,
lib/openai/models/graders/score_model_grader.rb,
lib/openai/models/image_edit_completed_event.rb,
lib/openai/models/moderation_create_response.rb,
lib/openai/models/moderation_image_url_input.rb,
lib/openai/models/realtime/call_refer_params.rb,
lib/openai/models/realtime/conversation_item.rb,
lib/openai/models/realtime/realtime_response.rb,
lib/openai/models/responses/apply_patch_tool.rb,
lib/openai/models/responses/file_search_tool.rb,
lib/openai/models/responses/response_content.rb,
lib/openai/models/uploads/part_create_params.rb,
lib/openai/models/vector_store_create_params.rb,
lib/openai/models/vector_store_delete_params.rb,
lib/openai/models/vector_store_search_params.rb,
lib/openai/models/vector_store_update_params.rb,
lib/openai/models/audio/transcription_include.rb,
lib/openai/models/audio/transcription_segment.rb,
lib/openai/models/audio/transcription_verbose.rb,
lib/openai/models/beta/assistant_stream_event.rb,
lib/openai/models/beta/chatkit/chatkit_thread.rb,
lib/openai/models/beta/thread_retrieve_params.rb,
lib/openai/models/beta/threads/runs/tool_call.rb,
lib/openai/models/chat/completion_list_params.rb,
lib/openai/models/chat/parsed_chat_completion.rb,
lib/openai/models/container_retrieve_response.rb,
lib/openai/models/containers/file_list_params.rb,
lib/openai/models/evals/run_retrieve_response.rb,
lib/openai/models/fine_tuning/fine_tuning_job.rb,
lib/openai/models/fine_tuning/job_list_params.rb,
lib/openai/models/graders/string_check_grader.rb,
lib/openai/models/realtime/call_accept_params.rb,
lib/openai/models/realtime/call_hangup_params.rb,
lib/openai/models/realtime/call_reject_params.rb,
lib/openai/models/response_format_json_object.rb,
lib/openai/models/response_format_json_schema.rb,
lib/openai/models/response_format_text_python.rb,
lib/openai/models/responses/tool_choice_shell.rb,
lib/openai/models/responses/tool_choice_types.rb,
lib/openai/models/audio/transcription_diarized.rb,
lib/openai/models/beta/assistant_create_params.rb,
lib/openai/models/beta/assistant_delete_params.rb,
lib/openai/models/beta/assistant_update_params.rb,
lib/openai/models/beta/threads/image_url_delta.rb,
lib/openai/models/beta/threads/message_content.rb,
lib/openai/models/beta/threads/message_deleted.rb,
lib/openai/models/beta/threads/run_list_params.rb,
lib/openai/models/chat/chat_completion_deleted.rb,
lib/openai/models/chat/chat_completion_message.rb,
lib/openai/models/file_chunking_strategy_param.rb,
lib/openai/models/fine_tuning/job_pause_params.rb,
lib/openai/models/moderation_multi_modal_input.rb,
lib/openai/models/realtime/audio_transcription.rb,
lib/openai/models/realtime/log_prob_properties.rb,
lib/openai/models/realtime/realtime_truncation.rb,
lib/openai/models/realtime/response_done_event.rb,
lib/openai/models/response_format_text_grammar.rb,
lib/openai/models/responses/compacted_response.rb,
lib/openai/models/responses/easy_input_message.rb,
lib/openai/models/responses/response_item_list.rb,
lib/openai/models/responses/tool_choice_custom.rb,
lib/openai/models/vector_store_retrieve_params.rb,
lib/openai/models/vector_store_search_response.rb,
lib/openai/models/beta/threads/annotation_delta.rb,
lib/openai/models/beta/threads/image_file_delta.rb,
lib/openai/models/beta/threads/text_delta_block.rb,
lib/openai/models/chat/chat_completion_modality.rb,
lib/openai/models/chat/completion_create_params.rb,
lib/openai/models/chat/completion_delete_params.rb,
lib/openai/models/chat/completion_update_params.rb,
lib/openai/models/containers/file_create_params.rb,
lib/openai/models/containers/file_delete_params.rb,
lib/openai/models/containers/file_list_response.rb,
lib/openai/models/conversations/refusal_content.rb,
lib/openai/models/fine_tuning/job_cancel_params.rb,
lib/openai/models/fine_tuning/job_create_params.rb,
lib/openai/models/fine_tuning/job_resume_params.rb,
lib/openai/models/fine_tuning/supervised_method.rb,
lib/openai/models/image_create_variation_params.rb,
lib/openai/models/image_gen_partial_image_event.rb,
lib/openai/models/realtime/noise_reduction_type.rb,
lib/openai/models/realtime/realtime_error_event.rb,
lib/openai/models/realtime/session_update_event.rb,
lib/openai/models/responses/function_shell_tool.rb,
lib/openai/models/responses/response_includable.rb,
lib/openai/models/responses/response_input_file.rb,
lib/openai/models/responses/response_input_item.rb,
lib/openai/models/responses/response_input_text.rb,
lib/openai/models/responses/tool_choice_allowed.rb,
lib/openai/models/responses/tool_choice_options.rb,
lib/openai/models/static_file_chunking_strategy.rb,
lib/openai/models/video_download_content_params.rb,
lib/openai/models/webhooks/unwrap_webhook_event.rb,
lib/openai/models/beta/assistant_retrieve_params.rb,
lib/openai/models/beta/threads/run_cancel_params.rb,
lib/openai/models/beta/threads/run_create_params.rb,
lib/openai/models/beta/threads/run_update_params.rb,
lib/openai/models/conversations/item_list_params.rb,
lib/openai/models/eval_custom_data_source_config.rb,
lib/openai/models/graders/text_similarity_grader.rb,
lib/openai/models/image_edit_partial_image_event.rb,
lib/openai/models/realtime/mcp_list_tools_failed.rb,
lib/openai/models/realtime/realtime_audio_config.rb,
lib/openai/models/realtime/realtime_client_event.rb,
lib/openai/models/realtime/realtime_server_event.rb,
lib/openai/models/realtime/realtime_tools_config.rb,
lib/openai/models/realtime/response_cancel_event.rb,
lib/openai/models/realtime/response_create_event.rb,
lib/openai/models/realtime/session_created_event.rb,
lib/openai/models/realtime/session_updated_event.rb,
lib/openai/models/responses/response_error_event.rb,
lib/openai/models/responses/response_input_audio.rb,
lib/openai/models/responses/response_input_image.rb,
lib/openai/models/responses/response_output_item.rb,
lib/openai/models/responses/response_output_text.rb,
lib/openai/models/responses/response_text_config.rb,
lib/openai/models/responses/tool_choice_function.rb,
lib/openai/models/vector_stores/file_list_params.rb,
lib/openai/models/webhooks/webhook_unwrap_params.rb,
lib/openai/models/audio/translation_create_params.rb,
lib/openai/models/beta/chatkit/chatkit_attachment.rb,
lib/openai/models/beta/chatkit/thread_list_params.rb,
lib/openai/models/beta/threads/text_content_block.rb,
lib/openai/models/chat/completion_retrieve_params.rb,
lib/openai/models/containers/file_create_response.rb,
lib/openai/models/containers/file_retrieve_params.rb,
lib/openai/models/conversations/conversation_item.rb,
lib/openai/models/fine_tuning/dpo_hyperparameters.rb,
lib/openai/models/fine_tuning/job_retrieve_params.rb,
lib/openai/models/realtime/conversation_item_done.rb,
lib/openai/models/realtime/realtime_audio_formats.rb,
lib/openai/models/realtime/realtime_function_tool.rb,
lib/openai/models/realtime/realtime_mcp_tool_call.rb,
lib/openai/models/realtime/realtime_mcphttp_error.rb,
lib/openai/models/realtime/response_created_event.rb,
lib/openai/models/responses/response_failed_event.rb,
lib/openai/models/responses/response_output_audio.rb,
lib/openai/models/responses/response_queued_event.rb,
lib/openai/models/responses/response_stream_event.rb,
lib/openai/models/vector_stores/vector_store_file.rb,
lib/openai/models/audio/transcription_stream_event.rb,
lib/openai/models/beta/chatkit/chat_session_status.rb,
lib/openai/models/beta/chatkit/chatkit_widget_item.rb,
lib/openai/models/beta/threads/message_delta_event.rb,
lib/openai/models/beta/threads/message_list_params.rb,
lib/openai/models/beta/threads/refusal_delta_block.rb,
lib/openai/models/beta/threads/run_retrieve_params.rb,
lib/openai/models/beta/threads/runs/run_step_delta.rb,
lib/openai/models/chat/chat_completion_audio_param.rb,
lib/openai/models/chat/chat_completion_custom_tool.rb,
lib/openai/models/conversations/input_file_content.rb,
lib/openai/models/conversations/input_text_content.rb,
lib/openai/models/conversations/item_create_params.rb,
lib/openai/models/conversations/item_delete_params.rb,
lib/openai/models/fine_tuning/reinforcement_method.rb,
lib/openai/models/realtime/conversation_item_added.rb,
lib/openai/models/realtime/realtime_mcp_list_tools.rb,
lib/openai/models/realtime/realtime_response_usage.rb,
lib/openai/models/realtime/realtime_tracing_config.rb,
lib/openai/models/responses/input_item_list_params.rb,
lib/openai/models/responses/response_cancel_params.rb,
lib/openai/models/responses/response_create_params.rb,
lib/openai/models/responses/response_created_event.rb,
lib/openai/models/responses/response_delete_params.rb,
lib/openai/models/responses/response_input_content.rb,
lib/openai/models/vector_stores/file_create_params.rb,
lib/openai/models/vector_stores/file_delete_params.rb,
lib/openai/models/vector_stores/file_update_params.rb,
lib/openai/models/audio/transcription_create_params.rb,
lib/openai/models/audio/translation_create_response.rb,
lib/openai/models/auto_file_chunking_strategy_param.rb,
lib/openai/models/beta/assistant_tool_choice_option.rb,
lib/openai/models/beta/chatkit/chat_session_history.rb,
lib/openai/models/beta/chatkit/thread_delete_params.rb,
lib/openai/models/beta/thread_create_and_run_params.rb,
lib/openai/models/beta/threads/file_path_annotation.rb,
lib/openai/models/beta/threads/runs/tool_call_delta.rb,
lib/openai/models/chat/chat_completion_content_part.rb,
lib/openai/models/containers/file_retrieve_response.rb,
lib/openai/models/conversations/input_image_content.rb,
lib/openai/models/conversations/output_text_content.rb,
lib/openai/models/fine_tuning/fine_tuning_job_event.rb,
lib/openai/models/realtime/mcp_list_tools_completed.rb,
lib/openai/models/realtime/realtime_response_status.rb,
lib/openai/models/realtime/response_mcp_call_failed.rb,
lib/openai/models/realtime/response_text_done_event.rb,
lib/openai/models/responses/response_compact_params.rb,
lib/openai/models/responses/response_output_message.rb,
lib/openai/models/responses/response_output_refusal.rb,
lib/openai/models/responses/response_reasoning_item.rb,
lib/openai/models/responses/tool_choice_apply_patch.rb,
lib/openai/models/responses/web_search_preview_tool.rb,
lib/openai/models/vector_stores/file_content_params.rb,
lib/openai/models/beta/chatkit/session_cancel_params.rb,
lib/openai/models/beta/chatkit/session_create_params.rb,
lib/openai/models/beta/threads/image_url_delta_block.rb,
lib/openai/models/beta/threads/message_content_delta.rb,
lib/openai/models/beta/threads/message_create_params.rb,
lib/openai/models/beta/threads/message_delete_params.rb,
lib/openai/models/beta/threads/message_update_params.rb,
lib/openai/models/beta/threads/refusal_content_block.rb,
lib/openai/models/beta/threads/runs/run_step_include.rb,
lib/openai/models/beta/threads/runs/step_list_params.rb,
lib/openai/models/chat/chat_completion_allowed_tools.rb,
lib/openai/models/chat/chat_completion_function_tool.rb,
lib/openai/models/chat/chat_completion_message_param.rb,
lib/openai/models/chat/chat_completion_store_message.rb,
lib/openai/models/chat/chat_completion_token_logprob.rb,
lib/openai/models/conversations/conversation_deleted.rb,
lib/openai/models/conversations/item_retrieve_params.rb,
lib/openai/models/conversations/summary_text_content.rb,
lib/openai/models/evals/runs/output_item_list_params.rb,
lib/openai/models/fine_tuning/job_list_events_params.rb,
lib/openai/models/realtime/rate_limits_updated_event.rb,
lib/openai/models/realtime/response_audio_done_event.rb,
lib/openai/models/realtime/response_text_delta_event.rb,
lib/openai/models/responses/input_token_count_params.rb,
lib/openai/models/responses/response_compaction_item.rb,
lib/openai/models/responses/response_completed_event.rb,
lib/openai/models/responses/response_retrieve_params.rb,
lib/openai/models/responses/response_text_done_event.rb,
lib/openai/models/vector_stores/file_retrieve_params.rb,
lib/openai/models/audio/transcription_create_response.rb,
lib/openai/models/audio/transcription_text_done_event.rb,
lib/openai/models/beta/assistant_tool_choice_function.rb,
lib/openai/models/beta/chatkit/thread_delete_response.rb,
lib/openai/models/beta/chatkit/thread_retrieve_params.rb,
lib/openai/models/beta/threads/image_file_delta_block.rb,
lib/openai/models/chat/chat_completion_stream_options.rb,
lib/openai/models/fine_tuning/alpha/grader_run_params.rb,
lib/openai/models/other_file_chunking_strategy_object.rb,
lib/openai/models/realtime/conversation_created_event.rb,
lib/openai/models/realtime/mcp_list_tools_in_progress.rb,
lib/openai/models/realtime/response_audio_delta_event.rb,
lib/openai/models/responses/response_audio_done_event.rb,
lib/openai/models/responses/response_custom_tool_call.rb,
lib/openai/models/responses/response_incomplete_event.rb,
lib/openai/models/responses/response_text_delta_event.rb,
lib/openai/models/vector_stores/file_content_response.rb,
lib/openai/models/webhooks/batch_failed_webhook_event.rb,
lib/openai/models/audio/transcription_diarized_segment.rb,
lib/openai/models/audio/transcription_text_delta_event.rb,
lib/openai/models/beta/threads/image_url_content_block.rb,
lib/openai/models/beta/threads/message_retrieve_params.rb,
lib/openai/models/beta/threads/runs/function_tool_call.rb,
lib/openai/models/chat/completions/message_list_params.rb,
lib/openai/models/conversations/conversation_item_list.rb,
lib/openai/models/evals/runs/output_item_list_response.rb,
lib/openai/models/realtime/client_secret_create_params.rb,
lib/openai/models/realtime/realtime_audio_config_input.rb,
lib/openai/models/realtime/realtime_mcp_protocol_error.rb,
lib/openai/models/realtime/realtime_tool_choice_config.rb,
lib/openai/models/realtime/realtime_tools_config_union.rb,
lib/openai/models/realtime/response_mcp_call_completed.rb,
lib/openai/models/responses/input_token_count_response.rb,
lib/openai/models/responses/response_audio_delta_event.rb,
lib/openai/models/responses/response_in_progress_event.rb,
lib/openai/models/static_file_chunking_strategy_object.rb,
lib/openai/models/webhooks/batch_expired_webhook_event.rb,
lib/openai/models/beta/assistant_response_format_option.rb,
lib/openai/models/beta/chatkit/chat_session_file_upload.rb,
lib/openai/models/beta/chatkit/chat_session_rate_limits.rb,
lib/openai/models/beta/chatkit/chatkit_thread_item_list.rb,
lib/openai/models/beta/chatkit/thread_list_items_params.rb,
lib/openai/models/beta/threads/file_citation_annotation.rb,
lib/openai/models/beta/threads/image_file_content_block.rb,
lib/openai/models/beta/threads/text_content_block_param.rb,
lib/openai/models/chat/chat_completion_reasoning_effort.rb,
lib/openai/models/fine_tuning/alpha/grader_run_response.rb,
lib/openai/models/realtime/realtime_audio_config_output.rb,
lib/openai/models/realtime/transcription_session_update.rb,
lib/openai/models/responses/response_computer_tool_call.rb,
lib/openai/models/responses/response_conversation_param.rb,
lib/openai/models/responses/response_format_text_config.rb,
lib/openai/models/responses/response_function_tool_call.rb,
lib/openai/models/responses/response_input_file_content.rb,
lib/openai/models/responses/response_input_message_item.rb,
lib/openai/models/responses/response_input_text_content.rb,
lib/openai/models/responses/response_refusal_done_event.rb,
lib/openai/models/vector_stores/vector_store_file_batch.rb,
lib/openai/models/audio/transcription_text_segment_event.rb,
lib/openai/models/beta/threads/runs/run_step_delta_event.rb,
lib/openai/models/beta/threads/runs/step_retrieve_params.rb,
lib/openai/models/chat/chat_completion_content_part_text.rb,
lib/openai/models/chat/chat_completion_message_tool_call.rb,
lib/openai/models/chat/chat_completion_named_tool_choice.rb,
lib/openai/models/evals/runs/output_item_retrieve_params.rb,
lib/openai/models/fine_tuning/supervised_hyperparameters.rb,
lib/openai/models/realtime/client_secret_create_response.rb,
lib/openai/models/realtime/realtime_mcp_approval_request.rb,
lib/openai/models/realtime/response_mcp_call_in_progress.rb,
lib/openai/models/responses/response_function_web_search.rb,
lib/openai/models/responses/response_input_image_content.rb,
lib/openai/models/responses/response_refusal_delta_event.rb,
lib/openai/models/vector_stores/file_batch_cancel_params.rb,
lib/openai/models/vector_stores/file_batch_create_params.rb,
lib/openai/models/webhooks/batch_cancelled_webhook_event.rb,
lib/openai/models/webhooks/batch_completed_webhook_event.rb,
lib/openai/models/webhooks/eval_run_failed_webhook_event.rb,
lib/openai/models/webhooks/response_failed_webhook_event.rb,
lib/openai/models/beta/threads/file_path_delta_annotation.rb,
lib/openai/models/beta/threads/message_content_part_param.rb,
lib/openai/models/beta/threads/runs/code_interpreter_logs.rb,
lib/openai/models/beta/threads/runs/file_search_tool_call.rb,
lib/openai/models/chat/chat_completion_content_part_image.rb,
lib/openai/models/chat/chat_completion_prediction_content.rb,
lib/openai/models/chat/chat_completion_tool_choice_option.rb,
lib/openai/models/chat/chat_completion_tool_message_param.rb,
lib/openai/models/chat/chat_completion_user_message_param.rb,
lib/openai/models/evals/create_eval_jsonl_run_data_source.rb,
lib/openai/models/fine_tuning/fine_tuning_job_integration.rb,
lib/openai/models/fine_tuning/jobs/checkpoint_list_params.rb,
lib/openai/models/realtime/conversation_item_create_event.rb,
lib/openai/models/realtime/conversation_item_delete_event.rb,
lib/openai/models/realtime/input_audio_buffer_clear_event.rb,
lib/openai/models/realtime/realtime_mcp_approval_response.rb,
lib/openai/models/realtime/realtime_session_client_secret.rb,
lib/openai/models/vector_stores/vector_store_file_deleted.rb,
lib/openai/models/beta/chatkit/chat_session_workflow_param.rb,
lib/openai/models/beta/threads/runs/tool_call_delta_object.rb,
lib/openai/models/chat/chat_completion_allowed_tool_choice.rb,
lib/openai/models/containers/files/content_retrieve_params.rb,
lib/openai/models/conversations/conversation_create_params.rb,
lib/openai/models/conversations/conversation_delete_params.rb,
lib/openai/models/conversations/conversation_update_params.rb,
lib/openai/models/evals/runs/output_item_retrieve_response.rb,
lib/openai/models/fine_tuning/alpha/grader_validate_params.rb,
lib/openai/models/realtime/conversation_item_created_event.rb,
lib/openai/models/realtime/conversation_item_deleted_event.rb,
lib/openai/models/realtime/input_audio_buffer_append_event.rb,
lib/openai/models/realtime/input_audio_buffer_commit_event.rb,
lib/openai/models/realtime/output_audio_buffer_clear_event.rb,
lib/openai/models/realtime/realtime_response_create_params.rb,
lib/openai/models/realtime/realtime_session_create_request.rb,
lib/openai/models/realtime/response_output_item_done_event.rb,
lib/openai/models/responses/response_apply_patch_tool_call.rb,
lib/openai/models/responses/response_compaction_item_param.rb,
lib/openai/models/responses/response_file_search_tool_call.rb,
lib/openai/models/responses/response_mcp_call_failed_event.rb,
lib/openai/models/vector_stores/file_batch_retrieve_params.rb,
lib/openai/models/webhooks/eval_run_canceled_webhook_event.rb,
lib/openai/models/beta/chatkit/chatkit_response_output_text.rb,
lib/openai/models/beta/threads/runs/tool_calls_step_details.rb,
lib/openai/models/chat/chat_completion_content_part_refusal.rb,
lib/openai/models/chat/chat_completion_function_call_option.rb,
lib/openai/models/chat/chat_completion_system_message_param.rb,
lib/openai/models/conversations/computer_screenshot_content.rb,
lib/openai/models/fine_tuning/reinforcement_hyperparameters.rb,
lib/openai/models/realtime/conversation_item_retrieve_event.rb,
lib/openai/models/realtime/conversation_item_truncate_event.rb,
lib/openai/models/realtime/conversation_item_with_reference.rb,
lib/openai/models/realtime/input_audio_buffer_cleared_event.rb,
lib/openai/models/realtime/realtime_session_create_response.rb,
lib/openai/models/realtime/response_content_part_done_event.rb,
lib/openai/models/realtime/response_mcp_call_arguments_done.rb,
lib/openai/models/realtime/response_output_item_added_event.rb,
lib/openai/models/responses/response_output_item_done_event.rb,
lib/openai/models/webhooks/eval_run_succeeded_webhook_event.rb,
lib/openai/models/webhooks/response_cancelled_webhook_event.rb,
lib/openai/models/webhooks/response_completed_webhook_event.rb,
lib/openai/models/beta/threads/runs/function_tool_call_delta.rb,
lib/openai/models/conversations/conversation_retrieve_params.rb,
lib/openai/models/eval_stored_completions_data_source_config.rb,
lib/openai/models/fine_tuning/alpha/grader_validate_response.rb,
lib/openai/models/realtime/conversation_item_truncated_event.rb,
lib/openai/models/realtime/realtime_mcp_tool_execution_error.rb,
lib/openai/models/realtime/realtime_response_create_mcp_tool.rb,
lib/openai/models/realtime/response_content_part_added_event.rb,
lib/openai/models/realtime/response_mcp_call_arguments_delta.rb,
lib/openai/models/responses/response_content_part_done_event.rb,
lib/openai/models/responses/response_custom_tool_call_output.rb,
lib/openai/models/responses/response_function_tool_call_item.rb,
lib/openai/models/responses/response_output_item_added_event.rb,
lib/openai/models/static_file_chunking_strategy_object_param.rb,
lib/openai/models/vector_stores/file_batch_list_files_params.rb,
lib/openai/models/webhooks/response_incomplete_webhook_event.rb,
lib/openai/models/beta/chatkit/chat_session_rate_limits_param.rb,
lib/openai/models/beta/threads/file_citation_delta_annotation.rb,
lib/openai/models/beta/threads/run_submit_tool_outputs_params.rb,
lib/openai/models/chat/chat_completion_function_message_param.rb,
lib/openai/models/conversations/conversation_deleted_resource.rb,
lib/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rb,
lib/openai/models/realtime/input_audio_buffer_committed_event.rb,
lib/openai/models/responses/response_content_part_added_event.rb,
lib/openai/models/responses/response_function_shell_tool_call.rb,
lib/openai/models/responses/response_mcp_call_completed_event.rb,
lib/openai/models/beta/threads/runs/code_interpreter_tool_call.rb,
lib/openai/models/chat/chat_completion_assistant_message_param.rb,
lib/openai/models/chat/chat_completion_developer_message_param.rb,
lib/openai/models/realtime/realtime_audio_input_turn_detection.rb,
lib/openai/models/realtime/realtime_truncation_retention_ratio.rb,
lib/openai/models/realtime/transcription_session_updated_event.rb,
lib/openai/models/responses/response_function_call_output_item.rb,
lib/openai/models/responses/response_reasoning_text_done_event.rb,
lib/openai/models/beta/chatkit/chat_session_expires_after_param.rb,
lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb,
lib/openai/models/beta/threads/runs/file_search_tool_call_delta.rb,
lib/openai/models/chat/chat_completion_content_part_input_audio.rb,
lib/openai/models/chat/chat_completion_message_custom_tool_call.rb,
lib/openai/models/chat/chat_completion_named_tool_choice_custom.rb,
lib/openai/models/evals/create_eval_completions_run_data_source.rb,
lib/openai/models/fine_tuning/fine_tuning_job_wandb_integration.rb,
lib/openai/models/realtime/input_audio_buffer_timeout_triggered.rb,
lib/openai/models/realtime/realtime_transcription_session_audio.rb,
lib/openai/models/realtime/response_audio_transcript_done_event.rb,
lib/openai/models/responses/response_code_interpreter_tool_call.rb,
lib/openai/models/responses/response_input_message_content_list.rb,
lib/openai/models/responses/response_mcp_call_in_progress_event.rb,
lib/openai/models/responses/response_reasoning_text_delta_event.rb,
lib/openai/models/webhooks/fine_tuning_job_failed_webhook_event.rb,
lib/openai/models/webhooks/realtime_call_incoming_webhook_event.rb,
lib/openai/models/beta/threads/runs/run_step_delta_message_delta.rb,
lib/openai/models/realtime/realtime_response_create_audio_output.rb,
lib/openai/models/realtime/response_audio_transcript_delta_event.rb,
lib/openai/models/responses/response_audio_transcript_done_event.rb,
lib/openai/models/responses/response_mcp_list_tools_failed_event.rb,
lib/openai/models/beta/chatkit/chat_session_chatkit_configuration.rb,
lib/openai/models/beta/threads/required_action_function_tool_call.rb,
lib/openai/models/beta/threads/runs/code_interpreter_output_image.rb,
lib/openai/models/beta/threads/runs/message_creation_step_details.rb,
lib/openai/models/chat/chat_completion_message_function_tool_call.rb,
lib/openai/models/responses/response_apply_patch_tool_call_output.rb,
lib/openai/models/responses/response_audio_transcript_delta_event.rb,
lib/openai/models/fine_tuning/checkpoints/permission_create_params.rb,
lib/openai/models/fine_tuning/checkpoints/permission_delete_params.rb,
lib/openai/models/realtime/input_audio_buffer_speech_started_event.rb,
lib/openai/models/realtime/input_audio_buffer_speech_stopped_event.rb,
lib/openai/models/realtime/realtime_conversation_item_user_message.rb,
lib/openai/models/responses/response_mcp_call_arguments_done_event.rb,
lib/openai/models/webhooks/fine_tuning_job_cancelled_webhook_event.rb,
lib/openai/models/webhooks/fine_tuning_job_succeeded_webhook_event.rb,
lib/openai/models/realtime/realtime_conversation_item_function_call.rb,
lib/openai/models/responses/response_computer_tool_call_output_item.rb,
lib/openai/models/responses/response_format_text_json_schema_config.rb,
lib/openai/models/responses/response_function_call_output_item_list.rb,
lib/openai/models/responses/response_function_tool_call_output_item.rb,
lib/openai/models/responses/response_image_gen_call_completed_event.rb,
lib/openai/models/responses/response_mcp_call_arguments_delta_event.rb,
lib/openai/models/responses/response_mcp_list_tools_completed_event.rb,
lib/openai/models/beta/chatkit/chat_session_automatic_thread_titling.rb,
lib/openai/models/beta/chatkit/chatkit_thread_assistant_message_item.rb,
lib/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rb,
lib/openai/models/fine_tuning/checkpoints/permission_create_response.rb,
lib/openai/models/fine_tuning/checkpoints/permission_delete_response.rb,
lib/openai/models/fine_tuning/checkpoints/permission_retrieve_params.rb,
lib/openai/models/realtime/realtime_conversation_item_system_message.rb,
lib/openai/models/responses/response_function_shell_tool_call_output.rb,
lib/openai/models/responses/response_image_gen_call_generating_event.rb,
lib/openai/models/responses/response_web_search_call_completed_event.rb,
lib/openai/models/responses/response_web_search_call_searching_event.rb,
lib/openai/models/realtime/realtime_transcription_session_audio_input.rb,
lib/openai/models/responses/response_file_search_call_completed_event.rb,
lib/openai/models/responses/response_file_search_call_searching_event.rb,
lib/openai/models/responses/response_image_gen_call_in_progress_event.rb,
lib/openai/models/responses/response_mcp_list_tools_in_progress_event.rb,
lib/openai/models/fine_tuning/checkpoints/permission_retrieve_response.rb,
lib/openai/models/fine_tuning/fine_tuning_job_wandb_integration_object.rb,
lib/openai/models/realtime/realtime_response_usage_input_token_details.rb,
lib/openai/models/realtime/response_function_call_arguments_done_event.rb,
lib/openai/models/responses/response_custom_tool_call_input_done_event.rb,
lib/openai/models/responses/response_reasoning_summary_part_done_event.rb,
lib/openai/models/responses/response_reasoning_summary_text_done_event.rb,
lib/openai/models/responses/response_web_search_call_in_progress_event.rb,
lib/openai/models/beta/chatkit/chat_session_chatkit_configuration_param.rb,
lib/openai/models/realtime/input_audio_buffer_dtmf_event_received_event.rb,
lib/openai/models/realtime/realtime_conversation_item_assistant_message.rb,
lib/openai/models/realtime/realtime_response_usage_output_token_details.rb,
lib/openai/models/realtime/response_function_call_arguments_delta_event.rb,
lib/openai/models/responses/response_custom_tool_call_input_delta_event.rb,
lib/openai/models/responses/response_file_search_call_in_progress_event.rb,
lib/openai/models/responses/response_function_call_arguments_done_event.rb,
lib/openai/models/responses/response_function_shell_call_output_content.rb,
lib/openai/models/responses/response_image_gen_call_partial_image_event.rb,
lib/openai/models/responses/response_output_text_annotation_added_event.rb,
lib/openai/models/responses/response_reasoning_summary_part_added_event.rb,
lib/openai/models/responses/response_reasoning_summary_text_delta_event.rb,
lib/openai/models/realtime/realtime_transcription_session_create_request.rb,
lib/openai/models/realtime/realtime_transcription_session_turn_detection.rb,
lib/openai/models/responses/response_function_call_arguments_delta_event.rb,
lib/openai/models/realtime/realtime_transcription_session_create_response.rb,
lib/openai/models/responses/response_computer_tool_call_output_screenshot.rb,
lib/openai/models/realtime/realtime_conversation_item_function_call_output.rb,
lib/openai/models/responses/response_code_interpreter_call_code_done_event.rb,
lib/openai/models/responses/response_code_interpreter_call_completed_event.rb,
lib/openai/models/responses/response_code_interpreter_call_code_delta_event.rb,
lib/openai/models/responses/response_code_interpreter_call_in_progress_event.rb,
lib/openai/models/responses/response_code_interpreter_call_interpreting_event.rb,
lib/openai/models/realtime/conversation_item_input_audio_transcription_segment.rb,
lib/openai/models/realtime/conversation_item_input_audio_transcription_delta_event.rb,
lib/openai/models/realtime/conversation_item_input_audio_transcription_failed_event.rb,
lib/openai/models/realtime/realtime_transcription_session_audio_input_turn_detection.rb,
lib/openai/models/realtime/conversation_item_input_audio_transcription_completed_event.rb

Defined Under Namespace

Modules: AllModels, Audio, AudioModel, AudioResponseFormat, Beta, Chat, ChatModel, Containers, Conversations, CustomToolInputFormat, EmbeddingModel, Evals, FileChunkingStrategy, FileChunkingStrategyParam, FilePurpose, FineTuning, Graders, ImageEditStreamEvent, ImageGenStreamEvent, ImageModel, ModerationModel, ModerationMultiModalInput, Realtime, ReasoningEffort, Responses, ResponsesModel, Uploads, VectorStores, VideoModel, VideoSeconds, VideoSize, Webhooks Classes: AutoFileChunkingStrategyParam, Batch, BatchCancelParams, BatchCreateParams, BatchError, BatchListParams, BatchRequestCounts, BatchRetrieveParams, BatchUsage, ComparisonFilter, Completion, CompletionChoice, CompletionCreateParams, CompletionUsage, CompoundFilter, ContainerCreateParams, ContainerCreateResponse, ContainerDeleteParams, ContainerListParams, ContainerListResponse, ContainerRetrieveParams, ContainerRetrieveResponse, CreateEmbeddingResponse, Embedding, EmbeddingCreateParams, ErrorObject, EvalCreateParams, EvalCreateResponse, EvalCustomDataSourceConfig, EvalDeleteParams, EvalDeleteResponse, EvalListParams, EvalListResponse, EvalRetrieveParams, EvalRetrieveResponse, EvalStoredCompletionsDataSourceConfig, EvalUpdateParams, EvalUpdateResponse, FileContentParams, FileCreateParams, FileDeleteParams, FileDeleted, FileListParams, FileObject, FileRetrieveParams, FunctionDefinition, Image, ImageCreateVariationParams, ImageEditCompletedEvent, ImageEditParams, ImageEditPartialImageEvent, ImageGenCompletedEvent, ImageGenPartialImageEvent, ImageGenerateParams, ImagesResponse, Model, ModelDeleteParams, ModelDeleted, ModelListParams, ModelRetrieveParams, Moderation, ModerationCreateParams, ModerationCreateResponse, ModerationImageURLInput, ModerationTextInput, OtherFileChunkingStrategyObject, Reasoning, ResponseFormatJSONObject, ResponseFormatJSONSchema, ResponseFormatText, ResponseFormatTextGrammar, ResponseFormatTextPython, StaticFileChunkingStrategy, StaticFileChunkingStrategyObject, StaticFileChunkingStrategyObjectParam, Upload, UploadCancelParams, UploadCompleteParams, UploadCreateParams, VectorStore, VectorStoreCreateParams, VectorStoreDeleteParams, VectorStoreDeleted, VectorStoreListParams, VectorStoreRetrieveParams, VectorStoreSearchParams, VectorStoreSearchResponse, VectorStoreUpdateParams, Video, VideoCreateError, VideoCreateParams, VideoDeleteParams, VideoDeleteResponse, VideoDownloadContentParams, VideoListParams, VideoRemixParams, VideoRetrieveParams

Constant Summary

Metadata =

OpenAI::Internal::Type::HashOf[String]

FileContent =

String

FunctionParameters =

OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]

UploadPart =

Uploads::UploadPart

ChatCompletion =

Chat::ChatCompletion

EvalAPIError =

Evals::EvalAPIError

MultiGrader =

Graders::MultiGrader

PythonGrader =

Graders::PythonGrader

ChatCompletionRole =

Chat::ChatCompletionRole

ChatCompletionTool =

Chat::ChatCompletionTool

ChatCompletionAudio =

Chat::ChatCompletionAudio

ChatCompletionChunk =

Chat::ChatCompletionChunk

LabelModelGrader =

Graders::LabelModelGrader

ScoreModelGrader =

Graders::ScoreModelGrader

FineTuningJob =

FineTuning::FineTuningJob

StringCheckGrader =

Graders::StringCheckGrader

ChatCompletionDeleted =

Chat::ChatCompletionDeleted

ChatCompletionMessage =

Chat::ChatCompletionMessage

ResponseItemList =

Responses::ResponseItemList

ChatCompletionModality =

Chat::ChatCompletionModality

TextSimilarityGrader =

Graders::TextSimilarityGrader

ConversationItem =

Conversations::ConversationItem

VectorStoreFile =

VectorStores::VectorStoreFile

ChatCompletionAudioParam =

Chat::ChatCompletionAudioParam

ChatCompletionCustomTool =

Chat::ChatCompletionCustomTool

ChatCompletionContentPart =

Chat::ChatCompletionContentPart

FineTuningJobEvent =

FineTuning::FineTuningJobEvent

ChatCompletionFunctionTool =

Chat::ChatCompletionFunctionTool

ChatCompletionMessageParam =

Chat::ChatCompletionMessageParam

ChatCompletionStoreMessage =

Chat::ChatCompletionStoreMessage

ChatCompletionTokenLogprob =

Chat::ChatCompletionTokenLogprob

ChatCompletionStreamOptions =

Chat::ChatCompletionStreamOptions

ConversationItemList =

Conversations::ConversationItemList

ChatCompletionReasoningEffort =

Chat::ChatCompletionReasoningEffort

VectorStoreFileBatch =

VectorStores::VectorStoreFileBatch

ChatCompletionContentPartText =

Chat::ChatCompletionContentPartText

ChatCompletionMessageToolCall =

Chat::ChatCompletionMessageToolCall

ChatCompletionNamedToolChoice =

Chat::ChatCompletionNamedToolChoice

ChatCompletionContentPartImage =

Chat::ChatCompletionContentPartImage

ChatCompletionPredictionContent =

Chat::ChatCompletionPredictionContent

ChatCompletionToolChoiceOption =

Chat::ChatCompletionToolChoiceOption

ChatCompletionToolMessageParam =

Chat::ChatCompletionToolMessageParam

ChatCompletionUserMessageParam =

Chat::ChatCompletionUserMessageParam

FineTuningJobIntegration =

FineTuning::FineTuningJobIntegration

RealtimeSessionClientSecret =

Realtime::RealtimeSessionClientSecret

VectorStoreFileDeleted =

VectorStores::VectorStoreFileDeleted

ChatCompletionAllowedToolChoice =

Chat::ChatCompletionAllowedToolChoice

ChatCompletionContentPartRefusal =

Chat::ChatCompletionContentPartRefusal

ChatCompletionFunctionCallOption =

Chat::ChatCompletionFunctionCallOption

ChatCompletionSystemMessageParam =

Chat::ChatCompletionSystemMessageParam

RealtimeSessionCreateResponse =

Realtime::RealtimeSessionCreateResponse

ChatCompletionFunctionMessageParam =

Chat::ChatCompletionFunctionMessageParam

ChatCompletionAssistantMessageParam =

Chat::ChatCompletionAssistantMessageParam

ChatCompletionDeveloperMessageParam =

Chat::ChatCompletionDeveloperMessageParam

ChatCompletionContentPartInputAudio =

Chat::ChatCompletionContentPartInputAudio

ChatCompletionMessageCustomToolCall =

Chat::ChatCompletionMessageCustomToolCall

ChatCompletionNamedToolChoiceCustom =

Chat::ChatCompletionNamedToolChoiceCustom

FineTuningJobWandbIntegration =

FineTuning::FineTuningJobWandbIntegration

ChatCompletionMessageFunctionToolCall =

Chat::ChatCompletionMessageFunctionToolCall

FineTuningJobWandbIntegrationObject =

FineTuning::FineTuningJobWandbIntegrationObject

RealtimeTranscriptionSessionTurnDetection =

Realtime::RealtimeTranscriptionSessionTurnDetection

RealtimeTranscriptionSessionCreateResponse =

Realtime::RealtimeTranscriptionSessionCreateResponse

Class Method Summary

• .values ⇒ Array<Symbol>
• .variants ⇒ Array(Symbol, :auto, OpenAI::Models::Realtime::RealtimeSessionCreateResponse::Tracing::TracingConfiguration)

Instance Method Summary

• #initialize(prefix_padding_ms: nil, silence_duration_ms: nil, threshold: nil, type: nil) ⇒ Object

  Some parameter documentations has been truncated, see Realtime::RealtimeTranscriptionSessionTurnDetection for more details.

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/openai/models/chat/chat_completion.rb', line 219

.variants ⇒ Array(Symbol, :auto, OpenAI::Models::Realtime::RealtimeSessionCreateResponse::Tracing::TracingConfiguration)

Returns:

• (Array(Symbol, :auto, OpenAI::Models::Realtime::RealtimeSessionCreateResponse::Tracing::TracingConfiguration))

# File 'lib/openai/models/graders/multi_grader.rb', line 70

Instance Method Details

#initialize(prefix_padding_ms: nil, silence_duration_ms: nil, threshold: nil, type: nil) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Realtime::RealtimeTranscriptionSessionTurnDetection for more details.

Configuration for turn detection. Can be set to ‘null` to turn off. Server VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech.

Parameters:

• prefix_padding_ms (Integer) (defaults to: nil) —

  Amount of audio to include before the VAD detected speech (in

• silence_duration_ms (Integer) (defaults to: nil) —

  Duration of silence to detect speech stop (in milliseconds). Defaults

• threshold (Float) (defaults to: nil) —

  Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A

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

  Type of turn detection, only ‘server_vad` is currently supported.

# File 'lib/openai/models/uploads/upload_part.rb', line 32