openai 0.92.0 → 0.93.0

data/sig/openai/models/function_definition.rbs

@@ -9,20 +9,65 @@ module OpenAI
       }
 
     class FunctionDefinition < OpenAI::Internal::Type::BaseModel
+      # The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
+      # underscores and dashes, with a maximum length of 64.
       attr_accessor name: String
 
+      # A description of what the function does, used by the model to choose when and
+      # how to call the function.
       attr_reader description: String?
 
+      # A description of what the function does, used by the model to choose when and
+      # how to call the function.
       def description=: (String) -> String
 
+      # The parameters the functions accepts, described as a JSON Schema object. See the
+      # [guide](https://developers.openai.com/api/docs/guides/function-calling) for
+      # examples, and the
+      # [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
+      # documentation about the format.
+      #
+      # Omitting `parameters` defines a function with an empty parameter list.
       attr_reader parameters: OpenAI::Models::function_parameters?
 
+      # The parameters the functions accepts, described as a JSON Schema object. See the
+      # [guide](https://developers.openai.com/api/docs/guides/function-calling) for
+      # examples, and the
+      # [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
+      # documentation about the format.
+      #
+      # Omitting `parameters` defines a function with an empty parameter list.
       def parameters=: (
         OpenAI::Models::function_parameters
       ) -> OpenAI::Models::function_parameters
 
+      # Whether to enable strict schema adherence when generating the function call. If
+      # set to true, the model will follow the exact schema defined in the `parameters`
+      # field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn
+      # more about Structured Outputs in the
+      # [function calling guide](https://developers.openai.com/api/docs/guides/function-calling).
       attr_accessor strict: bool?
 
+      # @param name
+      #   The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
+      #   underscores and dashes, with a maximum length of 64.
+      # @param description
+      #   A description of what the function does, used by the model to choose when and
+      #   how to call the function.
+      # @param parameters
+      #   The parameters the functions accepts, described as a JSON Schema object. See the
+      #   [guide](https://developers.openai.com/api/docs/guides/function-calling) for
+      #   examples, and the
+      #   [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
+      #   documentation about the format.
+      #
+      #   Omitting `parameters` defines a function with an empty parameter list.
+      # @param strict
+      #   Whether to enable strict schema adherence when generating the function call. If
+      #   set to true, the model will follow the exact schema defined in the `parameters`
+      #   field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn
+      #   more about Structured Outputs in the
+      #   [function calling guide](https://developers.openai.com/api/docs/guides/function-calling).
       def initialize: (
         name: String,
         ?description: String,

data/sig/openai/models/graders/grader_input_item.rbs

@@ -14,10 +14,16 @@ module OpenAI
         type output_text = { text: String, ?type: :output_text }
 
         class OutputText < OpenAI::Internal::Type::BaseModel
+          # The text output from the model.
           attr_accessor text: String
 
+          # The type of the output text. Always `output_text`.
           attr_accessor type: :output_text
 
+          # @param text
+          #   The text output from the model.
+          # @param type
+          #   The type of the output text. Always `output_text`.
           def initialize: (text: String, ?type: :output_text) -> void
 
           def to_hash: -> { text: String, ?type: :output_text }
@@ -27,14 +33,27 @@ module OpenAI
           { image_url: String, ?type: :input_image, ?detail: String }
 
         class InputImage < OpenAI::Internal::Type::BaseModel
+          # The URL of the image input.
           attr_accessor image_url: String
 
+          # The type of the image input. Always `input_image`.
           attr_accessor type: :input_image
 
+          # The detail level of the image to be sent to the model. One of `high`, `low`, or
+          # `auto`. Defaults to `auto`.
           attr_reader detail: String?
 
+          # The detail level of the image to be sent to the model. One of `high`, `low`, or
+          # `auto`. Defaults to `auto`.
           def detail=: (String) -> String
 
+          # @param image_url
+          #   The URL of the image input.
+          # @param detail
+          #   The detail level of the image to be sent to the model. One of `high`, `low`, or
+          #   `auto`. Defaults to `auto`.
+          # @param type
+          #   The type of the image input. Always `input_image`.
           def initialize: (
             image_url: String,
             ?detail: String,

data/sig/openai/models/graders/label_model_grader.rbs

@@ -16,16 +16,31 @@ module OpenAI
       class LabelModelGrader < OpenAI::Internal::Type::BaseModel
         attr_accessor input: ::Array[OpenAI::Graders::LabelModelGrader::Input]
 
+        # The labels to assign to each item in the evaluation.
         attr_accessor labels: ::Array[String]
 
+        # The model to use for the evaluation. Must support structured outputs.
         attr_accessor model: String
 
+        # The name of the grader.
         attr_accessor name: String
 
+        # The labels that indicate a passing result. Must be a subset of labels.
         attr_accessor passing_labels: ::Array[String]
 
+        # The object type, which is always `label_model`.
         attr_accessor type: :label_model
 
+        # @param labels
+        #   The labels to assign to each item in the evaluation.
+        # @param model
+        #   The model to use for the evaluation. Must support structured outputs.
+        # @param name
+        #   The name of the grader.
+        # @param passing_labels
+        #   The labels that indicate a passing result. Must be a subset of labels.
+        # @param type
+        #   The object type, which is always `label_model`.
         def initialize: (
           input: ::Array[OpenAI::Graders::LabelModelGrader::Input],
           labels: ::Array[String],
@@ -52,16 +67,30 @@ module OpenAI
           }
 
         class Input < OpenAI::Internal::Type::BaseModel
+          # Inputs to the model - can contain template strings. Supports text, output text,
+          # input images, and input audio, either as a single item or an array of items.
           attr_accessor content: OpenAI::Models::Graders::LabelModelGrader::Input::content
 
+          # The role of the message input. One of `user`, `assistant`, `system`, or
+          # `developer`.
           attr_accessor role: OpenAI::Models::Graders::LabelModelGrader::Input::role
 
+          # The type of the message input. Always `message`.
           attr_reader type: OpenAI::Models::Graders::LabelModelGrader::Input::type_?
 
+          # The type of the message input. Always `message`.
           def type=: (
             OpenAI::Models::Graders::LabelModelGrader::Input::type_
           ) -> OpenAI::Models::Graders::LabelModelGrader::Input::type_
 
+          # @param content
+          #   Inputs to the model - can contain template strings. Supports text, output text,
+          #   input images, and input audio, either as a single item or an array of items.
+          # @param role
+          #   The role of the message input. One of `user`, `assistant`, `system`, or
+          #   `developer`.
+          # @param type
+          #   The type of the message input. Always `message`.
           def initialize: (
             content: OpenAI::Models::Graders::LabelModelGrader::Input::content,
             role: OpenAI::Models::Graders::LabelModelGrader::Input::role,
@@ -88,10 +117,16 @@ module OpenAI
             type output_text = { text: String, ?type: :output_text }
 
             class OutputText < OpenAI::Internal::Type::BaseModel
+              # The text output from the model.
               attr_accessor text: String
 
+              # The type of the output text. Always `output_text`.
               attr_accessor type: :output_text
 
+              # @param text
+              #   The text output from the model.
+              # @param type
+              #   The type of the output text. Always `output_text`.
               def initialize: (text: String, ?type: :output_text) -> void
 
               def to_hash: -> { text: String, ?type: :output_text }
@@ -101,14 +136,27 @@ module OpenAI
               { image_url: String, ?type: :input_image, ?detail: String }
 
             class InputImage < OpenAI::Internal::Type::BaseModel
+              # The URL of the image input.
               attr_accessor image_url: String
 
+              # The type of the image input. Always `input_image`.
               attr_accessor type: :input_image
 
+              # The detail level of the image to be sent to the model. One of `high`, `low`, or
+              # `auto`. Defaults to `auto`.
               attr_reader detail: String?
 
+              # The detail level of the image to be sent to the model. One of `high`, `low`, or
+              # `auto`. Defaults to `auto`.
               def detail=: (String) -> String
 
+              # @param image_url
+              #   The URL of the image input.
+              # @param detail
+              #   The detail level of the image to be sent to the model. One of `high`, `low`, or
+              #   `auto`. Defaults to `auto`.
+              # @param type
+              #   The type of the image input. Always `input_image`.
               def initialize: (
                 image_url: String,
                 ?detail: String,

data/sig/openai/models/graders/multi_grader.rbs

@@ -12,14 +12,28 @@ module OpenAI
         }
 
       class MultiGrader < OpenAI::Internal::Type::BaseModel
+        # A formula to calculate the output based on grader results.
         attr_accessor calculate_output: String
 
+        # A StringCheckGrader object that performs a string comparison between input and
+        # reference using a specified operation.
         attr_accessor graders: OpenAI::Models::Graders::MultiGrader::graders
 
+        # The name of the grader.
         attr_accessor name: String
 
+        # The object type, which is always `multi`.
         attr_accessor type: :multi
 
+        # @param calculate_output
+        #   A formula to calculate the output based on grader results.
+        # @param graders
+        #   A StringCheckGrader object that performs a string comparison between input and
+        #   reference using a specified operation.
+        # @param name
+        #   The name of the grader.
+        # @param type
+        #   The object type, which is always `multi`.
         def initialize: (
           calculate_output: String,
           graders: OpenAI::Models::Graders::MultiGrader::graders,

data/sig/openai/models/graders/python_grader.rbs

@@ -7,16 +7,29 @@ module OpenAI
         { name: String, source: String, ?type: :python, ?image_tag: String }
 
       class PythonGrader < OpenAI::Internal::Type::BaseModel
+        # The name of the grader.
         attr_accessor name: String
 
+        # The source code of the python script.
         attr_accessor source: String
 
+        # The object type, which is always `python`.
         attr_accessor type: :python
 
+        # The image tag to use for the python script.
         attr_reader image_tag: String?
 
+        # The image tag to use for the python script.
         def image_tag=: (String) -> String
 
+        # @param name
+        #   The name of the grader.
+        # @param source
+        #   The source code of the python script.
+        # @param image_tag
+        #   The image tag to use for the python script.
+        # @param type
+        #   The object type, which is always `python`.
         def initialize: (
           name: String,
           source: String,

data/sig/openai/models/graders/score_model_grader.rbs

@@ -14,24 +14,46 @@ module OpenAI
         }
 
       class ScoreModelGrader < OpenAI::Internal::Type::BaseModel
+        # The input messages evaluated by the grader. Supports text, output text, input
+        # image, and input audio content blocks, and may include template strings.
         attr_accessor input: ::Array[OpenAI::Graders::ScoreModelGrader::Input]
 
+        # The model to use for the evaluation.
         attr_accessor model: String
 
+        # The name of the grader.
         attr_accessor name: String
 
+        # The object type, which is always `score_model`.
         attr_accessor type: :score_model
 
+        # The range of the score. Defaults to `[0, 1]`.
         attr_reader range: ::Array[Float]?
 
+        # The range of the score. Defaults to `[0, 1]`.
         def range=: (::Array[Float]) -> ::Array[Float]
 
+        # The sampling parameters for the model.
         attr_reader sampling_params: OpenAI::Graders::ScoreModelGrader::SamplingParams?
 
+        # The sampling parameters for the model.
         def sampling_params=: (
           OpenAI::Graders::ScoreModelGrader::SamplingParams
         ) -> OpenAI::Graders::ScoreModelGrader::SamplingParams
 
+        # @param input
+        #   The input messages evaluated by the grader. Supports text, output text, input
+        #   image, and input audio content blocks, and may include template strings.
+        # @param model
+        #   The model to use for the evaluation.
+        # @param name
+        #   The name of the grader.
+        # @param range
+        #   The range of the score. Defaults to `[0, 1]`.
+        # @param sampling_params
+        #   The sampling parameters for the model.
+        # @param type
+        #   The object type, which is always `score_model`.
         def initialize: (
           input: ::Array[OpenAI::Graders::ScoreModelGrader::Input],
           model: String,
@@ -58,16 +80,30 @@ module OpenAI
           }
 
         class Input < OpenAI::Internal::Type::BaseModel
+          # Inputs to the model - can contain template strings. Supports text, output text,
+          # input images, and input audio, either as a single item or an array of items.
           attr_accessor content: OpenAI::Models::Graders::ScoreModelGrader::Input::content
 
+          # The role of the message input. One of `user`, `assistant`, `system`, or
+          # `developer`.
           attr_accessor role: OpenAI::Models::Graders::ScoreModelGrader::Input::role
 
+          # The type of the message input. Always `message`.
           attr_reader type: OpenAI::Models::Graders::ScoreModelGrader::Input::type_?
 
+          # The type of the message input. Always `message`.
           def type=: (
             OpenAI::Models::Graders::ScoreModelGrader::Input::type_
           ) -> OpenAI::Models::Graders::ScoreModelGrader::Input::type_
 
+          # @param content
+          #   Inputs to the model - can contain template strings. Supports text, output text,
+          #   input images, and input audio, either as a single item or an array of items.
+          # @param role
+          #   The role of the message input. One of `user`, `assistant`, `system`, or
+          #   `developer`.
+          # @param type
+          #   The type of the message input. Always `message`.
           def initialize: (
             content: OpenAI::Models::Graders::ScoreModelGrader::Input::content,
             role: OpenAI::Models::Graders::ScoreModelGrader::Input::role,
@@ -94,10 +130,16 @@ module OpenAI
             type output_text = { text: String, ?type: :output_text }
 
             class OutputText < OpenAI::Internal::Type::BaseModel
+              # The text output from the model.
               attr_accessor text: String
 
+              # The type of the output text. Always `output_text`.
               attr_accessor type: :output_text
 
+              # @param text
+              #   The text output from the model.
+              # @param type
+              #   The type of the output text. Always `output_text`.
               def initialize: (text: String, ?type: :output_text) -> void
 
               def to_hash: -> { text: String, ?type: :output_text }
@@ -107,14 +149,27 @@ module OpenAI
               { image_url: String, ?type: :input_image, ?detail: String }
 
             class InputImage < OpenAI::Internal::Type::BaseModel
+              # The URL of the image input.
               attr_accessor image_url: String
 
+              # The type of the image input. Always `input_image`.
               attr_accessor type: :input_image
 
+              # The detail level of the image to be sent to the model. One of `high`, `low`, or
+              # `auto`. Defaults to `auto`.
               attr_reader detail: String?
 
+              # The detail level of the image to be sent to the model. One of `high`, `low`, or
+              # `auto`. Defaults to `auto`.
               def detail=: (String) -> String
 
+              # @param image_url
+              #   The URL of the image input.
+              # @param detail
+              #   The detail level of the image to be sent to the model. One of `high`, `low`, or
+              #   `auto`. Defaults to `auto`.
+              # @param type
+              #   The type of the image input. Always `input_image`.
               def initialize: (
                 image_url: String,
                 ?detail: String,
@@ -165,16 +220,41 @@ module OpenAI
           }
 
         class SamplingParams < OpenAI::Internal::Type::BaseModel
+          # The maximum number of tokens the grader model may generate in its response.
           attr_accessor max_completions_tokens: Integer?
 
+          # Constrains effort on reasoning for reasoning models. Currently supported values
+          # are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
+          # reasoning effort can result in faster responses and fewer tokens used on
+          # reasoning in a response. Not all reasoning models support every value. See the
+          # [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
+          # model-specific support.
           attr_accessor reasoning_effort: OpenAI::Models::reasoning_effort?
 
+          # A seed value to initialize the randomness, during sampling.
           attr_accessor seed: Integer?
 
+          # A higher temperature increases randomness in the outputs.
           attr_accessor temperature: Float?
 
+          # An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
           attr_accessor top_p: Float?
 
+          # @param max_completions_tokens
+          #   The maximum number of tokens the grader model may generate in its response.
+          # @param reasoning_effort
+          #   Constrains effort on reasoning for reasoning models. Currently supported values
+          #   are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
+          #   reasoning effort can result in faster responses and fewer tokens used on
+          #   reasoning in a response. Not all reasoning models support every value. See the
+          #   [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
+          #   model-specific support.
+          # @param seed
+          #   A seed value to initialize the randomness, during sampling.
+          # @param temperature
+          #   A higher temperature increases randomness in the outputs.
+          # @param top_p
+          #   An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
           def initialize: (
             ?max_completions_tokens: Integer?,
             ?reasoning_effort: OpenAI::Models::reasoning_effort?,

data/sig/openai/models/graders/string_check_grader.rbs

@@ -13,16 +13,31 @@ module OpenAI
         }
 
       class StringCheckGrader < OpenAI::Internal::Type::BaseModel
+        # The input text. This may include template strings.
         attr_accessor input: String
 
+        # The name of the grader.
         attr_accessor name: String
 
+        # The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`.
         attr_accessor operation: OpenAI::Models::Graders::StringCheckGrader::operation
 
+        # The reference text. This may include template strings.
         attr_accessor reference: String
 
+        # The object type, which is always `string_check`.
         attr_accessor type: :string_check
 
+        # @param input
+        #   The input text. This may include template strings.
+        # @param name
+        #   The name of the grader.
+        # @param operation
+        #   The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`.
+        # @param reference
+        #   The reference text. This may include template strings.
+        # @param type
+        #   The object type, which is always `string_check`.
         def initialize: (
           input: String,
           name: String,

data/sig/openai/models/graders/text_similarity_grader.rbs

@@ -13,16 +13,33 @@ module OpenAI
         }
 
       class TextSimilarityGrader < OpenAI::Internal::Type::BaseModel
+        # The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, `gleu`,
+        # `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, or `rouge_l`.
         attr_accessor evaluation_metric: OpenAI::Models::Graders::TextSimilarityGrader::evaluation_metric
 
+        # The text being graded.
         attr_accessor input: String
 
+        # The name of the grader.
         attr_accessor name: String
 
+        # The text being graded against.
         attr_accessor reference: String
 
+        # The type of grader.
         attr_accessor type: :text_similarity
 
+        # @param evaluation_metric
+        #   The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, `gleu`,
+        #   `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, or `rouge_l`.
+        # @param input
+        #   The text being graded.
+        # @param name
+        #   The name of the grader.
+        # @param reference
+        #   The text being graded against.
+        # @param type
+        #   The type of grader.
         def initialize: (
           evaluation_metric: OpenAI::Models::Graders::TextSimilarityGrader::evaluation_metric,
           input: String,

data/sig/openai/models/image.rbs

@@ -3,18 +3,42 @@ module OpenAI
     type image = { ?:b64_json => String, ?revised_prompt: String, ?url: String }
 
     class Image < OpenAI::Internal::Type::BaseModel
+      # The base64-encoded JSON of the generated image. Returned by default for the GPT
+      # image models, and only present if `response_format` is set to `b64_json` for
+      # `dall-e-2` and `dall-e-3`.
       attr_reader b64_json: String?
 
+      # The base64-encoded JSON of the generated image. Returned by default for the GPT
+      # image models, and only present if `response_format` is set to `b64_json` for
+      # `dall-e-2` and `dall-e-3`.
       def b64_json=: (String) -> String
 
+      # For `dall-e-3` only, the revised prompt that was used to generate the image.
       attr_reader revised_prompt: String?
 
+      # For `dall-e-3` only, the revised prompt that was used to generate the image.
       def revised_prompt=: (String) -> String
 
+      # When using `dall-e-2` or `dall-e-3`, the URL of the generated image if
+      # `response_format` is set to `url` (default value). Unsupported for the GPT image
+      # models.
       attr_reader url: String?
 
+      # When using `dall-e-2` or `dall-e-3`, the URL of the generated image if
+      # `response_format` is set to `url` (default value). Unsupported for the GPT image
+      # models.
       def url=: (String) -> String
 
+      # @param b64_json
+      #   The base64-encoded JSON of the generated image. Returned by default for the GPT
+      #   image models, and only present if `response_format` is set to `b64_json` for
+      #   `dall-e-2` and `dall-e-3`.
+      # @param revised_prompt
+      #   For `dall-e-3` only, the revised prompt that was used to generate the image.
+      # @param url
+      #   When using `dall-e-2` or `dall-e-3`, the URL of the generated image if
+      #   `response_format` is set to `url` (default value). Unsupported for the GPT image
+      #   models.
       def initialize: (
         ?b64_json: String,
         ?revised_prompt: String,

data/sig/openai/models/image_create_variation_params.rbs

@@ -15,20 +15,63 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
 
+      # The image to use as the basis for the variation(s). Must be a valid PNG file,
+      # less than 4MB, and square.
+      #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
       attr_accessor image: OpenAI::Internal::file_input
 
+      # The model to use for image generation. Only `dall-e-2` is supported at this
+      # time.
       attr_accessor model: OpenAI::Models::ImageCreateVariationParams::model?
 
+      # The number of images to generate. Must be between 1 and 10.
       attr_accessor n: Integer?
 
+      # The format in which the generated images are returned. Must be one of `url` or
+      # `b64_json`. URLs are only valid for 60 minutes after the image has been
+      # generated.
       attr_accessor response_format: OpenAI::Models::ImageCreateVariationParams::response_format?
 
+      # The size of the generated images. Must be one of `256x256`, `512x512`, or
+      # `1024x1024`.
       attr_accessor size: OpenAI::Models::ImageCreateVariationParams::size?
 
+      # A unique identifier representing your end-user, which can help OpenAI to monitor
+      # and detect abuse.
+      # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       attr_reader user: String?
 
+      # A unique identifier representing your end-user, which can help OpenAI to monitor
+      # and detect abuse.
+      # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       def user=: (String) -> String
 
+      # @param image
+      #   The image to use as the basis for the variation(s). Must be a valid PNG file,
+      #   less than 4MB, and square.
+      #
+      #   `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      #   metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      #   content type.
+      # @param model
+      #   The model to use for image generation. Only `dall-e-2` is supported at this
+      #   time.
+      # @param n
+      #   The number of images to generate. Must be between 1 and 10.
+      # @param response_format
+      #   The format in which the generated images are returned. Must be one of `url` or
+      #   `b64_json`. URLs are only valid for 60 minutes after the image has been
+      #   generated.
+      # @param size
+      #   The size of the generated images. Must be one of `256x256`, `512x512`, or
+      #   `1024x1024`.
+      # @param user
+      #   A unique identifier representing your end-user, which can help OpenAI to monitor
+      #   and detect abuse.
+      #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       def initialize: (
         image: OpenAI::Internal::file_input,
         ?model: OpenAI::Models::ImageCreateVariationParams::model?,