Table of Contents

Class BatchJob

Namespace
GenerativeAI.Types
Assembly
GenerativeAI.dll

Represents a batch processing job for generating content or embeddings at scale. Batch jobs allow processing large numbers of requests asynchronously.

public class BatchJob
Inheritance
BatchJob
Inherited Members
Extension Methods

Properties

BatchStats

Statistics about the batch job (Google AI only).

[JsonPropertyName("batchStats")]
public BatchStats? BatchStats { get; set; }

Property Value

BatchStats

CreateTime

The time when the BatchJob was created.

[JsonPropertyName("createTime")]
public string? CreateTime { get; set; }

Property Value

string

Destination

Configuration for the output data destination.

[JsonPropertyName("dest")]
public BatchJobDestination? Destination { get; set; }

Property Value

BatchJobDestination

DisplayName

The display name of the BatchJob.

[JsonPropertyName("displayName")]
public string? DisplayName { get; set; }

Property Value

string

EndTime

The time when the BatchJob was completed.

[JsonPropertyName("endTime")]
public string? EndTime { get; set; }

Property Value

string

Error

Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

[JsonPropertyName("error")]
public JobError? Error { get; set; }

Property Value

JobError

InputConfig

Input configuration for the batch job (Vertex AI only).

[JsonPropertyName("inputConfig")]
public VertexInputConfig? InputConfig { get; set; }

Property Value

VertexInputConfig

Model

The name of the model that produces the predictions via the BatchJob.

[JsonPropertyName("model")]
public string? Model { get; set; }

Property Value

string

Name

The resource name of the BatchJob. Output only.

[JsonPropertyName("name")]
public string? Name { get; set; }

Property Value

string

OutputConfig

Output configuration for the batch job (Vertex AI only).

[JsonPropertyName("outputConfig")]
public VertexOutputConfig? OutputConfig { get; set; }

Property Value

VertexOutputConfig

OutputInfo

Output only. Information about where the output is written (Vertex AI only). Only populated when the job's state is JOB_STATE_SUCCEEDED.

[JsonPropertyName("outputInfo")]
public BatchOutputInfo? OutputInfo { get; set; }

Property Value

BatchOutputInfo

Source

Configuration for the input data source.

[JsonPropertyName("src")]
public BatchJobSource? Source { get; set; }

Property Value

BatchJobSource

StartTime

Output only. Time when the Job for the first time entered the JOB_STATE_RUNNING state.

[JsonPropertyName("startTime")]
public string? StartTime { get; set; }

Property Value

string

State

The state of the BatchJob.

[JsonPropertyName("state")]
[JsonConverter(typeof(JobStateConverter))]
public JobState? State { get; set; }

Property Value

JobState?

Type

The type identifier for the metadata object (Google AI only).

[JsonPropertyName("@type")]
public string? Type { get; set; }

Property Value

string

UpdateTime

The time when the BatchJob was last updated.

[JsonPropertyName("updateTime")]
public string? UpdateTime { get; set; }

Property Value

string