RubyGems - openai - Versions diffs - 0.92.0 → 0.93.0 - Mend

openai 0.92.0 → 0.93.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.

Files changed (1311) hide show

data/sig/openai/models/evals/runs/output_item_list_params.rbs CHANGED Viewed

@@ -21,26 +21,48 @@ module OpenAI
           attr_accessor run_id: String
+          # Identifier for the last output item from the previous pagination request.
           attr_reader after: String?
+          # Identifier for the last output item from the previous pagination request.
           def after=: (String) -> String
+          # Number of output items to retrieve.
           attr_reader limit: Integer?
+          # Number of output items to retrieve.
           def limit=: (Integer) -> Integer
+          # Sort order for output items by timestamp. Use `asc` for ascending order or
+          # `desc` for descending order. Defaults to `asc`.
           attr_reader order: OpenAI::Models::Evals::Runs::OutputItemListParams::order?
+          # Sort order for output items by timestamp. Use `asc` for ascending order or
+          # `desc` for descending order. Defaults to `asc`.
           def order=: (
             OpenAI::Models::Evals::Runs::OutputItemListParams::order
           ) -> OpenAI::Models::Evals::Runs::OutputItemListParams::order
+          # Filter output items by status. Use `failed` to filter by failed output items or
+          # `pass` to filter by passed output items.
           attr_reader status: OpenAI::Models::Evals::Runs::OutputItemListParams::status?
+          # Filter output items by status. Use `failed` to filter by failed output items or
+          # `pass` to filter by passed output items.
           def status=: (
             OpenAI::Models::Evals::Runs::OutputItemListParams::status
           ) -> OpenAI::Models::Evals::Runs::OutputItemListParams::status
+          # @param after
+          #   Identifier for the last output item from the previous pagination request.
+          # @param limit
+          #   Number of output items to retrieve.
+          # @param order
+          #   Sort order for output items by timestamp. Use `asc` for ascending order or
+          #   `desc` for descending order. Defaults to `asc`.
+          # @param status
+          #   Filter output items by status. Use `failed` to filter by failed output items or
+          #   `pass` to filter by passed output items.
           def initialize: (
             eval_id: String,
             run_id: String,

data/sig/openai/models/evals/runs/output_item_list_response.rbs CHANGED Viewed

@@ -17,26 +17,56 @@ module OpenAI
           }
         class OutputItemListResponse < OpenAI::Internal::Type::BaseModel
+          # Unique identifier for the evaluation run output item.
           attr_accessor id: String
+          # Unix timestamp (in seconds) when the evaluation run was created.
           attr_accessor created_at: Integer
+          # Details of the input data source item.
           attr_accessor datasource_item: ::Hash[Symbol, top]
+          # The identifier for the data source item.
           attr_accessor datasource_item_id: Integer
+          # The identifier of the evaluation group.
           attr_accessor eval_id: String
+          # The type of the object. Always "eval.run.output_item".
           attr_accessor object: :"eval.run.output_item"
+          # A list of grader results for this output item.
           attr_accessor results: ::Array[OpenAI::Models::Evals::Runs::OutputItemListResponse::Result]
+          # The identifier of the evaluation run associated with this output item.
           attr_accessor run_id: String
+          # A sample containing the input and output of the evaluation run.
           attr_accessor sample: OpenAI::Models::Evals::Runs::OutputItemListResponse::Sample
+          # The status of the evaluation run.
           attr_accessor status: String
+          # @param id
+          #   Unique identifier for the evaluation run output item.
+          # @param created_at
+          #   Unix timestamp (in seconds) when the evaluation run was created.
+          # @param datasource_item
+          #   Details of the input data source item.
+          # @param datasource_item_id
+          #   The identifier for the data source item.
+          # @param eval_id
+          #   The identifier of the evaluation group.
+          # @param results
+          #   A list of grader results for this output item.
+          # @param run_id
+          #   The identifier of the evaluation run associated with this output item.
+          # @param sample
+          #   A sample containing the input and output of the evaluation run.
+          # @param status
+          #   The status of the evaluation run.
+          # @param object
+          #   The type of the object. Always "eval.run.output_item".
           def initialize: (
             id: String,
             created_at: Integer,
@@ -73,18 +103,34 @@ module OpenAI
             }
           class Result < OpenAI::Internal::Type::BaseModel
+            # The name of the grader.
             attr_accessor name: String
+            # Whether the grader considered the output a pass.
             attr_accessor passed: bool
+            # The numeric score produced by the grader.
             attr_accessor score: Float
+            # Optional sample or intermediate data produced by the grader.
             attr_accessor sample: ::Hash[Symbol, top]?
+            # The grader type (for example, "string-check-grader").
             attr_reader type: String?
+            # The grader type (for example, "string-check-grader").
             def type=: (String) -> String
+            # @param name
+            #   The name of the grader.
+            # @param passed
+            #   Whether the grader considered the output a pass.
+            # @param score
+            #   The numeric score produced by the grader.
+            # @param sample
+            #   Optional sample or intermediate data produced by the grader.
+            # @param type
+            #   The grader type (for example, "string-check-grader").
             def initialize: (
               name: String,
               passed: bool,
@@ -117,26 +163,56 @@ module OpenAI
             }
           class Sample < OpenAI::Internal::Type::BaseModel
+            # An object representing an error response from the Eval API.
             attr_accessor error: OpenAI::Evals::EvalAPIError
+            # The reason why the sample generation was finished.
             attr_accessor finish_reason: String
+            # An array of input messages.
             attr_accessor input: ::Array[OpenAI::Models::Evals::Runs::OutputItemListResponse::Sample::Input]
+            # The maximum number of tokens allowed for completion.
             attr_accessor max_completion_tokens: Integer
+            # The model used for generating the sample.
             attr_accessor model: String
+            # An array of output messages.
             attr_accessor output: ::Array[OpenAI::Models::Evals::Runs::OutputItemListResponse::Sample::Output]
+            # The seed used for generating the sample.
             attr_accessor seed: Integer
+            # The sampling temperature used.
             attr_accessor temperature: Float
+            # The top_p value used for sampling.
             attr_accessor top_p: Float
+            # Token usage details for the sample.
             attr_accessor usage: OpenAI::Models::Evals::Runs::OutputItemListResponse::Sample::Usage
+            # @param error
+            #   An object representing an error response from the Eval API.
+            # @param finish_reason
+            #   The reason why the sample generation was finished.
+            # @param input
+            #   An array of input messages.
+            # @param max_completion_tokens
+            #   The maximum number of tokens allowed for completion.
+            # @param model
+            #   The model used for generating the sample.
+            # @param output
+            #   An array of output messages.
+            # @param seed
+            #   The seed used for generating the sample.
+            # @param temperature
+            #   The sampling temperature used.
+            # @param top_p
+            #   The top_p value used for sampling.
+            # @param usage
+            #   Token usage details for the sample.
             def initialize: (
               error: OpenAI::Evals::EvalAPIError,
               finish_reason: String,
@@ -166,10 +242,16 @@ module OpenAI
             type input = { content: String, role: String }
             class Input < OpenAI::Internal::Type::BaseModel
+              # The content of the message.
               attr_accessor content: String
+              # The role of the message sender (e.g., system, user, developer).
               attr_accessor role: String
+              # @param content
+              #   The content of the message.
+              # @param role
+              #   The role of the message sender (e.g., system, user, developer).
               def initialize: (content: String, role: String) -> void
               def to_hash: -> { content: String, role: String }
@@ -178,14 +260,22 @@ module OpenAI
             type output = { ?content: String, ?role: String }
             class Output < OpenAI::Internal::Type::BaseModel
+              # The content of the message.
               attr_reader content: String?
+              # The content of the message.
               def content=: (String) -> String
+              # The role of the message (e.g. "system", "assistant", "user").
               attr_reader role: String?
+              # The role of the message (e.g. "system", "assistant", "user").
               def role=: (String) -> String
+              # @param content
+              #   The content of the message.
+              # @param role
+              #   The role of the message (e.g. "system", "assistant", "user").
               def initialize: (?content: String, ?role: String) -> void
               def to_hash: -> { ?content: String, ?role: String }
@@ -200,14 +290,26 @@ module OpenAI
               }
             class Usage < OpenAI::Internal::Type::BaseModel
+              # The number of tokens retrieved from cache.
               attr_accessor cached_tokens: Integer
+              # The number of completion tokens generated.
               attr_accessor completion_tokens: Integer
+              # The number of prompt tokens used.
               attr_accessor prompt_tokens: Integer
+              # The total number of tokens used.
               attr_accessor total_tokens: Integer
+              # @param cached_tokens
+              #   The number of tokens retrieved from cache.
+              # @param completion_tokens
+              #   The number of completion tokens generated.
+              # @param prompt_tokens
+              #   The number of prompt tokens used.
+              # @param total_tokens
+              #   The total number of tokens used.
               def initialize: (
                 cached_tokens: Integer,
                 completion_tokens: Integer,

data/sig/openai/models/evals/runs/output_item_retrieve_response.rbs CHANGED Viewed

@@ -17,26 +17,56 @@ module OpenAI
           }
         class OutputItemRetrieveResponse < OpenAI::Internal::Type::BaseModel
+          # Unique identifier for the evaluation run output item.
           attr_accessor id: String
+          # Unix timestamp (in seconds) when the evaluation run was created.
           attr_accessor created_at: Integer
+          # Details of the input data source item.
           attr_accessor datasource_item: ::Hash[Symbol, top]
+          # The identifier for the data source item.
           attr_accessor datasource_item_id: Integer
+          # The identifier of the evaluation group.
           attr_accessor eval_id: String
+          # The type of the object. Always "eval.run.output_item".
           attr_accessor object: :"eval.run.output_item"
+          # A list of grader results for this output item.
           attr_accessor results: ::Array[OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Result]
+          # The identifier of the evaluation run associated with this output item.
           attr_accessor run_id: String
+          # A sample containing the input and output of the evaluation run.
           attr_accessor sample: OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Sample
+          # The status of the evaluation run.
           attr_accessor status: String
+          # @param id
+          #   Unique identifier for the evaluation run output item.
+          # @param created_at
+          #   Unix timestamp (in seconds) when the evaluation run was created.
+          # @param datasource_item
+          #   Details of the input data source item.
+          # @param datasource_item_id
+          #   The identifier for the data source item.
+          # @param eval_id
+          #   The identifier of the evaluation group.
+          # @param results
+          #   A list of grader results for this output item.
+          # @param run_id
+          #   The identifier of the evaluation run associated with this output item.
+          # @param sample
+          #   A sample containing the input and output of the evaluation run.
+          # @param status
+          #   The status of the evaluation run.
+          # @param object
+          #   The type of the object. Always "eval.run.output_item".
           def initialize: (
             id: String,
             created_at: Integer,
@@ -73,18 +103,34 @@ module OpenAI
             }
           class Result < OpenAI::Internal::Type::BaseModel
+            # The name of the grader.
             attr_accessor name: String
+            # Whether the grader considered the output a pass.
             attr_accessor passed: bool
+            # The numeric score produced by the grader.
             attr_accessor score: Float
+            # Optional sample or intermediate data produced by the grader.
             attr_accessor sample: ::Hash[Symbol, top]?
+            # The grader type (for example, "string-check-grader").
             attr_reader type: String?
+            # The grader type (for example, "string-check-grader").
             def type=: (String) -> String
+            # @param name
+            #   The name of the grader.
+            # @param passed
+            #   Whether the grader considered the output a pass.
+            # @param score
+            #   The numeric score produced by the grader.
+            # @param sample
+            #   Optional sample or intermediate data produced by the grader.
+            # @param type
+            #   The grader type (for example, "string-check-grader").
             def initialize: (
               name: String,
               passed: bool,
@@ -117,26 +163,56 @@ module OpenAI
             }
           class Sample < OpenAI::Internal::Type::BaseModel
+            # An object representing an error response from the Eval API.
             attr_accessor error: OpenAI::Evals::EvalAPIError
+            # The reason why the sample generation was finished.
             attr_accessor finish_reason: String
+            # An array of input messages.
             attr_accessor input: ::Array[OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Sample::Input]
+            # The maximum number of tokens allowed for completion.
             attr_accessor max_completion_tokens: Integer
+            # The model used for generating the sample.
             attr_accessor model: String
+            # An array of output messages.
             attr_accessor output: ::Array[OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Sample::Output]
+            # The seed used for generating the sample.
             attr_accessor seed: Integer
+            # The sampling temperature used.
             attr_accessor temperature: Float
+            # The top_p value used for sampling.
             attr_accessor top_p: Float
+            # Token usage details for the sample.
             attr_accessor usage: OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Sample::Usage
+            # @param error
+            #   An object representing an error response from the Eval API.
+            # @param finish_reason
+            #   The reason why the sample generation was finished.
+            # @param input
+            #   An array of input messages.
+            # @param max_completion_tokens
+            #   The maximum number of tokens allowed for completion.
+            # @param model
+            #   The model used for generating the sample.
+            # @param output
+            #   An array of output messages.
+            # @param seed
+            #   The seed used for generating the sample.
+            # @param temperature
+            #   The sampling temperature used.
+            # @param top_p
+            #   The top_p value used for sampling.
+            # @param usage
+            #   Token usage details for the sample.
             def initialize: (
               error: OpenAI::Evals::EvalAPIError,
               finish_reason: String,
@@ -166,10 +242,16 @@ module OpenAI
             type input = { content: String, role: String }
             class Input < OpenAI::Internal::Type::BaseModel
+              # The content of the message.
               attr_accessor content: String
+              # The role of the message sender (e.g., system, user, developer).
               attr_accessor role: String
+              # @param content
+              #   The content of the message.
+              # @param role
+              #   The role of the message sender (e.g., system, user, developer).
               def initialize: (content: String, role: String) -> void
               def to_hash: -> { content: String, role: String }
@@ -178,14 +260,22 @@ module OpenAI
             type output = { ?content: String, ?role: String }
             class Output < OpenAI::Internal::Type::BaseModel
+              # The content of the message.
               attr_reader content: String?
+              # The content of the message.
               def content=: (String) -> String
+              # The role of the message (e.g. "system", "assistant", "user").
               attr_reader role: String?
+              # The role of the message (e.g. "system", "assistant", "user").
               def role=: (String) -> String
+              # @param content
+              #   The content of the message.
+              # @param role
+              #   The role of the message (e.g. "system", "assistant", "user").
               def initialize: (?content: String, ?role: String) -> void
               def to_hash: -> { ?content: String, ?role: String }
@@ -200,14 +290,26 @@ module OpenAI
               }
             class Usage < OpenAI::Internal::Type::BaseModel
+              # The number of tokens retrieved from cache.
               attr_accessor cached_tokens: Integer
+              # The number of completion tokens generated.
               attr_accessor completion_tokens: Integer
+              # The number of prompt tokens used.
               attr_accessor prompt_tokens: Integer
+              # The total number of tokens used.
               attr_accessor total_tokens: Integer
+              # @param cached_tokens
+              #   The number of tokens retrieved from cache.
+              # @param completion_tokens
+              #   The number of completion tokens generated.
+              # @param prompt_tokens
+              #   The number of prompt tokens used.
+              # @param total_tokens
+              #   The total number of tokens used.
               def initialize: (
                 cached_tokens: Integer,
                 completion_tokens: Integer,

data/sig/openai/models/file_create_params.rbs CHANGED Viewed

@@ -12,16 +12,51 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
+      # The File object (not file name) to be uploaded.
+      #
+      # `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 file: OpenAI::Internal::file_input
+      # The intended purpose of the uploaded file. One of:
+      #
+      # - `assistants`: Used in the Assistants API
+      # - `batch`: Used in the Batch API
+      # - `fine-tune`: Used for fine-tuning
+      # - `vision`: Images used for vision fine-tuning
+      # - `user_data`: Flexible file type for any purpose
+      # - `evals`: Used for eval data sets
       attr_accessor purpose: OpenAI::Models::file_purpose
+      # The expiration policy for a file. By default, files with `purpose=batch` expire
+      # after 30 days and all other files are persisted until they are manually deleted.
       attr_reader expires_after: OpenAI::FileCreateParams::ExpiresAfter?
+      # The expiration policy for a file. By default, files with `purpose=batch` expire
+      # after 30 days and all other files are persisted until they are manually deleted.
       def expires_after=: (
         OpenAI::FileCreateParams::ExpiresAfter
       ) -> OpenAI::FileCreateParams::ExpiresAfter
+      # @param file
+      #   The File object (not file name) to be uploaded.
+      #
+      #   `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 purpose
+      #   The intended purpose of the uploaded file. One of:
+      #
+      #   - `assistants`: Used in the Assistants API
+      #   - `batch`: Used in the Batch API
+      #   - `fine-tune`: Used for fine-tuning
+      #   - `vision`: Images used for vision fine-tuning
+      #   - `user_data`: Flexible file type for any purpose
+      #   - `evals`: Used for eval data sets
+      # @param expires_after
+      #   The expiration policy for a file. By default, files with `purpose=batch` expire
+      #   after 30 days and all other files are persisted until they are manually deleted.
       def initialize: (
         file: OpenAI::Internal::file_input,
         purpose: OpenAI::Models::file_purpose,
@@ -39,10 +74,20 @@ module OpenAI
       type expires_after = { ?anchor: :created_at, seconds: Integer }
       class ExpiresAfter < OpenAI::Internal::Type::BaseModel
+        # Anchor timestamp after which the expiration policy applies. Supported anchors:
+        # `created_at`.
         attr_accessor anchor: :created_at
+        # The number of seconds after the anchor time that the file will expire. Must be
+        # between 3600 (1 hour) and 2592000 (30 days).
         attr_accessor seconds: Integer
+        # @param seconds
+        #   The number of seconds after the anchor time that the file will expire. Must be
+        #   between 3600 (1 hour) and 2592000 (30 days).
+        # @param anchor
+        #   Anchor timestamp after which the expiration policy applies. Supported anchors:
+        #   `created_at`.
         def initialize: (seconds: Integer, ?anchor: :created_at) -> void
         def to_hash: -> { ?anchor: :created_at, seconds: Integer }

data/sig/openai/models/file_list_params.rbs CHANGED Viewed

@@ -13,24 +13,55 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
+      # A cursor for use in pagination. `after` is an object ID that defines your place
+      # in the list. For instance, if you make a list request and receive 100 objects,
+      # ending with obj_foo, your subsequent call can include after=obj_foo in order to
+      # fetch the next page of the list.
       attr_reader after: String?
+      # A cursor for use in pagination. `after` is an object ID that defines your place
+      # in the list. For instance, if you make a list request and receive 100 objects,
+      # ending with obj_foo, your subsequent call can include after=obj_foo in order to
+      # fetch the next page of the list.
       def after=: (String) -> String
+      # A limit on the number of objects to be returned. Limit can range between 1 and
+      # 10,000, and the default is 10,000.
       attr_reader limit: Integer?
+      # A limit on the number of objects to be returned. Limit can range between 1 and
+      # 10,000, and the default is 10,000.
       def limit=: (Integer) -> Integer
+      # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+      # order and `desc` for descending order.
       attr_reader order: OpenAI::Models::FileListParams::order?
+      # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+      # order and `desc` for descending order.
       def order=: (
         OpenAI::Models::FileListParams::order
       ) -> OpenAI::Models::FileListParams::order
+      # Only return files with the given purpose.
       attr_reader purpose: String?
+      # Only return files with the given purpose.
       def purpose=: (String) -> String
+      # @param after
+      #   A cursor for use in pagination. `after` is an object ID that defines your place
+      #   in the list. For instance, if you make a list request and receive 100 objects,
+      #   ending with obj_foo, your subsequent call can include after=obj_foo in order to
+      #   fetch the next page of the list.
+      # @param limit
+      #   A limit on the number of objects to be returned. Limit can range between 1 and
+      #   10,000, and the default is 10,000.
+      # @param order
+      #   Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+      #   order and `desc` for descending order.
+      # @param purpose
+      #   Only return files with the given purpose.
       def initialize: (
         ?after: String,
         ?limit: Integer,

data/sig/openai/models/file_object.rbs CHANGED Viewed

@@ -14,28 +14,66 @@ module OpenAI
       }
     class FileObject < OpenAI::Internal::Type::BaseModel
+      # The file identifier, which can be referenced in the API endpoints.
       attr_accessor id: String
+      # The size of the file, in bytes.
       attr_accessor bytes: Integer
+      # The Unix timestamp (in seconds) for when the file was created.
       attr_accessor created_at: Integer
+      # The name of the file.
       attr_accessor filename: String
+      # The object type, which is always `file`.
       attr_accessor object: :file
+      # The intended purpose of the file. Supported values are `assistants`,
+      # `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`,
+      # `vision`, and `user_data`.
       attr_accessor purpose: OpenAI::Models::FileObject::purpose
+      # Deprecated. The current status of the file, which can be either `uploaded`,
+      # `processed`, or `error`.
       attr_accessor status: OpenAI::Models::FileObject::status
+      # The Unix timestamp (in seconds) for when the file will expire.
       attr_reader expires_at: Integer?
+      # The Unix timestamp (in seconds) for when the file will expire.
       def expires_at=: (Integer) -> Integer
+      # Deprecated. For details on why a fine-tuning training file failed validation,
+      # see the `error` field on `fine_tuning.job`.
       attr_reader status_details: String?
+      # Deprecated. For details on why a fine-tuning training file failed validation,
+      # see the `error` field on `fine_tuning.job`.
       def status_details=: (String) -> String
+      # @param id
+      #   The file identifier, which can be referenced in the API endpoints.
+      # @param bytes
+      #   The size of the file, in bytes.
+      # @param created_at
+      #   The Unix timestamp (in seconds) for when the file was created.
+      # @param filename
+      #   The name of the file.
+      # @param purpose
+      #   The intended purpose of the file. Supported values are `assistants`,
+      #   `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`,
+      #   `vision`, and `user_data`.
+      # @param status
+      #   Deprecated. The current status of the file, which can be either `uploaded`,
+      #   `processed`, or `error`.
+      # @param expires_at
+      #   The Unix timestamp (in seconds) for when the file will expire.
+      # @param status_details
+      #   Deprecated. For details on why a fine-tuning training file failed validation,
+      #   see the `error` field on `fine_tuning.job`.
+      # @param object
+      #   The object type, which is always `file`.
       def initialize: (
         id: String,
         bytes: Integer,