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

openai 0.92.0 → 0.94.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/beta/threads/runs/code_interpreter_tool_call_delta.rbs CHANGED Viewed

@@ -12,20 +12,36 @@ module OpenAI
             }
           class CodeInterpreterToolCallDelta < OpenAI::Internal::Type::BaseModel
+            # The index of the tool call in the tool calls array.
             attr_accessor index: Integer
+            # The type of tool call. This is always going to be `code_interpreter` for this
+            # type of tool call.
             attr_accessor type: :code_interpreter
+            # The ID of the tool call.
             attr_reader id: String?
+            # The ID of the tool call.
             def id=: (String) -> String
+            # The Code Interpreter tool call definition.
             attr_reader code_interpreter: OpenAI::Beta::Threads::Runs::CodeInterpreterToolCallDelta::CodeInterpreter?
+            # The Code Interpreter tool call definition.
             def code_interpreter=: (
               OpenAI::Beta::Threads::Runs::CodeInterpreterToolCallDelta::CodeInterpreter
             ) -> OpenAI::Beta::Threads::Runs::CodeInterpreterToolCallDelta::CodeInterpreter
+            # @param index
+            #   The index of the tool call in the tool calls array.
+            # @param id
+            #   The ID of the tool call.
+            # @param code_interpreter
+            #   The Code Interpreter tool call definition.
+            # @param type
+            #   The type of tool call. This is always going to be `code_interpreter` for this
+            #   type of tool call.
             def initialize: (
               index: Integer,
               ?id: String,
@@ -47,16 +63,30 @@ module OpenAI
               }
             class CodeInterpreter < OpenAI::Internal::Type::BaseModel
+              # The input to the Code Interpreter tool call.
               attr_reader input: String?
+              # The input to the Code Interpreter tool call.
               def input=: (String) -> String
+              # The outputs from the Code Interpreter tool call. Code Interpreter can output one
+              # or more items, including text (`logs`) or images (`image`). Each of these are
+              # represented by a different object type.
               attr_reader outputs: ::Array[OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCallDelta::CodeInterpreter::output]?
+              # The outputs from the Code Interpreter tool call. Code Interpreter can output one
+              # or more items, including text (`logs`) or images (`image`). Each of these are
+              # represented by a different object type.
               def outputs=: (
                 ::Array[OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCallDelta::CodeInterpreter::output]
               ) -> ::Array[OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCallDelta::CodeInterpreter::output]
+              # @param input
+              #   The input to the Code Interpreter tool call.
+              # @param outputs
+              #   The outputs from the Code Interpreter tool call. Code Interpreter can output one
+              #   or more items, including text (`logs`) or images (`image`). Each of these are
+              #   represented by a different object type.
               def initialize: (
                 ?input: String,
                 ?outputs: ::Array[OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCallDelta::CodeInterpreter::output]

data/sig/openai/models/beta/threads/runs/file_search_tool_call.rbs CHANGED Viewed

@@ -11,12 +11,23 @@ module OpenAI
             }
           class FileSearchToolCall < OpenAI::Internal::Type::BaseModel
+            # The ID of the tool call object.
             attr_accessor id: String
+            # For now, this is always going to be an empty object.
             attr_accessor file_search: OpenAI::Beta::Threads::Runs::FileSearchToolCall::FileSearch
+            # The type of tool call. This is always going to be `file_search` for this type of
+            # tool call.
             attr_accessor type: :file_search
+            # @param id
+            #   The ID of the tool call object.
+            # @param file_search
+            #   For now, this is always going to be an empty object.
+            # @param type
+            #   The type of tool call. This is always going to be `file_search` for this type of
+            #   tool call.
             def initialize: (
               id: String,
               file_search: OpenAI::Beta::Threads::Runs::FileSearchToolCall::FileSearch,
@@ -36,18 +47,26 @@ module OpenAI
               }
             class FileSearch < OpenAI::Internal::Type::BaseModel
+              # The ranking options for the file search.
               attr_reader ranking_options: OpenAI::Beta::Threads::Runs::FileSearchToolCall::FileSearch::RankingOptions?
+              # The ranking options for the file search.
               def ranking_options=: (
                 OpenAI::Beta::Threads::Runs::FileSearchToolCall::FileSearch::RankingOptions
               ) -> OpenAI::Beta::Threads::Runs::FileSearchToolCall::FileSearch::RankingOptions
+              # The results of the file search.
               attr_reader results: ::Array[OpenAI::Beta::Threads::Runs::FileSearchToolCall::FileSearch::Result]?
+              # The results of the file search.
               def results=: (
                 ::Array[OpenAI::Beta::Threads::Runs::FileSearchToolCall::FileSearch::Result]
               ) -> ::Array[OpenAI::Beta::Threads::Runs::FileSearchToolCall::FileSearch::Result]
+              # @param ranking_options
+              #   The ranking options for the file search.
+              # @param results
+              #   The results of the file search.
               def initialize: (
                 ?ranking_options: OpenAI::Beta::Threads::Runs::FileSearchToolCall::FileSearch::RankingOptions,
                 ?results: ::Array[OpenAI::Beta::Threads::Runs::FileSearchToolCall::FileSearch::Result]
@@ -65,10 +84,20 @@ module OpenAI
                 }
               class RankingOptions < OpenAI::Internal::Type::BaseModel
+                # The ranker to use for the file search. If not specified will use the `auto`
+                # ranker.
                 attr_accessor ranker: OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall::FileSearch::RankingOptions::ranker
+                # The score threshold for the file search. All values must be a floating point
+                # number between 0 and 1.
                 attr_accessor score_threshold: Float
+                # @param ranker
+                #   The ranker to use for the file search. If not specified will use the `auto`
+                #   ranker.
+                # @param score_threshold
+                #   The score threshold for the file search. All values must be a floating point
+                #   number between 0 and 1.
                 def initialize: (
                   ranker: OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall::FileSearch::RankingOptions::ranker,
                   score_threshold: Float
@@ -100,18 +129,36 @@ module OpenAI
                 }
               class Result < OpenAI::Internal::Type::BaseModel
+                # The ID of the file that result was found in.
                 attr_accessor file_id: String
+                # The name of the file that result was found in.
                 attr_accessor file_name: String
+                # The score of the result. All values must be a floating point number between 0
+                # and 1.
                 attr_accessor score: Float
+                # The content of the result that was found. The content is only included if
+                # requested via the include query parameter.
                 attr_reader content: ::Array[OpenAI::Beta::Threads::Runs::FileSearchToolCall::FileSearch::Result::Content]?
+                # The content of the result that was found. The content is only included if
+                # requested via the include query parameter.
                 def content=: (
                   ::Array[OpenAI::Beta::Threads::Runs::FileSearchToolCall::FileSearch::Result::Content]
                 ) -> ::Array[OpenAI::Beta::Threads::Runs::FileSearchToolCall::FileSearch::Result::Content]
+                # @param file_id
+                #   The ID of the file that result was found in.
+                # @param file_name
+                #   The name of the file that result was found in.
+                # @param score
+                #   The score of the result. All values must be a floating point number between 0
+                #   and 1.
+                # @param content
+                #   The content of the result that was found. The content is only included if
+                #   requested via the include query parameter.
                 def initialize: (
                   file_id: String,
                   file_name: String,
@@ -133,16 +180,24 @@ module OpenAI
                   }
                 class Content < OpenAI::Internal::Type::BaseModel
+                  # The text content of the file.
                   attr_reader text: String?
+                  # The text content of the file.
                   def text=: (String) -> String
+                  # The type of the content.
                   attr_reader type: OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall::FileSearch::Result::Content::type_?
+                  # The type of the content.
                   def type=: (
                     OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall::FileSearch::Result::Content::type_
                   ) -> OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall::FileSearch::Result::Content::type_
+                  # @param text
+                  #   The text content of the file.
+                  # @param type
+                  #   The type of the content.
                   def initialize: (
                     ?text: String,
                     ?type: OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall::FileSearch::Result::Content::type_

data/sig/openai/models/beta/threads/runs/file_search_tool_call_delta.rbs CHANGED Viewed

@@ -12,16 +12,31 @@ module OpenAI
             }
           class FileSearchToolCallDelta < OpenAI::Internal::Type::BaseModel
+            # For now, this is always going to be an empty object.
             attr_accessor file_search: top
+            # The index of the tool call in the tool calls array.
             attr_accessor index: Integer
+            # The type of tool call. This is always going to be `file_search` for this type of
+            # tool call.
             attr_accessor type: :file_search
+            # The ID of the tool call object.
             attr_reader id: String?
+            # The ID of the tool call object.
             def id=: (String) -> String
+            # @param file_search
+            #   For now, this is always going to be an empty object.
+            # @param index
+            #   The index of the tool call in the tool calls array.
+            # @param id
+            #   The ID of the tool call object.
+            # @param type
+            #   The type of tool call. This is always going to be `file_search` for this type of
+            #   tool call.
             def initialize: (
               file_search: top,
               index: Integer,

data/sig/openai/models/beta/threads/runs/function_tool_call.rbs CHANGED Viewed

@@ -11,12 +11,23 @@ module OpenAI
             }
           class FunctionToolCall < OpenAI::Internal::Type::BaseModel
+            # The ID of the tool call object.
             attr_accessor id: String
+            # The definition of the function that was called.
             attr_accessor function: OpenAI::Beta::Threads::Runs::FunctionToolCall::Function
+            # The type of tool call. This is always going to be `function` for this type of
+            # tool call.
             attr_accessor type: :function
+            # @param id
+            #   The ID of the tool call object.
+            # @param function
+            #   The definition of the function that was called.
+            # @param type
+            #   The type of tool call. This is always going to be `function` for this type of
+            #   tool call.
             def initialize: (
               id: String,
               function: OpenAI::Beta::Threads::Runs::FunctionToolCall::Function,
@@ -32,12 +43,23 @@ module OpenAI
             type function = { arguments: String, name: String, output: String? }
             class Function < OpenAI::Internal::Type::BaseModel
+              # The arguments passed to the function.
               attr_accessor arguments: String
+              # The name of the function.
               attr_accessor name: String
+              # The output of the function. This will be `null` if the outputs have not been
+              # [submitted](https://developers.openai.com/api/docs/assistants/migration) yet.
               attr_accessor output: String?
+              # @param arguments
+              #   The arguments passed to the function.
+              # @param name
+              #   The name of the function.
+              # @param output
+              #   The output of the function. This will be `null` if the outputs have not been
+              #   [submitted](https://developers.openai.com/api/docs/assistants/migration) yet.
               def initialize: (
                 arguments: String,
                 name: String,

data/sig/openai/models/beta/threads/runs/function_tool_call_delta.rbs CHANGED Viewed

@@ -12,20 +12,36 @@ module OpenAI
             }
           class FunctionToolCallDelta < OpenAI::Internal::Type::BaseModel
+            # The index of the tool call in the tool calls array.
             attr_accessor index: Integer
+            # The type of tool call. This is always going to be `function` for this type of
+            # tool call.
             attr_accessor type: :function
+            # The ID of the tool call object.
             attr_reader id: String?
+            # The ID of the tool call object.
             def id=: (String) -> String
+            # The definition of the function that was called.
             attr_reader function: OpenAI::Beta::Threads::Runs::FunctionToolCallDelta::Function?
+            # The definition of the function that was called.
             def function=: (
               OpenAI::Beta::Threads::Runs::FunctionToolCallDelta::Function
             ) -> OpenAI::Beta::Threads::Runs::FunctionToolCallDelta::Function
+            # @param index
+            #   The index of the tool call in the tool calls array.
+            # @param id
+            #   The ID of the tool call object.
+            # @param function
+            #   The definition of the function that was called.
+            # @param type
+            #   The type of tool call. This is always going to be `function` for this type of
+            #   tool call.
             def initialize: (
               index: Integer,
               ?id: String,
@@ -44,16 +60,29 @@ module OpenAI
               { ?arguments: String, ?name: String, ?output: String? }
             class Function < OpenAI::Internal::Type::BaseModel
+              # The arguments passed to the function.
               attr_reader arguments: String?
+              # The arguments passed to the function.
               def arguments=: (String) -> String
+              # The name of the function.
               attr_reader name: String?
+              # The name of the function.
               def name=: (String) -> String
+              # The output of the function. This will be `null` if the outputs have not been
+              # [submitted](https://developers.openai.com/api/docs/assistants/migration) yet.
               attr_accessor output: String?
+              # @param arguments
+              #   The arguments passed to the function.
+              # @param name
+              #   The name of the function.
+              # @param output
+              #   The output of the function. This will be `null` if the outputs have not been
+              #   [submitted](https://developers.openai.com/api/docs/assistants/migration) yet.
               def initialize: (
                 ?arguments: String,
                 ?name: String,

data/sig/openai/models/beta/threads/runs/message_creation_step_details.rbs CHANGED Viewed

@@ -12,8 +12,11 @@ module OpenAI
           class MessageCreationStepDetails < OpenAI::Internal::Type::BaseModel
             attr_accessor message_creation: OpenAI::Beta::Threads::Runs::MessageCreationStepDetails::MessageCreation
+            # Always `message_creation`.
             attr_accessor type: :message_creation
+            # @param type
+            #   Always `message_creation`.
             def initialize: (
               message_creation: OpenAI::Beta::Threads::Runs::MessageCreationStepDetails::MessageCreation,
               ?type: :message_creation
@@ -27,8 +30,11 @@ module OpenAI
             type message_creation = { message_id: String }
             class MessageCreation < OpenAI::Internal::Type::BaseModel
+              # The ID of the message that was created by this run step.
               attr_accessor message_id: String
+              # @param message_id
+              #   The ID of the message that was created by this run step.
               def initialize: (message_id: String) -> void
               def to_hash: -> { message_id: String }

data/sig/openai/models/beta/threads/runs/run_step.rbs CHANGED Viewed

@@ -26,38 +26,114 @@ module OpenAI
             }
           class RunStep < OpenAI::Internal::Type::BaseModel
+            # The identifier of the run step, which can be referenced in API endpoints.
             attr_accessor id: String
+            # The ID of the
+            # [assistant](https://developers.openai.com/api/docs/assistants/migration)
+            # associated with the run step.
             attr_accessor assistant_id: String
+            # The Unix timestamp (in seconds) for when the run step was cancelled.
             attr_accessor cancelled_at: Integer?
+            # The Unix timestamp (in seconds) for when the run step completed.
             attr_accessor completed_at: Integer?
+            # The Unix timestamp (in seconds) for when the run step was created.
             attr_accessor created_at: Integer
+            # The Unix timestamp (in seconds) for when the run step expired. A step is
+            # considered expired if the parent run is expired.
             attr_accessor expired_at: Integer?
+            # The Unix timestamp (in seconds) for when the run step failed.
             attr_accessor failed_at: Integer?
+            # The last error associated with this run step. Will be `null` if there are no
+            # errors.
             attr_accessor last_error: OpenAI::Beta::Threads::Runs::RunStep::LastError?
+            # 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.
             attr_accessor metadata: OpenAI::Models::metadata?
+            # The object type, which is always `thread.run.step`.
             attr_accessor object: :"thread.run.step"
+            # The ID of the [run](https://developers.openai.com/api/docs/assistants/migration)
+            # that this run step is a part of.
             attr_accessor run_id: String
+            # The status of the run step, which can be either `in_progress`, `cancelled`,
+            # `failed`, `completed`, or `expired`.
             attr_accessor status: OpenAI::Models::Beta::Threads::Runs::RunStep::status
+            # The details of the run step.
             attr_accessor step_details: OpenAI::Models::Beta::Threads::Runs::RunStep::step_details
+            # The ID of the
+            # [thread](https://developers.openai.com/api/docs/assistants/migration) that was
+            # run.
             attr_accessor thread_id: String
+            # The type of run step, which can be either `message_creation` or `tool_calls`.
             attr_accessor type: OpenAI::Models::Beta::Threads::Runs::RunStep::type_
+            # Usage statistics related to the run step. This value will be `null` while the
+            # run step's status is `in_progress`.
             attr_accessor usage: OpenAI::Beta::Threads::Runs::RunStep::Usage?
+            # @param id
+            #   The identifier of the run step, which can be referenced in API endpoints.
+            # @param assistant_id
+            #   The ID of the
+            #   [assistant](https://developers.openai.com/api/docs/assistants/migration)
+            #   associated with the run step.
+            # @param cancelled_at
+            #   The Unix timestamp (in seconds) for when the run step was cancelled.
+            # @param completed_at
+            #   The Unix timestamp (in seconds) for when the run step completed.
+            # @param created_at
+            #   The Unix timestamp (in seconds) for when the run step was created.
+            # @param expired_at
+            #   The Unix timestamp (in seconds) for when the run step expired. A step is
+            #   considered expired if the parent run is expired.
+            # @param failed_at
+            #   The Unix timestamp (in seconds) for when the run step failed.
+            # @param last_error
+            #   The last error associated with this run step. Will be `null` if there are no
+            #   errors.
+            # @param metadata
+            #   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.
+            # @param run_id
+            #   The ID of the [run](https://developers.openai.com/api/docs/assistants/migration)
+            #   that this run step is a part of.
+            # @param status
+            #   The status of the run step, which can be either `in_progress`, `cancelled`,
+            #   `failed`, `completed`, or `expired`.
+            # @param step_details
+            #   The details of the run step.
+            # @param thread_id
+            #   The ID of the
+            #   [thread](https://developers.openai.com/api/docs/assistants/migration) that was
+            #   run.
+            # @param type
+            #   The type of run step, which can be either `message_creation` or `tool_calls`.
+            # @param usage
+            #   Usage statistics related to the run step. This value will be `null` while the
+            #   run step's status is `in_progress`.
+            # @param object
+            #   The object type, which is always `thread.run.step`.
             def initialize: (
               id: String,
               assistant_id: String,
@@ -103,10 +179,16 @@ module OpenAI
               }
             class LastError < OpenAI::Internal::Type::BaseModel
+              # One of `server_error` or `rate_limit_exceeded`.
               attr_accessor code: OpenAI::Models::Beta::Threads::Runs::RunStep::LastError::code
+              # A human-readable description of the error.
               attr_accessor message: String
+              # @param code
+              #   One of `server_error` or `rate_limit_exceeded`.
+              # @param message
+              #   A human-readable description of the error.
               def initialize: (
                 code: OpenAI::Models::Beta::Threads::Runs::RunStep::LastError::code,
                 message: String
@@ -173,12 +255,21 @@ module OpenAI
               }
             class Usage < OpenAI::Internal::Type::BaseModel
+              # Number of completion tokens used over the course of the run step.
               attr_accessor completion_tokens: Integer
+              # Number of prompt tokens used over the course of the run step.
               attr_accessor prompt_tokens: Integer
+              # Total number of tokens used (prompt + completion).
               attr_accessor total_tokens: Integer
+              # @param completion_tokens
+              #   Number of completion tokens used over the course of the run step.
+              # @param prompt_tokens
+              #   Number of prompt tokens used over the course of the run step.
+              # @param total_tokens
+              #   Total number of tokens used (prompt + completion).
               def initialize: (
                 completion_tokens: Integer,
                 prompt_tokens: Integer,

data/sig/openai/models/beta/threads/runs/run_step_delta.rbs CHANGED Viewed

@@ -11,12 +11,16 @@ module OpenAI
             }
           class RunStepDelta < OpenAI::Internal::Type::BaseModel
+            # The details of the run step.
             attr_reader step_details: OpenAI::Models::Beta::Threads::Runs::RunStepDelta::step_details?
+            # The details of the run step.
             def step_details=: (
               OpenAI::Models::Beta::Threads::Runs::RunStepDelta::step_details
             ) -> OpenAI::Models::Beta::Threads::Runs::RunStepDelta::step_details
+            # @param step_details
+            #   The details of the run step.
             def initialize: (
               ?step_details: OpenAI::Models::Beta::Threads::Runs::RunStepDelta::step_details
             ) -> void

data/sig/openai/models/beta/threads/runs/run_step_delta_event.rbs CHANGED Viewed

@@ -13,12 +13,21 @@ module OpenAI
             }
           class RunStepDeltaEvent < OpenAI::Internal::Type::BaseModel
+            # The identifier of the run step, which can be referenced in API endpoints.
             attr_accessor id: String
+            # The delta containing the fields that have changed on the run step.
             attr_accessor delta: OpenAI::Beta::Threads::Runs::RunStepDelta
+            # The object type, which is always `thread.run.step.delta`.
             attr_accessor object: :"thread.run.step.delta"
+            # @param id
+            #   The identifier of the run step, which can be referenced in API endpoints.
+            # @param delta
+            #   The delta containing the fields that have changed on the run step.
+            # @param object
+            #   The object type, which is always `thread.run.step.delta`.
             def initialize: (
               id: String,
               delta: OpenAI::Beta::Threads::Runs::RunStepDelta,

data/sig/openai/models/beta/threads/runs/run_step_delta_message_delta.rbs CHANGED Viewed

@@ -12,6 +12,7 @@ module OpenAI
             }
           class RunStepDeltaMessageDelta < OpenAI::Internal::Type::BaseModel
+            # Always `message_creation`.
             attr_accessor type: :message_creation
             attr_reader message_creation: OpenAI::Beta::Threads::Runs::RunStepDeltaMessageDelta::MessageCreation?
@@ -20,6 +21,8 @@ module OpenAI
               OpenAI::Beta::Threads::Runs::RunStepDeltaMessageDelta::MessageCreation
             ) -> OpenAI::Beta::Threads::Runs::RunStepDeltaMessageDelta::MessageCreation
+            # @param type
+            #   Always `message_creation`.
             def initialize: (
               ?message_creation: OpenAI::Beta::Threads::Runs::RunStepDeltaMessageDelta::MessageCreation,
               ?type: :message_creation
@@ -33,10 +36,14 @@ module OpenAI
             type message_creation = { ?message_id: String }
             class MessageCreation < OpenAI::Internal::Type::BaseModel
+              # The ID of the message that was created by this run step.
               attr_reader message_id: String?
+              # The ID of the message that was created by this run step.
               def message_id=: (String) -> String
+              # @param message_id
+              #   The ID of the message that was created by this run step.
               def initialize: (?message_id: String) -> void
               def to_hash: -> { ?message_id: String }