Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/openai/resources/mod.ts>BatchCreateParams

Deno build of the official Typescript library for the OpenAI API.
Extremely Popular
Go to Latest
interface BatchCreateParams
import { type BatchCreateParams } from "https://deno.land/x/openai@v4.62.1/resources/mod.ts";

Properties

completion_window: "24h"

The time frame within which the batch should be processed. Currently only 24h is supported.

endpoint: "/v1/chat/completions" | "/v1/embeddings" | "/v1/completions"

The endpoint to be used for all requests in the batch. Currently /v1/chat/completions, /v1/embeddings, and /v1/completions are supported. Note that /v1/embeddings batches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch.

input_file_id: string

The ID of an uploaded file that contains requests for the new batch.

See upload file for how to upload a file.

Your input file must be formatted as a JSONL file, and must be uploaded with the purpose batch. The file can contain up to 50,000 requests, and can be up to 100 MB in size.

optional
metadata: Record<string, string> | null

Optional custom metadata for the batch.