Struct BatchRequestInput

pub struct BatchRequestInput {
    pub custom_id: Option<String>,
    pub method: Option<String>,
    pub url: Option<String>,
}

on openapi.yaml

BatchRequestInput:
  type: object
  description: The per-line object of the batch input file
  properties:
    custom_id:
      type: string
      description:
        A developer-provided per-request id that will be used to match
        outputs to inputs. Must be unique for each request in a batch.
    method:
      type: string
      enum:
        - POST
      description:
        The HTTP method to be used for the request. Currently only `POST`
        is supported.
      x-stainless-const: true
    url:
      type: string
      description:
        The OpenAI API relative URL to be used for the request. Currently
        `/v1/chat/completions`, `/v1/embeddings`, and `/v1/completions` are
        supported.
  x-oaiMeta:
    name: The request input object
    example: >
      {"custom_id": "request-1", "method": "POST", "url":
      "/v1/chat/completions", "body": {"model": "gpt-4o-mini", "messages":
      [{"role": "system", "content": "You are a helpful assistant."},
      {"role": "user", "content": "What is 2+2?"}]}}

Fields

custom_id: Option<String>

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

method: Option<String>

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

url: Option<String>

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

Trait Implementations

impl Debug for BatchRequestInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BatchRequestInput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BatchRequestInput

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.