openai 0.130.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +36 -0
- data/README.md +39 -3
- data/lib/openai/client.rb +0 -4
- data/lib/openai/internal/type/union.rb +5 -1
- data/lib/openai/models/batch_create_params.rb +6 -19
- data/lib/openai/models/beta/beta_compacted_response.rb +3 -3
- data/lib/openai/models/beta/beta_response.rb +0 -18
- data/lib/openai/models/beta/beta_responses_client_event.rb +0 -26
- data/lib/openai/models/beta/response_compact_params.rb +0 -18
- data/lib/openai/models/beta/response_create_params.rb +0 -18
- data/lib/openai/models/chat/completion_create_params.rb +8 -6
- data/lib/openai/models/chat_model.rb +0 -12
- data/lib/openai/models/completion_create_params.rb +4 -2
- data/lib/openai/models/graders/multi_grader.rb +11 -15
- data/lib/openai/models/image_edit_completed_event.rb +9 -17
- data/lib/openai/models/image_edit_partial_image_event.rb +9 -17
- data/lib/openai/models/image_gen_completed_event.rb +9 -17
- data/lib/openai/models/image_gen_partial_image_event.rb +9 -17
- data/lib/openai/models/images_response.rb +8 -14
- data/lib/openai/models/live/responses_delegation_config.rb +47 -21
- data/lib/openai/models/live/responses_delegation_update_config.rb +47 -21
- data/lib/openai/models/responses/compacted_response.rb +3 -3
- data/lib/openai/models/responses/response_compact_params.rb +0 -18
- data/lib/openai/models.rb +0 -32
- data/lib/openai/providers/vertex.rb +9 -6
- data/lib/openai/resources/batches.rb +2 -6
- data/lib/openai/resources/beta.rb +0 -10
- data/lib/openai/resources/chat/completions.rb +8 -6
- data/lib/openai/resources/completions.rb +4 -2
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +0 -114
- data/rbi/openai/client.rbi +0 -3
- data/rbi/openai/models/batch_create_params.rbi +6 -19
- data/rbi/openai/models/beta/beta_compacted_response.rbi +22 -20
- data/rbi/openai/models/beta/beta_response.rbi +0 -3
- data/rbi/openai/models/beta/beta_responses_client_event.rbi +0 -12
- data/rbi/openai/models/beta/response_compact_params.rbi +0 -9
- data/rbi/openai/models/beta/response_create_params.rbi +0 -6
- data/rbi/openai/models/chat/completion_create_params.rbi +8 -6
- data/rbi/openai/models/chat_model.rbi +0 -3
- data/rbi/openai/models/completion_create_params.rbi +4 -2
- data/rbi/openai/models/graders/multi_grader.rbi +32 -27
- data/rbi/openai/models/image_edit_completed_event.rbi +11 -8
- data/rbi/openai/models/image_edit_partial_image_event.rbi +11 -8
- data/rbi/openai/models/image_gen_completed_event.rbi +11 -8
- data/rbi/openai/models/image_gen_partial_image_event.rbi +11 -8
- data/rbi/openai/models/images_response.rbi +6 -6
- data/rbi/openai/models/live/responses_delegation_config.rbi +54 -30
- data/rbi/openai/models/live/responses_delegation_update_config.rbi +54 -30
- data/rbi/openai/models/responses/compacted_response.rbi +19 -17
- data/rbi/openai/models/responses/response_compact_params.rbi +0 -12
- data/rbi/openai/models.rbi +0 -32
- data/rbi/openai/resources/batches.rbi +2 -6
- data/rbi/openai/resources/beta.rbi +0 -8
- data/rbi/openai/resources/chat/completions.rbi +8 -6
- data/rbi/openai/resources/completions.rbi +4 -2
- data/sig/openai/client.rbs +0 -2
- data/sig/openai/models/batch_create_params.rbs +4 -14
- data/sig/openai/models/beta/beta_compacted_response.rbs +4 -4
- data/sig/openai/models/beta/beta_response.rbs +0 -6
- data/sig/openai/models/beta/beta_responses_client_event.rbs +0 -6
- data/sig/openai/models/beta/response_compact_params.rbs +0 -6
- data/sig/openai/models/beta/response_create_params.rbs +0 -6
- data/sig/openai/models/chat/completion_create_params.rbs +8 -6
- data/sig/openai/models/chat_model.rbs +0 -6
- data/sig/openai/models/completion_create_params.rbs +4 -2
- data/sig/openai/models/graders/multi_grader.rbs +7 -12
- data/sig/openai/models/image_edit_completed_event.rbs +11 -9
- data/sig/openai/models/image_edit_partial_image_event.rbs +11 -9
- data/sig/openai/models/image_gen_completed_event.rbs +11 -9
- data/sig/openai/models/image_gen_partial_image_event.rbs +11 -9
- data/sig/openai/models/images_response.rbs +5 -7
- data/sig/openai/models/live/responses_delegation_config.rbs +50 -18
- data/sig/openai/models/live/responses_delegation_update_config.rbs +50 -18
- data/sig/openai/models/responses/compacted_response.rbs +4 -4
- data/sig/openai/models/responses/response_compact_params.rbs +0 -6
- data/sig/openai/models.rbs +0 -32
- data/sig/openai/resources/beta.rbs +0 -4
- metadata +1 -343
- data/lib/openai/models/beta/assistant.rb +0 -270
- data/lib/openai/models/beta/assistant_create_params.rb +0 -448
- data/lib/openai/models/beta/assistant_delete_params.rb +0 -22
- data/lib/openai/models/beta/assistant_deleted.rb +0 -30
- data/lib/openai/models/beta/assistant_list_params.rb +0 -80
- data/lib/openai/models/beta/assistant_response_format_option.rb +0 -50
- data/lib/openai/models/beta/assistant_retrieve_params.rb +0 -22
- data/lib/openai/models/beta/assistant_stream_event.rb +0 -688
- data/lib/openai/models/beta/assistant_tool.rb +0 -22
- data/lib/openai/models/beta/assistant_tool_choice.rb +0 -43
- data/lib/openai/models/beta/assistant_tool_choice_function.rb +0 -19
- data/lib/openai/models/beta/assistant_tool_choice_option.rb +0 -42
- data/lib/openai/models/beta/assistant_update_params.rb +0 -450
- data/lib/openai/models/beta/code_interpreter_tool.rb +0 -19
- data/lib/openai/models/beta/file_search_tool.rb +0 -123
- data/lib/openai/models/beta/function_tool.rb +0 -26
- data/lib/openai/models/beta/message_stream_event.rb +0 -159
- data/lib/openai/models/beta/run_step_stream_event.rb +0 -201
- data/lib/openai/models/beta/run_stream_event.rb +0 -288
- data/lib/openai/models/beta/thread.rb +0 -133
- data/lib/openai/models/beta/thread_create_and_run_params.rb +0 -857
- data/lib/openai/models/beta/thread_create_params.rb +0 -443
- data/lib/openai/models/beta/thread_delete_params.rb +0 -22
- data/lib/openai/models/beta/thread_deleted.rb +0 -30
- data/lib/openai/models/beta/thread_retrieve_params.rb +0 -22
- data/lib/openai/models/beta/thread_stream_event.rb +0 -41
- data/lib/openai/models/beta/thread_update_params.rb +0 -114
- data/lib/openai/models/beta/threads/annotation.rb +0 -27
- data/lib/openai/models/beta/threads/annotation_delta.rb +0 -27
- data/lib/openai/models/beta/threads/file_citation_annotation.rb +0 -68
- data/lib/openai/models/beta/threads/file_citation_delta_annotation.rb +0 -86
- data/lib/openai/models/beta/threads/file_path_annotation.rb +0 -67
- data/lib/openai/models/beta/threads/file_path_delta_annotation.rb +0 -76
- data/lib/openai/models/beta/threads/image_file.rb +0 -51
- data/lib/openai/models/beta/threads/image_file_content_block.rb +0 -32
- data/lib/openai/models/beta/threads/image_file_delta.rb +0 -51
- data/lib/openai/models/beta/threads/image_file_delta_block.rb +0 -41
- data/lib/openai/models/beta/threads/image_url.rb +0 -49
- data/lib/openai/models/beta/threads/image_url_content_block.rb +0 -30
- data/lib/openai/models/beta/threads/image_url_delta.rb +0 -49
- data/lib/openai/models/beta/threads/image_url_delta_block.rb +0 -39
- data/lib/openai/models/beta/threads/message.rb +0 -272
- data/lib/openai/models/beta/threads/message_content.rb +0 -33
- data/lib/openai/models/beta/threads/message_content_delta.rb +0 -33
- data/lib/openai/models/beta/threads/message_content_part_param.rb +0 -30
- data/lib/openai/models/beta/threads/message_create_params.rb +0 -172
- data/lib/openai/models/beta/threads/message_delete_params.rb +0 -30
- data/lib/openai/models/beta/threads/message_deleted.rb +0 -32
- data/lib/openai/models/beta/threads/message_delta.rb +0 -48
- data/lib/openai/models/beta/threads/message_delta_event.rb +0 -42
- data/lib/openai/models/beta/threads/message_list_params.rb +0 -98
- data/lib/openai/models/beta/threads/message_retrieve_params.rb +0 -30
- data/lib/openai/models/beta/threads/message_update_params.rb +0 -51
- data/lib/openai/models/beta/threads/refusal_content_block.rb +0 -30
- data/lib/openai/models/beta/threads/refusal_delta_block.rb +0 -39
- data/lib/openai/models/beta/threads/required_action_function_tool_call.rb +0 -73
- data/lib/openai/models/beta/threads/run.rb +0 -557
- data/lib/openai/models/beta/threads/run_cancel_params.rb +0 -30
- data/lib/openai/models/beta/threads/run_create_params.rb +0 -565
- data/lib/openai/models/beta/threads/run_list_params.rb +0 -89
- data/lib/openai/models/beta/threads/run_retrieve_params.rb +0 -30
- data/lib/openai/models/beta/threads/run_status.rb +0 -29
- data/lib/openai/models/beta/threads/run_submit_tool_outputs_params.rb +0 -69
- data/lib/openai/models/beta/threads/run_update_params.rb +0 -51
- data/lib/openai/models/beta/threads/runs/code_interpreter_logs.rb +0 -43
- data/lib/openai/models/beta/threads/runs/code_interpreter_output_image.rb +0 -54
- data/lib/openai/models/beta/threads/runs/code_interpreter_tool_call.rb +0 -161
- data/lib/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rb +0 -107
- data/lib/openai/models/beta/threads/runs/file_search_tool_call.rb +0 -207
- data/lib/openai/models/beta/threads/runs/file_search_tool_call_delta.rb +0 -52
- data/lib/openai/models/beta/threads/runs/function_tool_call.rb +0 -78
- data/lib/openai/models/beta/threads/runs/function_tool_call_delta.rb +0 -87
- data/lib/openai/models/beta/threads/runs/message_creation_step_details.rb +0 -48
- data/lib/openai/models/beta/threads/runs/run_step.rb +0 -311
- data/lib/openai/models/beta/threads/runs/run_step_delta.rb +0 -45
- data/lib/openai/models/beta/threads/runs/run_step_delta_event.rb +0 -46
- data/lib/openai/models/beta/threads/runs/run_step_delta_message_delta.rb +0 -47
- data/lib/openai/models/beta/threads/runs/run_step_include.rb +0 -22
- data/lib/openai/models/beta/threads/runs/step_list_params.rb +0 -122
- data/lib/openai/models/beta/threads/runs/step_retrieve_params.rb +0 -65
- data/lib/openai/models/beta/threads/runs/tool_call.rb +0 -28
- data/lib/openai/models/beta/threads/runs/tool_call_delta.rb +0 -28
- data/lib/openai/models/beta/threads/runs/tool_call_delta_object.rb +0 -41
- data/lib/openai/models/beta/threads/runs/tool_calls_step_details.rb +0 -38
- data/lib/openai/models/beta/threads/text.rb +0 -28
- data/lib/openai/models/beta/threads/text_content_block.rb +0 -30
- data/lib/openai/models/beta/threads/text_content_block_param.rb +0 -32
- data/lib/openai/models/beta/threads/text_delta.rb +0 -31
- data/lib/openai/models/beta/threads/text_delta_block.rb +0 -39
- data/lib/openai/models/image_input_reference_param.rb +0 -24
- data/lib/openai/models/video.rb +0 -161
- data/lib/openai/models/video_create_character_params.rb +0 -40
- data/lib/openai/models/video_create_character_response.rb +0 -36
- data/lib/openai/models/video_create_error.rb +0 -166
- data/lib/openai/models/video_create_params.rb +0 -85
- data/lib/openai/models/video_delete_params.rb +0 -20
- data/lib/openai/models/video_delete_response.rb +0 -38
- data/lib/openai/models/video_download_content_params.rb +0 -42
- data/lib/openai/models/video_edit_params.rb +0 -68
- data/lib/openai/models/video_extend_params.rb +0 -79
- data/lib/openai/models/video_get_character_params.rb +0 -20
- data/lib/openai/models/video_get_character_response.rb +0 -36
- data/lib/openai/models/video_list_params.rb +0 -55
- data/lib/openai/models/video_model.rb +0 -38
- data/lib/openai/models/video_remix_params.rb +0 -30
- data/lib/openai/models/video_retrieve_params.rb +0 -20
- data/lib/openai/models/video_seconds.rb +0 -16
- data/lib/openai/models/video_size.rb +0 -17
- data/lib/openai/resources/beta/assistants.rb +0 -320
- data/lib/openai/resources/beta/threads/messages.rb +0 -236
- data/lib/openai/resources/beta/threads/runs/steps.rb +0 -141
- data/lib/openai/resources/beta/threads/runs.rb +0 -623
- data/lib/openai/resources/beta/threads.rb +0 -444
- data/lib/openai/resources/videos.rb +0 -354
- data/rbi/openai/models/beta/assistant.rbi +0 -411
- data/rbi/openai/models/beta/assistant_create_params.rbi +0 -776
- data/rbi/openai/models/beta/assistant_delete_params.rbi +0 -53
- data/rbi/openai/models/beta/assistant_deleted.rbi +0 -60
- data/rbi/openai/models/beta/assistant_list_params.rbi +0 -132
- data/rbi/openai/models/beta/assistant_response_format_option.rbi +0 -49
- data/rbi/openai/models/beta/assistant_retrieve_params.rbi +0 -53
- data/rbi/openai/models/beta/assistant_stream_event.rbi +0 -1277
- data/rbi/openai/models/beta/assistant_tool.rbi +0 -28
- data/rbi/openai/models/beta/assistant_tool_choice.rbi +0 -79
- data/rbi/openai/models/beta/assistant_tool_choice_function.rbi +0 -49
- data/rbi/openai/models/beta/assistant_tool_choice_option.rbi +0 -53
- data/rbi/openai/models/beta/assistant_update_params.rbi +0 -556
- data/rbi/openai/models/beta/code_interpreter_tool.rbi +0 -49
- data/rbi/openai/models/beta/file_search_tool.rbi +0 -223
- data/rbi/openai/models/beta/function_tool.rbi +0 -59
- data/rbi/openai/models/beta/message_stream_event.rbi +0 -288
- data/rbi/openai/models/beta/run_step_stream_event.rbi +0 -378
- data/rbi/openai/models/beta/run_stream_event.rbi +0 -537
- data/rbi/openai/models/beta/thread.rbi +0 -255
- data/rbi/openai/models/beta/thread_create_and_run_params.rbi +0 -1461
- data/rbi/openai/models/beta/thread_create_params.rbi +0 -823
- data/rbi/openai/models/beta/thread_delete_params.rbi +0 -53
- data/rbi/openai/models/beta/thread_deleted.rbi +0 -60
- data/rbi/openai/models/beta/thread_retrieve_params.rbi +0 -53
- data/rbi/openai/models/beta/thread_stream_event.rbi +0 -75
- data/rbi/openai/models/beta/thread_update_params.rbi +0 -240
- data/rbi/openai/models/beta/threads/annotation.rbi +0 -34
- data/rbi/openai/models/beta/threads/annotation_delta.rbi +0 -34
- data/rbi/openai/models/beta/threads/file_citation_annotation.rbi +0 -132
- data/rbi/openai/models/beta/threads/file_citation_delta_annotation.rbi +0 -166
- data/rbi/openai/models/beta/threads/file_path_annotation.rbi +0 -131
- data/rbi/openai/models/beta/threads/file_path_delta_annotation.rbi +0 -153
- data/rbi/openai/models/beta/threads/image_file.rbi +0 -88
- data/rbi/openai/models/beta/threads/image_file_content_block.rbi +0 -66
- data/rbi/openai/models/beta/threads/image_file_delta.rbi +0 -91
- data/rbi/openai/models/beta/threads/image_file_delta_block.rbi +0 -75
- data/rbi/openai/models/beta/threads/image_url.rbi +0 -86
- data/rbi/openai/models/beta/threads/image_url_content_block.rbi +0 -64
- data/rbi/openai/models/beta/threads/image_url_delta.rbi +0 -89
- data/rbi/openai/models/beta/threads/image_url_delta_block.rbi +0 -73
- data/rbi/openai/models/beta/threads/message.rbi +0 -433
- data/rbi/openai/models/beta/threads/message_content.rbi +0 -36
- data/rbi/openai/models/beta/threads/message_content_delta.rbi +0 -36
- data/rbi/openai/models/beta/threads/message_content_part_param.rbi +0 -35
- data/rbi/openai/models/beta/threads/message_create_params.rbi +0 -299
- data/rbi/openai/models/beta/threads/message_delete_params.rbi +0 -64
- data/rbi/openai/models/beta/threads/message_deleted.rbi +0 -64
- data/rbi/openai/models/beta/threads/message_delta.rbi +0 -106
- data/rbi/openai/models/beta/threads/message_delta_event.rbi +0 -76
- data/rbi/openai/models/beta/threads/message_list_params.rbi +0 -157
- data/rbi/openai/models/beta/threads/message_retrieve_params.rbi +0 -64
- data/rbi/openai/models/beta/threads/message_update_params.rbi +0 -88
- data/rbi/openai/models/beta/threads/refusal_content_block.rbi +0 -61
- data/rbi/openai/models/beta/threads/refusal_delta_block.rbi +0 -73
- data/rbi/openai/models/beta/threads/required_action_function_tool_call.rbi +0 -130
- data/rbi/openai/models/beta/threads/run.rbi +0 -803
- data/rbi/openai/models/beta/threads/run_cancel_params.rbi +0 -64
- data/rbi/openai/models/beta/threads/run_create_params.rbi +0 -825
- data/rbi/openai/models/beta/threads/run_list_params.rbi +0 -144
- data/rbi/openai/models/beta/threads/run_retrieve_params.rbi +0 -64
- data/rbi/openai/models/beta/threads/run_status.rbi +0 -39
- data/rbi/openai/models/beta/threads/run_submit_tool_outputs_params.rbi +0 -132
- data/rbi/openai/models/beta/threads/run_update_params.rbi +0 -88
- data/rbi/openai/models/beta/threads/runs/code_interpreter_logs.rbi +0 -79
- data/rbi/openai/models/beta/threads/runs/code_interpreter_output_image.rbi +0 -118
- data/rbi/openai/models/beta/threads/runs/code_interpreter_tool_call.rbi +0 -315
- data/rbi/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rbi +0 -210
- data/rbi/openai/models/beta/threads/runs/file_search_tool_call.rbi +0 -409
- data/rbi/openai/models/beta/threads/runs/file_search_tool_call_delta.rbi +0 -89
- data/rbi/openai/models/beta/threads/runs/function_tool_call.rbi +0 -138
- data/rbi/openai/models/beta/threads/runs/function_tool_call_delta.rbi +0 -161
- data/rbi/openai/models/beta/threads/runs/message_creation_step_details.rbi +0 -111
- data/rbi/openai/models/beta/threads/runs/run_step.rbi +0 -422
- data/rbi/openai/models/beta/threads/runs/run_step_delta.rbi +0 -91
- data/rbi/openai/models/beta/threads/runs/run_step_delta_event.rbi +0 -82
- data/rbi/openai/models/beta/threads/runs/run_step_delta_message_delta.rbi +0 -113
- data/rbi/openai/models/beta/threads/runs/run_step_include.rbi +0 -37
- data/rbi/openai/models/beta/threads/runs/step_list_params.rbi +0 -181
- data/rbi/openai/models/beta/threads/runs/step_retrieve_params.rbi +0 -105
- data/rbi/openai/models/beta/threads/runs/tool_call.rbi +0 -37
- data/rbi/openai/models/beta/threads/runs/tool_call_delta.rbi +0 -37
- data/rbi/openai/models/beta/threads/runs/tool_call_delta_object.rbi +0 -91
- data/rbi/openai/models/beta/threads/runs/tool_calls_step_details.rbi +0 -77
- data/rbi/openai/models/beta/threads/text.rbi +0 -65
- data/rbi/openai/models/beta/threads/text_content_block.rbi +0 -64
- data/rbi/openai/models/beta/threads/text_content_block_param.rbi +0 -63
- data/rbi/openai/models/beta/threads/text_delta.rbi +0 -81
- data/rbi/openai/models/beta/threads/text_delta_block.rbi +0 -73
- data/rbi/openai/models/image_input_reference_param.rbi +0 -58
- data/rbi/openai/models/video.rbi +0 -203
- data/rbi/openai/models/video_create_character_params.rbi +0 -68
- data/rbi/openai/models/video_create_character_response.rbi +0 -63
- data/rbi/openai/models/video_create_error.rbi +0 -255
- data/rbi/openai/models/video_create_params.rbi +0 -132
- data/rbi/openai/models/video_delete_params.rbi +0 -49
- data/rbi/openai/models/video_delete_response.rbi +0 -64
- data/rbi/openai/models/video_download_content_params.rbi +0 -81
- data/rbi/openai/models/video_edit_params.rbi +0 -122
- data/rbi/openai/models/video_extend_params.rbi +0 -134
- data/rbi/openai/models/video_get_character_params.rbi +0 -49
- data/rbi/openai/models/video_get_character_response.rbi +0 -63
- data/rbi/openai/models/video_list_params.rbi +0 -101
- data/rbi/openai/models/video_model.rbi +0 -35
- data/rbi/openai/models/video_remix_params.rbi +0 -58
- data/rbi/openai/models/video_retrieve_params.rbi +0 -49
- data/rbi/openai/models/video_seconds.rbi +0 -22
- data/rbi/openai/models/video_size.rbi +0 -23
- data/rbi/openai/resources/beta/assistants.rbi +0 -285
- data/rbi/openai/resources/beta/threads/messages.rbi +0 -161
- data/rbi/openai/resources/beta/threads/runs/steps.rbi +0 -107
- data/rbi/openai/resources/beta/threads/runs.rbi +0 -527
- data/rbi/openai/resources/beta/threads.rbi +0 -391
- data/rbi/openai/resources/videos.rbi +0 -205
- data/sig/openai/models/beta/assistant.rbs +0 -278
- data/sig/openai/models/beta/assistant_create_params.rbs +0 -485
- data/sig/openai/models/beta/assistant_delete_params.rbs +0 -25
- data/sig/openai/models/beta/assistant_deleted.rbs +0 -28
- data/sig/openai/models/beta/assistant_list_params.rbs +0 -104
- data/sig/openai/models/beta/assistant_response_format_option.rbs +0 -17
- data/sig/openai/models/beta/assistant_retrieve_params.rbs +0 -25
- data/sig/openai/models/beta/assistant_stream_event.rbs +0 -645
- data/sig/openai/models/beta/assistant_tool.rbs +0 -16
- data/sig/openai/models/beta/assistant_tool_choice.rbs +0 -46
- data/sig/openai/models/beta/assistant_tool_choice_function.rbs +0 -18
- data/sig/openai/models/beta/assistant_tool_choice_option.rbs +0 -27
- data/sig/openai/models/beta/assistant_update_params.rbs +0 -396
- data/sig/openai/models/beta/code_interpreter_tool.rbs +0 -18
- data/sig/openai/models/beta/file_search_tool.rbs +0 -159
- data/sig/openai/models/beta/function_tool.rbs +0 -27
- data/sig/openai/models/beta/message_stream_event.rbs +0 -153
- data/sig/openai/models/beta/run_step_stream_event.rbs +0 -197
- data/sig/openai/models/beta/run_stream_event.rbs +0 -269
- data/sig/openai/models/beta/thread.rbs +0 -150
- data/sig/openai/models/beta/thread_create_and_run_params.rbs +0 -885
- data/sig/openai/models/beta/thread_create_params.rbs +0 -492
- data/sig/openai/models/beta/thread_delete_params.rbs +0 -25
- data/sig/openai/models/beta/thread_deleted.rbs +0 -28
- data/sig/openai/models/beta/thread_retrieve_params.rbs +0 -25
- data/sig/openai/models/beta/thread_stream_event.rbs +0 -43
- data/sig/openai/models/beta/thread_update_params.rbs +0 -137
- data/sig/openai/models/beta/threads/annotation.rbs +0 -17
- data/sig/openai/models/beta/threads/annotation_delta.rbs +0 -17
- data/sig/openai/models/beta/threads/file_citation_annotation.rbs +0 -63
- data/sig/openai/models/beta/threads/file_citation_delta_annotation.rbs +0 -93
- data/sig/openai/models/beta/threads/file_path_annotation.rbs +0 -63
- data/sig/openai/models/beta/threads/file_path_delta_annotation.rbs +0 -85
- data/sig/openai/models/beta/threads/image_file.rbs +0 -59
- data/sig/openai/models/beta/threads/image_file_content_block.rbs +0 -29
- data/sig/openai/models/beta/threads/image_file_delta.rbs +0 -64
- data/sig/openai/models/beta/threads/image_file_delta_block.rbs +0 -44
- data/sig/openai/models/beta/threads/image_url.rbs +0 -57
- data/sig/openai/models/beta/threads/image_url_content_block.rbs +0 -29
- data/sig/openai/models/beta/threads/image_url_delta.rbs +0 -61
- data/sig/openai/models/beta/threads/image_url_delta_block.rbs +0 -44
- data/sig/openai/models/beta/threads/message.rbs +0 -275
- data/sig/openai/models/beta/threads/message_content.rbs +0 -19
- data/sig/openai/models/beta/threads/message_content_delta.rbs +0 -19
- data/sig/openai/models/beta/threads/message_content_part_param.rbs +0 -18
- data/sig/openai/models/beta/threads/message_create_params.rbs +0 -167
- data/sig/openai/models/beta/threads/message_delete_params.rbs +0 -35
- data/sig/openai/models/beta/threads/message_deleted.rbs +0 -30
- data/sig/openai/models/beta/threads/message_delta.rbs +0 -56
- data/sig/openai/models/beta/threads/message_delta_event.rbs +0 -43
- data/sig/openai/models/beta/threads/message_list_params.rbs +0 -122
- data/sig/openai/models/beta/threads/message_retrieve_params.rbs +0 -35
- data/sig/openai/models/beta/threads/message_update_params.rbs +0 -53
- data/sig/openai/models/beta/threads/refusal_content_block.rbs +0 -22
- data/sig/openai/models/beta/threads/refusal_delta_block.rbs +0 -34
- data/sig/openai/models/beta/threads/required_action_function_tool_call.rbs +0 -69
- data/sig/openai/models/beta/threads/run.rbs +0 -545
- data/sig/openai/models/beta/threads/run_cancel_params.rbs +0 -35
- data/sig/openai/models/beta/threads/run_create_params.rbs +0 -524
- data/sig/openai/models/beta/threads/run_list_params.rbs +0 -111
- data/sig/openai/models/beta/threads/run_retrieve_params.rbs +0 -35
- data/sig/openai/models/beta/threads/run_status.rbs +0 -34
- data/sig/openai/models/beta/threads/run_submit_tool_outputs_params.rbs +0 -70
- data/sig/openai/models/beta/threads/run_update_params.rbs +0 -53
- data/sig/openai/models/beta/threads/runs/code_interpreter_logs.rbs +0 -40
- data/sig/openai/models/beta/threads/runs/code_interpreter_output_image.rbs +0 -65
- data/sig/openai/models/beta/threads/runs/code_interpreter_tool_call.rbs +0 -147
- data/sig/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rbs +0 -115
- data/sig/openai/models/beta/threads/runs/file_search_tool_call.rbs +0 -228
- data/sig/openai/models/beta/threads/runs/file_search_tool_call_delta.rbs +0 -58
- data/sig/openai/models/beta/threads/runs/function_tool_call.rbs +0 -80
- data/sig/openai/models/beta/threads/runs/function_tool_call_delta.rbs +0 -103
- data/sig/openai/models/beta/threads/runs/message_creation_step_details.rbs +0 -47
- data/sig/openai/models/beta/threads/runs/run_step.rbs +0 -290
- data/sig/openai/models/beta/threads/runs/run_step_delta.rbs +0 -46
- data/sig/openai/models/beta/threads/runs/run_step_delta_event.rbs +0 -47
- data/sig/openai/models/beta/threads/runs/run_step_delta_message_delta.rbs +0 -56
- data/sig/openai/models/beta/threads/runs/run_step_include.rbs +0 -22
- data/sig/openai/models/beta/threads/runs/step_list_params.rbs +0 -149
- data/sig/openai/models/beta/threads/runs/step_retrieve_params.rbs +0 -73
- data/sig/openai/models/beta/threads/runs/tool_call.rbs +0 -20
- data/sig/openai/models/beta/threads/runs/tool_call_delta.rbs +0 -20
- data/sig/openai/models/beta/threads/runs/tool_call_delta_object.rbs +0 -48
- data/sig/openai/models/beta/threads/runs/tool_calls_step_details.rbs +0 -41
- data/sig/openai/models/beta/threads/text.rbs +0 -32
- data/sig/openai/models/beta/threads/text_content_block.rbs +0 -26
- data/sig/openai/models/beta/threads/text_content_block_param.rbs +0 -25
- data/sig/openai/models/beta/threads/text_delta.rbs +0 -39
- data/sig/openai/models/beta/threads/text_delta_block.rbs +0 -44
- data/sig/openai/models/image_input_reference_param.rbs +0 -23
- data/sig/openai/models/video.rbs +0 -142
- data/sig/openai/models/video_create_character_params.rbs +0 -45
- data/sig/openai/models/video_create_character_response.rbs +0 -27
- data/sig/openai/models/video_create_error.rbs +0 -163
- data/sig/openai/models/video_create_params.rbs +0 -104
- data/sig/openai/models/video_delete_params.rbs +0 -23
- data/sig/openai/models/video_delete_response.rbs +0 -31
- data/sig/openai/models/video_download_content_params.rbs +0 -51
- data/sig/openai/models/video_edit_params.rbs +0 -77
- data/sig/openai/models/video_extend_params.rbs +0 -87
- data/sig/openai/models/video_get_character_params.rbs +0 -23
- data/sig/openai/models/video_get_character_response.rbs +0 -27
- data/sig/openai/models/video_list_params.rbs +0 -70
- data/sig/openai/models/video_model.rbs +0 -23
- data/sig/openai/models/video_remix_params.rbs +0 -34
- data/sig/openai/models/video_retrieve_params.rbs +0 -23
- data/sig/openai/models/video_seconds.rbs +0 -15
- data/sig/openai/models/video_size.rbs +0 -16
- data/sig/openai/resources/beta/assistants.rbs +0 -58
- data/sig/openai/resources/beta/threads/messages.rbs +0 -49
- data/sig/openai/resources/beta/threads/runs/steps.rbs +0 -32
- data/sig/openai/resources/beta/threads/runs.rbs +0 -99
- data/sig/openai/resources/beta/threads.rbs +0 -75
- data/sig/openai/resources/videos.rbs +0 -69
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c6cf11465a7fb571f146722ed9ce57e4889d1f567bbf5dfa84ecddf4515b1986
|
|
4
|
+
data.tar.gz: 6dfe8b19a85777e2ee96be56f31121fc10cfee1c51c789fcb5948c2b62d70094
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bbe8f6541ca6433a2846626a8ad23b214e17aa0ac5c469fee1b1be64ec2271f6e1968ca624f9cc42d02ea19a0dc0d4b96fc862927829caf93af6ea52f13d561d
|
|
7
|
+
data.tar.gz: 3bc1dd8587117e6c8f4e08ca3f8aba165e60978ccfc2ab41a6268edb25e68289410516881f275fa0a3d241dda4c85a2e689230baaf2424cc0c35ddb0def18652
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,41 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [1.0.0](https://github.com/openai/openai-ruby/compare/v0.130.0...v1.0.0) (2026-11-21)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### ⚠ BREAKING CHANGES
|
|
7
|
+
|
|
8
|
+
* **api:** Ruby 1.0 requires Ruby 3.3.0 or later. See the [Ruby SDK 1.0 migration guide](https://github.com/openai/openai-ruby/blob/v1.0.0/docs/MIGRATION_1.0.0.md) for code and type changes.
|
|
9
|
+
- **Assistants and Threads.** Removed `client.beta.assistants`, `client.beta.threads`, and their SDK types. Use Responses and Conversations.
|
|
10
|
+
- **Videos.** Removed `client.videos`, its SDK types, the Sora 2 model constants, and `/v1/videos` as a Batch endpoint.
|
|
11
|
+
- **Retired Chat Completions models.** Replace `GPT_4_VISION_PREVIEW`, `GPT_3_5_TURBO_0613`, and `GPT_3_5_TURBO_16K_0613` with a supported model ID.
|
|
12
|
+
- **Responses compaction.** GA output uses `ResponseItem` and beta output uses `BetaResponseItem`. Both can contain retained user, system, and developer messages alongside assistant output and compaction records. Update collection annotations and use `ResponseFunctionToolCallItem` or `BetaResponseFunctionToolCallItem` for compacted function calls.
|
|
13
|
+
- **Live Responses delegation.** Use `ToolChoice::Function` and `ToolChoice::Mcp` in delegation and update configs. MCP choices require `server_label` and allow `name` to be omitted or set to `nil`.
|
|
14
|
+
- **Named graders.** Pass a `graders:` hash keyed by grader name to `MultiGrader`, and use those names in `calculate_output`. Replace the `MultiGrader::Graders` type with `MultiGrader::Grader`.
|
|
15
|
+
- **Image sizes.** Read `size` as a string in image responses and generation or edit stream events. Compare it with a string such as `"1024x1024"`. The named size constants and `Size.values` use strings.
|
|
16
|
+
|
|
17
|
+
### Features
|
|
18
|
+
|
|
19
|
+
* **api:** release the Ruby SDK 1.0 API ([#1083](https://github.com/openai/openai-ruby/issues/1083)) ([6670181](https://github.com/openai/openai-ruby/commit/66701816f00c4b547ddbe70888342268a41b53e6))
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
### Bug Fixes
|
|
23
|
+
|
|
24
|
+
* **api:** decode assistant messages from `responses.input_items.list` as `ResponseOutputMessage` ([#883](https://github.com/openai/openai-ruby/issues/883)) ([6670181](https://github.com/openai/openai-ruby/commit/66701816f00c4b547ddbe70888342268a41b53e6))
|
|
25
|
+
* **vertex:** omit underlying exceptions from credential lookup and timeout errors ([#1051](https://github.com/openai/openai-ruby/issues/1051)) ([6670181](https://github.com/openai/openai-ruby/commit/66701816f00c4b547ddbe70888342268a41b53e6))
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
### Chores
|
|
29
|
+
|
|
30
|
+
* **deps:** bump ruby/setup-ruby from 1.342.0 to 1.343.0 ([#1096](https://github.com/openai/openai-ruby/issues/1096)) ([b5e3080](https://github.com/openai/openai-ruby/commit/b5e3080c777c878595447197932f466130a9dfc5))
|
|
31
|
+
* finalize Ruby 1.0 generation checkpoint ([#1099](https://github.com/openai/openai-ruby/issues/1099)) ([681e6a9](https://github.com/openai/openai-ruby/commit/681e6a990fd7b1714edbc007d9f7103be6fc7027))
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
### Documentation
|
|
35
|
+
|
|
36
|
+
* **api:** clarify when to omit completion choice count ([#1093](https://github.com/openai/openai-ruby/issues/1093)) ([f0f2c99](https://github.com/openai/openai-ruby/commit/f0f2c9988eeedeb8f6f575e06e24f961d5107500))
|
|
37
|
+
* explain nested request values and passing request models with `**params.to_hash` ([6670181](https://github.com/openai/openai-ruby/commit/66701816f00c4b547ddbe70888342268a41b53e6))
|
|
38
|
+
|
|
3
39
|
## [0.130.0](https://github.com/openai/openai-ruby/compare/v0.129.0...v0.130.0) (2026-11-19)
|
|
4
40
|
|
|
5
41
|
|
data/README.md
CHANGED
|
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
|
15
15
|
<!-- x-release-please-start-version -->
|
|
16
16
|
|
|
17
17
|
```ruby
|
|
18
|
-
gem "openai", "~> 0.
|
|
18
|
+
gem "openai", "~> 1.0.0"
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
<!-- x-release-please-end -->
|
|
@@ -1410,14 +1410,50 @@ Or, equivalently:
|
|
|
1410
1410
|
# Hashes work, but are not typesafe:
|
|
1411
1411
|
openai.chat.completions.create(messages: [{role: "user", content: "Say this is a test"}], model: "gpt-5.2")
|
|
1412
1412
|
|
|
1413
|
-
#
|
|
1413
|
+
# To submit a request model, pass its fields as keywords.
|
|
1414
1414
|
params = OpenAI::Chat::CompletionCreateParams.new(
|
|
1415
1415
|
messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(content: "Say this is a test")],
|
|
1416
1416
|
model: "gpt-5.2"
|
|
1417
1417
|
)
|
|
1418
|
-
openai.chat.completions.create(**params)
|
|
1418
|
+
openai.chat.completions.create(**params.to_hash)
|
|
1419
1419
|
```
|
|
1420
1420
|
|
|
1421
|
+
### Constructing nested request values
|
|
1422
|
+
|
|
1423
|
+
When you pass a message hash to a model constructor or setter, the model keeps
|
|
1424
|
+
the same hash. Accessing the nested value through `[]` or `to_h`, or copying the
|
|
1425
|
+
params with `ResponseCreateParams.new(**params)`, shares that message. You can
|
|
1426
|
+
keep using hash keys and edit the message before sending the request:
|
|
1427
|
+
|
|
1428
|
+
```ruby
|
|
1429
|
+
message = {role: "user", content: "Draft"}
|
|
1430
|
+
params = OpenAI::Responses::ResponseCreateParams.new(model: "gpt-5.2", input: [message])
|
|
1431
|
+
message[:content] = "Hello"
|
|
1432
|
+
openai.responses.create(**params) # sends "Hello"
|
|
1433
|
+
```
|
|
1434
|
+
|
|
1435
|
+
If your application owns a typed model, map its fields explicitly when building
|
|
1436
|
+
the request. For example, a Sorbet application can send the same message using
|
|
1437
|
+
an SDK object with a typed `content` reader:
|
|
1438
|
+
|
|
1439
|
+
```ruby
|
|
1440
|
+
require "sorbet-runtime"
|
|
1441
|
+
|
|
1442
|
+
class UserPrompt < T::Struct
|
|
1443
|
+
const :text, String
|
|
1444
|
+
end
|
|
1445
|
+
|
|
1446
|
+
prompt = UserPrompt.new(text: "Hello")
|
|
1447
|
+
message = OpenAI::Responses::EasyInputMessage.new(role: :user, content: prompt.text)
|
|
1448
|
+
params = OpenAI::Responses::ResponseCreateParams.new(model: "gpt-5.2", input: [message])
|
|
1449
|
+
openai.responses.create(**params)
|
|
1450
|
+
```
|
|
1451
|
+
|
|
1452
|
+
The generated RBI and RBS describe the fields on SDK objects. A hash you
|
|
1453
|
+
supply still uses hash access at runtime. This also applies when you construct
|
|
1454
|
+
a response model yourself. When the client parses an API response, it can
|
|
1455
|
+
build nested SDK objects and decode known enum values as symbols.
|
|
1456
|
+
|
|
1421
1457
|
### Enums
|
|
1422
1458
|
|
|
1423
1459
|
Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
|
data/lib/openai/client.rb
CHANGED
|
@@ -135,9 +135,6 @@ module OpenAI
|
|
|
135
135
|
# @return [OpenAI::Resources::Skills]
|
|
136
136
|
attr_reader :skills
|
|
137
137
|
|
|
138
|
-
# @return [OpenAI::Resources::Videos]
|
|
139
|
-
attr_reader :videos
|
|
140
|
-
|
|
141
138
|
# @api private
|
|
142
139
|
#
|
|
143
140
|
# @param security [Hash{Symbol=>Boolean}]
|
|
@@ -458,7 +455,6 @@ module OpenAI
|
|
|
458
455
|
@evals = OpenAI::Resources::Evals.new(client: self)
|
|
459
456
|
@containers = OpenAI::Resources::Containers.new(client: self)
|
|
460
457
|
@skills = OpenAI::Resources::Skills.new(client: self)
|
|
461
|
-
@videos = OpenAI::Resources::Videos.new(client: self)
|
|
462
458
|
end
|
|
463
459
|
end
|
|
464
460
|
end
|
|
@@ -100,7 +100,11 @@ module OpenAI
|
|
|
100
100
|
return nil if key == OpenAI::Internal::OMIT
|
|
101
101
|
|
|
102
102
|
key = key.to_sym if key.is_a?(String)
|
|
103
|
-
|
|
103
|
+
matches = known_variants.select { |k,| !k.nil? && k == key }
|
|
104
|
+
# A shared tag does not identify a variant; use the normal field matching.
|
|
105
|
+
return nil if matches.length > 1
|
|
106
|
+
|
|
107
|
+
_, found = matches.first
|
|
104
108
|
return OpenAI::Internal::Type::Converter.resolve_type(found, state: state) if found
|
|
105
109
|
|
|
106
110
|
known_variants.each do |variant_key, variant_fn|
|
|
@@ -15,12 +15,8 @@ module OpenAI
|
|
|
15
15
|
required :completion_window, enum: -> { OpenAI::BatchCreateParams::CompletionWindow }
|
|
16
16
|
|
|
17
17
|
# @!attribute endpoint
|
|
18
|
-
# The endpoint
|
|
19
|
-
#
|
|
20
|
-
# `/v1/moderations`, `/v1/images/generations`, `/v1/images/edits`, and
|
|
21
|
-
# `/v1/videos` are supported. Note that `/v1/embeddings` batches are also
|
|
22
|
-
# restricted to a maximum of 50,000 embedding inputs across all requests in the
|
|
23
|
-
# batch.
|
|
18
|
+
# The endpoint for all requests in the batch. Batches using `/v1/embeddings` can
|
|
19
|
+
# contain at most 50,000 embedding inputs across all requests.
|
|
24
20
|
#
|
|
25
21
|
# @return [Symbol, OpenAI::Models::BatchCreateParams::Endpoint]
|
|
26
22
|
required :endpoint, enum: -> { OpenAI::BatchCreateParams::Endpoint }
|
|
@@ -64,12 +60,8 @@ module OpenAI
|
|
|
64
60
|
# is supported.
|
|
65
61
|
#
|
|
66
62
|
# @param endpoint [Symbol, OpenAI::Models::BatchCreateParams::Endpoint]
|
|
67
|
-
# The endpoint
|
|
68
|
-
#
|
|
69
|
-
# `/v1/moderations`, `/v1/images/generations`, `/v1/images/edits`, and
|
|
70
|
-
# `/v1/videos` are supported. Note that `/v1/embeddings` batches are also
|
|
71
|
-
# restricted to a maximum of 50,000 embedding inputs across all requests in the
|
|
72
|
-
# batch.
|
|
63
|
+
# The endpoint for all requests in the batch. Batches using `/v1/embeddings` can
|
|
64
|
+
# contain at most 50,000 embedding inputs across all requests.
|
|
73
65
|
#
|
|
74
66
|
# @param input_file_id [String]
|
|
75
67
|
# The ID of an uploaded file that contains requests for the new batch.
|
|
@@ -108,12 +100,8 @@ module OpenAI
|
|
|
108
100
|
# @return [Array<Symbol>]
|
|
109
101
|
end
|
|
110
102
|
|
|
111
|
-
# The endpoint
|
|
112
|
-
#
|
|
113
|
-
# `/v1/moderations`, `/v1/images/generations`, `/v1/images/edits`, and
|
|
114
|
-
# `/v1/videos` are supported. Note that `/v1/embeddings` batches are also
|
|
115
|
-
# restricted to a maximum of 50,000 embedding inputs across all requests in the
|
|
116
|
-
# batch.
|
|
103
|
+
# The endpoint for all requests in the batch. Batches using `/v1/embeddings` can
|
|
104
|
+
# contain at most 50,000 embedding inputs across all requests.
|
|
117
105
|
module Endpoint
|
|
118
106
|
extend OpenAI::Internal::Type::Enum
|
|
119
107
|
|
|
@@ -124,7 +112,6 @@ module OpenAI
|
|
|
124
112
|
V1_MODERATIONS = :"/v1/moderations"
|
|
125
113
|
V1_IMAGES_GENERATIONS = :"/v1/images/generations"
|
|
126
114
|
V1_IMAGES_EDITS = :"/v1/images/edits"
|
|
127
|
-
V1_VIDEOS = :"/v1/videos"
|
|
128
115
|
|
|
129
116
|
# @!method self.values
|
|
130
117
|
# @return [Array<Symbol>]
|
|
@@ -27,8 +27,8 @@ module OpenAI
|
|
|
27
27
|
# The compacted list of output items. This is a list of all user messages,
|
|
28
28
|
# followed by a single compaction item.
|
|
29
29
|
#
|
|
30
|
-
# @return [Array<OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::
|
|
31
|
-
required :output, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::
|
|
30
|
+
# @return [Array<OpenAI::Models::Beta::BetaResponseInputMessageItem, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCallItem, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseItem::AgentMessage, OpenAI::Models::Beta::BetaResponseItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseItem::Program, OpenAI::Models::Beta::BetaResponseItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseItem::McpListTools, OpenAI::Models::Beta::BetaResponseItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallItem, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem>]
|
|
31
|
+
required :output, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaResponseItem] }
|
|
32
32
|
|
|
33
33
|
# @!attribute usage
|
|
34
34
|
# Token accounting for the compaction pass, including cached, reasoning, and total
|
|
@@ -49,7 +49,7 @@ module OpenAI
|
|
|
49
49
|
# @param created_at [Integer]
|
|
50
50
|
# Unix timestamp (in seconds) when the compacted conversation was created.
|
|
51
51
|
#
|
|
52
|
-
# @param output [Array<OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::
|
|
52
|
+
# @param output [Array<OpenAI::Models::Beta::BetaResponseInputMessageItem, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCallItem, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseItem::AgentMessage, OpenAI::Models::Beta::BetaResponseItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseItem::Program, OpenAI::Models::Beta::BetaResponseItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseItem::McpListTools, OpenAI::Models::Beta::BetaResponseItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallItem, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem>]
|
|
53
53
|
# The compacted list of output items. This is a list of all user messages,
|
|
54
54
|
# followed by a single compaction item.
|
|
55
55
|
#
|
|
@@ -904,8 +904,6 @@ module OpenAI
|
|
|
904
904
|
|
|
905
905
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_4_1106_PREVIEW }
|
|
906
906
|
|
|
907
|
-
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_4_VISION_PREVIEW }
|
|
908
|
-
|
|
909
907
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_4 }
|
|
910
908
|
|
|
911
909
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_4_0314 }
|
|
@@ -924,14 +922,10 @@ module OpenAI
|
|
|
924
922
|
|
|
925
923
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_3_5_TURBO_0301 }
|
|
926
924
|
|
|
927
|
-
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_3_5_TURBO_0613 }
|
|
928
|
-
|
|
929
925
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_3_5_TURBO_1106 }
|
|
930
926
|
|
|
931
927
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_3_5_TURBO_0125 }
|
|
932
928
|
|
|
933
|
-
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_3_5_TURBO_16K_0613 }
|
|
934
|
-
|
|
935
929
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::O1_PRO }
|
|
936
930
|
|
|
937
931
|
variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::O1_PRO_2025_03_19 }
|
|
@@ -1240,10 +1234,6 @@ module OpenAI
|
|
|
1240
1234
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1241
1235
|
# replacements.
|
|
1242
1236
|
GPT_4_1106_PREVIEW = :"gpt-4-1106-preview"
|
|
1243
|
-
# @deprecated Announced shutdown date: 2024-12-06. See
|
|
1244
|
-
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1245
|
-
# replacements.
|
|
1246
|
-
GPT_4_VISION_PREVIEW = :"gpt-4-vision-preview"
|
|
1247
1237
|
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
1248
1238
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1249
1239
|
# replacements.
|
|
@@ -1280,10 +1270,6 @@ module OpenAI
|
|
|
1280
1270
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1281
1271
|
# replacements.
|
|
1282
1272
|
GPT_3_5_TURBO_0301 = :"gpt-3.5-turbo-0301"
|
|
1283
|
-
# @deprecated Announced shutdown date: 2024-09-13. See
|
|
1284
|
-
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1285
|
-
# replacements.
|
|
1286
|
-
GPT_3_5_TURBO_0613 = :"gpt-3.5-turbo-0613"
|
|
1287
1273
|
# @deprecated Announced shutdown date: 2026-09-28. See
|
|
1288
1274
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1289
1275
|
# replacements.
|
|
@@ -1292,10 +1278,6 @@ module OpenAI
|
|
|
1292
1278
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1293
1279
|
# replacements.
|
|
1294
1280
|
GPT_3_5_TURBO_0125 = :"gpt-3.5-turbo-0125"
|
|
1295
|
-
# @deprecated Announced shutdown date: 2024-09-13. See
|
|
1296
|
-
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1297
|
-
# replacements.
|
|
1298
|
-
GPT_3_5_TURBO_16K_0613 = :"gpt-3.5-turbo-16k-0613"
|
|
1299
1281
|
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
1300
1282
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1301
1283
|
# replacements.
|
|
@@ -1303,10 +1303,6 @@ module OpenAI
|
|
|
1303
1303
|
const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_4_1106_PREVIEW }
|
|
1304
1304
|
)
|
|
1305
1305
|
|
|
1306
|
-
variant(
|
|
1307
|
-
const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_4_VISION_PREVIEW }
|
|
1308
|
-
)
|
|
1309
|
-
|
|
1310
1306
|
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_4 }
|
|
1311
1307
|
|
|
1312
1308
|
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_4_0314 }
|
|
@@ -1329,10 +1325,6 @@ module OpenAI
|
|
|
1329
1325
|
const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_3_5_TURBO_0301 }
|
|
1330
1326
|
)
|
|
1331
1327
|
|
|
1332
|
-
variant(
|
|
1333
|
-
const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_3_5_TURBO_0613 }
|
|
1334
|
-
)
|
|
1335
|
-
|
|
1336
1328
|
variant(
|
|
1337
1329
|
const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_3_5_TURBO_1106 }
|
|
1338
1330
|
)
|
|
@@ -1341,12 +1333,6 @@ module OpenAI
|
|
|
1341
1333
|
const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_3_5_TURBO_0125 }
|
|
1342
1334
|
)
|
|
1343
1335
|
|
|
1344
|
-
variant(
|
|
1345
|
-
const: -> {
|
|
1346
|
-
OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::GPT_3_5_TURBO_16K_0613
|
|
1347
|
-
}
|
|
1348
|
-
)
|
|
1349
|
-
|
|
1350
1336
|
variant const: -> { OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::Model::O1_PRO }
|
|
1351
1337
|
|
|
1352
1338
|
variant(
|
|
@@ -1705,10 +1691,6 @@ module OpenAI
|
|
|
1705
1691
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1706
1692
|
# replacements.
|
|
1707
1693
|
GPT_4_1106_PREVIEW = :"gpt-4-1106-preview"
|
|
1708
|
-
# @deprecated Announced shutdown date: 2024-12-06. See
|
|
1709
|
-
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1710
|
-
# replacements.
|
|
1711
|
-
GPT_4_VISION_PREVIEW = :"gpt-4-vision-preview"
|
|
1712
1694
|
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
1713
1695
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1714
1696
|
# replacements.
|
|
@@ -1745,10 +1727,6 @@ module OpenAI
|
|
|
1745
1727
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1746
1728
|
# replacements.
|
|
1747
1729
|
GPT_3_5_TURBO_0301 = :"gpt-3.5-turbo-0301"
|
|
1748
|
-
# @deprecated Announced shutdown date: 2024-09-13. See
|
|
1749
|
-
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1750
|
-
# replacements.
|
|
1751
|
-
GPT_3_5_TURBO_0613 = :"gpt-3.5-turbo-0613"
|
|
1752
1730
|
# @deprecated Announced shutdown date: 2026-09-28. See
|
|
1753
1731
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1754
1732
|
# replacements.
|
|
@@ -1757,10 +1735,6 @@ module OpenAI
|
|
|
1757
1735
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1758
1736
|
# replacements.
|
|
1759
1737
|
GPT_3_5_TURBO_0125 = :"gpt-3.5-turbo-0125"
|
|
1760
|
-
# @deprecated Announced shutdown date: 2024-09-13. See
|
|
1761
|
-
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1762
|
-
# replacements.
|
|
1763
|
-
GPT_3_5_TURBO_16K_0613 = :"gpt-3.5-turbo-16k-0613"
|
|
1764
1738
|
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
1765
1739
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1766
1740
|
# replacements.
|
|
@@ -347,8 +347,6 @@ module OpenAI
|
|
|
347
347
|
|
|
348
348
|
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_1106_PREVIEW }
|
|
349
349
|
|
|
350
|
-
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_VISION_PREVIEW }
|
|
351
|
-
|
|
352
350
|
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4 }
|
|
353
351
|
|
|
354
352
|
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_4_0314 }
|
|
@@ -367,14 +365,10 @@ module OpenAI
|
|
|
367
365
|
|
|
368
366
|
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_3_5_TURBO_0301 }
|
|
369
367
|
|
|
370
|
-
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_3_5_TURBO_0613 }
|
|
371
|
-
|
|
372
368
|
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_3_5_TURBO_1106 }
|
|
373
369
|
|
|
374
370
|
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_3_5_TURBO_0125 }
|
|
375
371
|
|
|
376
|
-
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::GPT_3_5_TURBO_16K_0613 }
|
|
377
|
-
|
|
378
372
|
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O1_PRO }
|
|
379
373
|
|
|
380
374
|
variant const: -> { OpenAI::Models::Beta::ResponseCompactParams::Model::O1_PRO_2025_03_19 }
|
|
@@ -685,10 +679,6 @@ module OpenAI
|
|
|
685
679
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
686
680
|
# replacements.
|
|
687
681
|
GPT_4_1106_PREVIEW = :"gpt-4-1106-preview"
|
|
688
|
-
# @deprecated Announced shutdown date: 2024-12-06. See
|
|
689
|
-
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
690
|
-
# replacements.
|
|
691
|
-
GPT_4_VISION_PREVIEW = :"gpt-4-vision-preview"
|
|
692
682
|
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
693
683
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
694
684
|
# replacements.
|
|
@@ -725,10 +715,6 @@ module OpenAI
|
|
|
725
715
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
726
716
|
# replacements.
|
|
727
717
|
GPT_3_5_TURBO_0301 = :"gpt-3.5-turbo-0301"
|
|
728
|
-
# @deprecated Announced shutdown date: 2024-09-13. See
|
|
729
|
-
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
730
|
-
# replacements.
|
|
731
|
-
GPT_3_5_TURBO_0613 = :"gpt-3.5-turbo-0613"
|
|
732
718
|
# @deprecated Announced shutdown date: 2026-09-28. See
|
|
733
719
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
734
720
|
# replacements.
|
|
@@ -737,10 +723,6 @@ module OpenAI
|
|
|
737
723
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
738
724
|
# replacements.
|
|
739
725
|
GPT_3_5_TURBO_0125 = :"gpt-3.5-turbo-0125"
|
|
740
|
-
# @deprecated Announced shutdown date: 2024-09-13. See
|
|
741
|
-
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
742
|
-
# replacements.
|
|
743
|
-
GPT_3_5_TURBO_16K_0613 = :"gpt-3.5-turbo-16k-0613"
|
|
744
726
|
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
745
727
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
746
728
|
# replacements.
|
|
@@ -1028,8 +1028,6 @@ module OpenAI
|
|
|
1028
1028
|
|
|
1029
1029
|
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_4_1106_PREVIEW }
|
|
1030
1030
|
|
|
1031
|
-
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_4_VISION_PREVIEW }
|
|
1032
|
-
|
|
1033
1031
|
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_4 }
|
|
1034
1032
|
|
|
1035
1033
|
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_4_0314 }
|
|
@@ -1048,14 +1046,10 @@ module OpenAI
|
|
|
1048
1046
|
|
|
1049
1047
|
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_3_5_TURBO_0301 }
|
|
1050
1048
|
|
|
1051
|
-
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_3_5_TURBO_0613 }
|
|
1052
|
-
|
|
1053
1049
|
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_3_5_TURBO_1106 }
|
|
1054
1050
|
|
|
1055
1051
|
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_3_5_TURBO_0125 }
|
|
1056
1052
|
|
|
1057
|
-
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_3_5_TURBO_16K_0613 }
|
|
1058
|
-
|
|
1059
1053
|
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::O1_PRO }
|
|
1060
1054
|
|
|
1061
1055
|
variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::O1_PRO_2025_03_19 }
|
|
@@ -1366,10 +1360,6 @@ module OpenAI
|
|
|
1366
1360
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1367
1361
|
# replacements.
|
|
1368
1362
|
GPT_4_1106_PREVIEW = :"gpt-4-1106-preview"
|
|
1369
|
-
# @deprecated Announced shutdown date: 2024-12-06. See
|
|
1370
|
-
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1371
|
-
# replacements.
|
|
1372
|
-
GPT_4_VISION_PREVIEW = :"gpt-4-vision-preview"
|
|
1373
1363
|
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
1374
1364
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1375
1365
|
# replacements.
|
|
@@ -1406,10 +1396,6 @@ module OpenAI
|
|
|
1406
1396
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1407
1397
|
# replacements.
|
|
1408
1398
|
GPT_3_5_TURBO_0301 = :"gpt-3.5-turbo-0301"
|
|
1409
|
-
# @deprecated Announced shutdown date: 2024-09-13. See
|
|
1410
|
-
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1411
|
-
# replacements.
|
|
1412
|
-
GPT_3_5_TURBO_0613 = :"gpt-3.5-turbo-0613"
|
|
1413
1399
|
# @deprecated Announced shutdown date: 2026-09-28. See
|
|
1414
1400
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1415
1401
|
# replacements.
|
|
@@ -1418,10 +1404,6 @@ module OpenAI
|
|
|
1418
1404
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1419
1405
|
# replacements.
|
|
1420
1406
|
GPT_3_5_TURBO_0125 = :"gpt-3.5-turbo-0125"
|
|
1421
|
-
# @deprecated Announced shutdown date: 2024-09-13. See
|
|
1422
|
-
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1423
|
-
# replacements.
|
|
1424
|
-
GPT_3_5_TURBO_16K_0613 = :"gpt-3.5-turbo-16k-0613"
|
|
1425
1407
|
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
1426
1408
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
1427
1409
|
# replacements.
|
|
@@ -164,9 +164,10 @@ module OpenAI
|
|
|
164
164
|
optional :moderation, -> { OpenAI::Chat::CompletionCreateParams::Moderation }, nil?: true
|
|
165
165
|
|
|
166
166
|
# @!attribute n
|
|
167
|
-
# How many chat completion choices to generate for each input message.
|
|
168
|
-
#
|
|
169
|
-
# choices
|
|
167
|
+
# How many chat completion choices to generate for each input message. Omit `n` to
|
|
168
|
+
# generate one choice. Newer models reject an explicit `n`, even `n=1`. When
|
|
169
|
+
# requesting multiple choices, you are billed for generated tokens across all
|
|
170
|
+
# choices.
|
|
170
171
|
#
|
|
171
172
|
# @return [Integer, nil]
|
|
172
173
|
optional :n, Integer, nil?: true
|
|
@@ -536,9 +537,10 @@ module OpenAI
|
|
|
536
537
|
# Configuration for running moderation on the request input and generated output.
|
|
537
538
|
#
|
|
538
539
|
# @param n [Integer, nil]
|
|
539
|
-
# How many chat completion choices to generate for each input message.
|
|
540
|
-
#
|
|
541
|
-
# choices
|
|
540
|
+
# How many chat completion choices to generate for each input message. Omit `n` to
|
|
541
|
+
# generate one choice. Newer models reject an explicit `n`, even `n=1`. When
|
|
542
|
+
# requesting multiple choices, you are billed for generated tokens across all
|
|
543
|
+
# choices.
|
|
542
544
|
#
|
|
543
545
|
# @param parallel_tool_calls [Boolean]
|
|
544
546
|
# Whether to enable
|
|
@@ -258,10 +258,6 @@ module OpenAI
|
|
|
258
258
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
259
259
|
# replacements.
|
|
260
260
|
GPT_4_1106_PREVIEW = :"gpt-4-1106-preview"
|
|
261
|
-
# @deprecated Announced shutdown date: 2024-12-06. See
|
|
262
|
-
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
263
|
-
# replacements.
|
|
264
|
-
GPT_4_VISION_PREVIEW = :"gpt-4-vision-preview"
|
|
265
261
|
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
266
262
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
267
263
|
# replacements.
|
|
@@ -298,10 +294,6 @@ module OpenAI
|
|
|
298
294
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
299
295
|
# replacements.
|
|
300
296
|
GPT_3_5_TURBO_0301 = :"gpt-3.5-turbo-0301"
|
|
301
|
-
# @deprecated Announced shutdown date: 2024-09-13. See
|
|
302
|
-
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
303
|
-
# replacements.
|
|
304
|
-
GPT_3_5_TURBO_0613 = :"gpt-3.5-turbo-0613"
|
|
305
297
|
# @deprecated Announced shutdown date: 2026-09-28. See
|
|
306
298
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
307
299
|
# replacements.
|
|
@@ -310,10 +302,6 @@ module OpenAI
|
|
|
310
302
|
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
311
303
|
# replacements.
|
|
312
304
|
GPT_3_5_TURBO_0125 = :"gpt-3.5-turbo-0125"
|
|
313
|
-
# @deprecated Announced shutdown date: 2024-09-13. See
|
|
314
|
-
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
315
|
-
# replacements.
|
|
316
|
-
GPT_3_5_TURBO_16K_0613 = :"gpt-3.5-turbo-16k-0613"
|
|
317
305
|
|
|
318
306
|
# @!method self.values
|
|
319
307
|
# @return [Array<Symbol>]
|
|
@@ -102,7 +102,8 @@ module OpenAI
|
|
|
102
102
|
optional :max_tokens, Integer, nil?: true
|
|
103
103
|
|
|
104
104
|
# @!attribute n
|
|
105
|
-
# How many completions to generate for each prompt.
|
|
105
|
+
# How many completions to generate for each prompt. Omit `n` to generate one
|
|
106
|
+
# completion per prompt.
|
|
106
107
|
#
|
|
107
108
|
# **Note:** Because this parameter generates many completions, it can quickly
|
|
108
109
|
# consume your token quota. Use carefully and ensure that you have reasonable
|
|
@@ -253,7 +254,8 @@ module OpenAI
|
|
|
253
254
|
# for counting tokens.
|
|
254
255
|
#
|
|
255
256
|
# @param n [Integer, nil]
|
|
256
|
-
# How many completions to generate for each prompt.
|
|
257
|
+
# How many completions to generate for each prompt. Omit `n` to generate one
|
|
258
|
+
# completion per prompt.
|
|
257
259
|
#
|
|
258
260
|
# **Note:** Because this parameter generates many completions, it can quickly
|
|
259
261
|
# consume your token quota. Use carefully and ensure that you have reasonable
|
|
@@ -11,11 +11,9 @@ module OpenAI
|
|
|
11
11
|
required :calculate_output, String
|
|
12
12
|
|
|
13
13
|
# @!attribute graders
|
|
14
|
-
# A StringCheckGrader object that performs a string comparison between input and
|
|
15
|
-
# reference using a specified operation.
|
|
16
14
|
#
|
|
17
|
-
# @return [OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::Graders::TextSimilarityGrader, OpenAI::Models::Graders::PythonGrader, OpenAI::Models::Graders::ScoreModelGrader, OpenAI::Models::Graders::LabelModelGrader]
|
|
18
|
-
required :graders,
|
|
15
|
+
# @return [Hash{Symbol=>OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::Graders::TextSimilarityGrader, OpenAI::Models::Graders::PythonGrader, OpenAI::Models::Graders::ScoreModelGrader, OpenAI::Models::Graders::LabelModelGrader}]
|
|
16
|
+
required :graders, -> { OpenAI::Internal::Type::HashOf[union: OpenAI::Graders::MultiGrader::Grader] }
|
|
19
17
|
|
|
20
18
|
# @!attribute name
|
|
21
19
|
# The name of the grader.
|
|
@@ -36,9 +34,7 @@ module OpenAI
|
|
|
36
34
|
# @param calculate_output [String]
|
|
37
35
|
# A formula to calculate the output based on grader results.
|
|
38
36
|
#
|
|
39
|
-
# @param graders [OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::Graders::TextSimilarityGrader, OpenAI::Models::Graders::PythonGrader, OpenAI::Models::Graders::ScoreModelGrader, OpenAI::Models::Graders::LabelModelGrader]
|
|
40
|
-
# A StringCheckGrader object that performs a string comparison between input and
|
|
41
|
-
# reference using a specified operation.
|
|
37
|
+
# @param graders [Hash{Symbol=>OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::Graders::TextSimilarityGrader, OpenAI::Models::Graders::PythonGrader, OpenAI::Models::Graders::ScoreModelGrader, OpenAI::Models::Graders::LabelModelGrader}]
|
|
42
38
|
#
|
|
43
39
|
# @param name [String]
|
|
44
40
|
# The name of the grader.
|
|
@@ -48,26 +44,26 @@ module OpenAI
|
|
|
48
44
|
|
|
49
45
|
# A StringCheckGrader object that performs a string comparison between input and
|
|
50
46
|
# reference using a specified operation.
|
|
51
|
-
|
|
52
|
-
# @see OpenAI::Models::Graders::MultiGrader#graders
|
|
53
|
-
module Graders
|
|
47
|
+
module Grader
|
|
54
48
|
extend OpenAI::Internal::Type::Union
|
|
55
49
|
|
|
50
|
+
discriminator :type
|
|
51
|
+
|
|
56
52
|
# A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.
|
|
57
|
-
variant -> { OpenAI::Graders::StringCheckGrader }
|
|
53
|
+
variant :string_check, -> { OpenAI::Graders::StringCheckGrader }
|
|
58
54
|
|
|
59
55
|
# A TextSimilarityGrader object which grades text based on similarity metrics.
|
|
60
|
-
variant -> { OpenAI::Graders::TextSimilarityGrader }
|
|
56
|
+
variant :text_similarity, -> { OpenAI::Graders::TextSimilarityGrader }
|
|
61
57
|
|
|
62
58
|
# A PythonGrader object that runs a python script on the input.
|
|
63
|
-
variant -> { OpenAI::Graders::PythonGrader }
|
|
59
|
+
variant :python, -> { OpenAI::Graders::PythonGrader }
|
|
64
60
|
|
|
65
61
|
# A ScoreModelGrader object that uses a model to assign a score to the input.
|
|
66
|
-
variant -> { OpenAI::Graders::ScoreModelGrader }
|
|
62
|
+
variant :score_model, -> { OpenAI::Graders::ScoreModelGrader }
|
|
67
63
|
|
|
68
64
|
# A LabelModelGrader object which uses a model to assign labels to each item
|
|
69
65
|
# in the evaluation.
|
|
70
|
-
variant -> { OpenAI::Graders::LabelModelGrader }
|
|
66
|
+
variant :label_model, -> { OpenAI::Graders::LabelModelGrader }
|
|
71
67
|
|
|
72
68
|
# @!method self.variants
|
|
73
69
|
# @return [Array(OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::Graders::TextSimilarityGrader, OpenAI::Models::Graders::PythonGrader, OpenAI::Models::Graders::ScoreModelGrader, OpenAI::Models::Graders::LabelModelGrader)]
|