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
|
@@ -1,101 +0,0 @@
|
|
|
1
|
-
# typed: strong
|
|
2
|
-
|
|
3
|
-
module OpenAI
|
|
4
|
-
module Models
|
|
5
|
-
|
|
6
|
-
class VideoListParams < OpenAI::Internal::Type::BaseModel
|
|
7
|
-
|
|
8
|
-
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
|
-
include OpenAI::Internal::Type::RequestParameters
|
|
10
|
-
|
|
11
|
-
OrHash = T.type_alias do
|
|
12
|
-
T.any(
|
|
13
|
-
OpenAI::VideoListParams,
|
|
14
|
-
OpenAI::Internal::AnyHash
|
|
15
|
-
)
|
|
16
|
-
end
|
|
17
|
-
|
|
18
|
-
# Identifier for the last item from the previous pagination request
|
|
19
|
-
sig { returns(T.nilable(String)) }
|
|
20
|
-
attr_reader :after
|
|
21
|
-
|
|
22
|
-
sig { params(after: String).void }
|
|
23
|
-
attr_writer :after
|
|
24
|
-
|
|
25
|
-
# Number of items to retrieve
|
|
26
|
-
sig { returns(T.nilable(Integer)) }
|
|
27
|
-
attr_reader :limit
|
|
28
|
-
|
|
29
|
-
sig { params(limit: Integer).void }
|
|
30
|
-
attr_writer :limit
|
|
31
|
-
|
|
32
|
-
# Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
|
|
33
|
-
# descending order.
|
|
34
|
-
sig { returns(T.nilable(OpenAI::VideoListParams::Order::OrSymbol)) }
|
|
35
|
-
attr_reader :order
|
|
36
|
-
|
|
37
|
-
sig { params(order: OpenAI::VideoListParams::Order::OrSymbol).void }
|
|
38
|
-
attr_writer :order
|
|
39
|
-
|
|
40
|
-
sig do
|
|
41
|
-
params(
|
|
42
|
-
|
|
43
|
-
after: String,
|
|
44
|
-
|
|
45
|
-
limit: Integer,
|
|
46
|
-
|
|
47
|
-
order: OpenAI::VideoListParams::Order::OrSymbol,
|
|
48
|
-
|
|
49
|
-
request_options: OpenAI::RequestOptions::OrHash
|
|
50
|
-
)
|
|
51
|
-
.returns(T.attached_class)
|
|
52
|
-
end
|
|
53
|
-
def self.new(
|
|
54
|
-
|
|
55
|
-
# Identifier for the last item from the previous pagination request
|
|
56
|
-
after: nil,
|
|
57
|
-
|
|
58
|
-
# Number of items to retrieve
|
|
59
|
-
limit: nil,
|
|
60
|
-
|
|
61
|
-
# Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
|
|
62
|
-
# descending order.
|
|
63
|
-
order: nil,
|
|
64
|
-
|
|
65
|
-
request_options: {}
|
|
66
|
-
)
|
|
67
|
-
end
|
|
68
|
-
|
|
69
|
-
sig do
|
|
70
|
-
override.returns(
|
|
71
|
-
{
|
|
72
|
-
after: String,
|
|
73
|
-
limit: Integer,
|
|
74
|
-
order: OpenAI::VideoListParams::Order::OrSymbol,
|
|
75
|
-
request_options: OpenAI::RequestOptions
|
|
76
|
-
}
|
|
77
|
-
)
|
|
78
|
-
end
|
|
79
|
-
def to_hash
|
|
80
|
-
end
|
|
81
|
-
|
|
82
|
-
# Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
|
|
83
|
-
# descending order.
|
|
84
|
-
module Order
|
|
85
|
-
extend OpenAI::Internal::Type::Enum
|
|
86
|
-
|
|
87
|
-
TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::VideoListParams::Order) }
|
|
88
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
89
|
-
|
|
90
|
-
ASC = T.let(:asc, OpenAI::VideoListParams::Order::TaggedSymbol)
|
|
91
|
-
DESC = T.let(:desc, OpenAI::VideoListParams::Order::TaggedSymbol)
|
|
92
|
-
|
|
93
|
-
sig { override.returns(T::Array[OpenAI::VideoListParams::Order::TaggedSymbol]) }
|
|
94
|
-
def self.values
|
|
95
|
-
end
|
|
96
|
-
end
|
|
97
|
-
|
|
98
|
-
end
|
|
99
|
-
|
|
100
|
-
end
|
|
101
|
-
end
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
# typed: strong
|
|
2
|
-
|
|
3
|
-
module OpenAI
|
|
4
|
-
module Models
|
|
5
|
-
|
|
6
|
-
module VideoModel
|
|
7
|
-
extend OpenAI::Internal::Type::Union
|
|
8
|
-
|
|
9
|
-
Variants = T.type_alias do
|
|
10
|
-
T.any(
|
|
11
|
-
String,
|
|
12
|
-
OpenAI::VideoModel::TaggedSymbol
|
|
13
|
-
)
|
|
14
|
-
end
|
|
15
|
-
|
|
16
|
-
sig { override.returns(T::Array[OpenAI::VideoModel::Variants]) }
|
|
17
|
-
def self.variants
|
|
18
|
-
end
|
|
19
|
-
|
|
20
|
-
TaggedSymbol = T.type_alias do
|
|
21
|
-
T.all(Symbol, OpenAI::VideoModel)
|
|
22
|
-
end
|
|
23
|
-
|
|
24
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
25
|
-
|
|
26
|
-
SORA_2 = T.let(:"sora-2", OpenAI::VideoModel::TaggedSymbol)
|
|
27
|
-
SORA_2_PRO = T.let(:"sora-2-pro", OpenAI::VideoModel::TaggedSymbol)
|
|
28
|
-
SORA_2_2025_10_06 = T.let(:"sora-2-2025-10-06", OpenAI::VideoModel::TaggedSymbol)
|
|
29
|
-
SORA_2_PRO_2025_10_06 = T.let(:"sora-2-pro-2025-10-06", OpenAI::VideoModel::TaggedSymbol)
|
|
30
|
-
SORA_2_2025_12_08 = T.let(:"sora-2-2025-12-08", OpenAI::VideoModel::TaggedSymbol)
|
|
31
|
-
|
|
32
|
-
end
|
|
33
|
-
|
|
34
|
-
end
|
|
35
|
-
end
|
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
# typed: strong
|
|
2
|
-
|
|
3
|
-
module OpenAI
|
|
4
|
-
module Models
|
|
5
|
-
|
|
6
|
-
class VideoRemixParams < OpenAI::Internal::Type::BaseModel
|
|
7
|
-
|
|
8
|
-
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
|
-
include OpenAI::Internal::Type::RequestParameters
|
|
10
|
-
|
|
11
|
-
OrHash = T.type_alias do
|
|
12
|
-
T.any(
|
|
13
|
-
OpenAI::VideoRemixParams,
|
|
14
|
-
OpenAI::Internal::AnyHash
|
|
15
|
-
)
|
|
16
|
-
end
|
|
17
|
-
|
|
18
|
-
sig { returns(String) }
|
|
19
|
-
attr_accessor :video_id
|
|
20
|
-
|
|
21
|
-
# Updated text prompt that directs the remix generation.
|
|
22
|
-
sig { returns(String) }
|
|
23
|
-
attr_accessor :prompt
|
|
24
|
-
|
|
25
|
-
sig do
|
|
26
|
-
params(
|
|
27
|
-
|
|
28
|
-
video_id: String,
|
|
29
|
-
|
|
30
|
-
prompt: String,
|
|
31
|
-
|
|
32
|
-
request_options: OpenAI::RequestOptions::OrHash
|
|
33
|
-
)
|
|
34
|
-
.returns(T.attached_class)
|
|
35
|
-
end
|
|
36
|
-
def self.new(
|
|
37
|
-
|
|
38
|
-
video_id:,
|
|
39
|
-
|
|
40
|
-
# Updated text prompt that directs the remix generation.
|
|
41
|
-
prompt:,
|
|
42
|
-
|
|
43
|
-
request_options: {}
|
|
44
|
-
)
|
|
45
|
-
end
|
|
46
|
-
|
|
47
|
-
sig do
|
|
48
|
-
override.returns(
|
|
49
|
-
{video_id: String, prompt: String, request_options: OpenAI::RequestOptions}
|
|
50
|
-
)
|
|
51
|
-
end
|
|
52
|
-
def to_hash
|
|
53
|
-
end
|
|
54
|
-
|
|
55
|
-
end
|
|
56
|
-
|
|
57
|
-
end
|
|
58
|
-
end
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
# typed: strong
|
|
2
|
-
|
|
3
|
-
module OpenAI
|
|
4
|
-
module Models
|
|
5
|
-
|
|
6
|
-
class VideoRetrieveParams < OpenAI::Internal::Type::BaseModel
|
|
7
|
-
|
|
8
|
-
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
|
-
include OpenAI::Internal::Type::RequestParameters
|
|
10
|
-
|
|
11
|
-
OrHash = T.type_alias do
|
|
12
|
-
T.any(
|
|
13
|
-
OpenAI::VideoRetrieveParams,
|
|
14
|
-
OpenAI::Internal::AnyHash
|
|
15
|
-
)
|
|
16
|
-
end
|
|
17
|
-
|
|
18
|
-
sig { returns(String) }
|
|
19
|
-
attr_accessor :video_id
|
|
20
|
-
|
|
21
|
-
sig do
|
|
22
|
-
params(
|
|
23
|
-
|
|
24
|
-
video_id: String,
|
|
25
|
-
|
|
26
|
-
request_options: OpenAI::RequestOptions::OrHash
|
|
27
|
-
)
|
|
28
|
-
.returns(T.attached_class)
|
|
29
|
-
end
|
|
30
|
-
def self.new(
|
|
31
|
-
|
|
32
|
-
video_id:,
|
|
33
|
-
|
|
34
|
-
request_options: {}
|
|
35
|
-
)
|
|
36
|
-
end
|
|
37
|
-
|
|
38
|
-
sig do
|
|
39
|
-
override.returns(
|
|
40
|
-
{video_id: String, request_options: OpenAI::RequestOptions}
|
|
41
|
-
)
|
|
42
|
-
end
|
|
43
|
-
def to_hash
|
|
44
|
-
end
|
|
45
|
-
|
|
46
|
-
end
|
|
47
|
-
|
|
48
|
-
end
|
|
49
|
-
end
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# typed: strong
|
|
2
|
-
|
|
3
|
-
module OpenAI
|
|
4
|
-
module Models
|
|
5
|
-
|
|
6
|
-
module VideoSeconds
|
|
7
|
-
extend OpenAI::Internal::Type::Enum
|
|
8
|
-
|
|
9
|
-
TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::VideoSeconds) }
|
|
10
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
11
|
-
|
|
12
|
-
VIDEO_SECONDS_4 = T.let(:"4", OpenAI::VideoSeconds::TaggedSymbol)
|
|
13
|
-
VIDEO_SECONDS_8 = T.let(:"8", OpenAI::VideoSeconds::TaggedSymbol)
|
|
14
|
-
VIDEO_SECONDS_12 = T.let(:"12", OpenAI::VideoSeconds::TaggedSymbol)
|
|
15
|
-
|
|
16
|
-
sig { override.returns(T::Array[OpenAI::VideoSeconds::TaggedSymbol]) }
|
|
17
|
-
def self.values
|
|
18
|
-
end
|
|
19
|
-
end
|
|
20
|
-
|
|
21
|
-
end
|
|
22
|
-
end
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
# typed: strong
|
|
2
|
-
|
|
3
|
-
module OpenAI
|
|
4
|
-
module Models
|
|
5
|
-
|
|
6
|
-
module VideoSize
|
|
7
|
-
extend OpenAI::Internal::Type::Enum
|
|
8
|
-
|
|
9
|
-
TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::VideoSize) }
|
|
10
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
11
|
-
|
|
12
|
-
VIDEO_SIZE_720X1280 = T.let(:"720x1280", OpenAI::VideoSize::TaggedSymbol)
|
|
13
|
-
VIDEO_SIZE_1280X720 = T.let(:"1280x720", OpenAI::VideoSize::TaggedSymbol)
|
|
14
|
-
VIDEO_SIZE_1024X1792 = T.let(:"1024x1792", OpenAI::VideoSize::TaggedSymbol)
|
|
15
|
-
VIDEO_SIZE_1792X1024 = T.let(:"1792x1024", OpenAI::VideoSize::TaggedSymbol)
|
|
16
|
-
|
|
17
|
-
sig { override.returns(T::Array[OpenAI::VideoSize::TaggedSymbol]) }
|
|
18
|
-
def self.values
|
|
19
|
-
end
|
|
20
|
-
end
|
|
21
|
-
|
|
22
|
-
end
|
|
23
|
-
end
|
|
@@ -1,285 +0,0 @@
|
|
|
1
|
-
# typed: strong
|
|
2
|
-
|
|
3
|
-
module OpenAI
|
|
4
|
-
module Resources
|
|
5
|
-
|
|
6
|
-
class Beta
|
|
7
|
-
|
|
8
|
-
# Build Assistants that can call models and use tools.
|
|
9
|
-
class Assistants
|
|
10
|
-
|
|
11
|
-
# Create an assistant with a model and instructions.
|
|
12
|
-
sig {
|
|
13
|
-
params(
|
|
14
|
-
model: T.any(String, OpenAI::ChatModel::OrSymbol),
|
|
15
|
-
description: T.nilable(String),
|
|
16
|
-
instructions: T.nilable(String),
|
|
17
|
-
metadata: T.nilable(T::Hash[Symbol, String]),
|
|
18
|
-
name: T.nilable(String),
|
|
19
|
-
reasoning_effort: T.nilable(OpenAI::ReasoningEffort::OrSymbol),
|
|
20
|
-
response_format: T.nilable(
|
|
21
|
-
T.any(
|
|
22
|
-
Symbol,
|
|
23
|
-
OpenAI::ResponseFormatText::OrHash,
|
|
24
|
-
OpenAI::ResponseFormatJSONObject::OrHash,
|
|
25
|
-
OpenAI::ResponseFormatJSONSchema::OrHash
|
|
26
|
-
)
|
|
27
|
-
),
|
|
28
|
-
temperature: T.nilable(Float),
|
|
29
|
-
tool_resources: T.nilable(OpenAI::Beta::AssistantCreateParams::ToolResources::OrHash),
|
|
30
|
-
tools: T::Array[
|
|
31
|
-
T.any(
|
|
32
|
-
OpenAI::Beta::CodeInterpreterTool::OrHash,
|
|
33
|
-
OpenAI::Beta::FileSearchTool::OrHash,
|
|
34
|
-
OpenAI::Beta::FunctionTool::OrHash
|
|
35
|
-
)
|
|
36
|
-
],
|
|
37
|
-
top_p: T.nilable(Float),
|
|
38
|
-
request_options: OpenAI::RequestOptions::OrHash
|
|
39
|
-
)
|
|
40
|
-
.returns(OpenAI::Beta::Assistant)
|
|
41
|
-
}
|
|
42
|
-
def create(
|
|
43
|
-
# ID of the model to use. You can use the
|
|
44
|
-
# [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
|
|
45
|
-
# API to see all of your available models, or see our
|
|
46
|
-
# [Model overview](https://developers.openai.com/api/docs/models) for descriptions
|
|
47
|
-
# of them.
|
|
48
|
-
model:,
|
|
49
|
-
# The description of the assistant. The maximum length is 512 characters.
|
|
50
|
-
description: nil,
|
|
51
|
-
# The system instructions that the assistant uses. The maximum length is 256,000
|
|
52
|
-
# characters.
|
|
53
|
-
instructions: nil,
|
|
54
|
-
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
55
|
-
# for storing additional information about the object in a structured format, and
|
|
56
|
-
# querying for objects via API or the dashboard.
|
|
57
|
-
#
|
|
58
|
-
# Keys are strings with a maximum length of 64 characters. Values are strings with
|
|
59
|
-
# a maximum length of 512 characters.
|
|
60
|
-
metadata: nil,
|
|
61
|
-
# The name of the assistant. The maximum length is 256 characters.
|
|
62
|
-
name: nil,
|
|
63
|
-
# Constrains effort on reasoning for reasoning models. Currently supported values
|
|
64
|
-
# are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
65
|
-
# reasoning effort can result in faster responses and fewer tokens used on
|
|
66
|
-
# reasoning in a response. Not all reasoning models support every value. See the
|
|
67
|
-
# [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
68
|
-
# model-specific support.
|
|
69
|
-
reasoning_effort: nil,
|
|
70
|
-
# Specifies the format that the model must output. Compatible with
|
|
71
|
-
# [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
|
|
72
|
-
# [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
|
|
73
|
-
# all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
|
|
74
|
-
#
|
|
75
|
-
# Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
|
|
76
|
-
# Outputs which ensures the model will match your supplied JSON schema. Learn more
|
|
77
|
-
# in the
|
|
78
|
-
# [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
79
|
-
#
|
|
80
|
-
# Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
|
|
81
|
-
# message the model generates is valid JSON.
|
|
82
|
-
#
|
|
83
|
-
# **Important:** when using JSON mode, you **must** also instruct the model to
|
|
84
|
-
# produce JSON yourself via a system or user message. Without this, the model may
|
|
85
|
-
# generate an unending stream of whitespace until the generation reaches the token
|
|
86
|
-
# limit, resulting in a long-running and seemingly "stuck" request. Also note that
|
|
87
|
-
# the message content may be partially cut off if `finish_reason="length"`, which
|
|
88
|
-
# indicates the generation exceeded `max_tokens` or the conversation exceeded the
|
|
89
|
-
# max context length.
|
|
90
|
-
response_format: nil,
|
|
91
|
-
# What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
|
|
92
|
-
# make the output more random, while lower values like 0.2 will make it more
|
|
93
|
-
# focused and deterministic.
|
|
94
|
-
temperature: nil,
|
|
95
|
-
# A set of resources that are used by the assistant's tools. The resources are
|
|
96
|
-
# specific to the type of tool. For example, the `code_interpreter` tool requires
|
|
97
|
-
# a list of file IDs, while the `file_search` tool requires a list of vector store
|
|
98
|
-
# IDs.
|
|
99
|
-
tool_resources: nil,
|
|
100
|
-
# A list of tool enabled on the assistant. There can be a maximum of 128 tools per
|
|
101
|
-
# assistant. Tools can be of types `code_interpreter`, `file_search`, or
|
|
102
|
-
# `function`.
|
|
103
|
-
tools: nil,
|
|
104
|
-
# An alternative to sampling with temperature, called nucleus sampling, where the
|
|
105
|
-
# model considers the results of the tokens with top_p probability mass. So 0.1
|
|
106
|
-
# means only the tokens comprising the top 10% probability mass are considered.
|
|
107
|
-
#
|
|
108
|
-
# We generally recommend altering this or temperature but not both.
|
|
109
|
-
top_p: nil,
|
|
110
|
-
request_options: {}
|
|
111
|
-
)
|
|
112
|
-
end
|
|
113
|
-
|
|
114
|
-
# Retrieves an assistant.
|
|
115
|
-
sig {
|
|
116
|
-
params(assistant_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(OpenAI::Beta::Assistant)
|
|
117
|
-
}
|
|
118
|
-
def retrieve(
|
|
119
|
-
# The ID of the assistant to retrieve.
|
|
120
|
-
assistant_id,
|
|
121
|
-
request_options: {}
|
|
122
|
-
)
|
|
123
|
-
end
|
|
124
|
-
|
|
125
|
-
# Modifies an assistant.
|
|
126
|
-
sig {
|
|
127
|
-
params(
|
|
128
|
-
assistant_id: String,
|
|
129
|
-
description: T.nilable(String),
|
|
130
|
-
instructions: T.nilable(String),
|
|
131
|
-
metadata: T.nilable(T::Hash[Symbol, String]),
|
|
132
|
-
model: T.any(String, OpenAI::Beta::AssistantUpdateParams::Model::OrSymbol),
|
|
133
|
-
name: T.nilable(String),
|
|
134
|
-
reasoning_effort: T.nilable(OpenAI::ReasoningEffort::OrSymbol),
|
|
135
|
-
response_format: T.nilable(
|
|
136
|
-
T.any(
|
|
137
|
-
Symbol,
|
|
138
|
-
OpenAI::ResponseFormatText::OrHash,
|
|
139
|
-
OpenAI::ResponseFormatJSONObject::OrHash,
|
|
140
|
-
OpenAI::ResponseFormatJSONSchema::OrHash
|
|
141
|
-
)
|
|
142
|
-
),
|
|
143
|
-
temperature: T.nilable(Float),
|
|
144
|
-
tool_resources: T.nilable(OpenAI::Beta::AssistantUpdateParams::ToolResources::OrHash),
|
|
145
|
-
tools: T::Array[
|
|
146
|
-
T.any(
|
|
147
|
-
OpenAI::Beta::CodeInterpreterTool::OrHash,
|
|
148
|
-
OpenAI::Beta::FileSearchTool::OrHash,
|
|
149
|
-
OpenAI::Beta::FunctionTool::OrHash
|
|
150
|
-
)
|
|
151
|
-
],
|
|
152
|
-
top_p: T.nilable(Float),
|
|
153
|
-
request_options: OpenAI::RequestOptions::OrHash
|
|
154
|
-
)
|
|
155
|
-
.returns(OpenAI::Beta::Assistant)
|
|
156
|
-
}
|
|
157
|
-
def update(
|
|
158
|
-
# The ID of the assistant to modify.
|
|
159
|
-
assistant_id,
|
|
160
|
-
# The description of the assistant. The maximum length is 512 characters.
|
|
161
|
-
description: nil,
|
|
162
|
-
# The system instructions that the assistant uses. The maximum length is 256,000
|
|
163
|
-
# characters.
|
|
164
|
-
instructions: nil,
|
|
165
|
-
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
166
|
-
# for storing additional information about the object in a structured format, and
|
|
167
|
-
# querying for objects via API or the dashboard.
|
|
168
|
-
#
|
|
169
|
-
# Keys are strings with a maximum length of 64 characters. Values are strings with
|
|
170
|
-
# a maximum length of 512 characters.
|
|
171
|
-
metadata: nil,
|
|
172
|
-
# ID of the model to use. You can use the
|
|
173
|
-
# [List models](https://developers.openai.com/api/reference/resources/models/methods/list)
|
|
174
|
-
# API to see all of your available models, or see our
|
|
175
|
-
# [Model overview](https://developers.openai.com/api/docs/models) for descriptions
|
|
176
|
-
# of them.
|
|
177
|
-
model: nil,
|
|
178
|
-
# The name of the assistant. The maximum length is 256 characters.
|
|
179
|
-
name: nil,
|
|
180
|
-
# Constrains effort on reasoning for reasoning models. Currently supported values
|
|
181
|
-
# are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
182
|
-
# reasoning effort can result in faster responses and fewer tokens used on
|
|
183
|
-
# reasoning in a response. Not all reasoning models support every value. See the
|
|
184
|
-
# [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
185
|
-
# model-specific support.
|
|
186
|
-
reasoning_effort: nil,
|
|
187
|
-
# Specifies the format that the model must output. Compatible with
|
|
188
|
-
# [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
|
|
189
|
-
# [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
|
|
190
|
-
# all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
|
|
191
|
-
#
|
|
192
|
-
# Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
|
|
193
|
-
# Outputs which ensures the model will match your supplied JSON schema. Learn more
|
|
194
|
-
# in the
|
|
195
|
-
# [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
196
|
-
#
|
|
197
|
-
# Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
|
|
198
|
-
# message the model generates is valid JSON.
|
|
199
|
-
#
|
|
200
|
-
# **Important:** when using JSON mode, you **must** also instruct the model to
|
|
201
|
-
# produce JSON yourself via a system or user message. Without this, the model may
|
|
202
|
-
# generate an unending stream of whitespace until the generation reaches the token
|
|
203
|
-
# limit, resulting in a long-running and seemingly "stuck" request. Also note that
|
|
204
|
-
# the message content may be partially cut off if `finish_reason="length"`, which
|
|
205
|
-
# indicates the generation exceeded `max_tokens` or the conversation exceeded the
|
|
206
|
-
# max context length.
|
|
207
|
-
response_format: nil,
|
|
208
|
-
# What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
|
|
209
|
-
# make the output more random, while lower values like 0.2 will make it more
|
|
210
|
-
# focused and deterministic.
|
|
211
|
-
temperature: nil,
|
|
212
|
-
# A set of resources that are used by the assistant's tools. The resources are
|
|
213
|
-
# specific to the type of tool. For example, the `code_interpreter` tool requires
|
|
214
|
-
# a list of file IDs, while the `file_search` tool requires a list of vector store
|
|
215
|
-
# IDs.
|
|
216
|
-
tool_resources: nil,
|
|
217
|
-
# A list of tool enabled on the assistant. There can be a maximum of 128 tools per
|
|
218
|
-
# assistant. Tools can be of types `code_interpreter`, `file_search`, or
|
|
219
|
-
# `function`.
|
|
220
|
-
tools: nil,
|
|
221
|
-
# An alternative to sampling with temperature, called nucleus sampling, where the
|
|
222
|
-
# model considers the results of the tokens with top_p probability mass. So 0.1
|
|
223
|
-
# means only the tokens comprising the top 10% probability mass are considered.
|
|
224
|
-
#
|
|
225
|
-
# We generally recommend altering this or temperature but not both.
|
|
226
|
-
top_p: nil,
|
|
227
|
-
request_options: {}
|
|
228
|
-
)
|
|
229
|
-
end
|
|
230
|
-
|
|
231
|
-
# Returns a list of assistants.
|
|
232
|
-
sig {
|
|
233
|
-
params(
|
|
234
|
-
after: String,
|
|
235
|
-
before: String,
|
|
236
|
-
limit: Integer,
|
|
237
|
-
order: OpenAI::Beta::AssistantListParams::Order::OrSymbol,
|
|
238
|
-
request_options: OpenAI::RequestOptions::OrHash
|
|
239
|
-
)
|
|
240
|
-
.returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Assistant])
|
|
241
|
-
}
|
|
242
|
-
def list(
|
|
243
|
-
# A cursor for use in pagination. `after` is an object ID that defines your place
|
|
244
|
-
# in the list. For instance, if you make a list request and receive 100 objects,
|
|
245
|
-
# ending with obj_foo, your subsequent call can include after=obj_foo in order to
|
|
246
|
-
# fetch the next page of the list.
|
|
247
|
-
after: nil,
|
|
248
|
-
# A cursor for use in pagination. `before` is an object ID that defines your place
|
|
249
|
-
# in the list. For instance, if you make a list request and receive 100 objects,
|
|
250
|
-
# starting with obj_foo, your subsequent call can include before=obj_foo in order
|
|
251
|
-
# to fetch the previous page of the list.
|
|
252
|
-
before: nil,
|
|
253
|
-
# A limit on the number of objects to be returned. Limit can range between 1 and
|
|
254
|
-
# 100, and the default is 20.
|
|
255
|
-
limit: nil,
|
|
256
|
-
# Sort order by the `created_at` timestamp of the objects. `asc` for ascending
|
|
257
|
-
# order and `desc` for descending order.
|
|
258
|
-
order: nil,
|
|
259
|
-
request_options: {}
|
|
260
|
-
)
|
|
261
|
-
end
|
|
262
|
-
|
|
263
|
-
# Delete an assistant.
|
|
264
|
-
sig {
|
|
265
|
-
params(assistant_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
|
|
266
|
-
OpenAI::Beta::AssistantDeleted
|
|
267
|
-
)
|
|
268
|
-
}
|
|
269
|
-
def delete(
|
|
270
|
-
# The ID of the assistant to delete.
|
|
271
|
-
assistant_id,
|
|
272
|
-
request_options: {}
|
|
273
|
-
)
|
|
274
|
-
end
|
|
275
|
-
|
|
276
|
-
# @api private
|
|
277
|
-
sig { params(client: OpenAI::Client).returns(T.attached_class) }
|
|
278
|
-
def self.new(client:)
|
|
279
|
-
end
|
|
280
|
-
end
|
|
281
|
-
|
|
282
|
-
end
|
|
283
|
-
|
|
284
|
-
end
|
|
285
|
-
end
|