class Anthropic::Resources::Messages::Batches

def cancel(message_batch_id, params = {})

Other tags:
    See: Anthropic::Models::Messages::BatchCancelParams -

Returns:
  • (Anthropic::Models::Messages::MessageBatch) -

Parameters:
  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • message_batch_id (String) -- ID of the Message Batch.

Overloads:
  • cancel(message_batch_id, request_options: {}) 
def cancel(message_batch_id, params = {})
  @client.request(
    method: :post,
    path: ["v1/messages/batches/%1$s/cancel", message_batch_id],
    model: Anthropic::Messages::MessageBatch,
    options: params[:request_options]
  )
end

def create(params)

Other tags:
    See: Anthropic::Models::Messages::BatchCreateParams -

Returns:
  • (Anthropic::Models::Messages::MessageBatch) -

Parameters:
  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • requests (Array) -- List of requests for prompt completion. Each is an individual request to create

Overloads:
  • create(requests:, request_options: {}) 
def create(params)
  parsed, options = Anthropic::Messages::BatchCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v1/messages/batches",
    body: parsed,
    model: Anthropic::Messages::MessageBatch,
    options: options
  )
end

def delete(message_batch_id, params = {})

Other tags:
    See: Anthropic::Models::Messages::BatchDeleteParams -

Returns:
  • (Anthropic::Models::Messages::DeletedMessageBatch) -

Parameters:
  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • message_batch_id (String) -- ID of the Message Batch.

Overloads:
  • delete(message_batch_id, request_options: {}) 
def delete(message_batch_id, params = {})
  @client.request(
    method: :delete,
    path: ["v1/messages/batches/%1$s", message_batch_id],
    model: Anthropic::Messages::DeletedMessageBatch,
    options: params[:request_options]
  )
end

def initialize(client:)

Parameters:
  • client (Anthropic::Client) --

Other tags:
    Api: - private 
def initialize(client:)
  @client = client
end

def list(params = {})

Other tags:
    See: Anthropic::Models::Messages::BatchListParams -

Returns:
  • (Anthropic::Internal::Page) -

Parameters:
  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • limit (Integer) -- Number of items to return per page.
  • before_id (String) -- ID of the object to use as a cursor for pagination. When provided, returns the p
  • after_id (String) -- ID of the object to use as a cursor for pagination. When provided, returns the p

Overloads:
  • list(after_id: nil, before_id: nil, limit: nil, request_options: {}) 
def list(params = {})
  parsed, options = Anthropic::Messages::BatchListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "v1/messages/batches",
    query: parsed,
    page: Anthropic::Internal::Page,
    model: Anthropic::Messages::MessageBatch,
    options: options
  )
end

def results_streaming(message_batch_id, params = {})

Other tags:
    See: Anthropic::Models::Messages::BatchResultsParams -

Returns:
  • (Anthropic::Internal::JsonLStream) -

Parameters:
  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • message_batch_id (String) -- ID of the Message Batch.

Overloads:
  • results_streaming(message_batch_id, request_options: {}) 
def results_streaming(message_batch_id, params = {})
  @client.request(
    method: :get,
    path: ["v1/messages/batches/%1$s/results", message_batch_id],
    headers: {"accept" => "application/x-jsonl"},
    stream: Anthropic::Internal::JsonLStream,
    model: Anthropic::Messages::MessageBatchIndividualResponse,
    options: params[:request_options]
  )
end

def retrieve(message_batch_id, params = {})

Other tags:
    See: Anthropic::Models::Messages::BatchRetrieveParams -

Returns:
  • (Anthropic::Models::Messages::MessageBatch) -

Parameters:
  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • message_batch_id (String) -- ID of the Message Batch.

Overloads:
  • retrieve(message_batch_id, request_options: {}) 
def retrieve(message_batch_id, params = {})
  @client.request(
    method: :get,
    path: ["v1/messages/batches/%1$s", message_batch_id],
    model: Anthropic::Messages::MessageBatch,
    options: params[:request_options]
  )
end