google-adk-kotlin-core/com.google.adk.kt.annotations

Package-level declarations

Types

@RequiresOptIn(message = "Java-interop API: prefer the Kotlin constructor and named arguments; opt in only if you need the Java-facing surface.", level = RequiresOptIn.Level.WARNING)

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

annotation class AdkJavaInteropApi

Marks an API that exists only to make ADK usable from Java, such as the fluent builders. Kotlin callers should use the primary constructor and named arguments instead; opting in acknowledges that you specifically need the Java-facing surface. Java callers are unaffected, since the opt-in requirement is enforced only by the Kotlin compiler.

ExperimentalAppFunctionsFeature

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "ADK AppFunctions support is an experimental feature whose API may change at any time. Opt in with @OptIn(ExperimentalAppFunctionsFeature::class) to acknowledge the risk.")

annotation class ExperimentalAppFunctionsFeature

Marks ADK's AppFunctions APIs as experimental: their shape and semantics may change in future releases without prior notice, as the underlying AppFunctions SDK is itself pre-release.

ExperimentalAuthApi

@RequiresOptIn(message = "The ADK auth API is experimental and may change without notice.", level = RequiresOptIn.Level.ERROR)

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

annotation class ExperimentalAuthApi

Marks the auth API (credentials, auth schemes and sign-in requests), which is experimental and expected to change without notice. Opt in with @OptIn(ExperimentalAuthApi::class).

ExperimentalContextCachingFeature

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "ADK context caching is an experimental feature whose API may change at any time. Opt in with @OptIn(ExperimentalContextCachingFeature::class) to acknowledge the risk.")

annotation class ExperimentalContextCachingFeature

Marks ADK's context caching APIs as experimental: their shape and semantics may change in future releases without prior notice.

ExperimentalEnvironmentApi

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "ADK environment APIs are experimental and may change at any time. Opt in with @OptIn(ExperimentalEnvironmentApi::class) to acknowledge the risk.")

annotation class ExperimentalEnvironmentApi

Marks ADK's environment APIs as experimental: their shape and semantics may change in future releases without prior notice.

ExperimentalLiveApi

@RequiresOptIn(message = "The ADK live API is experimental and may change without notice.", level = RequiresOptIn.Level.ERROR)

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

annotation class ExperimentalLiveApi

Marks the live (bidirectional streaming) API, which is experimental and expected to change without notice. Opt in with @OptIn(ExperimentalLiveApi::class).

ExperimentalWorkflowApi

@RequiresOptIn(message = "The ADK workflow API is experimental and may change without notice.", level = RequiresOptIn.Level.ERROR)

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

annotation class ExperimentalWorkflowApi

Marks the graph-workflow API, which is experimental and expected to change without notice. Opt in with @OptIn(ExperimentalWorkflowApi::class).

FrameworkInternalApi

@RequiresOptIn(message = "This API is for ADK framework use only.", level = RequiresOptIn.Level.ERROR)

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

annotation class FrameworkInternalApi

Param

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Param(val description: String = "", val name: String = "", val required: Requiredness = Requiredness.AUTO)

Annotates a parameter of a function annotated with Tool to provide explicit metadata.

Requiredness

enum Requiredness : Enum<Requiredness>

Whether a Param is required in the generated tool schema.

SecretAccess

@ExperimentalAuthApi

@RequiresOptIn(message = "Reveals a secret value.", level = RequiresOptIn.Level.ERROR)

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

annotation class SecretAccess

Marks APIs that return a secret's raw value, such as Secret.reveal. Opt in with @OptIn(SecretAccess::class), which makes each place that handles a raw credential visible in review.

Tool

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Tool(val name: String = "", val description: String = "", val requireConfirmation: Boolean = false, val isLongRunning: Boolean = false)

Annotates a function to be exposed as an executable tool by the Google ADK Kotlin. KSP will generate a corresponding com.google.adk.kt.tools.FunctionTool wrapper for annotated functions.