Actions21
- Azure OpenAI Actions
- Batch API Actions
- Content Safety Actions
- Document Intelligence Actions
- Language Actions
- Speech Actions
- Translator Actions
- Vision Actions
Batch API → Poll Batch
AI-generatedSummary
Poll a previously started Azure OpenAI batch job by its Batch ID until the job reaches a terminal status (completed, failed, expired, or cancelled), retrieving the current status and details of the batch job.
Inputs
- Authentication (required) — Select the authentication method to use: either API Key for Azure resource API key or Entra ID (OAuth2) for Microsoft Entra ID OAuth2 integration.
- Batch ID (required) — The unique identifier of the batch job to poll, which is returned by the Start Batch operation.
- Polling Interval (Seconds) — Seconds to wait between each status check; defaults to 10 seconds and must be between 1 and 300 seconds.
Output shape
A single JSON object representing the polled batch job status and details.
The operation continuously polls the Azure OpenAI batch job endpoint at the specified interval until the batch job status is one of: 'completed', 'failed', 'expired', or 'cancelled'. The output includes the batch job's current status, and when completed, it provides details such as the output file ID. The node does not return binary data for this operation.
Examples
Example 1: Polling a Batch Job Until Completion
Provide the Batch ID of the job started previously and optionally adjust the polling interval to control how frequently the node checks the job status. The node will wait and poll repeatedly until the batch job finishes or fails, then outputs the final status and details.