Method: OpenAI::Models::Batch#initialize

Defined in:
lib/openai/models/batch.rb

#initialize(id: , completion_window: , created_at: , endpoint: , input_file_id: , status: , cancelled_at: nil, cancelling_at: nil, completed_at: nil, error_file_id: nil, errors: nil, expired_at: nil, expires_at: nil, failed_at: nil, finalizing_at: nil, in_progress_at: nil, metadata: nil, output_file_id: nil, request_counts: nil, object: :batch) ⇒ void

Some parameter documentations has been truncated, see OpenAI::Models::Batch for more details.

Parameters:

  • id (String) (defaults to: )
  • completion_window (String) (defaults to: )

    The time frame within which the batch should be processed.

  • created_at (Integer) (defaults to: )

    The Unix timestamp (in seconds) for when the batch was created.

  • endpoint (String) (defaults to: )

    The OpenAI API endpoint used by the batch.

  • input_file_id (String) (defaults to: )

    The ID of the input file for the batch.

  • status (Symbol, OpenAI::Models::Batch::Status) (defaults to: )

    The current status of the batch.

  • cancelled_at (Integer) (defaults to: nil)

    The Unix timestamp (in seconds) for when the batch was cancelled.

  • cancelling_at (Integer) (defaults to: nil)

    The Unix timestamp (in seconds) for when the batch started cancelling.

  • completed_at (Integer) (defaults to: nil)

    The Unix timestamp (in seconds) for when the batch was completed.

  • error_file_id (String) (defaults to: nil)

    The ID of the file containing the outputs of requests with errors.

  • errors (OpenAI::Models::Batch::Errors) (defaults to: nil)
  • expired_at (Integer) (defaults to: nil)

    The Unix timestamp (in seconds) for when the batch expired.

  • expires_at (Integer) (defaults to: nil)

    The Unix timestamp (in seconds) for when the batch will expire.

  • failed_at (Integer) (defaults to: nil)

    The Unix timestamp (in seconds) for when the batch failed.

  • finalizing_at (Integer) (defaults to: nil)

    The Unix timestamp (in seconds) for when the batch started finalizing.

  • in_progress_at (Integer) (defaults to: nil)

    The Unix timestamp (in seconds) for when the batch started processing.

  • metadata (Hash{Symbol=>String}, nil) (defaults to: nil)

    Set of 16 key-value pairs that can be attached to an object. This can be

  • output_file_id (String) (defaults to: nil)

    The ID of the file containing the outputs of successfully executed requests.

  • request_counts (OpenAI::Models::BatchRequestCounts) (defaults to: nil)

    The request counts for different statuses within the batch.

  • object (Symbol, :batch) (defaults to: :batch)

    The object type, which is always batch.



# File 'lib/openai/models/batch.rb', line 130