Struct BatchRequestOutput

pub struct BatchRequestOutput {
    pub custom_id: Option<String>,
    pub error: Option<BatchRequestOutputError>,
    pub id: Option<String>,
    pub response: Option<BatchRequestOutputResponse>,
}

on openapi.yaml

BatchRequestOutput:
  type: object
  description: The per-line object of the batch output and error files
  properties:
    id:
      type: string
    custom_id:
      type: string
      description:
        A developer-provided per-request id that will be used to match
        outputs to inputs.
    response:
      type: object
      nullable: true
      properties:
        status_code:
          type: integer
          description: The HTTP status code of the response
        request_id:
          type: string
          description:
            An unique identifier for the OpenAI API request. Please include
            this request ID when contacting support.
        body:
          type: object
          x-oaiTypeLabel: map
          description: The JSON body of the response
    error:
      type: object
      nullable: true
      description:
        For requests that failed with a non-HTTP error, this will contain
        more information on the cause of the failure.
      properties:
        code:
          type: string
          description: A machine-readable error code.
        message:
          type: string
          description: A human-readable error message.
  x-oaiMeta:
    name: The request output object
    example: >
      {"id": "batch_req_wnaDys", "custom_id": "request-2", "response":
      {"status_code": 200, "request_id": "req_c187b3", "body": {"id":
      "chatcmpl-9758Iw", "object": "chat.completion", "created": 1711475054,
      "model": "gpt-4o-mini", "choices": [{"index": 0, "message": {"role":
      "assistant", "content": "2 + 2 equals 4."}, "finish_reason": "stop"}],
      "usage": {"prompt_tokens": 24, "completion_tokens": 15,
      "total_tokens": 39}, "system_fingerprint": null}}, "error": null}

Fields

custom_id: Option<String>

A developer-provided per-request id that will be used to match outputs to inputs.

error: Option<BatchRequestOutputError>

id: Option<String>

response: Option<BatchRequestOutputResponse>

Trait Implementations

impl Debug for BatchRequestOutput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BatchRequestOutput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BatchRequestOutput

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

where __S: Serializer,

Serialize this value into the given Serde serializer.