0.4.2

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

Package-level declarations

Types

CompletionTokensDetails

class CompletionTokensDetails(val acceptedPredictionTokens: Int? = null, val audioTokens: Int? = null, val reasoningTokens: Int? = null, val rejectedPredictionTokens: Int? = null)

@Serializable(with = ContentSerializer::class)

sealed interface Content

Represents the content of a message in the OpenAI chat completion API. Can be either a simple text message or a complex content consisting of multiple parts.

JsonSchemaObject

class JsonSchemaObject(val name: String, val description: String? = null, val schema: JsonObject? = null, val strict: Boolean? = null)

Structured Outputs configuration options, including a JSON Schema.

class OpenAIAudio(val data: String? = null, val expiresAt: Long? = null, val id: String, val transcript: String? = null)

Data about a previous audio response from the model.

OpenAIAudioConfig

class OpenAIAudioConfig(val format: OpenAIAudioFormat, val voice: OpenAIAudioVoice)

Parameters for audio output.

OpenAIAudioFormat

enum OpenAIAudioFormat : Enum<OpenAIAudioFormat>

Represents the supported audio output formats.

OpenAIAudioVoice

enum OpenAIAudioVoice : Enum<OpenAIAudioVoice>

Represents the available voice options for audio output in OpenAI's system.

OpenAIBaseLLMRequest

interface OpenAIBaseLLMRequest

Base interface for LLM OpenAI API requests. Contains properties that are common across all supported LLM providers.

OpenAIBaseLLMResponse

interface OpenAIBaseLLMResponse

Base interface for all LLM OpenAI API responses. Contains properties that are common across different response types.

OpenAIBaseLLMStreamResponse

interface OpenAIBaseLLMStreamResponse : OpenAIBaseLLMResponse

Represents a base interface for handling real-time streaming responses from OpenAI's LLM API. Provides a structure extending from the common attributes defined in OpenAIBaseLLMResponse. Used as a foundation for streaming response data models in OpenAI integrations.

class OpenAIChoice(val finishReason: String, val index: Int, val logprobs: OpenAIChoiceLogProbs? = null, val message: OpenAIMessage)

Chat completion choice

OpenAIChoiceLogProbs

class OpenAIChoiceLogProbs(val content: List<OpenAIChoiceLogProbs.ContentLogProbs>? = null, val refusal: List<OpenAIChoiceLogProbs.ContentLogProbs>? = null)

OpenAIContentPart

sealed interface OpenAIContentPart

Represents a content part that can be used within OpenAI chat completion APIs. This is a sealed interface that defines various types of content components, like text, images, audio, and files, enabling diverse inputs and outputs in the API.

class OpenAIFunction(val name: String, val arguments: String)

Function call from an OpenAI model, containing the function name and arguments.

sealed interface OpenAIMessage

Represents a message in the OpenAI chat completion API.

OpenAIModalities

enum OpenAIModalities : Enum<OpenAIModalities>

Specifies the supported modalities for OpenAI API operations.

OpenAIResponseFormat

sealed interface OpenAIResponseFormat

Expected response format from OpenAI's chat completion API. This interface defines different types of response formats that can be requested:

OpenAIStaticContent

class OpenAIStaticContent(val content: Content)

Static predicted output content, such as the content of a text file that is being regenerated.

OpenAIStreamChoice

class OpenAIStreamChoice(val delta: OpenAIStreamDelta, val finishReason: String? = null, val index: Int, val logprobs: OpenAIChoiceLogProbs? = null)

OpenAIStreamDelta

class OpenAIStreamDelta(val content: String? = null, val refusal: String? = null, val role: String? = null, val toolCalls: List<OpenAIToolCall>? = null)

OpenAIStreamOptions

class OpenAIStreamOptions(val includeUsage: Boolean? = null)

Options for streaming response.

class OpenAITool(val function: OpenAIToolFunction)

Tool the model may call.

class OpenAIToolCall(val id: String, val function: OpenAIFunction)

Tool call generated by the OpenAI model.

OpenAIToolChoice

@Serializable(with = OpenAIToolChoiceSerializer::class)

sealed interface OpenAIToolChoice

Controls which (if any) tool is called by the model.

OpenAIToolFunction

class OpenAIToolFunction(val name: String, val description: String? = null, val parameters: JsonObject? = null, val strict: Boolean? = null)

class OpenAIUsage(val promptTokens: Int? = null, val completionTokens: Int? = null, val totalTokens: Int? = null, val completionTokensDetails: CompletionTokensDetails? = null, val promptTokensDetails: PromptTokensDetails? = null)

OpenAIUserLocation

class OpenAIUserLocation(val approximate: OpenAIUserLocation.ApproximateLocation)

Approximate location parameters for the search.

OpenAIWebSearchOptions

class OpenAIWebSearchOptions(val searchContextSize: String? = null, val userLocation: OpenAIUserLocation? = null)

OpenAIWebUrlCitation

class OpenAIWebUrlCitation(val urlCitation: OpenAIWebUrlCitation.Citation)

PromptTokensDetails

class PromptTokensDetails(val audioTokens: Int? = null, val cachedTokens: Int? = null)

ReasoningEffort

enum ReasoningEffort : Enum<ReasoningEffort>

Constrains the amount of effort a reasoning-capable model spends on internal reasoning.

enum ServiceTier : Enum<ServiceTier>

Service tier used to process a request.