google-genai-kotlin/com.google.genai.kotlin

Package-level declarations

Types

class AutomaticFunctionCalling(val functions: List<CallableFunction>, val maximumRemoteCalls: Int = 10, val runFunctionsInParallel: Boolean = false)

The functions the model may ask for during a chat, and the limits on running them.

Batches

class Batches

Caches

class Caches

Provides methods for managing cached content. Instantiating this class is not required. After instantiating a Client, access methods through client.caches directly.

CallableFunction

class CallableFunction

A function you give to the model, and the handler that runs when the model asks for it.

Chat

class Chat

A multi-turn chat session with a generative model.

Chats

class Chats

A factory for multi-turn Chat sessions.

Client

class Client : AutoCloseable

The main entry point for the Google Gen AI SDK.

ClientException

class ClientException(val code: Int, val status: String, message: String) : GenAiApiException

Exception thrown for 4xx client errors from the GenAI API.

Describe

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.CLASS])

annotation class Describe(val value: String)

Describes a function parameter to the model, so it knows what to pass.

ExperimentalGenAiApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.TYPEALIAS])

annotation class ExperimentalGenAiApi

Marks declarations that are experimental in the Google GenAI SDK.

Files

class Files

GenAiApiException

open class GenAiApiException(val code: Int, val status: String, message: String) : GenAiException

Exception thrown when the GenAI API returns an error response.

GenAiException

sealed class GenAiException : Exception

Base exception class for all exceptions originating from the GenAI SDK.

GoogleCredentials

expect class GoogleCredentials

Represents the credentials used to authenticate requests to the Google GenAI API.

actual typealias GoogleCredentials = <Error class: unknown class>

Live

class Live

The Live API client for establishing WebSocket connections to Gemini models.

LiveSession

class LiveSession : AutoCloseable

Represents an active WebSocket session with the Live API.

Models

class Models

Provides methods for interacting with the available GenAI models. Instantiating this class is not required. After instantiating a Client, access methods through client.models directly.

Page

class Page<T>

Represents a single immutable page of results.

Pager

class Pager<T> : Flow<T>

A generic pagination class that implements Flow of T items.

ServerException

class ServerException(val code: Int, val status: String, message: String) : GenAiApiException

Exception thrown for 5xx server errors from the GenAI API.

Tokens

class Tokens

Provides methods for managing ephemeral auth tokens. The tokens module is experimental.

Tunings

class Tunings

Functions

callableFunction

inline fun <R> callableFunction(name: String, description: String? = null, noinline handler: suspend () -> R): CallableFunction

Makes a CallableFunction from a function that takes no parameters.

inline fun <A, R> callableFunction(name: String, description: String? = null, noinline handler: suspend (A) -> R): CallableFunction

Makes a CallableFunction from a function that takes one @Serializable class of parameters.

inline fun <A, R> callableFunction(name: String, description: String? = null, paramName: String, noinline handler: suspend (A) -> R): CallableFunction

Makes a CallableFunction from a function that takes one parameter.

inline fun <A, B, R> callableFunction(name: String, description: String? = null, paramNames: List<String>, noinline handler: suspend (A, B) -> R): CallableFunction

Makes a CallableFunction from a function that takes two parameters.

inline fun <A, B, C, R> callableFunction(name: String, description: String? = null, paramNames: List<String>, noinline handler: suspend (A, B, C) -> R): CallableFunction

Makes a CallableFunction from a function that takes three parameters.

downloadToFile

suspend fun Files.downloadToFile(file: File, outputPath: <Error class: unknown class>, config: DownloadFileConfig? = null)

suspend fun Files.downloadToFile(fileName: String, outputPath: <Error class: unknown class>, config: DownloadFileConfig? = null)

Downloads a file from the API and streams it directly to a local file path.

upload

suspend fun Files.upload(path: <Error class: unknown class>, config: UploadFileConfig? = null): File

Uploads a file at the specified path to the API.

suspend fun Files.upload(file: <Error class: unknown class>, config: UploadFileConfig? = null): File

Uploads a file to the API.