openai 0.1.0.pre.beta.2 → 0.1.0

data/rbi/openai/models/eval_list_response.rbi

@@ -1,328 +0,0 @@
-# typed: strong
-
-module OpenAI
-  module Models
-    class EvalListResponse < OpenAI::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(OpenAI::Models::EvalListResponse, OpenAI::Internal::AnyHash)
-        end
-
-      # Unique identifier for the evaluation.
-      sig { returns(String) }
-      attr_accessor :id
-
-      # The Unix timestamp (in seconds) for when the eval was created.
-      sig { returns(Integer) }
-      attr_accessor :created_at
-
-      # Configuration of data sources used in runs of the evaluation.
-      sig do
-        returns(OpenAI::Models::EvalListResponse::DataSourceConfig::Variants)
-      end
-      attr_accessor :data_source_config
-
-      # Set of 16 key-value pairs that can be attached to an object. This can be useful
-      # for storing additional information about the object in a structured format, and
-      # querying for objects via API or the dashboard.
-      #
-      # Keys are strings with a maximum length of 64 characters. Values are strings with
-      # a maximum length of 512 characters.
-      sig { returns(T.nilable(T::Hash[Symbol, String])) }
-      attr_accessor :metadata
-
-      # The name of the evaluation.
-      sig { returns(String) }
-      attr_accessor :name
-
-      # The object type.
-      sig { returns(Symbol) }
-      attr_accessor :object
-
-      # A list of testing criteria.
-      sig do
-        returns(
-          T::Array[OpenAI::Models::EvalListResponse::TestingCriterion::Variants]
-        )
-      end
-      attr_accessor :testing_criteria
-
-      # An Eval object with a data source config and testing criteria. An Eval
-      # represents a task to be done for your LLM integration. Like:
-      #
-      # - Improve the quality of my chatbot
-      # - See how well my chatbot handles customer support
-      # - Check if o4-mini is better at my usecase than gpt-4o
-      sig do
-        params(
-          id: String,
-          created_at: Integer,
-          data_source_config:
-            T.any(
-              OpenAI::EvalCustomDataSourceConfig::OrHash,
-              OpenAI::Models::EvalListResponse::DataSourceConfig::Logs::OrHash,
-              OpenAI::EvalStoredCompletionsDataSourceConfig::OrHash
-            ),
-          metadata: T.nilable(T::Hash[Symbol, String]),
-          name: String,
-          testing_criteria:
-            T::Array[
-              T.any(
-                OpenAI::Models::Graders::LabelModelGrader::OrHash,
-                OpenAI::Models::Graders::StringCheckGrader::OrHash,
-                OpenAI::Models::EvalListResponse::TestingCriterion::EvalGraderTextSimilarity::OrHash,
-                OpenAI::Models::EvalListResponse::TestingCriterion::EvalGraderPython::OrHash,
-                OpenAI::Models::EvalListResponse::TestingCriterion::EvalGraderScoreModel::OrHash
-              )
-            ],
-          object: Symbol
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Unique identifier for the evaluation.
-        id:,
-        # The Unix timestamp (in seconds) for when the eval was created.
-        created_at:,
-        # Configuration of data sources used in runs of the evaluation.
-        data_source_config:,
-        # Set of 16 key-value pairs that can be attached to an object. This can be useful
-        # for storing additional information about the object in a structured format, and
-        # querying for objects via API or the dashboard.
-        #
-        # Keys are strings with a maximum length of 64 characters. Values are strings with
-        # a maximum length of 512 characters.
-        metadata:,
-        # The name of the evaluation.
-        name:,
-        # A list of testing criteria.
-        testing_criteria:,
-        # The object type.
-        object: :eval
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            created_at: Integer,
-            data_source_config:
-              OpenAI::Models::EvalListResponse::DataSourceConfig::Variants,
-            metadata: T.nilable(T::Hash[Symbol, String]),
-            name: String,
-            object: Symbol,
-            testing_criteria:
-              T::Array[
-                OpenAI::Models::EvalListResponse::TestingCriterion::Variants
-              ]
-          }
-        )
-      end
-      def to_hash
-      end
-
-      # Configuration of data sources used in runs of the evaluation.
-      module DataSourceConfig
-        extend OpenAI::Internal::Type::Union
-
-        Variants =
-          T.type_alias do
-            T.any(
-              OpenAI::EvalCustomDataSourceConfig,
-              OpenAI::Models::EvalListResponse::DataSourceConfig::Logs,
-              OpenAI::EvalStoredCompletionsDataSourceConfig
-            )
-          end
-
-        class Logs < OpenAI::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                OpenAI::Models::EvalListResponse::DataSourceConfig::Logs,
-                OpenAI::Internal::AnyHash
-              )
-            end
-
-          # The json schema for the run data source items. Learn how to build JSON schemas
-          # [here](https://json-schema.org/).
-          sig { returns(T::Hash[Symbol, T.anything]) }
-          attr_accessor :schema
-
-          # The type of data source. Always `logs`.
-          sig { returns(Symbol) }
-          attr_accessor :type
-
-          # Set of 16 key-value pairs that can be attached to an object. This can be useful
-          # for storing additional information about the object in a structured format, and
-          # querying for objects via API or the dashboard.
-          #
-          # Keys are strings with a maximum length of 64 characters. Values are strings with
-          # a maximum length of 512 characters.
-          sig { returns(T.nilable(T::Hash[Symbol, String])) }
-          attr_accessor :metadata
-
-          # A LogsDataSourceConfig which specifies the metadata property of your logs query.
-          # This is usually metadata like `usecase=chatbot` or `prompt-version=v2`, etc. The
-          # schema returned by this data source config is used to defined what variables are
-          # available in your evals. `item` and `sample` are both defined when using this
-          # data source config.
-          sig do
-            params(
-              schema: T::Hash[Symbol, T.anything],
-              metadata: T.nilable(T::Hash[Symbol, String]),
-              type: Symbol
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # The json schema for the run data source items. Learn how to build JSON schemas
-            # [here](https://json-schema.org/).
-            schema:,
-            # Set of 16 key-value pairs that can be attached to an object. This can be useful
-            # for storing additional information about the object in a structured format, and
-            # querying for objects via API or the dashboard.
-            #
-            # Keys are strings with a maximum length of 64 characters. Values are strings with
-            # a maximum length of 512 characters.
-            metadata: nil,
-            # The type of data source. Always `logs`.
-            type: :logs
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                schema: T::Hash[Symbol, T.anything],
-                type: Symbol,
-                metadata: T.nilable(T::Hash[Symbol, String])
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-
-        sig do
-          override.returns(
-            T::Array[
-              OpenAI::Models::EvalListResponse::DataSourceConfig::Variants
-            ]
-          )
-        end
-        def self.variants
-        end
-      end
-
-      # A LabelModelGrader object which uses a model to assign labels to each item in
-      # the evaluation.
-      module TestingCriterion
-        extend OpenAI::Internal::Type::Union
-
-        Variants =
-          T.type_alias do
-            T.any(
-              OpenAI::Models::Graders::LabelModelGrader,
-              OpenAI::Models::Graders::StringCheckGrader,
-              OpenAI::Models::EvalListResponse::TestingCriterion::EvalGraderTextSimilarity,
-              OpenAI::Models::EvalListResponse::TestingCriterion::EvalGraderPython,
-              OpenAI::Models::EvalListResponse::TestingCriterion::EvalGraderScoreModel
-            )
-          end
-
-        class EvalGraderTextSimilarity < OpenAI::Models::Graders::TextSimilarityGrader
-          OrHash =
-            T.type_alias do
-              T.any(
-                OpenAI::Models::EvalListResponse::TestingCriterion::EvalGraderTextSimilarity,
-                OpenAI::Internal::AnyHash
-              )
-            end
-
-          # The threshold for the score.
-          sig { returns(Float) }
-          attr_accessor :pass_threshold
-
-          # A TextSimilarityGrader object which grades text based on similarity metrics.
-          sig { params(pass_threshold: Float).returns(T.attached_class) }
-          def self.new(
-            # The threshold for the score.
-            pass_threshold:
-          )
-          end
-
-          sig { override.returns({ pass_threshold: Float }) }
-          def to_hash
-          end
-        end
-
-        class EvalGraderPython < OpenAI::Models::Graders::PythonGrader
-          OrHash =
-            T.type_alias do
-              T.any(
-                OpenAI::Models::EvalListResponse::TestingCriterion::EvalGraderPython,
-                OpenAI::Internal::AnyHash
-              )
-            end
-
-          # The threshold for the score.
-          sig { returns(T.nilable(Float)) }
-          attr_reader :pass_threshold
-
-          sig { params(pass_threshold: Float).void }
-          attr_writer :pass_threshold
-
-          # A PythonGrader object that runs a python script on the input.
-          sig { params(pass_threshold: Float).returns(T.attached_class) }
-          def self.new(
-            # The threshold for the score.
-            pass_threshold: nil
-          )
-          end
-
-          sig { override.returns({ pass_threshold: Float }) }
-          def to_hash
-          end
-        end
-
-        class EvalGraderScoreModel < OpenAI::Models::Graders::ScoreModelGrader
-          OrHash =
-            T.type_alias do
-              T.any(
-                OpenAI::Models::EvalListResponse::TestingCriterion::EvalGraderScoreModel,
-                OpenAI::Internal::AnyHash
-              )
-            end
-
-          # The threshold for the score.
-          sig { returns(T.nilable(Float)) }
-          attr_reader :pass_threshold
-
-          sig { params(pass_threshold: Float).void }
-          attr_writer :pass_threshold
-
-          # A ScoreModelGrader object that uses a model to assign a score to the input.
-          sig { params(pass_threshold: Float).returns(T.attached_class) }
-          def self.new(
-            # The threshold for the score.
-            pass_threshold: nil
-          )
-          end
-
-          sig { override.returns({ pass_threshold: Float }) }
-          def to_hash
-          end
-        end
-
-        sig do
-          override.returns(
-            T::Array[
-              OpenAI::Models::EvalListResponse::TestingCriterion::Variants
-            ]
-          )
-        end
-        def self.variants
-        end
-      end
-    end
-  end
-end

data/rbi/openai/models/eval_retrieve_params.rbi

@@ -1,27 +0,0 @@
-# typed: strong
-
-module OpenAI
-  module Models
-    class EvalRetrieveParams < OpenAI::Internal::Type::BaseModel
-      extend OpenAI::Internal::Type::RequestParameters::Converter
-      include OpenAI::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(OpenAI::EvalRetrieveParams, OpenAI::Internal::AnyHash)
-        end
-
-      sig do
-        params(request_options: OpenAI::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
-      end
-      def self.new(request_options: {})
-      end
-
-      sig { override.returns({ request_options: OpenAI::RequestOptions }) }
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/openai/models/eval_retrieve_response.rbi

@@ -1,332 +0,0 @@
-# typed: strong
-
-module OpenAI
-  module Models
-    class EvalRetrieveResponse < OpenAI::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(OpenAI::Models::EvalRetrieveResponse, OpenAI::Internal::AnyHash)
-        end
-
-      # Unique identifier for the evaluation.
-      sig { returns(String) }
-      attr_accessor :id
-
-      # The Unix timestamp (in seconds) for when the eval was created.
-      sig { returns(Integer) }
-      attr_accessor :created_at
-
-      # Configuration of data sources used in runs of the evaluation.
-      sig do
-        returns(
-          OpenAI::Models::EvalRetrieveResponse::DataSourceConfig::Variants
-        )
-      end
-      attr_accessor :data_source_config
-
-      # Set of 16 key-value pairs that can be attached to an object. This can be useful
-      # for storing additional information about the object in a structured format, and
-      # querying for objects via API or the dashboard.
-      #
-      # Keys are strings with a maximum length of 64 characters. Values are strings with
-      # a maximum length of 512 characters.
-      sig { returns(T.nilable(T::Hash[Symbol, String])) }
-      attr_accessor :metadata
-
-      # The name of the evaluation.
-      sig { returns(String) }
-      attr_accessor :name
-
-      # The object type.
-      sig { returns(Symbol) }
-      attr_accessor :object
-
-      # A list of testing criteria.
-      sig do
-        returns(
-          T::Array[
-            OpenAI::Models::EvalRetrieveResponse::TestingCriterion::Variants
-          ]
-        )
-      end
-      attr_accessor :testing_criteria
-
-      # An Eval object with a data source config and testing criteria. An Eval
-      # represents a task to be done for your LLM integration. Like:
-      #
-      # - Improve the quality of my chatbot
-      # - See how well my chatbot handles customer support
-      # - Check if o4-mini is better at my usecase than gpt-4o
-      sig do
-        params(
-          id: String,
-          created_at: Integer,
-          data_source_config:
-            T.any(
-              OpenAI::EvalCustomDataSourceConfig::OrHash,
-              OpenAI::Models::EvalRetrieveResponse::DataSourceConfig::Logs::OrHash,
-              OpenAI::EvalStoredCompletionsDataSourceConfig::OrHash
-            ),
-          metadata: T.nilable(T::Hash[Symbol, String]),
-          name: String,
-          testing_criteria:
-            T::Array[
-              T.any(
-                OpenAI::Models::Graders::LabelModelGrader::OrHash,
-                OpenAI::Models::Graders::StringCheckGrader::OrHash,
-                OpenAI::Models::EvalRetrieveResponse::TestingCriterion::EvalGraderTextSimilarity::OrHash,
-                OpenAI::Models::EvalRetrieveResponse::TestingCriterion::EvalGraderPython::OrHash,
-                OpenAI::Models::EvalRetrieveResponse::TestingCriterion::EvalGraderScoreModel::OrHash
-              )
-            ],
-          object: Symbol
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Unique identifier for the evaluation.
-        id:,
-        # The Unix timestamp (in seconds) for when the eval was created.
-        created_at:,
-        # Configuration of data sources used in runs of the evaluation.
-        data_source_config:,
-        # Set of 16 key-value pairs that can be attached to an object. This can be useful
-        # for storing additional information about the object in a structured format, and
-        # querying for objects via API or the dashboard.
-        #
-        # Keys are strings with a maximum length of 64 characters. Values are strings with
-        # a maximum length of 512 characters.
-        metadata:,
-        # The name of the evaluation.
-        name:,
-        # A list of testing criteria.
-        testing_criteria:,
-        # The object type.
-        object: :eval
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            created_at: Integer,
-            data_source_config:
-              OpenAI::Models::EvalRetrieveResponse::DataSourceConfig::Variants,
-            metadata: T.nilable(T::Hash[Symbol, String]),
-            name: String,
-            object: Symbol,
-            testing_criteria:
-              T::Array[
-                OpenAI::Models::EvalRetrieveResponse::TestingCriterion::Variants
-              ]
-          }
-        )
-      end
-      def to_hash
-      end
-
-      # Configuration of data sources used in runs of the evaluation.
-      module DataSourceConfig
-        extend OpenAI::Internal::Type::Union
-
-        Variants =
-          T.type_alias do
-            T.any(
-              OpenAI::EvalCustomDataSourceConfig,
-              OpenAI::Models::EvalRetrieveResponse::DataSourceConfig::Logs,
-              OpenAI::EvalStoredCompletionsDataSourceConfig
-            )
-          end
-
-        class Logs < OpenAI::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                OpenAI::Models::EvalRetrieveResponse::DataSourceConfig::Logs,
-                OpenAI::Internal::AnyHash
-              )
-            end
-
-          # The json schema for the run data source items. Learn how to build JSON schemas
-          # [here](https://json-schema.org/).
-          sig { returns(T::Hash[Symbol, T.anything]) }
-          attr_accessor :schema
-
-          # The type of data source. Always `logs`.
-          sig { returns(Symbol) }
-          attr_accessor :type
-
-          # Set of 16 key-value pairs that can be attached to an object. This can be useful
-          # for storing additional information about the object in a structured format, and
-          # querying for objects via API or the dashboard.
-          #
-          # Keys are strings with a maximum length of 64 characters. Values are strings with
-          # a maximum length of 512 characters.
-          sig { returns(T.nilable(T::Hash[Symbol, String])) }
-          attr_accessor :metadata
-
-          # A LogsDataSourceConfig which specifies the metadata property of your logs query.
-          # This is usually metadata like `usecase=chatbot` or `prompt-version=v2`, etc. The
-          # schema returned by this data source config is used to defined what variables are
-          # available in your evals. `item` and `sample` are both defined when using this
-          # data source config.
-          sig do
-            params(
-              schema: T::Hash[Symbol, T.anything],
-              metadata: T.nilable(T::Hash[Symbol, String]),
-              type: Symbol
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # The json schema for the run data source items. Learn how to build JSON schemas
-            # [here](https://json-schema.org/).
-            schema:,
-            # Set of 16 key-value pairs that can be attached to an object. This can be useful
-            # for storing additional information about the object in a structured format, and
-            # querying for objects via API or the dashboard.
-            #
-            # Keys are strings with a maximum length of 64 characters. Values are strings with
-            # a maximum length of 512 characters.
-            metadata: nil,
-            # The type of data source. Always `logs`.
-            type: :logs
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                schema: T::Hash[Symbol, T.anything],
-                type: Symbol,
-                metadata: T.nilable(T::Hash[Symbol, String])
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-
-        sig do
-          override.returns(
-            T::Array[
-              OpenAI::Models::EvalRetrieveResponse::DataSourceConfig::Variants
-            ]
-          )
-        end
-        def self.variants
-        end
-      end
-
-      # A LabelModelGrader object which uses a model to assign labels to each item in
-      # the evaluation.
-      module TestingCriterion
-        extend OpenAI::Internal::Type::Union
-
-        Variants =
-          T.type_alias do
-            T.any(
-              OpenAI::Models::Graders::LabelModelGrader,
-              OpenAI::Models::Graders::StringCheckGrader,
-              OpenAI::Models::EvalRetrieveResponse::TestingCriterion::EvalGraderTextSimilarity,
-              OpenAI::Models::EvalRetrieveResponse::TestingCriterion::EvalGraderPython,
-              OpenAI::Models::EvalRetrieveResponse::TestingCriterion::EvalGraderScoreModel
-            )
-          end
-
-        class EvalGraderTextSimilarity < OpenAI::Models::Graders::TextSimilarityGrader
-          OrHash =
-            T.type_alias do
-              T.any(
-                OpenAI::Models::EvalRetrieveResponse::TestingCriterion::EvalGraderTextSimilarity,
-                OpenAI::Internal::AnyHash
-              )
-            end
-
-          # The threshold for the score.
-          sig { returns(Float) }
-          attr_accessor :pass_threshold
-
-          # A TextSimilarityGrader object which grades text based on similarity metrics.
-          sig { params(pass_threshold: Float).returns(T.attached_class) }
-          def self.new(
-            # The threshold for the score.
-            pass_threshold:
-          )
-          end
-
-          sig { override.returns({ pass_threshold: Float }) }
-          def to_hash
-          end
-        end
-
-        class EvalGraderPython < OpenAI::Models::Graders::PythonGrader
-          OrHash =
-            T.type_alias do
-              T.any(
-                OpenAI::Models::EvalRetrieveResponse::TestingCriterion::EvalGraderPython,
-                OpenAI::Internal::AnyHash
-              )
-            end
-
-          # The threshold for the score.
-          sig { returns(T.nilable(Float)) }
-          attr_reader :pass_threshold
-
-          sig { params(pass_threshold: Float).void }
-          attr_writer :pass_threshold
-
-          # A PythonGrader object that runs a python script on the input.
-          sig { params(pass_threshold: Float).returns(T.attached_class) }
-          def self.new(
-            # The threshold for the score.
-            pass_threshold: nil
-          )
-          end
-
-          sig { override.returns({ pass_threshold: Float }) }
-          def to_hash
-          end
-        end
-
-        class EvalGraderScoreModel < OpenAI::Models::Graders::ScoreModelGrader
-          OrHash =
-            T.type_alias do
-              T.any(
-                OpenAI::Models::EvalRetrieveResponse::TestingCriterion::EvalGraderScoreModel,
-                OpenAI::Internal::AnyHash
-              )
-            end
-
-          # The threshold for the score.
-          sig { returns(T.nilable(Float)) }
-          attr_reader :pass_threshold
-
-          sig { params(pass_threshold: Float).void }
-          attr_writer :pass_threshold
-
-          # A ScoreModelGrader object that uses a model to assign a score to the input.
-          sig { params(pass_threshold: Float).returns(T.attached_class) }
-          def self.new(
-            # The threshold for the score.
-            pass_threshold: nil
-          )
-          end
-
-          sig { override.returns({ pass_threshold: Float }) }
-          def to_hash
-          end
-        end
-
-        sig do
-          override.returns(
-            T::Array[
-              OpenAI::Models::EvalRetrieveResponse::TestingCriterion::Variants
-            ]
-          )
-        end
-        def self.variants
-        end
-      end
-    end
-  end
-end