Files
Kristopher Overholt 1f2147bfff Add Kotlin language support to ADK docs (#1768)
* Add Kotlin to hero / front page

* Add quickstart page for Kotlin

* Complete Kotlin quickstart guide and fix hero code sample (#2)

* Replace GitHub repo links with language icons in header (#3)

* Fix header icon FOUC and homepage font weight regression (#4)

* Testing staging pipeline

* Revert test edit (for staging pipeline)

* Update language icon tooltips to indicate GitHub destination (#5)

* Add link to ADK Kotlin release notes (#7)

* Initial commit of ADK Kotlin API reference docs (#6)

* Add script to generate ADK Kotlin API reference docs (#8)

* Update links and link checker ignore list (temporarily) (#9)

* Add ADK Kotlin for Android getting started guide to Advanced setup page (#10)

* Add advanced setup page with steps to "Use ADK Kotlin in Android projects"

* Update temp link checker rules

* Add placeholder folder for adk-samples (#13)

* adding linter/compilation checks for kotlin snippets (#12)

* adding linter/compilation checks for kotlin snippets

* Add Kotlin validation scripts

* Initial commit of Kotlin sample agents for adk-samples (#15)

* Adding kotlin snippet for llm agents (#16)

* Adding kotlin snippets to  Events (#17)

* Pull changes to docs/events/index.md from glaforge-kotlin-snippets

* fixing kotlin event timestamp and longRunningToolIds

* Fix language tags (#19)

* Fix language tags

* Update

* Fix wrapping

* Fix wrapping (again)

* Fix wrapping/format

* Fix language tag on integration page

* Enable check_paths in PyMdown Snippets Extension to make the build fail if a snippet can't be found (#20)

* Update mkdocs config (#21)

* Fix broken links, update URLs to adk.dev, and improve (temp) lychee config (#22)

* Add Kotlin/maven badge to README (#23)

* Adding Kotlin snippets for artifacts  (#18)

* Pull Kotlin snippets for artifacts from glaforge-kotlin-snippets

* Add comprehensive Kotlin snippets for artifacts

* Refactor artifacts documentation to use external Kotlin snippets

* Update Kotlin model to gemini-flash-latest

* Fix GCS initialization in Kotlin artifact snippet

* afixi failing test with capital-agent added to files_to_check

* Fix snippet label syntax for MkDocs build

* Configure proper Gradle project for Kotlin snippets and fix dependencies

* Add KSP support and generated sources to Kotlin snippets build

* fixing capital_agent turnComplete

* Fix syntax error in build.gradle.kts by removing invalid placeholders (#25)

* Adding Kotlin snippets to google-gemini.md (#27)

Pulling kotlin changes to google-gemini.md from glaforge-kotlin-snippets

* Add a warning about not adding an api key to production code. (#28)

* Add a warning about not adding an api key to production code.

* Update note

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>

* Add ADK Demo App sample showcasing Gemini-powered agents (#29)

This sample demonstrates how to use the Google ADK (Agent Development Kit) in an Android application to create a chat interface powered by a Gemini-based "Fun Facts" agent. The implementation features:
*   Integration with the Kotlin ADK core and processor libraries.
*   A `FunFactsAgent` defined using `LlmAgent` and the Gemini model.
*   A `ChatViewModel` utilizing `InMemoryRunner` for asynchronous message streaming.
*   A modern UI built with Jetpack Compose and Material 3.
*   Build configuration logic for secure API key management via environment variables or `local.properties`.

* Update Kotlin docs and samples to align with adk-kotlin API changes (#30)

Rename GeminiModel to Gemini, @AdkTool/@AdkParam to @Tool/@Param,
adkTools() to generatedTools(), replace DebugRunner with InMemoryRunner,
fix AgentLoader import path, use SingleAgentLoader, bump Kotlin to
2.3.21 and KSP to 2.3.7, and update Android minSdk from 24 to 26.

* adding kotlin info to READMEs (#14)

* Reorganize Android sample agent and add READMEs (#31)

* Move Android sample agent

* Update repo README, add Android README, update sample agent README

* Minor edit to language support tags (#32)

* Remove blog post link (#33)

Will re-add after it's published

* Remove examples link (#34)

* Adding Kotlin snippets for Sessions docs (#26)

* initial kotlins snippets additions to sessions docs

* Updating memory docs with kotlin snippets

* Adding kotlin snippets to session state docs.

* update model to gemini-flash-latest

* sessions examples clean-up

* fixing sessions snippet markers

* adding kotlin session snippets to files to test

* adding callback to memory_example

* Fixing capital agent snippet  (#35)

Fixing file name
Updating adkTool > Tool
Updating GeminiModel > Gemini

* Adding kotlin snippets for tools docs (#36)

* adding function tool kotlin snippets

* adding function_tools snippets to files to test

* Adding kotlin snippets to observability docs (#37)

* initial kotlin observability updates

* adding observability snippets to file check (#38)

* Adding Kotlin snippets to Callbacks docs (#39)

*  kotlin callbacks snippets

* adding callbacks snippets to file check

* Align Kotlin and KSP versions with published 0.1.0 artifacts (#40)

* switch CLI entry points from InMemoryRunner to ReplRunner (#41)

* Switch CLI entry points from InMemoryRunner to ReplRunner

* Fix wording

* Update API reference docs for Kotlin, 2026-05-18 (#42)

* Remove ADK on Android note until published (#43)

* Update Kotlin code samples (#44)

* Rename GeminiModel to Gemini in Kotlin snippets and docs

* Remove broken SessionKey call and use sessionId directly in AgentTool snippet

* Rewrite Go hero snippet to use llmagent API

* Use isFinalResponse with safe access in CapitalAgent snippet

* Use Role.USER constant instead of raw string in SetupExample

* Use full semver v0.1.0 in Kotlin language support tags

* Remove Android setup steps, moving to new property (#45)

* Tutorial Kotlin agent (#46)

* Adding multi-tool-agent snippet and updating tutorial
* Fixing Go language order on tutorial page
* adding multi tool agent example to files to test

* Inline Kotlin get-started code sample

* Kotlin Multi agents snippets (#47)

* Multi-agent kotlin snippets

* Fixing docs tags in multiagent example

* Fix Kotlin language support tags, code samples, and google-gemini.md cleanup (#48)

* Add Kotlin v0.1.0 to language support tags across docs

* Fix MultiToolAgent.kt model string and argument style

* Update MultiAgentExample.kt to use gemini-flash-latest model string

* Fix google-gemini.md: add Kotlin sample, remove unsupported Java tabs

* Remove explicit apiKey from CallbackBasic.kt for consistency

* Standardize Gemini() constructor to use named args in all snippets

* Remove adk-samples directory (moved to google/adk-samples#1969)

* Remove adk-samples directory (moved to google/adk-samples#1969) (#49)

* Update API reference docs for ADK Kotlin 0.1.0 (#50)

* Remove adk-samples directory (moved to google/adk-samples#1969)

* Update API reference docs for ADK Kotlin 0.1.0

* Remove kotlin lycheeignore config (#51)

* Remove adk-samples directory (moved to google/adk-samples#1969)

* Remove Kotlin .lycheeignore config links

---------

Co-authored-by: Toni Klopfenstein <2359976+ToniCorinne@users.noreply.github.com>
Co-authored-by: Jolanda Verhoef <JolandaVerhoef@users.noreply.github.com>
2026-05-19 18:24:40 +00:00

164 lines
5.4 KiB
Kotlin

package com.google.adk.kt.examples.artifacts
import com.google.adk.kt.agents.LlmAgent
import com.google.adk.kt.agents.Instruction
import com.google.adk.kt.models.Gemini
import com.google.adk.kt.runners.InMemoryRunner
import com.google.adk.kt.sessions.InMemorySessionService
import com.google.adk.kt.artifacts.InMemoryArtifactService
import com.google.adk.kt.artifacts.GcsArtifactService
import com.google.adk.kt.tools.ToolContext
import com.google.adk.kt.tools.LoadArtifactsTool
import com.google.adk.kt.types.Part
import com.google.adk.kt.types.Blob
import kotlinx.coroutines.runBlocking
// --8<-- [start:full_example]
// --8<-- [start:representation]
fun artifactRepresentationExample() {
// Assume 'imageBytes' contains the binary data of a PNG image
val imageBytes = byteArrayOf(0x89.toByte(), 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A)
val imageArtifact = Part(
inlineData = Blob(
mimeType = "image/png",
data = imageBytes
)
)
println("Artifact MIME Type: ${imageArtifact.inlineData?.mimeType}")
println("Artifact Data (first 8 bytes): ${imageArtifact.inlineData?.data?.take(8)}")
}
// --8<-- [end:representation]
// --8<-- [start:configure_runner]
fun configureRunnerExample() {
val myAgent = LlmAgent(name = "artifact_user_agent", model = Gemini(name = "gemini-flash-latest"))
val artifactService = InMemoryArtifactService()
val sessionService = InMemorySessionService()
val runner = InMemoryRunner(
agent = myAgent,
appName = "my_artifact_app",
sessionService = sessionService,
artifactService = artifactService
)
}
// --8<-- [end:configure_runner]
// --8<-- [start:artifact_data]
fun artifactDataExample() {
val pdfBytes = "%PDF-1.4...".toByteArray()
val pdfMimeType = "application/pdf"
val pdfArtifact = Part(
inlineData = Blob(
data = pdfBytes,
mimeType = pdfMimeType
)
)
println("Created Kotlin artifact with MIME type: ${pdfArtifact.inlineData?.mimeType}")
}
// --8<-- [end:artifact_data]
// --8<-- [start:namespacing]
fun namespacingExample() {
// Session-specific artifact filename
val sessionReportFilename = "summary.txt"
// User-specific artifact filename
val userConfigFilename = "user:settings.json"
}
// --8<-- [end:namespacing]
// --8<-- [start:interaction_save]
suspend fun saveGeneratedReport(context: ToolContext, reportBytes: ByteArray) {
val reportArtifact = Part(
inlineData = Blob(
data = reportBytes,
mimeType = "application/pdf"
)
)
val filename = "generated_report.pdf"
val service = context.invocationContext.artifactService
if (service != null) {
val version = service.saveArtifact(context.invocationContext.session.key, filename, reportArtifact)
println("Successfully saved Kotlin artifact '$filename' as version $version.")
} else {
println("Artifact service not available.")
}
}
// --8<-- [end:interaction_save]
// --8<-- [start:interaction_load]
suspend fun processLatestReport(context: ToolContext) {
val filename = "generated_report.pdf"
val reportArtifact = context.loadArtifact(filename)
if (reportArtifact != null && reportArtifact.inlineData != null) {
println("Successfully loaded latest Kotlin artifact '$filename'.")
println("MIME Type: ${reportArtifact.inlineData?.mimeType}")
val pdfBytes = reportArtifact.inlineData?.data
println("Report size: ${pdfBytes?.size} bytes.")
} else {
println("Kotlin artifact '$filename' not found.")
}
}
// --8<-- [end:interaction_load]
// --8<-- [start:load_artifacts_tool]
fun loadArtifactsToolExample() {
val rootAgent = LlmAgent(
name = "artifact_reader",
model = Gemini(name = "gemini-flash-latest"),
instruction = Instruction(
"Answer questions about available user files. " +
"Call load_artifacts before answering when you need file contents."
),
tools = listOf(LoadArtifactsTool())
)
}
// --8<-- [end:load_artifacts_tool]
// --8<-- [start:listing_artifacts]
suspend fun listUserFiles(context: ToolContext): String {
val availableFiles = context.listArtifacts()
if (availableFiles.isEmpty()) {
return "You have no saved artifacts."
} else {
val fileListStr = availableFiles.joinToString("\n") { "- $it" }
return "Here are your available Kotlin artifacts:\n$fileListStr"
}
}
// --8<-- [end:listing_artifacts]
// --8<-- [start:in_memory_service]
fun inMemoryServiceExample() {
val inMemoryService = InMemoryArtifactService()
}
// --8<-- [end:in_memory_service]
// --8<-- [start:gcs_service]
fun gcsServiceExample() {
val gcsBucketName = "your-gcs-bucket-for-adk-artifacts"
try {
// Initialize the GCS Storage client (usually uses Application Default Credentials)
val storage = com.google.cloud.storage.StorageOptions.getDefaultInstance().service
val gcsService = GcsArtifactService(bucketName = gcsBucketName, storageClient = storage)
println("Kotlin GcsArtifactService initialized for bucket: $gcsBucketName")
} catch (e: Exception) {
println("Error initializing Kotlin GcsArtifactService: ${e.message}")
}
}
// --8<-- [end:gcs_service]
fun main() = runBlocking {
artifactRepresentationExample()
artifactDataExample()
inMemoryServiceExample()
gcsServiceExample()
}
// --8<-- [end:full_example]