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

Response

data class Response(val metadata: Map<String, String>?, val temperature: Double? = 1.0, val topP: Double? = 1.0, val model: String, val instructions: String?, val tools: List<Tool> = emptyList(), val toolChoice: String = "auto", val id: String, val objectType: String = "response", val createdAt: Long, val output: List<OutputMessage>, val parallelToolCalls: Boolean = true, val user: String? = null, val previousResponseId: String? = null, val reasoning: Reasoning? = null, val maxOutputTokens: Int? = null, val truncation: Truncation? = Truncation.DISABLED, val status: Response.Status? = null, val outputText: String? = null, val text: TextConfig? = null, val store: Boolean? = null, val incompleteDetails: IncompleteDetails? = null, val usage: Usage, val error: ResponseError? = null) : Record(source)

Represents a response from the OpenAI API.

Author

Konstantin Pavlov

Constructors

constructor(metadata: Map<String, String>?, temperature: Double? = 1.0, topP: Double? = 1.0, model: String, instructions: String?, tools: List<Tool> = emptyList(), toolChoice: String = "auto", id: String, objectType: String = "response", createdAt: Long, output: List<OutputMessage>, parallelToolCalls: Boolean = true, user: String? = null, previousResponseId: String? = null, reasoning: Reasoning? = null, maxOutputTokens: Int? = null, truncation: Truncation? = Truncation.DISABLED, status: Response.Status? = null, outputText: String? = null, text: TextConfig? = null, store: Boolean? = null, incompleteDetails: IncompleteDetails? = null, usage: Usage, error: ResponseError? = null)

Types

enum Status : Enum<Response.Status>

The status of the response generation.

Properties

@SerialName(value = "created_at")

val createdAt: Long

The timestamp when the response was created.

@EncodeDefault(mode = EncodeDefault.Mode.ALWAYS)

@SerialName(value = "error")

val error: ResponseError?

@SerialName(value = "id")

The unique identifier for the response.

incompleteDetails

@EncodeDefault(mode = EncodeDefault.Mode.ALWAYS)

@SerialName(value = "incomplete_details")

val incompleteDetails: IncompleteDetails?

@SerialName(value = "instructions")

val instructions: String?

The instructions provided to the model.

maxOutputTokens

@EncodeDefault(mode = EncodeDefault.Mode.ALWAYS)

@SerialName(value = "max_output_tokens")

val maxOutputTokens: Int?

Optional maximum number of tokens generated.

@SerialName(value = "metadata")

val metadata: Map<String, String>?

Metadata for the response.

@SerialName(value = "model")

val model: String

The model used for generating the response.

@EncodeDefault(mode = EncodeDefault.Mode.ALWAYS)

@SerialName(value = "object")

val objectType: String

The type of the object, always "response".

@SerialName(value = "output")

val output: List<OutputMessage>

The output content generated by the model.

@SerialName(value = "output_text")

val outputText: String?

Optional convenience property with aggregated text output.

parallelToolCalls

@SerialName(value = "parallel_tool_calls")

val parallelToolCalls: Boolean

Whether parallel tool calls were allowed.

previousResponseId

@EncodeDefault(mode = EncodeDefault.Mode.ALWAYS)

@SerialName(value = "previous_response_id")

val previousResponseId: String?

Optional ID of the previous response.

@EncodeDefault(mode = EncodeDefault.Mode.ALWAYS)

@SerialName(value = "reasoning")

val reasoning: Reasoning?

Optional reasoning information.

@EncodeDefault(mode = EncodeDefault.Mode.ALWAYS)

@SerialName(value = "status")

val status: Response.Status?

The status of the response generation.

@EncodeDefault(mode = EncodeDefault.Mode.ALWAYS)

@SerialName(value = "store")

val store: Boolean?

Whether the response is stored.

@SerialName(value = "temperature")

val temperature: Double?

The temperature used for generating the response.

@EncodeDefault(mode = EncodeDefault.Mode.ALWAYS)

@SerialName(value = "text")

val text: TextConfig?

Optional text configuration for the response.

@SerialName(value = "tool_choice")

val toolChoice: String

The tool choice configuration.

@SerialName(value = "tools")

val tools: List<Tool>

The tools available to the model.

@SerialName(value = "top_p")

val topP: Double?

The top_p value used for generating the response.

@EncodeDefault(mode = EncodeDefault.Mode.ALWAYS)

@SerialName(value = "truncation")

val truncation: Truncation?

Optional truncation strategy used.

@SerialName(value = "usage")

val usage: Usage

@EncodeDefault(mode = EncodeDefault.Mode.ALWAYS)

@SerialName(value = "user")

val user: String?

Optional user identifier.