gemini4kt/io.github.ugaikit.gemini4kt.batch

Package-level declarations

Types

class Batch(apiKey: String, client: HttpClient? = null)

Client for interacting with the Gemini Batch API.

@Serializable

data class BatchConfig(val displayName: String? = null, val inputConfig: BatchInputConfig)

Represents the configuration for a batch job.

BatchConfigBuilder

class BatchConfigBuilder

Represents the batch config builder.

@Serializable

data class BatchGcsSource(val uris: List<String>)

Represents a Google Cloud Storage source.

BatchInlineResponse

@Serializable

data class BatchInlineResponse(val response: GenerateContentResponse? = null, val error: JsonElement? = null, val metadata: ResponseMetadata? = null)

Represents a single inline response in a batch job result.

BatchInputConfig

@Serializable

data class BatchInputConfig(val gcsSource: BatchGcsSource? = null, val fileName: String? = null, val requests: BatchRequestInput? = null)

Represents the input configuration for a batch job.

BatchInputConfigBuilder

class BatchInputConfigBuilder

Represents the batch input config builder.

BatchItemRequest

@Serializable

data class BatchItemRequest(val request: JsonElement, val metadata: ResponseMetadata? = null)

Represents a single request within a batch.

BatchItemRequestBuilder

class BatchItemRequestBuilder

Represents the batch item request builder.

@Serializable

data class BatchJob(val name: String, val metadata: BatchJobMetadata? = null, val done: Boolean? = null, val error: GeminiError? = null, val response: BatchJobResponse? = null)

Represents the response from a batch job creation or retrieval. This corresponds to the Operation resource in the API.

BatchJobMetadata

@Serializable

data class BatchJobMetadata(val model: String? = null, val displayName: String? = null, val output: BatchOutput? = null, val createTime: String? = null, val endTime: String? = null, val updateTime: String? = null, val batchStats: BatchStats? = null, val state: String? = null, val name: String? = null)

Metadata for a batch job.

BatchJobResponse

@Serializable

data class BatchJobResponse(val inlinedResponses: InlinedResponsesWrapper? = null)

The response payload of a completed batch job.

@Serializable

data class BatchOutput(val inlinedResponses: InlinedResponsesWrapper? = null)

The output of the batch job.

BatchRequestInput

@Serializable

data class BatchRequestInput(val requests: List<BatchItemRequest>)

Represents inline requests for a batch job.

BatchRequestInputBuilder

class BatchRequestInputBuilder

Represents the batch request input builder.

@Serializable

data class BatchStats(val requestCount: Int? = null, val successfulRequestCount: Int? = null)

Stats about the batch.

CreateBatchRequest

@Serializable

data class CreateBatchRequest(val batch: BatchConfig)

Represents a request to create a batch job.

CreateBatchRequestBuilder

class CreateBatchRequestBuilder

Represents the create batch request builder.

InlinedResponsesWrapper

@Serializable

data class InlinedResponsesWrapper(val inlinedResponses: List<BatchInlineResponse>? = null)

Wrapper for the list of inline responses.

ListBatchesResponse

@Serializable

data class ListBatchesResponse(val operations: List<BatchJob>? = null, val nextPageToken: String? = null)

Represents the response from listing batch jobs.

ResponseMetadata

@Serializable

data class ResponseMetadata(val key: String? = null)

Optional metadata to identify the request.

ResponseMetadataBuilder

class ResponseMetadataBuilder

Represents the response metadata builder.

Functions

fun batchConfig(block: BatchConfigBuilder.() -> Unit): BatchConfig

A DSL for building BatchConfig objects.

batchInputConfig

fun batchInputConfig(block: BatchInputConfigBuilder.() -> Unit): BatchInputConfig

A DSL for building BatchInputConfig objects.

batchItemRequest

fun batchItemRequest(block: BatchItemRequestBuilder.() -> Unit): BatchItemRequest

A DSL for building BatchItemRequest objects.

batchRequestInput

fun batchRequestInput(block: BatchRequestInputBuilder.() -> Unit): BatchRequestInput

A DSL for building BatchRequestInput objects.

createBatchRequest

fun createBatchRequest(block: CreateBatchRequestBuilder.() -> Unit): CreateBatchRequest

A DSL for building CreateBatchRequest objects.

responseMetadata

fun responseMetadata(block: ResponseMetadataBuilder.() -> Unit): ResponseMetadata

A DSL for building ResponseMetadata objects.