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,443 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module OpenAI
|
|
4
|
-
module Models
|
|
5
|
-
module Beta
|
|
6
|
-
# @see OpenAI::Resources::Beta::Threads#create
|
|
7
|
-
class ThreadCreateParams < OpenAI::Internal::Type::BaseModel
|
|
8
|
-
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
|
-
include OpenAI::Internal::Type::RequestParameters
|
|
10
|
-
|
|
11
|
-
# @!attribute messages
|
|
12
|
-
# A list of
|
|
13
|
-
# [messages](https://developers.openai.com/api/docs/assistants/migration) to start
|
|
14
|
-
# the thread with.
|
|
15
|
-
#
|
|
16
|
-
# @return [Array<OpenAI::Models::Beta::ThreadCreateParams::Message>, nil]
|
|
17
|
-
optional :messages, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::ThreadCreateParams::Message] }
|
|
18
|
-
|
|
19
|
-
# @!attribute metadata
|
|
20
|
-
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
21
|
-
# for storing additional information about the object in a structured format, and
|
|
22
|
-
# querying for objects via API or the dashboard.
|
|
23
|
-
#
|
|
24
|
-
# Keys are strings with a maximum length of 64 characters. Values are strings with
|
|
25
|
-
# a maximum length of 512 characters.
|
|
26
|
-
#
|
|
27
|
-
# @return [Hash{Symbol=>String}, nil]
|
|
28
|
-
optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
|
|
29
|
-
|
|
30
|
-
# @!attribute tool_resources
|
|
31
|
-
# A set of resources that are made available to the assistant's tools in this
|
|
32
|
-
# thread. The resources are specific to the type of tool. For example, the
|
|
33
|
-
# `code_interpreter` tool requires a list of file IDs, while the `file_search`
|
|
34
|
-
# tool requires a list of vector store IDs.
|
|
35
|
-
#
|
|
36
|
-
# @return [OpenAI::Models::Beta::ThreadCreateParams::ToolResources, nil]
|
|
37
|
-
optional :tool_resources, -> { OpenAI::Beta::ThreadCreateParams::ToolResources }, nil?: true
|
|
38
|
-
|
|
39
|
-
# @!method initialize(messages: nil, metadata: nil, tool_resources: nil, request_options: {})
|
|
40
|
-
# @param messages [Array<OpenAI::Models::Beta::ThreadCreateParams::Message>]
|
|
41
|
-
# A list of
|
|
42
|
-
# [messages](https://developers.openai.com/api/docs/assistants/migration) to start
|
|
43
|
-
# the thread with.
|
|
44
|
-
#
|
|
45
|
-
# @param metadata [Hash{Symbol=>String}, nil]
|
|
46
|
-
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
47
|
-
# for storing additional information about the object in a structured format, and
|
|
48
|
-
# querying for objects via API or the dashboard.
|
|
49
|
-
#
|
|
50
|
-
# Keys are strings with a maximum length of 64 characters. Values are strings with
|
|
51
|
-
# a maximum length of 512 characters.
|
|
52
|
-
#
|
|
53
|
-
# @param tool_resources [OpenAI::Models::Beta::ThreadCreateParams::ToolResources, nil]
|
|
54
|
-
# A set of resources that are made available to the assistant's tools in this
|
|
55
|
-
# thread. The resources are specific to the type of tool. For example, the
|
|
56
|
-
# `code_interpreter` tool requires a list of file IDs, while the `file_search`
|
|
57
|
-
# tool requires a list of vector store IDs.
|
|
58
|
-
#
|
|
59
|
-
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
60
|
-
|
|
61
|
-
class Message < OpenAI::Internal::Type::BaseModel
|
|
62
|
-
# @!attribute content
|
|
63
|
-
# The text contents of the message.
|
|
64
|
-
#
|
|
65
|
-
# @return [String, Array<OpenAI::Models::Beta::Threads::ImageFileContentBlock, OpenAI::Models::Beta::Threads::ImageURLContentBlock, OpenAI::Models::Beta::Threads::TextContentBlockParam>]
|
|
66
|
-
required :content, union: -> { OpenAI::Beta::ThreadCreateParams::Message::Content }
|
|
67
|
-
|
|
68
|
-
# @!attribute role
|
|
69
|
-
# The role of the entity that is creating the message. Allowed values include:
|
|
70
|
-
#
|
|
71
|
-
# - `user`: Indicates the message is sent by an actual user and should be used in
|
|
72
|
-
# most cases to represent user-generated messages.
|
|
73
|
-
# - `assistant`: Indicates the message is generated by the assistant. Use this
|
|
74
|
-
# value to insert messages from the assistant into the conversation.
|
|
75
|
-
#
|
|
76
|
-
# @return [Symbol, OpenAI::Models::Beta::ThreadCreateParams::Message::Role]
|
|
77
|
-
required :role, enum: -> { OpenAI::Beta::ThreadCreateParams::Message::Role }
|
|
78
|
-
|
|
79
|
-
# @!attribute attachments
|
|
80
|
-
# A list of files attached to the message, and the tools they should be added to.
|
|
81
|
-
#
|
|
82
|
-
# @return [Array<OpenAI::Models::Beta::ThreadCreateParams::Message::Attachment>, nil]
|
|
83
|
-
optional(
|
|
84
|
-
:attachments,
|
|
85
|
-
-> {
|
|
86
|
-
OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::ThreadCreateParams::Message::Attachment]
|
|
87
|
-
},
|
|
88
|
-
nil?: true
|
|
89
|
-
)
|
|
90
|
-
|
|
91
|
-
# @!attribute metadata
|
|
92
|
-
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
93
|
-
# for storing additional information about the object in a structured format, and
|
|
94
|
-
# querying for objects via API or the dashboard.
|
|
95
|
-
#
|
|
96
|
-
# Keys are strings with a maximum length of 64 characters. Values are strings with
|
|
97
|
-
# a maximum length of 512 characters.
|
|
98
|
-
#
|
|
99
|
-
# @return [Hash{Symbol=>String}, nil]
|
|
100
|
-
optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
|
|
101
|
-
|
|
102
|
-
# @!method initialize(content:, role:, attachments: nil, metadata: nil)
|
|
103
|
-
# @param content [String, Array<OpenAI::Models::Beta::Threads::ImageFileContentBlock, OpenAI::Models::Beta::Threads::ImageURLContentBlock, OpenAI::Models::Beta::Threads::TextContentBlockParam>]
|
|
104
|
-
# The text contents of the message.
|
|
105
|
-
#
|
|
106
|
-
# @param role [Symbol, OpenAI::Models::Beta::ThreadCreateParams::Message::Role]
|
|
107
|
-
# The role of the entity that is creating the message. Allowed values include:
|
|
108
|
-
#
|
|
109
|
-
# - `user`: Indicates the message is sent by an actual user and should be used in
|
|
110
|
-
# most cases to represent user-generated messages.
|
|
111
|
-
# - `assistant`: Indicates the message is generated by the assistant. Use this
|
|
112
|
-
# value to insert messages from the assistant into the conversation.
|
|
113
|
-
#
|
|
114
|
-
# @param attachments [Array<OpenAI::Models::Beta::ThreadCreateParams::Message::Attachment>, nil]
|
|
115
|
-
# A list of files attached to the message, and the tools they should be added to.
|
|
116
|
-
#
|
|
117
|
-
# @param metadata [Hash{Symbol=>String}, nil]
|
|
118
|
-
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
119
|
-
# for storing additional information about the object in a structured format, and
|
|
120
|
-
# querying for objects via API or the dashboard.
|
|
121
|
-
#
|
|
122
|
-
# Keys are strings with a maximum length of 64 characters. Values are strings with
|
|
123
|
-
# a maximum length of 512 characters.
|
|
124
|
-
|
|
125
|
-
# The text contents of the message.
|
|
126
|
-
#
|
|
127
|
-
# @see OpenAI::Models::Beta::ThreadCreateParams::Message#content
|
|
128
|
-
module Content
|
|
129
|
-
extend OpenAI::Internal::Type::Union
|
|
130
|
-
|
|
131
|
-
# The text contents of the message.
|
|
132
|
-
variant String
|
|
133
|
-
|
|
134
|
-
# An array of content parts with a defined type, each can be of type `text` or images can be passed with `image_url` or `image_file`. Image types are only supported on [Vision-compatible models](https://developers.openai.com/api/docs/models).
|
|
135
|
-
variant -> { OpenAI::Models::Beta::ThreadCreateParams::Message::Content::MessageContentPartParamArray }
|
|
136
|
-
|
|
137
|
-
# @!method self.variants
|
|
138
|
-
# @return [Array(String, Array<OpenAI::Models::Beta::Threads::ImageFileContentBlock, OpenAI::Models::Beta::Threads::ImageURLContentBlock, OpenAI::Models::Beta::Threads::TextContentBlockParam>)]
|
|
139
|
-
|
|
140
|
-
# @type [OpenAI::Internal::Type::Converter]
|
|
141
|
-
MessageContentPartParamArray = OpenAI::Internal::Type::ArrayOf[
|
|
142
|
-
union: -> { OpenAI::Beta::Threads::MessageContentPartParam }
|
|
143
|
-
]
|
|
144
|
-
end
|
|
145
|
-
|
|
146
|
-
# The role of the entity that is creating the message. Allowed values include:
|
|
147
|
-
#
|
|
148
|
-
# - `user`: Indicates the message is sent by an actual user and should be used in
|
|
149
|
-
# most cases to represent user-generated messages.
|
|
150
|
-
# - `assistant`: Indicates the message is generated by the assistant. Use this
|
|
151
|
-
# value to insert messages from the assistant into the conversation.
|
|
152
|
-
#
|
|
153
|
-
# @see OpenAI::Models::Beta::ThreadCreateParams::Message#role
|
|
154
|
-
module Role
|
|
155
|
-
extend OpenAI::Internal::Type::Enum
|
|
156
|
-
|
|
157
|
-
USER = :user
|
|
158
|
-
ASSISTANT = :assistant
|
|
159
|
-
|
|
160
|
-
# @!method self.values
|
|
161
|
-
# @return [Array<Symbol>]
|
|
162
|
-
end
|
|
163
|
-
|
|
164
|
-
class Attachment < OpenAI::Internal::Type::BaseModel
|
|
165
|
-
# @!attribute file_id
|
|
166
|
-
# The ID of the file to attach to the message.
|
|
167
|
-
#
|
|
168
|
-
# @return [String, nil]
|
|
169
|
-
optional :file_id, String
|
|
170
|
-
|
|
171
|
-
# @!attribute tools
|
|
172
|
-
# The tools to add this file to.
|
|
173
|
-
#
|
|
174
|
-
# @return [Array<OpenAI::Models::Beta::CodeInterpreterTool, OpenAI::Models::Beta::ThreadCreateParams::Message::Attachment::Tool::FileSearch>, nil]
|
|
175
|
-
optional(
|
|
176
|
-
:tools,
|
|
177
|
-
-> {
|
|
178
|
-
OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::ThreadCreateParams::Message::Attachment::Tool]
|
|
179
|
-
}
|
|
180
|
-
)
|
|
181
|
-
|
|
182
|
-
# @!method initialize(file_id: nil, tools: nil)
|
|
183
|
-
# @param file_id [String]
|
|
184
|
-
# The ID of the file to attach to the message.
|
|
185
|
-
#
|
|
186
|
-
# @param tools [Array<OpenAI::Models::Beta::CodeInterpreterTool, OpenAI::Models::Beta::ThreadCreateParams::Message::Attachment::Tool::FileSearch>]
|
|
187
|
-
# The tools to add this file to.
|
|
188
|
-
module Tool
|
|
189
|
-
extend OpenAI::Internal::Type::Union
|
|
190
|
-
|
|
191
|
-
discriminator :type
|
|
192
|
-
|
|
193
|
-
variant :code_interpreter, -> { OpenAI::Beta::CodeInterpreterTool }
|
|
194
|
-
|
|
195
|
-
variant :file_search, -> { OpenAI::Beta::ThreadCreateParams::Message::Attachment::Tool::FileSearch }
|
|
196
|
-
|
|
197
|
-
class FileSearch < OpenAI::Internal::Type::BaseModel
|
|
198
|
-
# @!attribute type
|
|
199
|
-
# The type of tool being defined: `file_search`
|
|
200
|
-
#
|
|
201
|
-
# @return [Symbol, :file_search]
|
|
202
|
-
required :type, const: :file_search
|
|
203
|
-
|
|
204
|
-
# @!method initialize(type: :file_search)
|
|
205
|
-
# @param type [Symbol, :file_search]
|
|
206
|
-
# The type of tool being defined: `file_search`
|
|
207
|
-
end
|
|
208
|
-
|
|
209
|
-
# @!method self.variants
|
|
210
|
-
# @return [Array(OpenAI::Models::Beta::CodeInterpreterTool, OpenAI::Models::Beta::ThreadCreateParams::Message::Attachment::Tool::FileSearch)]
|
|
211
|
-
end
|
|
212
|
-
end
|
|
213
|
-
end
|
|
214
|
-
|
|
215
|
-
class ToolResources < OpenAI::Internal::Type::BaseModel
|
|
216
|
-
# @!attribute code_interpreter
|
|
217
|
-
#
|
|
218
|
-
# @return [OpenAI::Models::Beta::ThreadCreateParams::ToolResources::CodeInterpreter, nil]
|
|
219
|
-
optional :code_interpreter, -> { OpenAI::Beta::ThreadCreateParams::ToolResources::CodeInterpreter }
|
|
220
|
-
|
|
221
|
-
# @!attribute file_search
|
|
222
|
-
#
|
|
223
|
-
# @return [OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch, nil]
|
|
224
|
-
optional :file_search, -> { OpenAI::Beta::ThreadCreateParams::ToolResources::FileSearch }
|
|
225
|
-
|
|
226
|
-
# @!method initialize(code_interpreter: nil, file_search: nil)
|
|
227
|
-
# A set of resources that are made available to the assistant's tools in this
|
|
228
|
-
# thread. The resources are specific to the type of tool. For example, the
|
|
229
|
-
# `code_interpreter` tool requires a list of file IDs, while the `file_search`
|
|
230
|
-
# tool requires a list of vector store IDs.
|
|
231
|
-
#
|
|
232
|
-
# @param code_interpreter [OpenAI::Models::Beta::ThreadCreateParams::ToolResources::CodeInterpreter]
|
|
233
|
-
# @param file_search [OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch]
|
|
234
|
-
|
|
235
|
-
# @see OpenAI::Models::Beta::ThreadCreateParams::ToolResources#code_interpreter
|
|
236
|
-
class CodeInterpreter < OpenAI::Internal::Type::BaseModel
|
|
237
|
-
# @!attribute file_ids
|
|
238
|
-
# A list of [file](https://developers.openai.com/api/reference/resources/files)
|
|
239
|
-
# IDs made available to the `code_interpreter` tool. There can be a maximum of 20
|
|
240
|
-
# files associated with the tool.
|
|
241
|
-
#
|
|
242
|
-
# @return [Array<String>, nil]
|
|
243
|
-
optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]
|
|
244
|
-
|
|
245
|
-
# @!method initialize(file_ids: nil)
|
|
246
|
-
# @param file_ids [Array<String>]
|
|
247
|
-
# A list of [file](https://developers.openai.com/api/reference/resources/files)
|
|
248
|
-
# IDs made available to the `code_interpreter` tool. There can be a maximum of 20
|
|
249
|
-
# files associated with the tool.
|
|
250
|
-
end
|
|
251
|
-
|
|
252
|
-
# @see OpenAI::Models::Beta::ThreadCreateParams::ToolResources#file_search
|
|
253
|
-
class FileSearch < OpenAI::Internal::Type::BaseModel
|
|
254
|
-
# @!attribute vector_store_ids
|
|
255
|
-
# The
|
|
256
|
-
# [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
|
|
257
|
-
# attached to this thread. There can be a maximum of 1 vector store attached to
|
|
258
|
-
# the thread.
|
|
259
|
-
#
|
|
260
|
-
# @return [Array<String>, nil]
|
|
261
|
-
optional :vector_store_ids, OpenAI::Internal::Type::ArrayOf[String]
|
|
262
|
-
|
|
263
|
-
# @!attribute vector_stores
|
|
264
|
-
# A helper to create a
|
|
265
|
-
# [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
|
|
266
|
-
# with file_ids and attach it to this thread. There can be a maximum of 1 vector
|
|
267
|
-
# store attached to the thread.
|
|
268
|
-
#
|
|
269
|
-
# @return [Array<OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore>, nil]
|
|
270
|
-
optional(
|
|
271
|
-
:vector_stores,
|
|
272
|
-
-> {
|
|
273
|
-
OpenAI::Internal::Type::ArrayOf[
|
|
274
|
-
OpenAI::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore
|
|
275
|
-
]
|
|
276
|
-
}
|
|
277
|
-
)
|
|
278
|
-
|
|
279
|
-
# @!method initialize(vector_store_ids: nil, vector_stores: nil)
|
|
280
|
-
# @param vector_store_ids [Array<String>]
|
|
281
|
-
# The
|
|
282
|
-
# [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
|
|
283
|
-
# attached to this thread. There can be a maximum of 1 vector store attached to
|
|
284
|
-
# the thread.
|
|
285
|
-
#
|
|
286
|
-
# @param vector_stores [Array<OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore>]
|
|
287
|
-
# A helper to create a
|
|
288
|
-
# [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
|
|
289
|
-
# with file_ids and attach it to this thread. There can be a maximum of 1 vector
|
|
290
|
-
# store attached to the thread.
|
|
291
|
-
class VectorStore < OpenAI::Internal::Type::BaseModel
|
|
292
|
-
# @!attribute chunking_strategy
|
|
293
|
-
# The chunking strategy used to chunk the file(s). If not set, will use the `auto`
|
|
294
|
-
# strategy.
|
|
295
|
-
#
|
|
296
|
-
# @return [OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Auto, OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static, nil]
|
|
297
|
-
optional(
|
|
298
|
-
:chunking_strategy,
|
|
299
|
-
union: -> {
|
|
300
|
-
OpenAI::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy
|
|
301
|
-
}
|
|
302
|
-
)
|
|
303
|
-
|
|
304
|
-
# @!attribute file_ids
|
|
305
|
-
# A list of [file](https://developers.openai.com/api/reference/resources/files)
|
|
306
|
-
# IDs to add to the vector store. For vector stores created before Nov 2025, there
|
|
307
|
-
# can be a maximum of 10,000 files in a vector store. For vector stores created
|
|
308
|
-
# starting in Nov 2025, the limit is 100,000,000 files.
|
|
309
|
-
#
|
|
310
|
-
# @return [Array<String>, nil]
|
|
311
|
-
optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]
|
|
312
|
-
|
|
313
|
-
# @!attribute metadata
|
|
314
|
-
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
315
|
-
# for storing additional information about the object in a structured format, and
|
|
316
|
-
# querying for objects via API or the dashboard.
|
|
317
|
-
#
|
|
318
|
-
# Keys are strings with a maximum length of 64 characters. Values are strings with
|
|
319
|
-
# a maximum length of 512 characters.
|
|
320
|
-
#
|
|
321
|
-
# @return [Hash{Symbol=>String}, nil]
|
|
322
|
-
optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
|
|
323
|
-
|
|
324
|
-
# @!method initialize(chunking_strategy: nil, file_ids: nil, metadata: nil)
|
|
325
|
-
# @param chunking_strategy [OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Auto, OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static]
|
|
326
|
-
# The chunking strategy used to chunk the file(s). If not set, will use the `auto`
|
|
327
|
-
# strategy.
|
|
328
|
-
#
|
|
329
|
-
# @param file_ids [Array<String>]
|
|
330
|
-
# A list of [file](https://developers.openai.com/api/reference/resources/files)
|
|
331
|
-
# IDs to add to the vector store. For vector stores created before Nov 2025, there
|
|
332
|
-
# can be a maximum of 10,000 files in a vector store. For vector stores created
|
|
333
|
-
# starting in Nov 2025, the limit is 100,000,000 files.
|
|
334
|
-
#
|
|
335
|
-
# @param metadata [Hash{Symbol=>String}, nil]
|
|
336
|
-
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
337
|
-
# for storing additional information about the object in a structured format, and
|
|
338
|
-
# querying for objects via API or the dashboard.
|
|
339
|
-
#
|
|
340
|
-
# Keys are strings with a maximum length of 64 characters. Values are strings with
|
|
341
|
-
# a maximum length of 512 characters.
|
|
342
|
-
|
|
343
|
-
# The chunking strategy used to chunk the file(s). If not set, will use the `auto`
|
|
344
|
-
# strategy.
|
|
345
|
-
#
|
|
346
|
-
# @see OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore#chunking_strategy
|
|
347
|
-
module ChunkingStrategy
|
|
348
|
-
extend OpenAI::Internal::Type::Union
|
|
349
|
-
|
|
350
|
-
discriminator :type
|
|
351
|
-
|
|
352
|
-
# The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.
|
|
353
|
-
variant(
|
|
354
|
-
:auto,
|
|
355
|
-
-> {
|
|
356
|
-
OpenAI::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Auto
|
|
357
|
-
}
|
|
358
|
-
)
|
|
359
|
-
|
|
360
|
-
variant(
|
|
361
|
-
:static,
|
|
362
|
-
-> {
|
|
363
|
-
OpenAI::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static
|
|
364
|
-
}
|
|
365
|
-
)
|
|
366
|
-
|
|
367
|
-
class Auto < OpenAI::Internal::Type::BaseModel
|
|
368
|
-
# @!attribute type
|
|
369
|
-
# Always `auto`.
|
|
370
|
-
#
|
|
371
|
-
# @return [Symbol, :auto]
|
|
372
|
-
required :type, const: :auto
|
|
373
|
-
|
|
374
|
-
# @!method initialize(type: :auto)
|
|
375
|
-
# The default strategy. This strategy currently uses a `max_chunk_size_tokens` of
|
|
376
|
-
# `800` and `chunk_overlap_tokens` of `400`.
|
|
377
|
-
#
|
|
378
|
-
# @param type [Symbol, :auto]
|
|
379
|
-
# Always `auto`.
|
|
380
|
-
end
|
|
381
|
-
|
|
382
|
-
class Static < OpenAI::Internal::Type::BaseModel
|
|
383
|
-
# @!attribute static
|
|
384
|
-
#
|
|
385
|
-
# @return [OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static]
|
|
386
|
-
required(
|
|
387
|
-
:static,
|
|
388
|
-
-> {
|
|
389
|
-
OpenAI::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static
|
|
390
|
-
}
|
|
391
|
-
)
|
|
392
|
-
|
|
393
|
-
# @!attribute type
|
|
394
|
-
# Always `static`.
|
|
395
|
-
#
|
|
396
|
-
# @return [Symbol, :static]
|
|
397
|
-
required :type, const: :static
|
|
398
|
-
|
|
399
|
-
# @!method initialize(static:, type: :static)
|
|
400
|
-
# @param static [OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static::Static]
|
|
401
|
-
#
|
|
402
|
-
# @param type [Symbol, :static]
|
|
403
|
-
# Always `static`.
|
|
404
|
-
|
|
405
|
-
# @see OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static#static
|
|
406
|
-
class Static < OpenAI::Internal::Type::BaseModel
|
|
407
|
-
# @!attribute chunk_overlap_tokens
|
|
408
|
-
# The number of tokens that overlap between chunks. The default value is `400`.
|
|
409
|
-
#
|
|
410
|
-
# Note that the overlap must not exceed half of `max_chunk_size_tokens`.
|
|
411
|
-
#
|
|
412
|
-
# @return [Integer]
|
|
413
|
-
required :chunk_overlap_tokens, Integer
|
|
414
|
-
|
|
415
|
-
# @!attribute max_chunk_size_tokens
|
|
416
|
-
# The maximum number of tokens in each chunk. The default value is `800`. The
|
|
417
|
-
# minimum value is `100` and the maximum value is `4096`.
|
|
418
|
-
#
|
|
419
|
-
# @return [Integer]
|
|
420
|
-
required :max_chunk_size_tokens, Integer
|
|
421
|
-
|
|
422
|
-
# @!method initialize(chunk_overlap_tokens:, max_chunk_size_tokens:)
|
|
423
|
-
# @param chunk_overlap_tokens [Integer]
|
|
424
|
-
# The number of tokens that overlap between chunks. The default value is `400`.
|
|
425
|
-
#
|
|
426
|
-
# Note that the overlap must not exceed half of `max_chunk_size_tokens`.
|
|
427
|
-
#
|
|
428
|
-
# @param max_chunk_size_tokens [Integer]
|
|
429
|
-
# The maximum number of tokens in each chunk. The default value is `800`. The
|
|
430
|
-
# minimum value is `100` and the maximum value is `4096`.
|
|
431
|
-
end
|
|
432
|
-
end
|
|
433
|
-
|
|
434
|
-
# @!method self.variants
|
|
435
|
-
# @return [Array(OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Auto, OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static)]
|
|
436
|
-
end
|
|
437
|
-
end
|
|
438
|
-
end
|
|
439
|
-
end
|
|
440
|
-
end
|
|
441
|
-
end
|
|
442
|
-
end
|
|
443
|
-
end
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module OpenAI
|
|
4
|
-
module Models
|
|
5
|
-
module Beta
|
|
6
|
-
# @see OpenAI::Resources::Beta::Threads#delete
|
|
7
|
-
class ThreadDeleteParams < OpenAI::Internal::Type::BaseModel
|
|
8
|
-
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
|
-
include OpenAI::Internal::Type::RequestParameters
|
|
10
|
-
|
|
11
|
-
# @!attribute thread_id
|
|
12
|
-
#
|
|
13
|
-
# @return [String]
|
|
14
|
-
required :thread_id, String
|
|
15
|
-
|
|
16
|
-
# @!method initialize(thread_id:, request_options: {})
|
|
17
|
-
# @param thread_id [String]
|
|
18
|
-
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
19
|
-
end
|
|
20
|
-
end
|
|
21
|
-
end
|
|
22
|
-
end
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module OpenAI
|
|
4
|
-
module Models
|
|
5
|
-
module Beta
|
|
6
|
-
# @see OpenAI::Resources::Beta::Threads#delete
|
|
7
|
-
class ThreadDeleted < OpenAI::Internal::Type::BaseModel
|
|
8
|
-
# @!attribute id
|
|
9
|
-
#
|
|
10
|
-
# @return [String]
|
|
11
|
-
required :id, String
|
|
12
|
-
|
|
13
|
-
# @!attribute deleted
|
|
14
|
-
#
|
|
15
|
-
# @return [Boolean]
|
|
16
|
-
required :deleted, OpenAI::Internal::Type::Boolean
|
|
17
|
-
|
|
18
|
-
# @!attribute object
|
|
19
|
-
#
|
|
20
|
-
# @return [Symbol, :"thread.deleted"]
|
|
21
|
-
required :object, const: :"thread.deleted"
|
|
22
|
-
|
|
23
|
-
# @!method initialize(id:, deleted:, object: :"thread.deleted")
|
|
24
|
-
# @param id [String]
|
|
25
|
-
# @param deleted [Boolean]
|
|
26
|
-
# @param object [Symbol, :"thread.deleted"]
|
|
27
|
-
end
|
|
28
|
-
end
|
|
29
|
-
end
|
|
30
|
-
end
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module OpenAI
|
|
4
|
-
module Models
|
|
5
|
-
module Beta
|
|
6
|
-
# @see OpenAI::Resources::Beta::Threads#retrieve
|
|
7
|
-
class ThreadRetrieveParams < OpenAI::Internal::Type::BaseModel
|
|
8
|
-
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
|
-
include OpenAI::Internal::Type::RequestParameters
|
|
10
|
-
|
|
11
|
-
# @!attribute thread_id
|
|
12
|
-
#
|
|
13
|
-
# @return [String]
|
|
14
|
-
required :thread_id, String
|
|
15
|
-
|
|
16
|
-
# @!method initialize(thread_id:, request_options: {})
|
|
17
|
-
# @param thread_id [String]
|
|
18
|
-
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
19
|
-
end
|
|
20
|
-
end
|
|
21
|
-
end
|
|
22
|
-
end
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module OpenAI
|
|
4
|
-
module Models
|
|
5
|
-
module Beta
|
|
6
|
-
class ThreadStreamEvent < OpenAI::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute data
|
|
8
|
-
# Represents a thread that contains
|
|
9
|
-
# [messages](https://developers.openai.com/api/docs/assistants/migration).
|
|
10
|
-
#
|
|
11
|
-
# @return [OpenAI::Models::Beta::Thread]
|
|
12
|
-
required :data, -> { OpenAI::Beta::Thread }
|
|
13
|
-
|
|
14
|
-
# @!attribute event
|
|
15
|
-
#
|
|
16
|
-
# @return [Symbol, :"thread.created"]
|
|
17
|
-
required :event, const: :"thread.created"
|
|
18
|
-
|
|
19
|
-
# @!attribute enabled
|
|
20
|
-
# Whether to enable input audio transcription.
|
|
21
|
-
#
|
|
22
|
-
# @return [Boolean, nil]
|
|
23
|
-
optional :enabled, OpenAI::Internal::Type::Boolean
|
|
24
|
-
|
|
25
|
-
# @!method initialize(data:, enabled: nil, event: :"thread.created")
|
|
26
|
-
# Occurs when a new
|
|
27
|
-
# [thread](https://developers.openai.com/api/docs/assistants/migration) is
|
|
28
|
-
# created.
|
|
29
|
-
#
|
|
30
|
-
# @param data [OpenAI::Models::Beta::Thread]
|
|
31
|
-
# Represents a thread that contains
|
|
32
|
-
# [messages](https://developers.openai.com/api/docs/assistants/migration).
|
|
33
|
-
#
|
|
34
|
-
# @param enabled [Boolean]
|
|
35
|
-
# Whether to enable input audio transcription.
|
|
36
|
-
#
|
|
37
|
-
# @param event [Symbol, :"thread.created"]
|
|
38
|
-
end
|
|
39
|
-
end
|
|
40
|
-
end
|
|
41
|
-
end
|
|
@@ -1,114 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module OpenAI
|
|
4
|
-
module Models
|
|
5
|
-
module Beta
|
|
6
|
-
# @see OpenAI::Resources::Beta::Threads#update
|
|
7
|
-
class ThreadUpdateParams < OpenAI::Internal::Type::BaseModel
|
|
8
|
-
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
|
-
include OpenAI::Internal::Type::RequestParameters
|
|
10
|
-
|
|
11
|
-
# @!attribute thread_id
|
|
12
|
-
#
|
|
13
|
-
# @return [String]
|
|
14
|
-
required :thread_id, String
|
|
15
|
-
|
|
16
|
-
# @!attribute metadata
|
|
17
|
-
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
18
|
-
# for storing additional information about the object in a structured format, and
|
|
19
|
-
# querying for objects via API or the dashboard.
|
|
20
|
-
#
|
|
21
|
-
# Keys are strings with a maximum length of 64 characters. Values are strings with
|
|
22
|
-
# a maximum length of 512 characters.
|
|
23
|
-
#
|
|
24
|
-
# @return [Hash{Symbol=>String}, nil]
|
|
25
|
-
optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
|
|
26
|
-
|
|
27
|
-
# @!attribute tool_resources
|
|
28
|
-
# A set of resources that are made available to the assistant's tools in this
|
|
29
|
-
# thread. The resources are specific to the type of tool. For example, the
|
|
30
|
-
# `code_interpreter` tool requires a list of file IDs, while the `file_search`
|
|
31
|
-
# tool requires a list of vector store IDs.
|
|
32
|
-
#
|
|
33
|
-
# @return [OpenAI::Models::Beta::ThreadUpdateParams::ToolResources, nil]
|
|
34
|
-
optional :tool_resources, -> { OpenAI::Beta::ThreadUpdateParams::ToolResources }, nil?: true
|
|
35
|
-
|
|
36
|
-
# @!method initialize(thread_id:, metadata: nil, tool_resources: nil, request_options: {})
|
|
37
|
-
# @param thread_id [String]
|
|
38
|
-
#
|
|
39
|
-
# @param metadata [Hash{Symbol=>String}, nil]
|
|
40
|
-
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
41
|
-
# for storing additional information about the object in a structured format, and
|
|
42
|
-
# querying for objects via API or the dashboard.
|
|
43
|
-
#
|
|
44
|
-
# Keys are strings with a maximum length of 64 characters. Values are strings with
|
|
45
|
-
# a maximum length of 512 characters.
|
|
46
|
-
#
|
|
47
|
-
# @param tool_resources [OpenAI::Models::Beta::ThreadUpdateParams::ToolResources, nil]
|
|
48
|
-
# A set of resources that are made available to the assistant's tools in this
|
|
49
|
-
# thread. The resources are specific to the type of tool. For example, the
|
|
50
|
-
# `code_interpreter` tool requires a list of file IDs, while the `file_search`
|
|
51
|
-
# tool requires a list of vector store IDs.
|
|
52
|
-
#
|
|
53
|
-
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
54
|
-
|
|
55
|
-
class ToolResources < OpenAI::Internal::Type::BaseModel
|
|
56
|
-
# @!attribute code_interpreter
|
|
57
|
-
#
|
|
58
|
-
# @return [OpenAI::Models::Beta::ThreadUpdateParams::ToolResources::CodeInterpreter, nil]
|
|
59
|
-
optional :code_interpreter, -> { OpenAI::Beta::ThreadUpdateParams::ToolResources::CodeInterpreter }
|
|
60
|
-
|
|
61
|
-
# @!attribute file_search
|
|
62
|
-
#
|
|
63
|
-
# @return [OpenAI::Models::Beta::ThreadUpdateParams::ToolResources::FileSearch, nil]
|
|
64
|
-
optional :file_search, -> { OpenAI::Beta::ThreadUpdateParams::ToolResources::FileSearch }
|
|
65
|
-
|
|
66
|
-
# @!method initialize(code_interpreter: nil, file_search: nil)
|
|
67
|
-
# A set of resources that are made available to the assistant's tools in this
|
|
68
|
-
# thread. The resources are specific to the type of tool. For example, the
|
|
69
|
-
# `code_interpreter` tool requires a list of file IDs, while the `file_search`
|
|
70
|
-
# tool requires a list of vector store IDs.
|
|
71
|
-
#
|
|
72
|
-
# @param code_interpreter [OpenAI::Models::Beta::ThreadUpdateParams::ToolResources::CodeInterpreter]
|
|
73
|
-
# @param file_search [OpenAI::Models::Beta::ThreadUpdateParams::ToolResources::FileSearch]
|
|
74
|
-
|
|
75
|
-
# @see OpenAI::Models::Beta::ThreadUpdateParams::ToolResources#code_interpreter
|
|
76
|
-
class CodeInterpreter < OpenAI::Internal::Type::BaseModel
|
|
77
|
-
# @!attribute file_ids
|
|
78
|
-
# A list of [file](https://developers.openai.com/api/reference/resources/files)
|
|
79
|
-
# IDs made available to the `code_interpreter` tool. There can be a maximum of 20
|
|
80
|
-
# files associated with the tool.
|
|
81
|
-
#
|
|
82
|
-
# @return [Array<String>, nil]
|
|
83
|
-
optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]
|
|
84
|
-
|
|
85
|
-
# @!method initialize(file_ids: nil)
|
|
86
|
-
# @param file_ids [Array<String>]
|
|
87
|
-
# A list of [file](https://developers.openai.com/api/reference/resources/files)
|
|
88
|
-
# IDs made available to the `code_interpreter` tool. There can be a maximum of 20
|
|
89
|
-
# files associated with the tool.
|
|
90
|
-
end
|
|
91
|
-
|
|
92
|
-
# @see OpenAI::Models::Beta::ThreadUpdateParams::ToolResources#file_search
|
|
93
|
-
class FileSearch < OpenAI::Internal::Type::BaseModel
|
|
94
|
-
# @!attribute vector_store_ids
|
|
95
|
-
# The
|
|
96
|
-
# [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
|
|
97
|
-
# attached to this thread. There can be a maximum of 1 vector store attached to
|
|
98
|
-
# the thread.
|
|
99
|
-
#
|
|
100
|
-
# @return [Array<String>, nil]
|
|
101
|
-
optional :vector_store_ids, OpenAI::Internal::Type::ArrayOf[String]
|
|
102
|
-
|
|
103
|
-
# @!method initialize(vector_store_ids: nil)
|
|
104
|
-
# @param vector_store_ids [Array<String>]
|
|
105
|
-
# The
|
|
106
|
-
# [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
|
|
107
|
-
# attached to this thread. There can be a maximum of 1 vector store attached to
|
|
108
|
-
# the thread.
|
|
109
|
-
end
|
|
110
|
-
end
|
|
111
|
-
end
|
|
112
|
-
end
|
|
113
|
-
end
|
|
114
|
-
end
|