openai-core/com.aallam.openai.api.assistant/AssistantResponseFormat

AssistantResponseFormat

@Serializable(with = AssistantResponseFormat.ResponseFormatSerializer::class)

data class AssistantResponseFormat(val type: String, val jsonSchema: AssistantResponseFormat.JsonSchema? = null)

Represents the format of the response from the assistant.

Constructors

AssistantResponseFormat

constructor(type: String, jsonSchema: AssistantResponseFormat.JsonSchema? = null)

Types

object Companion

@Serializable

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

Represents a JSON schema.

ResponseFormatSerializer

object ResponseFormatSerializer : KSerializer<AssistantResponseFormat>

Properties

val jsonSchema: AssistantResponseFormat.JsonSchema? = null

The JSON schema associated with the response format, if type is "json_schema" otherwise null.

val type: String

The type of the response format.