`experimental_startBatch()`
experimental_startBatch()
경고: 배치 지원은 실험적이며 API가 patch 릴리스에서 바뀔 수 있어요.
텍스트 또는 이미지 생성 요청의 비동기 배치를 시작해요. 배치 수명주기에 대한 전체 가이드는 Batch를 참고하세요.
import { experimental_startBatch as startBatch } from 'ai';
const batch = await startBatch({
requests: [
{
id: 'france',
type: 'text',
model: 'gpt-5.4-nano',
prompt: 'What is the capital of France?',
},
],
});
출처: 문서
본문
Import
import { experimental_startBatch } from "ai"
API 시그니처 (API Signature)
파라미터 (Parameters)
| 이름 | 타입 | 선택 | 설명 |
|---|---|---|---|
provider |
Experimental_BatchProvider |
선택 | 사용할 provider. 기본값은 전역 provider, 또는 전역 provider가 없으면 AI Gateway. |
requests |
Array<Experimental_BatchRequest> |
처리할 독립 요청. 각 요청은 고유하고 비어 있지 않은 id, 지원되는 타입, 그리고 텍스트 요청의 model·prompt/messages 같은 타입별 속성을 가져야 해요. | |
providerOptions |
ProviderOptions |
선택 | 배치용 추가 provider별 옵션. |
webhookUrl |
string |
선택 | 배치가 종료 상태에 도달할 때 알릴 URL. 지원과 페이로드는 provider별로 달라요. |
abortSignal |
AbortSignal |
선택 | 배치를 시작하는 요청을 취소하는 선택적 abort 신호. |
timeout |
number | { totalMs?: number } |
선택 | 배치 생성 요청에 허용되는 최대 시간. |
headers |
Record<string, string | undefined> |
선택 | 요청용 추가 HTTP 헤더. |
반환 (Returns)
| 이름 | 타입 | 설명 |
|---|---|---|
version |
'2' |
직렬화 가능한 배치 참조의 버전. |
id |
string |
provider 배치 식별자. |
provider |
string |
배치의 provider 식별자. |
status |
'pending' | 'completed' | 'failed' |
초기 정규화 배치 상태. |
rawStatus |
string |
선택 |
requestCounts |
{ total: number; pending: number; completed: number; failed: number } |
선택 |
error |
Experimental_BatchError |
선택 |
createdAt |
string |
선택 |
expiresAt |
string |
선택 |
providerMetadata |
ProviderMetadata |
선택 |
warnings |
Warning[] |