Class: OpenAI::Resources::Batches

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/batches.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Batches

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Batches.

Parameters:



104
105
106
 
# File 'lib/openai/resources/batches.rb', line 104

def initialize(client:)
  @client = client
end

Instance Method Details

#cancel(batch_id, request_options: {}) ⇒ OpenAI::Models::Batch

Cancels an in-progress batch. The batch will be in status cancelling for up to 10 minutes, before changing to cancelled, where it will have partial results (if any) available in the output file.

Parameters:

  • batch_id (String) —

    The ID of the batch to cancel.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



92
93
94
95
96
97
98
99
 
# File 'lib/openai/resources/batches.rb', line 92

def cancel(batch_id, params = {})
  @client.request(
    method: :post,
    path: ["batches/%1$s/cancel", batch_id],
    model: OpenAI::Batch,
    options: params[:request_options]
  )
end

#create(completion_window: , endpoint: , input_file_id: , metadata: nil, request_options: {}) ⇒ OpenAI::Models::Batch

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

Creates and executes a batch from an uploaded file of requests

Parameters:

  • completion_window (Symbol, OpenAI::Models::BatchCreateParams::CompletionWindow) —

    The time frame within which the batch should be processed. Currently only 24h

  • endpoint (Symbol, OpenAI::Models::BatchCreateParams::Endpoint) —

    The endpoint to be used for all requests in the batch. Currently /v1/responses

  • input_file_id (String) —

    The ID of an uploaded file that contains requests for the new batch.

  • metadata (Hash{Symbol=>String}, nil) —

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

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



26
27
28
29
 
# File 'lib/openai/resources/batches.rb', line 26

def create(params)
  parsed, options = OpenAI::BatchCreateParams.dump_request(params)
  @client.request(method: :post, path: "batches", body: parsed, model: OpenAI::Batch, options: options)
end

#list(after: nil, limit: nil, request_options: {}) ⇒ OpenAI::Internal::CursorPage<OpenAI::Models::Batch>

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

List your organization's batches.

Parameters:

  • after (String) —

    A cursor for use in pagination. after is an object ID that defines your place

  • limit (Integer) —

    A limit on the number of objects to be returned. Limit can range between 1 and 1

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/openai/resources/batches.rb', line 67

def list(params = {})
  parsed, options = OpenAI::BatchListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "batches",
    query: parsed,
    page: OpenAI::Internal::CursorPage,
    model: OpenAI::Batch,
    options: options
  )
end

#retrieve(batch_id, request_options: {}) ⇒ OpenAI::Models::Batch

Retrieves a batch.

Parameters:

  • batch_id (String) —

    The ID of the batch to retrieve.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



42
43
44
45
46
47
48
49
 
# File 'lib/openai/resources/batches.rb', line 42

def retrieve(batch_id, params = {})
  @client.request(
    method: :get,
    path: ["batches/%1$s", batch_id],
    model: OpenAI::Batch,
    options: params[:request_options]
  )
end