koog-spring-boot-starter/ai.koog.spring.prompt.executor.clients.openai/OpenAIKoogProperties

OpenAIKoogProperties

@ConfigurationProperties(prefix = "ai.koog.openai", ignoreUnknownFields = true)
class OpenAIKoogProperties(val enabled: Boolean, val apiKey: String, val baseUrl: String, val retry: RetryConfigKoogProperties? = null) : KoogLlmClientProperties(source)

Configuration class for OpenAI settings in the Koog framework. This class defines properties required to configure and use OpenAI-related services, such as API keys, base URLs for the services, and optional retry configurations.

The class is annotated with @ConfigurationProperties to bind its fields to configuration file properties prefixed with ai.koog.openai.

Constructors

Link copied to clipboard
constructor(enabled: Boolean, apiKey: String, baseUrl: String, retry: RetryConfigKoogProperties? = null)

Types

Link copied to clipboard
object Companion

Companion object for the OpenAIKoogProperties class, providing constant values and utilities associated with the configuration of OpenAI-related properties.

Properties

Link copied to clipboard
val apiKey: String

The API key required to authenticate requests to the OpenAI API.

Link copied to clipboard
open override val baseUrl: String

The base URL for accessing the OpenAI API.

Link copied to clipboard
open override val enabled: Boolean

Determines if the OpenAI client is enabled.

Link copied to clipboard
open override val retry: RetryConfigKoogProperties? = null

Optional retry configuration settings, such as maximum attempts, delays, and backoff strategies.

Functions

Link copied to clipboard
open override fun toString(): String

Returns a string representation of the OpenAIKoogProperties object. The string includes details about the enabled status, masked apiKey, baseUrl, and retry configuration.