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,524 +0,0 @@
|
|
|
1
|
-
module OpenAI
|
|
2
|
-
module Models
|
|
3
|
-
module Beta
|
|
4
|
-
module Threads
|
|
5
|
-
type run_create_params =
|
|
6
|
-
{
|
|
7
|
-
thread_id: String,
|
|
8
|
-
assistant_id: String,
|
|
9
|
-
?include: ::Array[OpenAI::Models::Beta::Threads::Runs::run_step_include],
|
|
10
|
-
?additional_instructions: String?,
|
|
11
|
-
?additional_messages: ::Array[OpenAI::Beta::Threads::RunCreateParams::AdditionalMessage]?,
|
|
12
|
-
?instructions: String?,
|
|
13
|
-
?max_completion_tokens: Integer?,
|
|
14
|
-
?max_prompt_tokens: Integer?,
|
|
15
|
-
?metadata: OpenAI::Models::metadata?,
|
|
16
|
-
?model: OpenAI::Models::Beta::Threads::RunCreateParams::model?,
|
|
17
|
-
?parallel_tool_calls: bool,
|
|
18
|
-
?reasoning_effort: OpenAI::Models::reasoning_effort?,
|
|
19
|
-
?response_format: OpenAI::Models::Beta::assistant_response_format_option?,
|
|
20
|
-
?temperature: Float?,
|
|
21
|
-
?tool_choice: OpenAI::Models::Beta::assistant_tool_choice_option?,
|
|
22
|
-
?tools: ::Array[OpenAI::Models::Beta::assistant_tool]?,
|
|
23
|
-
?top_p: Float?,
|
|
24
|
-
?truncation_strategy: OpenAI::Beta::Threads::RunCreateParams::TruncationStrategy?,
|
|
25
|
-
?request_options: OpenAI::request_opts
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
class RunCreateParams < OpenAI::Internal::Type::BaseModel
|
|
29
|
-
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
30
|
-
include OpenAI::Internal::Type::RequestParameters
|
|
31
|
-
|
|
32
|
-
attr_accessor thread_id: String
|
|
33
|
-
|
|
34
|
-
# The ID of the
|
|
35
|
-
# [assistant](https://developers.openai.com/api/docs/assistants/migration) to use
|
|
36
|
-
# to execute this run.
|
|
37
|
-
attr_accessor assistant_id: String
|
|
38
|
-
|
|
39
|
-
# A list of additional fields to include in the response. Currently the only
|
|
40
|
-
# supported value is `step_details.tool_calls[*].file_search.results[*].content`
|
|
41
|
-
# to fetch the file search result content.
|
|
42
|
-
#
|
|
43
|
-
# See the
|
|
44
|
-
# [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
|
|
45
|
-
# for more information.
|
|
46
|
-
attr_reader include: ::Array[OpenAI::Models::Beta::Threads::Runs::run_step_include]?
|
|
47
|
-
|
|
48
|
-
# A list of additional fields to include in the response. Currently the only
|
|
49
|
-
# supported value is `step_details.tool_calls[*].file_search.results[*].content`
|
|
50
|
-
# to fetch the file search result content.
|
|
51
|
-
#
|
|
52
|
-
# See the
|
|
53
|
-
# [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
|
|
54
|
-
# for more information.
|
|
55
|
-
def include=: (
|
|
56
|
-
::Array[OpenAI::Models::Beta::Threads::Runs::run_step_include]
|
|
57
|
-
) -> ::Array[OpenAI::Models::Beta::Threads::Runs::run_step_include]
|
|
58
|
-
|
|
59
|
-
# Appends additional instructions at the end of the instructions for the run. This
|
|
60
|
-
# is useful for modifying the behavior on a per-run basis without overriding other
|
|
61
|
-
# instructions.
|
|
62
|
-
attr_accessor additional_instructions: String?
|
|
63
|
-
|
|
64
|
-
# Adds additional messages to the thread before creating the run.
|
|
65
|
-
attr_accessor additional_messages: ::Array[OpenAI::Beta::Threads::RunCreateParams::AdditionalMessage]?
|
|
66
|
-
|
|
67
|
-
# Overrides the
|
|
68
|
-
# [instructions](https://developers.openai.com/api/docs/assistants/migration) of
|
|
69
|
-
# the assistant. This is useful for modifying the behavior on a per-run basis.
|
|
70
|
-
attr_accessor instructions: String?
|
|
71
|
-
|
|
72
|
-
# The maximum number of completion tokens that may be used over the course of the
|
|
73
|
-
# run. The run will make a best effort to use only the number of completion tokens
|
|
74
|
-
# specified, across multiple turns of the run. If the run exceeds the number of
|
|
75
|
-
# completion tokens specified, the run will end with status `incomplete`. See
|
|
76
|
-
# `incomplete_details` for more info.
|
|
77
|
-
attr_accessor max_completion_tokens: Integer?
|
|
78
|
-
|
|
79
|
-
# The maximum number of prompt tokens that may be used over the course of the run.
|
|
80
|
-
# The run will make a best effort to use only the number of prompt tokens
|
|
81
|
-
# specified, across multiple turns of the run. If the run exceeds the number of
|
|
82
|
-
# prompt tokens specified, the run will end with status `incomplete`. See
|
|
83
|
-
# `incomplete_details` for more info.
|
|
84
|
-
attr_accessor max_prompt_tokens: Integer?
|
|
85
|
-
|
|
86
|
-
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
87
|
-
# for storing additional information about the object in a structured format, and
|
|
88
|
-
# querying for objects via API or the dashboard.
|
|
89
|
-
#
|
|
90
|
-
# Keys are strings with a maximum length of 64 characters. Values are strings with
|
|
91
|
-
# a maximum length of 512 characters.
|
|
92
|
-
attr_accessor metadata: OpenAI::Models::metadata?
|
|
93
|
-
|
|
94
|
-
# The ID of the
|
|
95
|
-
# [Model](https://developers.openai.com/api/reference/resources/models) to be used
|
|
96
|
-
# to execute this run. If a value is provided here, it will override the model
|
|
97
|
-
# associated with the assistant. If not, the model associated with the assistant
|
|
98
|
-
# will be used.
|
|
99
|
-
attr_accessor model: OpenAI::Models::Beta::Threads::RunCreateParams::model?
|
|
100
|
-
|
|
101
|
-
# Whether to enable
|
|
102
|
-
# [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling)
|
|
103
|
-
# during tool use.
|
|
104
|
-
attr_reader parallel_tool_calls: bool?
|
|
105
|
-
|
|
106
|
-
# Whether to enable
|
|
107
|
-
# [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling)
|
|
108
|
-
# during tool use.
|
|
109
|
-
def parallel_tool_calls=: (bool) -> bool
|
|
110
|
-
|
|
111
|
-
# Constrains effort on reasoning for reasoning models. Currently supported values
|
|
112
|
-
# are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
113
|
-
# reasoning effort can result in faster responses and fewer tokens used on
|
|
114
|
-
# reasoning in a response. Not all reasoning models support every value. See the
|
|
115
|
-
# [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
116
|
-
# model-specific support.
|
|
117
|
-
attr_accessor reasoning_effort: OpenAI::Models::reasoning_effort?
|
|
118
|
-
|
|
119
|
-
# Specifies the format that the model must output. Compatible with
|
|
120
|
-
# [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
|
|
121
|
-
# [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
|
|
122
|
-
# all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
|
|
123
|
-
#
|
|
124
|
-
# Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
|
|
125
|
-
# Outputs which ensures the model will match your supplied JSON schema. Learn more
|
|
126
|
-
# in the
|
|
127
|
-
# [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
128
|
-
#
|
|
129
|
-
# Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
|
|
130
|
-
# message the model generates is valid JSON.
|
|
131
|
-
#
|
|
132
|
-
# **Important:** when using JSON mode, you **must** also instruct the model to
|
|
133
|
-
# produce JSON yourself via a system or user message. Without this, the model may
|
|
134
|
-
# generate an unending stream of whitespace until the generation reaches the token
|
|
135
|
-
# limit, resulting in a long-running and seemingly "stuck" request. Also note that
|
|
136
|
-
# the message content may be partially cut off if `finish_reason="length"`, which
|
|
137
|
-
# indicates the generation exceeded `max_tokens` or the conversation exceeded the
|
|
138
|
-
# max context length.
|
|
139
|
-
attr_accessor response_format: OpenAI::Models::Beta::assistant_response_format_option?
|
|
140
|
-
|
|
141
|
-
# What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
|
|
142
|
-
# make the output more random, while lower values like 0.2 will make it more
|
|
143
|
-
# focused and deterministic.
|
|
144
|
-
attr_accessor temperature: Float?
|
|
145
|
-
|
|
146
|
-
# Controls which (if any) tool is called by the model. `none` means the model will
|
|
147
|
-
# not call any tools and instead generates a message. `auto` is the default value
|
|
148
|
-
# and means the model can pick between generating a message or calling one or more
|
|
149
|
-
# tools. `required` means the model must call one or more tools before responding
|
|
150
|
-
# to the user. Specifying a particular tool like `{"type": "file_search"}` or
|
|
151
|
-
# `{"type": "function", "function": {"name": "my_function"}}` forces the model to
|
|
152
|
-
# call that tool.
|
|
153
|
-
attr_accessor tool_choice: OpenAI::Models::Beta::assistant_tool_choice_option?
|
|
154
|
-
|
|
155
|
-
# Override the tools the assistant can use for this run. This is useful for
|
|
156
|
-
# modifying the behavior on a per-run basis.
|
|
157
|
-
attr_accessor tools: ::Array[OpenAI::Models::Beta::assistant_tool]?
|
|
158
|
-
|
|
159
|
-
# An alternative to sampling with temperature, called nucleus sampling, where the
|
|
160
|
-
# model considers the results of the tokens with top_p probability mass. So 0.1
|
|
161
|
-
# means only the tokens comprising the top 10% probability mass are considered.
|
|
162
|
-
#
|
|
163
|
-
# We generally recommend altering this or temperature but not both.
|
|
164
|
-
attr_accessor top_p: Float?
|
|
165
|
-
|
|
166
|
-
# Controls for how a thread will be truncated prior to the run. Use this to
|
|
167
|
-
# control the initial context window of the run.
|
|
168
|
-
attr_accessor truncation_strategy: OpenAI::Beta::Threads::RunCreateParams::TruncationStrategy?
|
|
169
|
-
|
|
170
|
-
# @param assistant_id
|
|
171
|
-
# The ID of the
|
|
172
|
-
# [assistant](https://developers.openai.com/api/docs/assistants/migration) to use
|
|
173
|
-
# to execute this run.
|
|
174
|
-
# @param include
|
|
175
|
-
# A list of additional fields to include in the response. Currently the only
|
|
176
|
-
# supported value is `step_details.tool_calls[*].file_search.results[*].content`
|
|
177
|
-
# to fetch the file search result content.
|
|
178
|
-
#
|
|
179
|
-
# See the
|
|
180
|
-
# [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
|
|
181
|
-
# for more information.
|
|
182
|
-
# @param additional_instructions
|
|
183
|
-
# Appends additional instructions at the end of the instructions for the run. This
|
|
184
|
-
# is useful for modifying the behavior on a per-run basis without overriding other
|
|
185
|
-
# instructions.
|
|
186
|
-
# @param additional_messages
|
|
187
|
-
# Adds additional messages to the thread before creating the run.
|
|
188
|
-
# @param instructions
|
|
189
|
-
# Overrides the
|
|
190
|
-
# [instructions](https://developers.openai.com/api/docs/assistants/migration) of
|
|
191
|
-
# the assistant. This is useful for modifying the behavior on a per-run basis.
|
|
192
|
-
# @param max_completion_tokens
|
|
193
|
-
# The maximum number of completion tokens that may be used over the course of the
|
|
194
|
-
# run. The run will make a best effort to use only the number of completion tokens
|
|
195
|
-
# specified, across multiple turns of the run. If the run exceeds the number of
|
|
196
|
-
# completion tokens specified, the run will end with status `incomplete`. See
|
|
197
|
-
# `incomplete_details` for more info.
|
|
198
|
-
# @param max_prompt_tokens
|
|
199
|
-
# The maximum number of prompt tokens that may be used over the course of the run.
|
|
200
|
-
# The run will make a best effort to use only the number of prompt tokens
|
|
201
|
-
# specified, across multiple turns of the run. If the run exceeds the number of
|
|
202
|
-
# prompt tokens specified, the run will end with status `incomplete`. See
|
|
203
|
-
# `incomplete_details` for more info.
|
|
204
|
-
# @param metadata
|
|
205
|
-
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
206
|
-
# for storing additional information about the object in a structured format, and
|
|
207
|
-
# querying for objects via API or the dashboard.
|
|
208
|
-
#
|
|
209
|
-
# Keys are strings with a maximum length of 64 characters. Values are strings with
|
|
210
|
-
# a maximum length of 512 characters.
|
|
211
|
-
# @param model
|
|
212
|
-
# The ID of the
|
|
213
|
-
# [Model](https://developers.openai.com/api/reference/resources/models) to be used
|
|
214
|
-
# to execute this run. If a value is provided here, it will override the model
|
|
215
|
-
# associated with the assistant. If not, the model associated with the assistant
|
|
216
|
-
# will be used.
|
|
217
|
-
# @param parallel_tool_calls
|
|
218
|
-
# Whether to enable
|
|
219
|
-
# [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling)
|
|
220
|
-
# during tool use.
|
|
221
|
-
# @param reasoning_effort
|
|
222
|
-
# Constrains effort on reasoning for reasoning models. Currently supported values
|
|
223
|
-
# are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
224
|
-
# reasoning effort can result in faster responses and fewer tokens used on
|
|
225
|
-
# reasoning in a response. Not all reasoning models support every value. See the
|
|
226
|
-
# [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
|
|
227
|
-
# model-specific support.
|
|
228
|
-
# @param response_format
|
|
229
|
-
# Specifies the format that the model must output. Compatible with
|
|
230
|
-
# [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
|
|
231
|
-
# [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and
|
|
232
|
-
# all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
|
|
233
|
-
#
|
|
234
|
-
# Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured
|
|
235
|
-
# Outputs which ensures the model will match your supplied JSON schema. Learn more
|
|
236
|
-
# in the
|
|
237
|
-
# [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
|
|
238
|
-
#
|
|
239
|
-
# Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
|
|
240
|
-
# message the model generates is valid JSON.
|
|
241
|
-
#
|
|
242
|
-
# **Important:** when using JSON mode, you **must** also instruct the model to
|
|
243
|
-
# produce JSON yourself via a system or user message. Without this, the model may
|
|
244
|
-
# generate an unending stream of whitespace until the generation reaches the token
|
|
245
|
-
# limit, resulting in a long-running and seemingly "stuck" request. Also note that
|
|
246
|
-
# the message content may be partially cut off if `finish_reason="length"`, which
|
|
247
|
-
# indicates the generation exceeded `max_tokens` or the conversation exceeded the
|
|
248
|
-
# max context length.
|
|
249
|
-
# @param temperature
|
|
250
|
-
# What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
|
|
251
|
-
# make the output more random, while lower values like 0.2 will make it more
|
|
252
|
-
# focused and deterministic.
|
|
253
|
-
# @param tool_choice
|
|
254
|
-
# Controls which (if any) tool is called by the model. `none` means the model will
|
|
255
|
-
# not call any tools and instead generates a message. `auto` is the default value
|
|
256
|
-
# and means the model can pick between generating a message or calling one or more
|
|
257
|
-
# tools. `required` means the model must call one or more tools before responding
|
|
258
|
-
# to the user. Specifying a particular tool like `{"type": "file_search"}` or
|
|
259
|
-
# `{"type": "function", "function": {"name": "my_function"}}` forces the model to
|
|
260
|
-
# call that tool.
|
|
261
|
-
# @param tools
|
|
262
|
-
# Override the tools the assistant can use for this run. This is useful for
|
|
263
|
-
# modifying the behavior on a per-run basis.
|
|
264
|
-
# @param top_p
|
|
265
|
-
# An alternative to sampling with temperature, called nucleus sampling, where the
|
|
266
|
-
# model considers the results of the tokens with top_p probability mass. So 0.1
|
|
267
|
-
# means only the tokens comprising the top 10% probability mass are considered.
|
|
268
|
-
#
|
|
269
|
-
# We generally recommend altering this or temperature but not both.
|
|
270
|
-
# @param truncation_strategy
|
|
271
|
-
# Controls for how a thread will be truncated prior to the run. Use this to
|
|
272
|
-
# control the initial context window of the run.
|
|
273
|
-
def initialize: (
|
|
274
|
-
thread_id: String,
|
|
275
|
-
assistant_id: String,
|
|
276
|
-
?include: ::Array[OpenAI::Models::Beta::Threads::Runs::run_step_include],
|
|
277
|
-
?additional_instructions: String?,
|
|
278
|
-
?additional_messages: ::Array[OpenAI::Beta::Threads::RunCreateParams::AdditionalMessage]?,
|
|
279
|
-
?instructions: String?,
|
|
280
|
-
?max_completion_tokens: Integer?,
|
|
281
|
-
?max_prompt_tokens: Integer?,
|
|
282
|
-
?metadata: OpenAI::Models::metadata?,
|
|
283
|
-
?model: OpenAI::Models::Beta::Threads::RunCreateParams::model?,
|
|
284
|
-
?parallel_tool_calls: bool,
|
|
285
|
-
?reasoning_effort: OpenAI::Models::reasoning_effort?,
|
|
286
|
-
?response_format: OpenAI::Models::Beta::assistant_response_format_option?,
|
|
287
|
-
?temperature: Float?,
|
|
288
|
-
?tool_choice: OpenAI::Models::Beta::assistant_tool_choice_option?,
|
|
289
|
-
?tools: ::Array[OpenAI::Models::Beta::assistant_tool]?,
|
|
290
|
-
?top_p: Float?,
|
|
291
|
-
?truncation_strategy: OpenAI::Beta::Threads::RunCreateParams::TruncationStrategy?,
|
|
292
|
-
?request_options: OpenAI::request_opts
|
|
293
|
-
) -> void
|
|
294
|
-
|
|
295
|
-
def to_hash: -> {
|
|
296
|
-
thread_id: String,
|
|
297
|
-
assistant_id: String,
|
|
298
|
-
?include: ::Array[OpenAI::Models::Beta::Threads::Runs::run_step_include],
|
|
299
|
-
?additional_instructions: String?,
|
|
300
|
-
?additional_messages: ::Array[OpenAI::Beta::Threads::RunCreateParams::AdditionalMessage]?,
|
|
301
|
-
?instructions: String?,
|
|
302
|
-
?max_completion_tokens: Integer?,
|
|
303
|
-
?max_prompt_tokens: Integer?,
|
|
304
|
-
?metadata: OpenAI::Models::metadata?,
|
|
305
|
-
?model: OpenAI::Models::Beta::Threads::RunCreateParams::model?,
|
|
306
|
-
?parallel_tool_calls: bool,
|
|
307
|
-
?reasoning_effort: OpenAI::Models::reasoning_effort?,
|
|
308
|
-
?response_format: OpenAI::Models::Beta::assistant_response_format_option?,
|
|
309
|
-
?temperature: Float?,
|
|
310
|
-
?tool_choice: OpenAI::Models::Beta::assistant_tool_choice_option?,
|
|
311
|
-
?tools: ::Array[OpenAI::Models::Beta::assistant_tool]?,
|
|
312
|
-
?top_p: Float?,
|
|
313
|
-
?truncation_strategy: OpenAI::Beta::Threads::RunCreateParams::TruncationStrategy?,
|
|
314
|
-
?request_options: OpenAI::RequestOptions
|
|
315
|
-
}
|
|
316
|
-
|
|
317
|
-
type additional_message =
|
|
318
|
-
{
|
|
319
|
-
content: OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::content,
|
|
320
|
-
role: OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::role,
|
|
321
|
-
?attachments: ::Array[OpenAI::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment]?,
|
|
322
|
-
?metadata: OpenAI::Models::metadata?
|
|
323
|
-
}
|
|
324
|
-
|
|
325
|
-
class AdditionalMessage < OpenAI::Internal::Type::BaseModel
|
|
326
|
-
# The text contents of the message.
|
|
327
|
-
attr_accessor content: OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::content
|
|
328
|
-
|
|
329
|
-
# The role of the entity that is creating the message. Allowed values include:
|
|
330
|
-
#
|
|
331
|
-
# - `user`: Indicates the message is sent by an actual user and should be used in
|
|
332
|
-
# most cases to represent user-generated messages.
|
|
333
|
-
# - `assistant`: Indicates the message is generated by the assistant. Use this
|
|
334
|
-
# value to insert messages from the assistant into the conversation.
|
|
335
|
-
attr_accessor role: OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::role
|
|
336
|
-
|
|
337
|
-
# A list of files attached to the message, and the tools they should be added to.
|
|
338
|
-
attr_accessor attachments: ::Array[OpenAI::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment]?
|
|
339
|
-
|
|
340
|
-
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
341
|
-
# for storing additional information about the object in a structured format, and
|
|
342
|
-
# querying for objects via API or the dashboard.
|
|
343
|
-
#
|
|
344
|
-
# Keys are strings with a maximum length of 64 characters. Values are strings with
|
|
345
|
-
# a maximum length of 512 characters.
|
|
346
|
-
attr_accessor metadata: OpenAI::Models::metadata?
|
|
347
|
-
|
|
348
|
-
# @param content
|
|
349
|
-
# The text contents of the message.
|
|
350
|
-
# @param role
|
|
351
|
-
# The role of the entity that is creating the message. Allowed values include:
|
|
352
|
-
#
|
|
353
|
-
# - `user`: Indicates the message is sent by an actual user and should be used in
|
|
354
|
-
# most cases to represent user-generated messages.
|
|
355
|
-
# - `assistant`: Indicates the message is generated by the assistant. Use this
|
|
356
|
-
# value to insert messages from the assistant into the conversation.
|
|
357
|
-
# @param attachments
|
|
358
|
-
# A list of files attached to the message, and the tools they should be added to.
|
|
359
|
-
# @param metadata
|
|
360
|
-
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
361
|
-
# for storing additional information about the object in a structured format, and
|
|
362
|
-
# querying for objects via API or the dashboard.
|
|
363
|
-
#
|
|
364
|
-
# Keys are strings with a maximum length of 64 characters. Values are strings with
|
|
365
|
-
# a maximum length of 512 characters.
|
|
366
|
-
def initialize: (
|
|
367
|
-
content: OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::content,
|
|
368
|
-
role: OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::role,
|
|
369
|
-
?attachments: ::Array[OpenAI::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment]?,
|
|
370
|
-
?metadata: OpenAI::Models::metadata?
|
|
371
|
-
) -> void
|
|
372
|
-
|
|
373
|
-
def to_hash: -> {
|
|
374
|
-
content: OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::content,
|
|
375
|
-
role: OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::role,
|
|
376
|
-
?attachments: ::Array[OpenAI::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment]?,
|
|
377
|
-
?metadata: OpenAI::Models::metadata?
|
|
378
|
-
}
|
|
379
|
-
|
|
380
|
-
type content =
|
|
381
|
-
String
|
|
382
|
-
| ::Array[OpenAI::Models::Beta::Threads::message_content_part_param]
|
|
383
|
-
|
|
384
|
-
module Content
|
|
385
|
-
extend OpenAI::Internal::Type::Union
|
|
386
|
-
|
|
387
|
-
def self?.variants: -> ::Array[OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::content]
|
|
388
|
-
|
|
389
|
-
MessageContentPartParamArray: OpenAI::Internal::Type::Converter
|
|
390
|
-
end
|
|
391
|
-
|
|
392
|
-
type role = :user | :assistant
|
|
393
|
-
|
|
394
|
-
module Role
|
|
395
|
-
extend OpenAI::Internal::Type::Enum
|
|
396
|
-
|
|
397
|
-
USER: :user
|
|
398
|
-
ASSISTANT: :assistant
|
|
399
|
-
|
|
400
|
-
def self?.values: -> ::Array[OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::role]
|
|
401
|
-
end
|
|
402
|
-
|
|
403
|
-
type attachment =
|
|
404
|
-
{
|
|
405
|
-
?file_id: String,
|
|
406
|
-
?tools: ::Array[OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment::tool]
|
|
407
|
-
}
|
|
408
|
-
|
|
409
|
-
class Attachment < OpenAI::Internal::Type::BaseModel
|
|
410
|
-
# The ID of the file to attach to the message.
|
|
411
|
-
attr_reader file_id: String?
|
|
412
|
-
|
|
413
|
-
# The ID of the file to attach to the message.
|
|
414
|
-
def file_id=: (String) -> String
|
|
415
|
-
|
|
416
|
-
# The tools to add this file to.
|
|
417
|
-
attr_reader tools: ::Array[OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment::tool]?
|
|
418
|
-
|
|
419
|
-
# The tools to add this file to.
|
|
420
|
-
def tools=: (
|
|
421
|
-
::Array[OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment::tool
|
|
422
|
-
| { type: :file_search }]
|
|
423
|
-
) -> ::Array[(OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment::tool
|
|
424
|
-
| { type: :file_search })]
|
|
425
|
-
|
|
426
|
-
# @param file_id
|
|
427
|
-
# The ID of the file to attach to the message.
|
|
428
|
-
# @param tools
|
|
429
|
-
# The tools to add this file to.
|
|
430
|
-
def initialize: (
|
|
431
|
-
?file_id: String,
|
|
432
|
-
?tools: ::Array[OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment::tool
|
|
433
|
-
| { type: :file_search }]
|
|
434
|
-
) -> void
|
|
435
|
-
|
|
436
|
-
def to_hash: -> {
|
|
437
|
-
?file_id: String,
|
|
438
|
-
?tools: ::Array[OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment::tool]
|
|
439
|
-
}
|
|
440
|
-
|
|
441
|
-
type tool =
|
|
442
|
-
OpenAI::Beta::CodeInterpreterTool
|
|
443
|
-
| OpenAI::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment::Tool::FileSearch
|
|
444
|
-
|
|
445
|
-
module Tool
|
|
446
|
-
extend OpenAI::Internal::Type::Union
|
|
447
|
-
|
|
448
|
-
type file_search = { ?type: :file_search }
|
|
449
|
-
|
|
450
|
-
class FileSearch < OpenAI::Internal::Type::BaseModel
|
|
451
|
-
# The type of tool being defined: `file_search`
|
|
452
|
-
attr_accessor type: :file_search
|
|
453
|
-
|
|
454
|
-
# @param type
|
|
455
|
-
# The type of tool being defined: `file_search`
|
|
456
|
-
def initialize: (?type: :file_search) -> void
|
|
457
|
-
|
|
458
|
-
def to_hash: -> { ?type: :file_search }
|
|
459
|
-
end
|
|
460
|
-
|
|
461
|
-
def self?.variants: -> ::Array[OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment::tool]
|
|
462
|
-
end
|
|
463
|
-
end
|
|
464
|
-
end
|
|
465
|
-
|
|
466
|
-
type model = String | OpenAI::Models::chat_model
|
|
467
|
-
|
|
468
|
-
module Model
|
|
469
|
-
extend OpenAI::Internal::Type::Union
|
|
470
|
-
|
|
471
|
-
def self?.variants: -> ::Array[OpenAI::Models::Beta::Threads::RunCreateParams::model]
|
|
472
|
-
end
|
|
473
|
-
|
|
474
|
-
type truncation_strategy =
|
|
475
|
-
{
|
|
476
|
-
type: OpenAI::Models::Beta::Threads::RunCreateParams::TruncationStrategy::type_,
|
|
477
|
-
?last_messages: Integer?
|
|
478
|
-
}
|
|
479
|
-
|
|
480
|
-
class TruncationStrategy < OpenAI::Internal::Type::BaseModel
|
|
481
|
-
# The truncation strategy to use for the thread. The default is `auto`. If set to
|
|
482
|
-
# `last_messages`, the thread will be truncated to the n most recent messages in
|
|
483
|
-
# the thread. When set to `auto`, messages in the middle of the thread will be
|
|
484
|
-
# dropped to fit the context length of the model, `max_prompt_tokens`.
|
|
485
|
-
attr_accessor type: OpenAI::Models::Beta::Threads::RunCreateParams::TruncationStrategy::type_
|
|
486
|
-
|
|
487
|
-
# The number of most recent messages from the thread when constructing the context
|
|
488
|
-
# for the run.
|
|
489
|
-
attr_accessor last_messages: Integer?
|
|
490
|
-
|
|
491
|
-
# @param type
|
|
492
|
-
# The truncation strategy to use for the thread. The default is `auto`. If set to
|
|
493
|
-
# `last_messages`, the thread will be truncated to the n most recent messages in
|
|
494
|
-
# the thread. When set to `auto`, messages in the middle of the thread will be
|
|
495
|
-
# dropped to fit the context length of the model, `max_prompt_tokens`.
|
|
496
|
-
# @param last_messages
|
|
497
|
-
# The number of most recent messages from the thread when constructing the context
|
|
498
|
-
# for the run.
|
|
499
|
-
def initialize: (
|
|
500
|
-
type: OpenAI::Models::Beta::Threads::RunCreateParams::TruncationStrategy::type_,
|
|
501
|
-
?last_messages: Integer?
|
|
502
|
-
) -> void
|
|
503
|
-
|
|
504
|
-
def to_hash: -> {
|
|
505
|
-
type: OpenAI::Models::Beta::Threads::RunCreateParams::TruncationStrategy::type_,
|
|
506
|
-
?last_messages: Integer?
|
|
507
|
-
}
|
|
508
|
-
|
|
509
|
-
type type_ = :auto | :last_messages
|
|
510
|
-
|
|
511
|
-
module Type
|
|
512
|
-
extend OpenAI::Internal::Type::Enum
|
|
513
|
-
|
|
514
|
-
AUTO: :auto
|
|
515
|
-
LAST_MESSAGES: :last_messages
|
|
516
|
-
|
|
517
|
-
def self?.values: -> ::Array[OpenAI::Models::Beta::Threads::RunCreateParams::TruncationStrategy::type_]
|
|
518
|
-
end
|
|
519
|
-
end
|
|
520
|
-
end
|
|
521
|
-
end
|
|
522
|
-
end
|
|
523
|
-
end
|
|
524
|
-
end
|
|
@@ -1,111 +0,0 @@
|
|
|
1
|
-
module OpenAI
|
|
2
|
-
module Models
|
|
3
|
-
module Beta
|
|
4
|
-
module Threads
|
|
5
|
-
type run_list_params =
|
|
6
|
-
{
|
|
7
|
-
thread_id: String,
|
|
8
|
-
?after: String,
|
|
9
|
-
?before: String,
|
|
10
|
-
?limit: Integer,
|
|
11
|
-
?order: OpenAI::Models::Beta::Threads::RunListParams::order,
|
|
12
|
-
?request_options: OpenAI::request_opts
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
class RunListParams < OpenAI::Internal::Type::BaseModel
|
|
16
|
-
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
17
|
-
include OpenAI::Internal::Type::RequestParameters
|
|
18
|
-
|
|
19
|
-
attr_accessor thread_id: String
|
|
20
|
-
|
|
21
|
-
# A cursor for use in pagination. `after` is an object ID that defines your place
|
|
22
|
-
# in the list. For instance, if you make a list request and receive 100 objects,
|
|
23
|
-
# ending with obj_foo, your subsequent call can include after=obj_foo in order to
|
|
24
|
-
# fetch the next page of the list.
|
|
25
|
-
attr_reader after: String?
|
|
26
|
-
|
|
27
|
-
# A cursor for use in pagination. `after` is an object ID that defines your place
|
|
28
|
-
# in the list. For instance, if you make a list request and receive 100 objects,
|
|
29
|
-
# ending with obj_foo, your subsequent call can include after=obj_foo in order to
|
|
30
|
-
# fetch the next page of the list.
|
|
31
|
-
def after=: (String) -> String
|
|
32
|
-
|
|
33
|
-
# A cursor for use in pagination. `before` is an object ID that defines your place
|
|
34
|
-
# in the list. For instance, if you make a list request and receive 100 objects,
|
|
35
|
-
# starting with obj_foo, your subsequent call can include before=obj_foo in order
|
|
36
|
-
# to fetch the previous page of the list.
|
|
37
|
-
attr_reader before: String?
|
|
38
|
-
|
|
39
|
-
# A cursor for use in pagination. `before` is an object ID that defines your place
|
|
40
|
-
# in the list. For instance, if you make a list request and receive 100 objects,
|
|
41
|
-
# starting with obj_foo, your subsequent call can include before=obj_foo in order
|
|
42
|
-
# to fetch the previous page of the list.
|
|
43
|
-
def before=: (String) -> String
|
|
44
|
-
|
|
45
|
-
# A limit on the number of objects to be returned. Limit can range between 1 and
|
|
46
|
-
# 100, and the default is 20.
|
|
47
|
-
attr_reader limit: Integer?
|
|
48
|
-
|
|
49
|
-
# A limit on the number of objects to be returned. Limit can range between 1 and
|
|
50
|
-
# 100, and the default is 20.
|
|
51
|
-
def limit=: (Integer) -> Integer
|
|
52
|
-
|
|
53
|
-
# Sort order by the `created_at` timestamp of the objects. `asc` for ascending
|
|
54
|
-
# order and `desc` for descending order.
|
|
55
|
-
attr_reader order: OpenAI::Models::Beta::Threads::RunListParams::order?
|
|
56
|
-
|
|
57
|
-
# Sort order by the `created_at` timestamp of the objects. `asc` for ascending
|
|
58
|
-
# order and `desc` for descending order.
|
|
59
|
-
def order=: (
|
|
60
|
-
OpenAI::Models::Beta::Threads::RunListParams::order
|
|
61
|
-
) -> OpenAI::Models::Beta::Threads::RunListParams::order
|
|
62
|
-
|
|
63
|
-
# @param after
|
|
64
|
-
# A cursor for use in pagination. `after` is an object ID that defines your place
|
|
65
|
-
# in the list. For instance, if you make a list request and receive 100 objects,
|
|
66
|
-
# ending with obj_foo, your subsequent call can include after=obj_foo in order to
|
|
67
|
-
# fetch the next page of the list.
|
|
68
|
-
# @param before
|
|
69
|
-
# A cursor for use in pagination. `before` is an object ID that defines your place
|
|
70
|
-
# in the list. For instance, if you make a list request and receive 100 objects,
|
|
71
|
-
# starting with obj_foo, your subsequent call can include before=obj_foo in order
|
|
72
|
-
# to fetch the previous page of the list.
|
|
73
|
-
# @param limit
|
|
74
|
-
# A limit on the number of objects to be returned. Limit can range between 1 and
|
|
75
|
-
# 100, and the default is 20.
|
|
76
|
-
# @param order
|
|
77
|
-
# Sort order by the `created_at` timestamp of the objects. `asc` for ascending
|
|
78
|
-
# order and `desc` for descending order.
|
|
79
|
-
def initialize: (
|
|
80
|
-
thread_id: String,
|
|
81
|
-
?after: String,
|
|
82
|
-
?before: String,
|
|
83
|
-
?limit: Integer,
|
|
84
|
-
?order: OpenAI::Models::Beta::Threads::RunListParams::order,
|
|
85
|
-
?request_options: OpenAI::request_opts
|
|
86
|
-
) -> void
|
|
87
|
-
|
|
88
|
-
def to_hash: -> {
|
|
89
|
-
thread_id: String,
|
|
90
|
-
?after: String,
|
|
91
|
-
?before: String,
|
|
92
|
-
?limit: Integer,
|
|
93
|
-
?order: OpenAI::Models::Beta::Threads::RunListParams::order,
|
|
94
|
-
?request_options: OpenAI::RequestOptions
|
|
95
|
-
}
|
|
96
|
-
|
|
97
|
-
type order = :asc | :desc
|
|
98
|
-
|
|
99
|
-
module Order
|
|
100
|
-
extend OpenAI::Internal::Type::Enum
|
|
101
|
-
|
|
102
|
-
ASC: :asc
|
|
103
|
-
DESC: :desc
|
|
104
|
-
|
|
105
|
-
def self?.values: -> ::Array[OpenAI::Models::Beta::Threads::RunListParams::order]
|
|
106
|
-
end
|
|
107
|
-
end
|
|
108
|
-
end
|
|
109
|
-
end
|
|
110
|
-
end
|
|
111
|
-
end
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
module OpenAI
|
|
2
|
-
module Models
|
|
3
|
-
module Beta
|
|
4
|
-
module Threads
|
|
5
|
-
type run_retrieve_params =
|
|
6
|
-
{
|
|
7
|
-
thread_id: String,
|
|
8
|
-
run_id: String,
|
|
9
|
-
?request_options: OpenAI::request_opts
|
|
10
|
-
}
|
|
11
|
-
|
|
12
|
-
class RunRetrieveParams < OpenAI::Internal::Type::BaseModel
|
|
13
|
-
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
14
|
-
include OpenAI::Internal::Type::RequestParameters
|
|
15
|
-
|
|
16
|
-
attr_accessor thread_id: String
|
|
17
|
-
|
|
18
|
-
attr_accessor run_id: String
|
|
19
|
-
|
|
20
|
-
def initialize: (
|
|
21
|
-
thread_id: String,
|
|
22
|
-
run_id: String,
|
|
23
|
-
?request_options: OpenAI::request_opts
|
|
24
|
-
) -> void
|
|
25
|
-
|
|
26
|
-
def to_hash: -> {
|
|
27
|
-
thread_id: String,
|
|
28
|
-
run_id: String,
|
|
29
|
-
?request_options: OpenAI::RequestOptions
|
|
30
|
-
}
|
|
31
|
-
end
|
|
32
|
-
end
|
|
33
|
-
end
|
|
34
|
-
end
|
|
35
|
-
end
|