class Anthropic::Resources::Beta::Messages::Batches

def cancel(message_batch_id, params = {})

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

Returns:
  • (Anthropic::Models::Beta::Messages::BetaMessageBatch) -

Parameters:
  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • betas (Array) -- Optional header to specify the beta version(s) you want to use.
  • message_batch_id (String) -- ID of the Message Batch.

Overloads:
  • cancel(message_batch_id, betas: nil, request_options: {}) 
def cancel(message_batch_id, params = {})
  parsed, options = Anthropic::Beta::Messages::BatchCancelParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/messages/batches/%1$s/cancel?beta=true", message_batch_id],
    headers: parsed.transform_keys(betas: "anthropic-beta"),
    model: Anthropic::Beta::Messages::BetaMessageBatch,
    options: {extra_headers: {"anthropic-beta" => "message-batches-2024-09-24"}, **options}
  )
end

def create(params)

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

Returns:
  • (Anthropic::Models::Beta::Messages::BetaMessageBatch) -

Parameters:
  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • betas (Array) -- Header param: Optional header to specify the beta version(s) you want to use.
  • requests (Array) -- Body param: List of requests for prompt completion. Each is an individual reques

Overloads:
  • create(requests:, betas: nil, request_options: {}) 
def create(params)
  parsed, options = Anthropic::Beta::Messages::BatchCreateParams.dump_request(params)
  header_params = {betas: "anthropic-beta"}
  @client.request(
    method: :post,
    path: "v1/messages/batches?beta=true",
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: Anthropic::Beta::Messages::BetaMessageBatch,
    options: {extra_headers: {"anthropic-beta" => "message-batches-2024-09-24"}, **options}
  )
end

def delete(message_batch_id, params = {})

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

Returns:
  • (Anthropic::Models::Beta::Messages::BetaDeletedMessageBatch) -

Parameters:
  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • betas (Array) -- Optional header to specify the beta version(s) you want to use.
  • message_batch_id (String) -- ID of the Message Batch.

Overloads:
  • delete(message_batch_id, betas: nil, request_options: {}) 
def delete(message_batch_id, params = {})
  parsed, options = Anthropic::Beta::Messages::BatchDeleteParams.dump_request(params)
  @client.request(
    method: :delete,
    path: ["v1/messages/batches/%1$s?beta=true", message_batch_id],
    headers: parsed.transform_keys(betas: "anthropic-beta"),
    model: Anthropic::Beta::Messages::BetaDeletedMessageBatch,
    options: {extra_headers: {"anthropic-beta" => "message-batches-2024-09-24"}, **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::Beta::Messages::BatchListParams -

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

Parameters:
  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • betas (Array) -- Header param: Optional header to specify the beta version(s) you want to use.
  • limit (Integer) -- Query param: Number of items to return per page.
  • before_id (String) -- Query param: ID of the object to use as a cursor for pagination. When provided,
  • after_id (String) -- Query param: ID of the object to use as a cursor for pagination. When provided,

Overloads:
  • list(after_id: nil, before_id: nil, limit: nil, betas: nil, request_options: {}) 
def list(params = {})
  parsed, options = Anthropic::Beta::Messages::BatchListParams.dump_request(params)
  query_params = [:after_id, :before_id, :limit]
  @client.request(
    method: :get,
    path: "v1/messages/batches?beta=true",
    query: parsed.slice(*query_params),
    headers: parsed.except(*query_params).transform_keys(betas: "anthropic-beta"),
    page: Anthropic::Internal::Page,
    model: Anthropic::Beta::Messages::BetaMessageBatch,
    options: {extra_headers: {"anthropic-beta" => "message-batches-2024-09-24"}, **options}
  )
end

def results_streaming(message_batch_id, params = {})

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

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

Parameters:
  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • betas (Array) -- Optional header to specify the beta version(s) you want to use.
  • message_batch_id (String) -- ID of the Message Batch.

Overloads:
  • results_streaming(message_batch_id, betas: nil, request_options: {}) 
def results_streaming(message_batch_id, params = {})
  parsed, options = Anthropic::Beta::Messages::BatchResultsParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["v1/messages/batches/%1$s/results?beta=true", message_batch_id],
    headers: {"accept" => "application/x-jsonl", **parsed}.transform_keys(betas: "anthropic-beta"),
    stream: Anthropic::Internal::JsonLStream,
    model: Anthropic::Beta::Messages::BetaMessageBatchIndividualResponse,
    options: {extra_headers: {"anthropic-beta" => "message-batches-2024-09-24"}, **options}
  )
end

def retrieve(message_batch_id, params = {})

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

Returns:
  • (Anthropic::Models::Beta::Messages::BetaMessageBatch) -

Parameters:
  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • betas (Array) -- Optional header to specify the beta version(s) you want to use.
  • message_batch_id (String) -- ID of the Message Batch.

Overloads:
  • retrieve(message_batch_id, betas: nil, request_options: {}) 
def retrieve(message_batch_id, params = {})
  parsed, options = Anthropic::Beta::Messages::BatchRetrieveParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["v1/messages/batches/%1$s?beta=true", message_batch_id],
    headers: parsed.transform_keys(betas: "anthropic-beta"),
    model: Anthropic::Beta::Messages::BetaMessageBatch,
    options: {extra_headers: {"anthropic-beta" => "message-batches-2024-09-24"}, **options}
  )
end