prompt-executor-openai-client/ai.koog.prompt.executor.clients.openai

Package-level declarations

Types

Link copied to clipboard
class OpenAIChatParams(temperature: Double? = null, maxTokens: Int? = null, numberOfChoices: Int? = null, speculation: String? = null, schema: LLMParams.Schema? = null, toolChoice: LLMParams.ToolChoice? = null, user: String? = null, includeThoughts: Boolean? = null, thinkingBudget: Int? = null, additionalProperties: Map<String, JsonElement>? = null, val frequencyPenalty: Double? = null, val presencePenalty: Double? = null, val parallelToolCalls: Boolean? = null, val promptCacheKey: String? = null, val safetyIdentifier: String? = null, val serviceTier: ServiceTier? = null, val store: Boolean? = null, val audio: OpenAIAudioConfig? = null, val logprobs: Boolean? = null, val reasoningEffort: ReasoningEffort? = null, val stop: List<String>? = null, val topLogprobs: Int? = null, val topP: Double? = null, val webSearchOptions: OpenAIWebSearchOptions? = null) : LLMParams, OpenAIParams

OpenAI chat/completions parameters layered on top of LLMParams.

Link copied to clipboard
class OpenAIClientSettings(baseUrl: String = "https://api.openai.com", timeoutConfig: ConnectionTimeoutConfig = ConnectionTimeoutConfig(), chatCompletionsPath: String = "v1/chat/completions", val responsesAPIPath: String = "v1/responses", val embeddingsPath: String = "v1/embeddings", val moderationsPath: String = "v1/moderations") : OpenAIBasedSettings

Represents the settings for configuring an OpenAI client.

Link copied to clipboard
open class OpenAILLMClient(apiKey: String, settings: OpenAIClientSettings = OpenAIClientSettings(), baseClient: HttpClient = HttpClient(), clock: Clock = Clock.System) : AbstractOpenAILLMClient<OpenAIChatCompletionResponse, OpenAIChatCompletionStreamResponse> , LLMEmbeddingProvider

Implementation of LLMClient for OpenAI API. Uses Ktor HttpClient to communicate with the OpenAI API.

Link copied to clipboard
object OpenAIModels : LLModelDefinitions

Object containing a collection of predefined OpenAI model configurations. These models span various use cases, including reasoning, chat, and cost-optimized tasks.

Link copied to clipboard
@ApiStatus.Experimental
class OpenAIResponsesParams(temperature: Double? = null, maxTokens: Int? = null, numberOfChoices: Int? = null, speculation: String? = null, schema: LLMParams.Schema? = null, toolChoice: LLMParams.ToolChoice? = null, user: String? = null, includeThoughts: Boolean? = null, thinkingBudget: Int? = null, additionalProperties: Map<String, JsonElement>? = null, val background: Boolean? = null, val include: List<String>? = null, val maxToolCalls: Int? = null, val parallelToolCalls: Boolean? = null, val reasoning: ReasoningConfig? = null, val truncation: Truncation? = null, val promptCacheKey: String? = null, val safetyIdentifier: String? = null, val serviceTier: ServiceTier? = null, val store: Boolean? = null, val logprobs: Boolean? = null, val topLogprobs: Int? = null, val topP: Double? = null) : LLMParams, OpenAIParams

OpenAI Responses API parameters layered on top of LLMParams.