class

OpenAI::BatchRequestInput

Inherits JSON::Serializable < Reference < Object

The per-line object of the batch input file

Constructors

new(pull : JSON::PullParser)

Source

new(custom_id : String | Nil = nil, method : BatchRequestInputMethod | Nil = nil, url : String | Nil = nil)

Source

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Source

Instance methods

custom_id

A developer-provided per-request id that will be used to match outputs to inputs. Must be unique for each request in a batch.

Source

custom_id=(custom_id : String | Nil)

A developer-provided per-request id that will be used to match outputs to inputs. Must be unique for each request in a batch.

Source

method

The HTTP method to be used for the request. Currently only POST is supported.

Source

method=(method : BatchRequestInputMethod | Nil)

The HTTP method to be used for the request. Currently only POST is supported.

Source

url

The OpenAI API relative URL to be used for the request. Currently /v1/responses, /v1/chat/completions, /v1/embeddings, /v1/completions, and /v1/moderations are supported.

Source

url=(url : String | Nil)

The OpenAI API relative URL to be used for the request. Currently /v1/responses, /v1/chat/completions, /v1/embeddings, /v1/completions, and /v1/moderations are supported.

Source