google-adk-kotlin-webserver/com.google.adk.kt.webserver/AdkServerConfig

AdkServerConfig

data class AdkServerConfig(val agentLoader: AgentLoader, val sessionService: SessionService, val artifactService: ArtifactService, val port: Int = DEFAULT_PORT, val host: String = DEFAULT_HOST, val apiServerSpanExporter: ApiServerSpanExporter = ApiServerSpanExporter(), val captureMessageContent: Boolean = false, val plugins: List<Plugin> = emptyList(), val webUiEnabled: Boolean? = null)

What an AdkApiServer or AdkDevServer needs to serve a set of agents over HTTP.

Constructors

AdkServerConfig

constructor(agentLoader: AgentLoader, sessionService: SessionService, artifactService: ArtifactService, port: Int = DEFAULT_PORT, host: String = DEFAULT_HOST, apiServerSpanExporter: ApiServerSpanExporter = ApiServerSpanExporter(), captureMessageContent: Boolean = false, plugins: List<Plugin> = emptyList(), webUiEnabled: Boolean? = null)

Types

Companion

object Companion

Properties

agentLoader

val agentLoader: AgentLoader

apiServerSpanExporter

val apiServerSpanExporter: ApiServerSpanExporter

artifactService

val artifactService: ArtifactService

captureMessageContent

val captureMessageContent: Boolean

When true the server records prompt and response content into telemetry spans so the Dev UI trace view can display it. This may capture PII, so it defaults to false; enable it only for local development.

host

val host: String

Interface AdkApiServer and AdkDevServer bind to; IPv4 loopback by default, since these endpoints are unauthenticated; nothing listens on ::1. Installing a module into your own engine binds whatever that engine was given, not this.

plugins

val plugins: List<Plugin>

port

val port: Int

sessionService

val sessionService: SessionService

webUiEnabled

val webUiEnabled: Boolean?

Whether to mount the Development UI; null leaves the choice to the server variant, off for AdkApiServer and on for AdkDevServer. The adk.web.ui.enabled property overrides it either way, so that a deployment which cannot change code can still turn the UI off; the corollary is that an ambient property beats an explicit setting here.