`experimental_cancelBatch()`

경고: 배치 지원은 실험적이며 API가 patch 릴리스에서 바뀔 수 있어요.

비동기 배치의 취소를 요청해요. 성공적인 호출은 provider가 취소 요청을 수락했다는 뜻이지, 취소가 끝났다는 뜻은 아니에요. 배치 수명주기에 대한 전체 가이드는 Batch를 참고하세요.

import { experimental_cancelBatch as cancelBatch } from 'ai';

const result = await cancelBatch({
  provider,
  batch,
});

console.log(result.providerMetadata);

출처: 문서

본문

Import

import { experimental_cancelBatch } from "ai"

API 시그니처 (API Signature)

파라미터 (Parameters)

이름	타입	선택	설명
`provider`	`Experimental_BatchProvider`	선택	배치 접근에 사용한 provider. 기본값은 전역 provider, 또는 전역 provider가 없으면 AI Gateway.
`batch`	`Experimental_BatchReference`		`experimental_startBatch`가 반환한 직렬화 가능한 참조.
`providerOptions`	`ProviderOptions`	선택	취소 요청용 추가 provider별 옵션.
`abortSignal`	`AbortSignal`	선택	API 요청을 취소하는 선택적 abort 신호.
`timeout`	`number \| { totalMs?: number }`	선택	취소 요청에 허용되는 최대 시간.
`headers`	`Record<string, string \| undefined>`	선택	요청용 추가 HTTP 헤더.

반환 (Returns)

이름	타입	설명
`providerMetadata`	`ProviderMetadata`	선택

배치 취소를 지원하지 않는 provider로 이 함수를 호출하면 UnsupportedFunctionalityError가 throw돼요.

`experimental_cancelBatch()`

experimental_cancelBatch()

본문

Import

API 시그니처 (API Signature)

파라미터 (Parameters)

반환 (Returns)

더 알아보기 (Learn more)

`experimental_cancelBatch()`