openai 0.64.0 → 0.66.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 +16 -0
- data/README.md +1 -1
- data/lib/openai/models/admin/organization/audit_log_list_params.rb +6 -0
- data/lib/openai/models/admin/organization/audit_log_list_response.rb +231 -1
- data/lib/openai/models/chat/chat_completion.rb +341 -3
- data/lib/openai/models/chat/chat_completion_chunk.rb +341 -1
- data/lib/openai/models/chat/completion_create_params.rb +42 -1
- data/lib/openai/models/conversations/conversation_create_params.rb +2 -2
- data/lib/openai/models/conversations/conversation_item.rb +57 -1
- data/lib/openai/models/conversations/conversation_item_list.rb +2 -2
- data/lib/openai/models/conversations/item_create_params.rb +2 -2
- data/lib/openai/models/responses/compacted_response.rb +2 -2
- data/lib/openai/models/responses/input_token_count_params.rb +41 -4
- data/lib/openai/models/responses/response.rb +296 -6
- data/lib/openai/models/responses/response_compact_params.rb +3 -3
- data/lib/openai/models/responses/response_create_params.rb +45 -4
- data/lib/openai/models/responses/response_function_web_search.rb +11 -9
- data/lib/openai/models/responses/response_input_item.rb +38 -1
- data/lib/openai/models/responses/response_item.rb +57 -1
- data/lib/openai/models/responses/response_item_list.rb +2 -2
- data/lib/openai/models/responses/response_output_item.rb +57 -1
- data/lib/openai/models/responses/response_output_item_added_event.rb +2 -2
- data/lib/openai/models/responses/response_output_item_done_event.rb +2 -2
- data/lib/openai/models/responses/responses_client_event.rb +46 -4
- data/lib/openai/resources/chat/completions.rb +6 -2
- data/lib/openai/resources/conversations/items.rb +3 -3
- data/lib/openai/resources/conversations.rb +1 -1
- data/lib/openai/resources/responses/input_items.rb +1 -1
- data/lib/openai/resources/responses/input_tokens.rb +4 -2
- data/lib/openai/resources/responses.rb +9 -5
- data/lib/openai/version.rb +1 -1
- data/rbi/openai/models/admin/organization/audit_log_list_params.rbi +30 -0
- data/rbi/openai/models/admin/organization/audit_log_list_response.rbi +489 -3
- data/rbi/openai/models/chat/chat_completion.rbi +620 -3
- data/rbi/openai/models/chat/chat_completion_chunk.rbi +621 -0
- data/rbi/openai/models/chat/completion_create_params.rbi +76 -0
- data/rbi/openai/models/conversations/conversation_create_params.rbi +3 -0
- data/rbi/openai/models/conversations/conversation_item.rbi +150 -0
- data/rbi/openai/models/conversations/conversation_item_list.rbi +1 -0
- data/rbi/openai/models/conversations/item_create_params.rbi +3 -0
- data/rbi/openai/models/responses/compacted_response.rbi +1 -0
- data/rbi/openai/models/responses/input_token_count_params.rbi +85 -0
- data/rbi/openai/models/responses/response.rbi +510 -0
- data/rbi/openai/models/responses/response_create_params.rbi +78 -0
- data/rbi/openai/models/responses/response_function_web_search.rbi +11 -8
- data/rbi/openai/models/responses/response_input_item.rbi +120 -0
- data/rbi/openai/models/responses/response_item.rbi +150 -0
- data/rbi/openai/models/responses/response_item_list.rbi +1 -0
- data/rbi/openai/models/responses/response_output_item.rbi +150 -0
- data/rbi/openai/models/responses/response_output_item_added_event.rbi +1 -0
- data/rbi/openai/models/responses/response_output_item_done_event.rbi +1 -0
- data/rbi/openai/models/responses/responses_client_event.rbi +78 -0
- data/rbi/openai/resources/chat/completions.rbi +28 -0
- data/rbi/openai/resources/conversations/items.rbi +1 -0
- data/rbi/openai/resources/conversations.rbi +1 -0
- data/rbi/openai/resources/responses/input_tokens.rbi +9 -0
- data/rbi/openai/resources/responses.rbi +28 -0
- data/sig/openai/models/admin/organization/audit_log_list_params.rbs +12 -0
- data/sig/openai/models/admin/organization/audit_log_list_response.rbs +216 -3
- data/sig/openai/models/chat/chat_completion.rbs +243 -0
- data/sig/openai/models/chat/chat_completion_chunk.rbs +243 -0
- data/sig/openai/models/chat/completion_create_params.rbs +15 -0
- data/sig/openai/models/conversations/conversation_item.rbs +58 -0
- data/sig/openai/models/responses/input_token_count_params.rbs +20 -0
- data/sig/openai/models/responses/response.rbs +189 -0
- data/sig/openai/models/responses/response_create_params.rbs +15 -0
- data/sig/openai/models/responses/response_function_web_search.rbs +7 -5
- data/sig/openai/models/responses/response_input_item.rbs +33 -0
- data/sig/openai/models/responses/response_item.rbs +58 -0
- data/sig/openai/models/responses/response_output_item.rbs +58 -0
- data/sig/openai/models/responses/responses_client_event.rbs +15 -0
- data/sig/openai/resources/chat/completions.rbs +2 -0
- data/sig/openai/resources/responses/input_tokens.rbs +1 -0
- data/sig/openai/resources/responses.rbs +2 -0
- metadata +2 -2
|
@@ -37,6 +37,13 @@ module OpenAI
|
|
|
37
37
|
# @return [Symbol, :"chat.completion.chunk"]
|
|
38
38
|
required :object, const: :"chat.completion.chunk"
|
|
39
39
|
|
|
40
|
+
# @!attribute moderation
|
|
41
|
+
# Moderation results for the request input and generated output. Present on the
|
|
42
|
+
# moderation chunk when moderated completions are requested.
|
|
43
|
+
#
|
|
44
|
+
# @return [OpenAI::Models::Chat::ChatCompletionChunk::Moderation, nil]
|
|
45
|
+
optional :moderation, -> { OpenAI::Chat::ChatCompletionChunk::Moderation }, nil?: true
|
|
46
|
+
|
|
40
47
|
# @!attribute service_tier
|
|
41
48
|
# Specifies the processing type used for serving the request.
|
|
42
49
|
#
|
|
@@ -80,7 +87,7 @@ module OpenAI
|
|
|
80
87
|
# @return [OpenAI::Models::CompletionUsage, nil]
|
|
81
88
|
optional :usage, -> { OpenAI::CompletionUsage }, nil?: true
|
|
82
89
|
|
|
83
|
-
# @!method initialize(id:, choices:, created:, model:, service_tier: nil, system_fingerprint: nil, usage: nil, object: :"chat.completion.chunk")
|
|
90
|
+
# @!method initialize(id:, choices:, created:, model:, moderation: nil, service_tier: nil, system_fingerprint: nil, usage: nil, object: :"chat.completion.chunk")
|
|
84
91
|
# Some parameter documentations has been truncated, see
|
|
85
92
|
# {OpenAI::Models::Chat::ChatCompletionChunk} for more details.
|
|
86
93
|
#
|
|
@@ -96,6 +103,8 @@ module OpenAI
|
|
|
96
103
|
#
|
|
97
104
|
# @param model [String] The model to generate the completion.
|
|
98
105
|
#
|
|
106
|
+
# @param moderation [OpenAI::Models::Chat::ChatCompletionChunk::Moderation, nil] Moderation results for the request input and generated output. Present
|
|
107
|
+
#
|
|
99
108
|
# @param service_tier [Symbol, OpenAI::Models::Chat::ChatCompletionChunk::ServiceTier, nil] Specifies the processing type used for serving the request.
|
|
100
109
|
#
|
|
101
110
|
# @param system_fingerprint [String] This fingerprint represents the backend configuration that the model runs with.
|
|
@@ -370,6 +379,337 @@ module OpenAI
|
|
|
370
379
|
end
|
|
371
380
|
end
|
|
372
381
|
|
|
382
|
+
# @see OpenAI::Models::Chat::ChatCompletionChunk#moderation
|
|
383
|
+
class Moderation < OpenAI::Internal::Type::BaseModel
|
|
384
|
+
# @!attribute input
|
|
385
|
+
# Moderation for the request input.
|
|
386
|
+
#
|
|
387
|
+
# @return [OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Input::ModerationResults, OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Input::Error]
|
|
388
|
+
required :input, union: -> { OpenAI::Chat::ChatCompletionChunk::Moderation::Input }
|
|
389
|
+
|
|
390
|
+
# @!attribute output
|
|
391
|
+
# Moderation for the generated output.
|
|
392
|
+
#
|
|
393
|
+
# @return [OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Output::ModerationResults, OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Output::Error]
|
|
394
|
+
required :output, union: -> { OpenAI::Chat::ChatCompletionChunk::Moderation::Output }
|
|
395
|
+
|
|
396
|
+
# @!method initialize(input:, output:)
|
|
397
|
+
# Moderation results for the request input and generated output. Present on the
|
|
398
|
+
# moderation chunk when moderated completions are requested.
|
|
399
|
+
#
|
|
400
|
+
# @param input [OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Input::ModerationResults, OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Input::Error] Moderation for the request input.
|
|
401
|
+
#
|
|
402
|
+
# @param output [OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Output::ModerationResults, OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Output::Error] Moderation for the generated output.
|
|
403
|
+
|
|
404
|
+
# Moderation for the request input.
|
|
405
|
+
#
|
|
406
|
+
# @see OpenAI::Models::Chat::ChatCompletionChunk::Moderation#input
|
|
407
|
+
module Input
|
|
408
|
+
extend OpenAI::Internal::Type::Union
|
|
409
|
+
|
|
410
|
+
discriminator :type
|
|
411
|
+
|
|
412
|
+
# Successful moderation results for the request input or generated output.
|
|
413
|
+
variant :moderation_results,
|
|
414
|
+
-> { OpenAI::Chat::ChatCompletionChunk::Moderation::Input::ModerationResults }
|
|
415
|
+
|
|
416
|
+
# An error produced while attempting moderation.
|
|
417
|
+
variant :error, -> { OpenAI::Chat::ChatCompletionChunk::Moderation::Input::Error }
|
|
418
|
+
|
|
419
|
+
class ModerationResults < OpenAI::Internal::Type::BaseModel
|
|
420
|
+
# @!attribute model
|
|
421
|
+
# The moderation model used to generate the results.
|
|
422
|
+
#
|
|
423
|
+
# @return [String]
|
|
424
|
+
required :model, String
|
|
425
|
+
|
|
426
|
+
# @!attribute results
|
|
427
|
+
# A list of moderation results.
|
|
428
|
+
#
|
|
429
|
+
# @return [Array<OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Input::ModerationResults::Result>]
|
|
430
|
+
required :results,
|
|
431
|
+
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Chat::ChatCompletionChunk::Moderation::Input::ModerationResults::Result] }
|
|
432
|
+
|
|
433
|
+
# @!attribute type
|
|
434
|
+
# The object type, which is always `moderation_results`.
|
|
435
|
+
#
|
|
436
|
+
# @return [Symbol, :moderation_results]
|
|
437
|
+
required :type, const: :moderation_results
|
|
438
|
+
|
|
439
|
+
# @!method initialize(model:, results:, type: :moderation_results)
|
|
440
|
+
# Successful moderation results for the request input or generated output.
|
|
441
|
+
#
|
|
442
|
+
# @param model [String] The moderation model used to generate the results.
|
|
443
|
+
#
|
|
444
|
+
# @param results [Array<OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Input::ModerationResults::Result>] A list of moderation results.
|
|
445
|
+
#
|
|
446
|
+
# @param type [Symbol, :moderation_results] The object type, which is always `moderation_results`.
|
|
447
|
+
|
|
448
|
+
class Result < OpenAI::Internal::Type::BaseModel
|
|
449
|
+
# @!attribute categories
|
|
450
|
+
# A dictionary of moderation categories to booleans, True if the input is flagged
|
|
451
|
+
# under this category.
|
|
452
|
+
#
|
|
453
|
+
# @return [Hash{Symbol=>Boolean}]
|
|
454
|
+
required :categories, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Boolean]
|
|
455
|
+
|
|
456
|
+
# @!attribute category_applied_input_types
|
|
457
|
+
# Which modalities of input are reflected by the score for each category.
|
|
458
|
+
#
|
|
459
|
+
# @return [Hash{Symbol=>Array<Symbol, OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Input::ModerationResults::Result::CategoryAppliedInputType>}]
|
|
460
|
+
required :category_applied_input_types,
|
|
461
|
+
-> do
|
|
462
|
+
OpenAI::Internal::Type::HashOf[
|
|
463
|
+
OpenAI::Internal::Type::ArrayOf[
|
|
464
|
+
enum: OpenAI::Chat::ChatCompletionChunk::Moderation::Input::ModerationResults::Result::CategoryAppliedInputType
|
|
465
|
+
]
|
|
466
|
+
]
|
|
467
|
+
end
|
|
468
|
+
|
|
469
|
+
# @!attribute category_scores
|
|
470
|
+
# A dictionary of moderation categories to scores.
|
|
471
|
+
#
|
|
472
|
+
# @return [Hash{Symbol=>Float}]
|
|
473
|
+
required :category_scores, OpenAI::Internal::Type::HashOf[Float]
|
|
474
|
+
|
|
475
|
+
# @!attribute flagged
|
|
476
|
+
# A boolean indicating whether the content was flagged by any category.
|
|
477
|
+
#
|
|
478
|
+
# @return [Boolean]
|
|
479
|
+
required :flagged, OpenAI::Internal::Type::Boolean
|
|
480
|
+
|
|
481
|
+
# @!attribute model
|
|
482
|
+
# The moderation model that produced this result.
|
|
483
|
+
#
|
|
484
|
+
# @return [String]
|
|
485
|
+
required :model, String
|
|
486
|
+
|
|
487
|
+
# @!attribute type
|
|
488
|
+
# The object type, which was always `moderation_result` for successful moderation
|
|
489
|
+
# results.
|
|
490
|
+
#
|
|
491
|
+
# @return [Symbol, :moderation_result]
|
|
492
|
+
required :type, const: :moderation_result
|
|
493
|
+
|
|
494
|
+
# @!method initialize(categories:, category_applied_input_types:, category_scores:, flagged:, model:, type: :moderation_result)
|
|
495
|
+
# Some parameter documentations has been truncated, see
|
|
496
|
+
# {OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Input::ModerationResults::Result}
|
|
497
|
+
# for more details.
|
|
498
|
+
#
|
|
499
|
+
# A moderation result produced for the response input or output.
|
|
500
|
+
#
|
|
501
|
+
# @param categories [Hash{Symbol=>Boolean}] A dictionary of moderation categories to booleans, True if the input is flagged
|
|
502
|
+
#
|
|
503
|
+
# @param category_applied_input_types [Hash{Symbol=>Array<Symbol, OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Input::ModerationResults::Result::CategoryAppliedInputType>}] Which modalities of input are reflected by the score for each category.
|
|
504
|
+
#
|
|
505
|
+
# @param category_scores [Hash{Symbol=>Float}] A dictionary of moderation categories to scores.
|
|
506
|
+
#
|
|
507
|
+
# @param flagged [Boolean] A boolean indicating whether the content was flagged by any category.
|
|
508
|
+
#
|
|
509
|
+
# @param model [String] The moderation model that produced this result.
|
|
510
|
+
#
|
|
511
|
+
# @param type [Symbol, :moderation_result] The object type, which was always `moderation_result` for successful moderation
|
|
512
|
+
|
|
513
|
+
module CategoryAppliedInputType
|
|
514
|
+
extend OpenAI::Internal::Type::Enum
|
|
515
|
+
|
|
516
|
+
TEXT = :text
|
|
517
|
+
IMAGE = :image
|
|
518
|
+
|
|
519
|
+
# @!method self.values
|
|
520
|
+
# @return [Array<Symbol>]
|
|
521
|
+
end
|
|
522
|
+
end
|
|
523
|
+
end
|
|
524
|
+
|
|
525
|
+
class Error < OpenAI::Internal::Type::BaseModel
|
|
526
|
+
# @!attribute code
|
|
527
|
+
# The error code.
|
|
528
|
+
#
|
|
529
|
+
# @return [String]
|
|
530
|
+
required :code, String
|
|
531
|
+
|
|
532
|
+
# @!attribute message
|
|
533
|
+
# The error message.
|
|
534
|
+
#
|
|
535
|
+
# @return [String]
|
|
536
|
+
required :message, String
|
|
537
|
+
|
|
538
|
+
# @!attribute type
|
|
539
|
+
# The object type, which is always `error`.
|
|
540
|
+
#
|
|
541
|
+
# @return [Symbol, :error]
|
|
542
|
+
required :type, const: :error
|
|
543
|
+
|
|
544
|
+
# @!method initialize(code:, message:, type: :error)
|
|
545
|
+
# An error produced while attempting moderation.
|
|
546
|
+
#
|
|
547
|
+
# @param code [String] The error code.
|
|
548
|
+
#
|
|
549
|
+
# @param message [String] The error message.
|
|
550
|
+
#
|
|
551
|
+
# @param type [Symbol, :error] The object type, which is always `error`.
|
|
552
|
+
end
|
|
553
|
+
|
|
554
|
+
# @!method self.variants
|
|
555
|
+
# @return [Array(OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Input::ModerationResults, OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Input::Error)]
|
|
556
|
+
end
|
|
557
|
+
|
|
558
|
+
# Moderation for the generated output.
|
|
559
|
+
#
|
|
560
|
+
# @see OpenAI::Models::Chat::ChatCompletionChunk::Moderation#output
|
|
561
|
+
module Output
|
|
562
|
+
extend OpenAI::Internal::Type::Union
|
|
563
|
+
|
|
564
|
+
discriminator :type
|
|
565
|
+
|
|
566
|
+
# Successful moderation results for the request input or generated output.
|
|
567
|
+
variant :moderation_results,
|
|
568
|
+
-> { OpenAI::Chat::ChatCompletionChunk::Moderation::Output::ModerationResults }
|
|
569
|
+
|
|
570
|
+
# An error produced while attempting moderation.
|
|
571
|
+
variant :error, -> { OpenAI::Chat::ChatCompletionChunk::Moderation::Output::Error }
|
|
572
|
+
|
|
573
|
+
class ModerationResults < OpenAI::Internal::Type::BaseModel
|
|
574
|
+
# @!attribute model
|
|
575
|
+
# The moderation model used to generate the results.
|
|
576
|
+
#
|
|
577
|
+
# @return [String]
|
|
578
|
+
required :model, String
|
|
579
|
+
|
|
580
|
+
# @!attribute results
|
|
581
|
+
# A list of moderation results.
|
|
582
|
+
#
|
|
583
|
+
# @return [Array<OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Output::ModerationResults::Result>]
|
|
584
|
+
required :results,
|
|
585
|
+
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Chat::ChatCompletionChunk::Moderation::Output::ModerationResults::Result] }
|
|
586
|
+
|
|
587
|
+
# @!attribute type
|
|
588
|
+
# The object type, which is always `moderation_results`.
|
|
589
|
+
#
|
|
590
|
+
# @return [Symbol, :moderation_results]
|
|
591
|
+
required :type, const: :moderation_results
|
|
592
|
+
|
|
593
|
+
# @!method initialize(model:, results:, type: :moderation_results)
|
|
594
|
+
# Successful moderation results for the request input or generated output.
|
|
595
|
+
#
|
|
596
|
+
# @param model [String] The moderation model used to generate the results.
|
|
597
|
+
#
|
|
598
|
+
# @param results [Array<OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Output::ModerationResults::Result>] A list of moderation results.
|
|
599
|
+
#
|
|
600
|
+
# @param type [Symbol, :moderation_results] The object type, which is always `moderation_results`.
|
|
601
|
+
|
|
602
|
+
class Result < OpenAI::Internal::Type::BaseModel
|
|
603
|
+
# @!attribute categories
|
|
604
|
+
# A dictionary of moderation categories to booleans, True if the input is flagged
|
|
605
|
+
# under this category.
|
|
606
|
+
#
|
|
607
|
+
# @return [Hash{Symbol=>Boolean}]
|
|
608
|
+
required :categories, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Boolean]
|
|
609
|
+
|
|
610
|
+
# @!attribute category_applied_input_types
|
|
611
|
+
# Which modalities of input are reflected by the score for each category.
|
|
612
|
+
#
|
|
613
|
+
# @return [Hash{Symbol=>Array<Symbol, OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Output::ModerationResults::Result::CategoryAppliedInputType>}]
|
|
614
|
+
required :category_applied_input_types,
|
|
615
|
+
-> do
|
|
616
|
+
OpenAI::Internal::Type::HashOf[
|
|
617
|
+
OpenAI::Internal::Type::ArrayOf[
|
|
618
|
+
enum: OpenAI::Chat::ChatCompletionChunk::Moderation::Output::ModerationResults::Result::CategoryAppliedInputType
|
|
619
|
+
]
|
|
620
|
+
]
|
|
621
|
+
end
|
|
622
|
+
|
|
623
|
+
# @!attribute category_scores
|
|
624
|
+
# A dictionary of moderation categories to scores.
|
|
625
|
+
#
|
|
626
|
+
# @return [Hash{Symbol=>Float}]
|
|
627
|
+
required :category_scores, OpenAI::Internal::Type::HashOf[Float]
|
|
628
|
+
|
|
629
|
+
# @!attribute flagged
|
|
630
|
+
# A boolean indicating whether the content was flagged by any category.
|
|
631
|
+
#
|
|
632
|
+
# @return [Boolean]
|
|
633
|
+
required :flagged, OpenAI::Internal::Type::Boolean
|
|
634
|
+
|
|
635
|
+
# @!attribute model
|
|
636
|
+
# The moderation model that produced this result.
|
|
637
|
+
#
|
|
638
|
+
# @return [String]
|
|
639
|
+
required :model, String
|
|
640
|
+
|
|
641
|
+
# @!attribute type
|
|
642
|
+
# The object type, which was always `moderation_result` for successful moderation
|
|
643
|
+
# results.
|
|
644
|
+
#
|
|
645
|
+
# @return [Symbol, :moderation_result]
|
|
646
|
+
required :type, const: :moderation_result
|
|
647
|
+
|
|
648
|
+
# @!method initialize(categories:, category_applied_input_types:, category_scores:, flagged:, model:, type: :moderation_result)
|
|
649
|
+
# Some parameter documentations has been truncated, see
|
|
650
|
+
# {OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Output::ModerationResults::Result}
|
|
651
|
+
# for more details.
|
|
652
|
+
#
|
|
653
|
+
# A moderation result produced for the response input or output.
|
|
654
|
+
#
|
|
655
|
+
# @param categories [Hash{Symbol=>Boolean}] A dictionary of moderation categories to booleans, True if the input is flagged
|
|
656
|
+
#
|
|
657
|
+
# @param category_applied_input_types [Hash{Symbol=>Array<Symbol, OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Output::ModerationResults::Result::CategoryAppliedInputType>}] Which modalities of input are reflected by the score for each category.
|
|
658
|
+
#
|
|
659
|
+
# @param category_scores [Hash{Symbol=>Float}] A dictionary of moderation categories to scores.
|
|
660
|
+
#
|
|
661
|
+
# @param flagged [Boolean] A boolean indicating whether the content was flagged by any category.
|
|
662
|
+
#
|
|
663
|
+
# @param model [String] The moderation model that produced this result.
|
|
664
|
+
#
|
|
665
|
+
# @param type [Symbol, :moderation_result] The object type, which was always `moderation_result` for successful moderation
|
|
666
|
+
|
|
667
|
+
module CategoryAppliedInputType
|
|
668
|
+
extend OpenAI::Internal::Type::Enum
|
|
669
|
+
|
|
670
|
+
TEXT = :text
|
|
671
|
+
IMAGE = :image
|
|
672
|
+
|
|
673
|
+
# @!method self.values
|
|
674
|
+
# @return [Array<Symbol>]
|
|
675
|
+
end
|
|
676
|
+
end
|
|
677
|
+
end
|
|
678
|
+
|
|
679
|
+
class Error < OpenAI::Internal::Type::BaseModel
|
|
680
|
+
# @!attribute code
|
|
681
|
+
# The error code.
|
|
682
|
+
#
|
|
683
|
+
# @return [String]
|
|
684
|
+
required :code, String
|
|
685
|
+
|
|
686
|
+
# @!attribute message
|
|
687
|
+
# The error message.
|
|
688
|
+
#
|
|
689
|
+
# @return [String]
|
|
690
|
+
required :message, String
|
|
691
|
+
|
|
692
|
+
# @!attribute type
|
|
693
|
+
# The object type, which is always `error`.
|
|
694
|
+
#
|
|
695
|
+
# @return [Symbol, :error]
|
|
696
|
+
required :type, const: :error
|
|
697
|
+
|
|
698
|
+
# @!method initialize(code:, message:, type: :error)
|
|
699
|
+
# An error produced while attempting moderation.
|
|
700
|
+
#
|
|
701
|
+
# @param code [String] The error code.
|
|
702
|
+
#
|
|
703
|
+
# @param message [String] The error message.
|
|
704
|
+
#
|
|
705
|
+
# @param type [Symbol, :error] The object type, which is always `error`.
|
|
706
|
+
end
|
|
707
|
+
|
|
708
|
+
# @!method self.variants
|
|
709
|
+
# @return [Array(OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Output::ModerationResults, OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Output::Error)]
|
|
710
|
+
end
|
|
711
|
+
end
|
|
712
|
+
|
|
373
713
|
# Specifies the processing type used for serving the request.
|
|
374
714
|
#
|
|
375
715
|
# - If set to 'auto', then the request will be processed with the service tier
|
|
@@ -151,6 +151,12 @@ module OpenAI
|
|
|
151
151
|
-> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Chat::CompletionCreateParams::Modality] },
|
|
152
152
|
nil?: true
|
|
153
153
|
|
|
154
|
+
# @!attribute moderation
|
|
155
|
+
# Configuration for running moderation on the request input and generated output.
|
|
156
|
+
#
|
|
157
|
+
# @return [OpenAI::Models::Chat::CompletionCreateParams::Moderation, nil]
|
|
158
|
+
optional :moderation, -> { OpenAI::Chat::CompletionCreateParams::Moderation }, nil?: true
|
|
159
|
+
|
|
154
160
|
# @!attribute n
|
|
155
161
|
# How many chat completion choices to generate for each input message. Note that
|
|
156
162
|
# you will be charged based on the number of generated tokens across all of the
|
|
@@ -195,6 +201,14 @@ module OpenAI
|
|
|
195
201
|
# prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
196
202
|
# of 24 hours.
|
|
197
203
|
# [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
|
|
204
|
+
# For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
|
|
205
|
+
#
|
|
206
|
+
# For older models that support both `in_memory` and `24h`, the default depends on
|
|
207
|
+
# your organization's data retention policy:
|
|
208
|
+
#
|
|
209
|
+
# - Organizations without ZDR enabled default to `24h`.
|
|
210
|
+
# - Organizations with ZDR enabled default to `in_memory` when
|
|
211
|
+
# `prompt_cache_retention` is not specified.
|
|
198
212
|
#
|
|
199
213
|
# @return [Symbol, OpenAI::Models::Chat::CompletionCreateParams::PromptCacheRetention, nil]
|
|
200
214
|
optional :prompt_cache_retention,
|
|
@@ -386,7 +400,7 @@ module OpenAI
|
|
|
386
400
|
# @return [OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions, nil]
|
|
387
401
|
optional :web_search_options, -> { OpenAI::Chat::CompletionCreateParams::WebSearchOptions }
|
|
388
402
|
|
|
389
|
-
# @!method initialize(messages:, model:, audio: nil, frequency_penalty: nil, function_call: nil, functions: nil, logit_bias: nil, logprobs: nil, max_completion_tokens: nil, max_tokens: nil, metadata: nil, modalities: nil, n: nil, parallel_tool_calls: nil, prediction: nil, presence_penalty: nil, prompt_cache_key: nil, prompt_cache_retention: nil, reasoning_effort: nil, response_format: nil, safety_identifier: nil, seed: nil, service_tier: nil, stop: nil, store: nil, stream_options: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, user: nil, verbosity: nil, web_search_options: nil, request_options: {})
|
|
403
|
+
# @!method initialize(messages:, model:, audio: nil, frequency_penalty: nil, function_call: nil, functions: nil, logit_bias: nil, logprobs: nil, max_completion_tokens: nil, max_tokens: nil, metadata: nil, modalities: nil, moderation: nil, n: nil, parallel_tool_calls: nil, prediction: nil, presence_penalty: nil, prompt_cache_key: nil, prompt_cache_retention: nil, reasoning_effort: nil, response_format: nil, safety_identifier: nil, seed: nil, service_tier: nil, stop: nil, store: nil, stream_options: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, user: nil, verbosity: nil, web_search_options: nil, request_options: {})
|
|
390
404
|
# Some parameter documentations has been truncated, see
|
|
391
405
|
# {OpenAI::Models::Chat::CompletionCreateParams} for more details.
|
|
392
406
|
#
|
|
@@ -414,6 +428,8 @@ module OpenAI
|
|
|
414
428
|
#
|
|
415
429
|
# @param modalities [Array<Symbol, OpenAI::Models::Chat::CompletionCreateParams::Modality>, nil] Output types that you would like the model to generate.
|
|
416
430
|
#
|
|
431
|
+
# @param moderation [OpenAI::Models::Chat::CompletionCreateParams::Moderation, nil] Configuration for running moderation on the request input and generated output.
|
|
432
|
+
#
|
|
417
433
|
# @param n [Integer, nil] How many chat completion choices to generate for each input message. Note that y
|
|
418
434
|
#
|
|
419
435
|
# @param parallel_tool_calls [Boolean] Whether to enable [parallel function calling](https://platform.openai.com/docs/g
|
|
@@ -571,10 +587,35 @@ module OpenAI
|
|
|
571
587
|
# @return [Array<Symbol>]
|
|
572
588
|
end
|
|
573
589
|
|
|
590
|
+
class Moderation < OpenAI::Internal::Type::BaseModel
|
|
591
|
+
# @!attribute model
|
|
592
|
+
# The moderation model to use for moderated completions, e.g.
|
|
593
|
+
# 'omni-moderation-latest'.
|
|
594
|
+
#
|
|
595
|
+
# @return [String]
|
|
596
|
+
required :model, String
|
|
597
|
+
|
|
598
|
+
# @!method initialize(model:)
|
|
599
|
+
# Some parameter documentations has been truncated, see
|
|
600
|
+
# {OpenAI::Models::Chat::CompletionCreateParams::Moderation} for more details.
|
|
601
|
+
#
|
|
602
|
+
# Configuration for running moderation on the request input and generated output.
|
|
603
|
+
#
|
|
604
|
+
# @param model [String] The moderation model to use for moderated completions, e.g. 'omni-moderation-lat
|
|
605
|
+
end
|
|
606
|
+
|
|
574
607
|
# The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
575
608
|
# prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
576
609
|
# of 24 hours.
|
|
577
610
|
# [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
|
|
611
|
+
# For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
|
|
612
|
+
#
|
|
613
|
+
# For older models that support both `in_memory` and `24h`, the default depends on
|
|
614
|
+
# your organization's data retention policy:
|
|
615
|
+
#
|
|
616
|
+
# - Organizations without ZDR enabled default to `24h`.
|
|
617
|
+
# - Organizations with ZDR enabled default to `in_memory` when
|
|
618
|
+
# `prompt_cache_retention` is not specified.
|
|
578
619
|
module PromptCacheRetention
|
|
579
620
|
extend OpenAI::Internal::Type::Enum
|
|
580
621
|
|
|
@@ -12,7 +12,7 @@ module OpenAI
|
|
|
12
12
|
# Initial items to include in the conversation context. You may add up to 20 items
|
|
13
13
|
# at a time.
|
|
14
14
|
#
|
|
15
|
-
# @return [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
|
|
15
|
+
# @return [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
|
|
16
16
|
optional :items,
|
|
17
17
|
-> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseInputItem] },
|
|
18
18
|
nil?: true
|
|
@@ -32,7 +32,7 @@ module OpenAI
|
|
|
32
32
|
# Some parameter documentations has been truncated, see
|
|
33
33
|
# {OpenAI::Models::Conversations::ConversationCreateParams} for more details.
|
|
34
34
|
#
|
|
35
|
-
# @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Initial items to include in the conversation context. You may add up to 20 items
|
|
35
|
+
# @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Initial items to include in the conversation context. You may add up to 20 items
|
|
36
36
|
#
|
|
37
37
|
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
|
|
38
38
|
#
|
|
@@ -43,6 +43,8 @@ module OpenAI
|
|
|
43
43
|
|
|
44
44
|
variant :tool_search_output, -> { OpenAI::Responses::ResponseToolSearchOutputItem }
|
|
45
45
|
|
|
46
|
+
variant :additional_tools, -> { OpenAI::Conversations::ConversationItem::AdditionalTools }
|
|
47
|
+
|
|
46
48
|
# A description of the chain of thought used by a reasoning model while generating
|
|
47
49
|
# a response. Be sure to include these items in your `input` to the Responses API
|
|
48
50
|
# for subsequent turns of a conversation if you are manually
|
|
@@ -147,6 +149,60 @@ module OpenAI
|
|
|
147
149
|
end
|
|
148
150
|
end
|
|
149
151
|
|
|
152
|
+
class AdditionalTools < OpenAI::Internal::Type::BaseModel
|
|
153
|
+
# @!attribute id
|
|
154
|
+
# The unique ID of the additional tools item.
|
|
155
|
+
#
|
|
156
|
+
# @return [String]
|
|
157
|
+
required :id, String
|
|
158
|
+
|
|
159
|
+
# @!attribute role
|
|
160
|
+
# The role that provided the additional tools.
|
|
161
|
+
#
|
|
162
|
+
# @return [Symbol, OpenAI::Models::Conversations::ConversationItem::AdditionalTools::Role]
|
|
163
|
+
required :role, enum: -> { OpenAI::Conversations::ConversationItem::AdditionalTools::Role }
|
|
164
|
+
|
|
165
|
+
# @!attribute tools
|
|
166
|
+
# The additional tool definitions made available at this item.
|
|
167
|
+
#
|
|
168
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>]
|
|
169
|
+
required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
|
|
170
|
+
|
|
171
|
+
# @!attribute type
|
|
172
|
+
# The type of the item. Always `additional_tools`.
|
|
173
|
+
#
|
|
174
|
+
# @return [Symbol, :additional_tools]
|
|
175
|
+
required :type, const: :additional_tools
|
|
176
|
+
|
|
177
|
+
# @!method initialize(id:, role:, tools:, type: :additional_tools)
|
|
178
|
+
# @param id [String] The unique ID of the additional tools item.
|
|
179
|
+
#
|
|
180
|
+
# @param role [Symbol, OpenAI::Models::Conversations::ConversationItem::AdditionalTools::Role] The role that provided the additional tools.
|
|
181
|
+
#
|
|
182
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] The additional tool definitions made available at this item.
|
|
183
|
+
#
|
|
184
|
+
# @param type [Symbol, :additional_tools] The type of the item. Always `additional_tools`.
|
|
185
|
+
|
|
186
|
+
# The role that provided the additional tools.
|
|
187
|
+
#
|
|
188
|
+
# @see OpenAI::Models::Conversations::ConversationItem::AdditionalTools#role
|
|
189
|
+
module Role
|
|
190
|
+
extend OpenAI::Internal::Type::Enum
|
|
191
|
+
|
|
192
|
+
UNKNOWN = :unknown
|
|
193
|
+
USER = :user
|
|
194
|
+
ASSISTANT = :assistant
|
|
195
|
+
SYSTEM = :system
|
|
196
|
+
CRITIC = :critic
|
|
197
|
+
DISCRIMINATOR = :discriminator
|
|
198
|
+
DEVELOPER = :developer
|
|
199
|
+
TOOL = :tool
|
|
200
|
+
|
|
201
|
+
# @!method self.values
|
|
202
|
+
# @return [Array<Symbol>]
|
|
203
|
+
end
|
|
204
|
+
end
|
|
205
|
+
|
|
150
206
|
class LocalShellCall < OpenAI::Internal::Type::BaseModel
|
|
151
207
|
# @!attribute id
|
|
152
208
|
# The unique ID of the local shell call.
|
|
@@ -611,7 +667,7 @@ module OpenAI
|
|
|
611
667
|
end
|
|
612
668
|
|
|
613
669
|
# @!method self.variants
|
|
614
|
-
# @return [Array(OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput)]
|
|
670
|
+
# @return [Array(OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Conversations::ConversationItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput)]
|
|
615
671
|
end
|
|
616
672
|
end
|
|
617
673
|
|
|
@@ -8,7 +8,7 @@ module OpenAI
|
|
|
8
8
|
# @!attribute data
|
|
9
9
|
# A list of conversation items.
|
|
10
10
|
#
|
|
11
|
-
# @return [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>]
|
|
11
|
+
# @return [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Conversations::ConversationItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>]
|
|
12
12
|
required :data, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Conversations::ConversationItem] }
|
|
13
13
|
|
|
14
14
|
# @!attribute first_id
|
|
@@ -38,7 +38,7 @@ module OpenAI
|
|
|
38
38
|
# @!method initialize(data:, first_id:, has_more:, last_id:, object: :list)
|
|
39
39
|
# A list of Conversation items.
|
|
40
40
|
#
|
|
41
|
-
# @param data [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>] A list of conversation items.
|
|
41
|
+
# @param data [Array<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Conversations::ConversationItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>] A list of conversation items.
|
|
42
42
|
#
|
|
43
43
|
# @param first_id [String] The ID of the first item in the list.
|
|
44
44
|
#
|
|
@@ -16,7 +16,7 @@ module OpenAI
|
|
|
16
16
|
# @!attribute items
|
|
17
17
|
# The items to add to the conversation. You may add up to 20 items at a time.
|
|
18
18
|
#
|
|
19
|
-
# @return [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>]
|
|
19
|
+
# @return [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>]
|
|
20
20
|
required :items, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseInputItem] }
|
|
21
21
|
|
|
22
22
|
# @!attribute include
|
|
@@ -33,7 +33,7 @@ module OpenAI
|
|
|
33
33
|
#
|
|
34
34
|
# @param conversation_id [String]
|
|
35
35
|
#
|
|
36
|
-
# @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] The items to add to the conversation. You may add up to 20 items at a time.
|
|
36
|
+
# @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] The items to add to the conversation. You may add up to 20 items at a time.
|
|
37
37
|
#
|
|
38
38
|
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Additional fields to include in the response. See the `include`
|
|
39
39
|
#
|