koog-ktor/ai.koog.ktor/KoogAgentsConfig

KoogAgentsConfig

class KoogAgentsConfig(scope: CoroutineScope)(source)

Configuration class for setting up a Koog agents server. Provides options to configure LLM connections, agent tools, features, and other related settings.

Constructors

KoogAgentsConfig

constructor(scope: CoroutineScope)

Types

AgentConfig

inner class AgentConfig

Configuration class for managing agent-specific settings and tools.

AnthropicConfig

class AnthropicConfig

AnthropicConfig is a configuration class for integrating with the Anthropic API. It allows for customization of base API URL, model versions, API version, timeout settings, and the HTTP client used for requests. This class facilitates specifying all necessary parameters and settings required to interact with Anthropic's LLM services.

DeepSeekConfig

class DeepSeekConfig

DeepSeekConfig is a configuration class for setting up the DeepSeek client. It manages essential parameters such as API key, base URL, connection timeout settings, and the HTTP client used for requests.

GoogleConfig

class GoogleConfig

GoogleConfig is a configuration class for setting up and customizing integrations with the Google Generative Language API. It allows for specifying an API key, configuring timeouts, and setting the base URL used for API requests.

LLMConfig

inner class LLMConfig

Configuration class for managing various Language Learning Model (LLM) providers and their settings. This class allows integration with different LLM services such as OpenAI, Anthropic, Google, OpenRouter, DeepSeek, and Ollama. Users can also define fallback configurations and custom LLM clients.

OllamaConfig

class OllamaConfig

OllamaConfig is a configuration class for managing the settings required to connect and interact with an Ollama-based language model server. It includes properties for setting the server's base URL, connection timeouts, and an HTTP client for underlying network communication.

OpenAIConfig

class OpenAIConfig

Configuration class for OpenAI integration, providing options to set API-specific paths, network timeouts, and base connection settings.

OpenRouterConfig

class OpenRouterConfig

OpenRouterConfig is a configuration class for setting up the OpenRouter client. It manages essential parameters such as API key, base URL, connection timeout settings, and the HTTP client used for requests.

TimeoutConfiguration

@Serializable

data class TimeoutConfiguration(var requestTimeout: Duration = DEFAULT_TIMEOUT, var connectTimeout: Duration = DEFAULT_CONNECT_TIMEOUT, var socketTimeout: Duration = DEFAULT_TIMEOUT)

Configuration class for defining timeout durations in network requests. Used to set and customize the request, connection, and socket timeouts.

Functions

agentConfig

fun agentConfig(configure: KoogAgentsConfig.AgentConfig.() -> Unit)

Configures default configuration for all AI agents with the specified settings.

llm

fun llm(configure: KoogAgentsConfig.LLMConfig.() -> Unit)

Configures the properties and behavior of the large language model (LLM) within the server environment. Allows setting and customizing various aspects of LLM providers, fallbacks, and related configurations.