`experimental_listBatches()`
experimental_listBatches()
경고: 배치 지원은 실험적이며 API가 patch 릴리스에서 바뀔 수 있어요.
한 페이지 분량의 비동기 배치와 그 최신 정규화 상태를 나열해요. 배치 수명주기에 대한 전체 가이드는 Batch를 참고하세요.
import { experimental_listBatches as listBatches } from 'ai';
const page = await listBatches({
provider,
limit: 20,
cursor,
});
console.log(page.batches, page.nextCursor);
출처: 문서
본문
Import
import { experimental_listBatches } from "ai"
API 시그니처 (API Signature)
파라미터 (Parameters)
| 이름 | 타입 | 선택 | 설명 |
|---|---|---|---|
provider |
Experimental_BatchProvider |
선택 | 배치를 나열할 provider. 기본값은 전역 provider, 또는 전역 provider가 없으면 AI Gateway. |
limit |
number |
선택 | 이 페이지에서 반환할 최대 배치 수. |
cursor |
string |
선택 | 이전 목록 연산이 nextCursor로 반환한 불투명 커서. |
providerOptions |
ProviderOptions |
선택 | 배치 나열용 추가 provider별 옵션. |
maxRetries |
number |
선택 | 배치 나열의 최대 재시도 횟수. 0으로 설정하면 재시도 비활성화. 기본값: 2. |
abortSignal |
AbortSignal |
선택 | 요청을 취소하는 선택적 abort 신호. |
timeout |
number | { totalMs?: number } |
선택 | 나열 요청에 허용되는 최대 시간. |
headers |
Record<string, string | undefined> |
선택 | 요청용 추가 HTTP 헤더. |
반환 (Returns)
| 이름 | 타입 | 설명 |
|---|---|---|
batches |
Array<Experimental_Batch> |
이 페이지의 배치. 각 항목은 직렬화 가능한 배치 참조와 최신 정규화 상태를 담아요. |
nextCursor |
string |
선택 |
providerMetadata |
ProviderMetadata |
선택 |
배치 나열을 지원하지 않는 provider로 이 함수를 호출하면 UnsupportedFunctionalityError가 throw돼요.