Skip to content

Latest commit

 

History

History
53 lines (39 loc) · 1.69 KB

batch.md

File metadata and controls

53 lines (39 loc) · 1.69 KB
page_title subcategory description
openai_batch Data Source - terraform-provider-openai

openai_batch (Data Source)

Example Usage

# Fetch a specific batch job by ID
data "openai_batch" "embeddings_batch" {
  batch_id = "batch_abc123"
}

# Output batch job details
output "batch_status" {
  value = data.openai_batch.embeddings_batch.status
}

Schema

Required

  • batch_id (String) The ID of the batch job to retrieve

Optional

  • project_id (String) The ID of the project associated with the batch job. If not specified, the API key's default project will be used.

Read-Only

  • completed_at (Number) The timestamp when the batch job completed
  • completion_window (String) The time window specified for batch completion
  • created_at (Number) The timestamp when the batch job was created
  • endpoint (String) The endpoint used for the batch request (e.g., '/v1/chat/completions')
  • error (String) Information about errors that occurred during processing
  • error_file_id (String) The ID of the error file (if available)
  • expires_at (Number) The timestamp when the batch job expires
  • id (String) The ID of this resource.
  • in_progress_at (Number) The timestamp when the batch job began processing
  • input_file_id (String) The ID of the input file used for the batch
  • metadata (Map of String) Custom metadata attached to the batch job
  • output_file_id (String) The ID of the output file (if available)
  • request_counts (Map of Number) Statistics about request processing
  • status (String) The current status of the batch job