ai-mocks-openai/dev.mokksy.aimocks.openai.model

Package-level declarations

Types

data class Annotation(val type: Annotation.Type, val index: Int, val fileId: String, val url: String, val title: String, val startIndex: Int, val endIndex: Int)

ChatCompletionRole

@Serializable

enum ChatCompletionRole : Enum<ChatCompletionRole>

The role of the author of a message

ChatCompletionStreamOptions

@Serializable

data class ChatCompletionStreamOptions(val includeUsage: Boolean? = null)

Options for streaming response. Only set this when you set stream: true.

Error

@Serializable

data class Error(val code: String?, val message: String, val param: String?, val type: String)

FileCitation

@Serializable

data class FileCitation(val type: FileCitation.Type, val index: Int, val fileId: String)

A citation to a file.

FilePath

@Serializable

data class FilePath(val type: FilePath.Type, val fileId: String, val index: Int)

A path to a file.

OutputContent

@Serializable

data class OutputContent(val type: OutputContent.Type, val text: String, val annotations: List<Annotation>, val refusal: String? = null)

OutputMessage

@Serializable

data class OutputMessage(val id: String, val type: OutputMessage.Type, val role: OutputMessage.Role, val content: List<OutputContent>, val status: OutputMessage.Status)

An output message from the model.

OutputText

@Serializable

data class OutputText(val type: OutputText.Type, val text: String, val annotations: List<Annotation>)

A text output from the model.

Reasoning

@Serializable

data class Reasoning(val effort: ReasoningEffort? = ReasoningEffort.MEDIUM, val generateSummary: Reasoning.GenerateSummary? = null)

o-series models only Configuration options for reasoning models.

ReasoningEffort

@Serializable

enum ReasoningEffort : Enum<ReasoningEffort>

o-series models only Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

Refusal

@Serializable

data class Refusal(val type: Refusal.Type, val refusal: String)

A refusal from the model.

ResponseError

@Serializable

data class ResponseError(val code: ResponseErrorCode, val message: String)

An error object returned when the model fails to generate a Response.

ResponseErrorCode

@Serializable

enum ResponseErrorCode : Enum<ResponseErrorCode>

The error code for the response.

UrlCitation

@Serializable

data class UrlCitation(val url: String, val title: String, val type: UrlCitation.Type, val startIndex: Int, val endIndex: Int)

A citation for a web resource used to generate a model response.