// File generated from our OpenAPI spec by Stainless.

package com.openai.models

import com.fasterxml.jackson.annotation.JsonCreator
import com.openai.core.Enum
import com.openai.core.JsonField
import com.openai.errors.OpenAIInvalidDataException

class ChatModel @JsonCreator private constructor(private val value: JsonField<String>) : Enum {

    /**
     * Returns this class instance's raw value.
     *
     * This is usually only useful if this instance was deserialized from data that doesn't match
     * any known member, and you want to know that value. For example, if the SDK is on an older
     * version than the API, then the API may respond with new members that the SDK is unaware of.
     */
    @com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField<String> = value

    companion object {

        @JvmField val GPT_4_1 = of("gpt-4.1")

        @JvmField val GPT_4_1_MINI = of("gpt-4.1-mini")

        @JvmField val GPT_4_1_NANO = of("gpt-4.1-nano")

        @JvmField val GPT_4_1_2025_04_14 = of("gpt-4.1-2025-04-14")

        @JvmField val GPT_4_1_MINI_2025_04_14 = of("gpt-4.1-mini-2025-04-14")

        @JvmField val GPT_4_1_NANO_2025_04_14 = of("gpt-4.1-nano-2025-04-14")

        @JvmField val O4_MINI = of("o4-mini")

        @JvmField val O4_MINI_2025_04_16 = of("o4-mini-2025-04-16")

        @JvmField val O3 = of("o3")

        @JvmField val O3_2025_04_16 = of("o3-2025-04-16")

        @JvmField val O3_MINI = of("o3-mini")

        @JvmField val O3_MINI_2025_01_31 = of("o3-mini-2025-01-31")

        @JvmField val O1 = of("o1")

        @JvmField val O1_2024_12_17 = of("o1-2024-12-17")

        @JvmField val O1_PREVIEW = of("o1-preview")

        @JvmField val O1_PREVIEW_2024_09_12 = of("o1-preview-2024-09-12")

        @JvmField val O1_MINI = of("o1-mini")

        @JvmField val O1_MINI_2024_09_12 = of("o1-mini-2024-09-12")

        @JvmField val GPT_4O = of("gpt-4o")

        @JvmField val GPT_4O_2024_11_20 = of("gpt-4o-2024-11-20")

        @JvmField val GPT_4O_2024_08_06 = of("gpt-4o-2024-08-06")

        @JvmField val GPT_4O_2024_05_13 = of("gpt-4o-2024-05-13")

        @JvmField val GPT_4O_AUDIO_PREVIEW = of("gpt-4o-audio-preview")

        @JvmField val GPT_4O_AUDIO_PREVIEW_2024_10_01 = of("gpt-4o-audio-preview-2024-10-01")

        @JvmField val GPT_4O_AUDIO_PREVIEW_2024_12_17 = of("gpt-4o-audio-preview-2024-12-17")

        @JvmField val GPT_4O_AUDIO_PREVIEW_2025_06_03 = of("gpt-4o-audio-preview-2025-06-03")

        @JvmField val GPT_4O_MINI_AUDIO_PREVIEW = of("gpt-4o-mini-audio-preview")

        @JvmField
        val GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17 = of("gpt-4o-mini-audio-preview-2024-12-17")

        @JvmField val GPT_4O_SEARCH_PREVIEW = of("gpt-4o-search-preview")

        @JvmField val GPT_4O_MINI_SEARCH_PREVIEW = of("gpt-4o-mini-search-preview")

        @JvmField val GPT_4O_SEARCH_PREVIEW_2025_03_11 = of("gpt-4o-search-preview-2025-03-11")

        @JvmField
        val GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11 = of("gpt-4o-mini-search-preview-2025-03-11")

        @JvmField val CHATGPT_4O_LATEST = of("chatgpt-4o-latest")

        @JvmField val CODEX_MINI_LATEST = of("codex-mini-latest")

        @JvmField val GPT_4O_MINI = of("gpt-4o-mini")

        @JvmField val GPT_4O_MINI_2024_07_18 = of("gpt-4o-mini-2024-07-18")

        @JvmField val GPT_4_TURBO = of("gpt-4-turbo")

        @JvmField val GPT_4_TURBO_2024_04_09 = of("gpt-4-turbo-2024-04-09")

        @JvmField val GPT_4_0125_PREVIEW = of("gpt-4-0125-preview")

        @JvmField val GPT_4_TURBO_PREVIEW = of("gpt-4-turbo-preview")

        @JvmField val GPT_4_1106_PREVIEW = of("gpt-4-1106-preview")

        @JvmField val GPT_4_VISION_PREVIEW = of("gpt-4-vision-preview")

        @JvmField val GPT_4 = of("gpt-4")

        @JvmField val GPT_4_0314 = of("gpt-4-0314")

        @JvmField val GPT_4_0613 = of("gpt-4-0613")

        @JvmField val GPT_4_32K = of("gpt-4-32k")

        @JvmField val GPT_4_32K_0314 = of("gpt-4-32k-0314")

        @JvmField val GPT_4_32K_0613 = of("gpt-4-32k-0613")

        @JvmField val GPT_3_5_TURBO = of("gpt-3.5-turbo")

        @JvmField val GPT_3_5_TURBO_16K = of("gpt-3.5-turbo-16k")

        @JvmField val GPT_3_5_TURBO_0301 = of("gpt-3.5-turbo-0301")

        @JvmField val GPT_3_5_TURBO_0613 = of("gpt-3.5-turbo-0613")

        @JvmField val GPT_3_5_TURBO_1106 = of("gpt-3.5-turbo-1106")

        @JvmField val GPT_3_5_TURBO_0125 = of("gpt-3.5-turbo-0125")

        @JvmField val GPT_3_5_TURBO_16K_0613 = of("gpt-3.5-turbo-16k-0613")

        @JvmStatic fun of(value: String) = ChatModel(JsonField.of(value))
    }

    /** An enum containing [ChatModel]'s known values. */
    enum class Known {
        GPT_4_1,
        GPT_4_1_MINI,
        GPT_4_1_NANO,
        GPT_4_1_2025_04_14,
        GPT_4_1_MINI_2025_04_14,
        GPT_4_1_NANO_2025_04_14,
        O4_MINI,
        O4_MINI_2025_04_16,
        O3,
        O3_2025_04_16,
        O3_MINI,
        O3_MINI_2025_01_31,
        O1,
        O1_2024_12_17,
        O1_PREVIEW,
        O1_PREVIEW_2024_09_12,
        O1_MINI,
        O1_MINI_2024_09_12,
        GPT_4O,
        GPT_4O_2024_11_20,
        GPT_4O_2024_08_06,
        GPT_4O_2024_05_13,
        GPT_4O_AUDIO_PREVIEW,
        GPT_4O_AUDIO_PREVIEW_2024_10_01,
        GPT_4O_AUDIO_PREVIEW_2024_12_17,
        GPT_4O_AUDIO_PREVIEW_2025_06_03,
        GPT_4O_MINI_AUDIO_PREVIEW,
        GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17,
        GPT_4O_SEARCH_PREVIEW,
        GPT_4O_MINI_SEARCH_PREVIEW,
        GPT_4O_SEARCH_PREVIEW_2025_03_11,
        GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11,
        CHATGPT_4O_LATEST,
        CODEX_MINI_LATEST,
        GPT_4O_MINI,
        GPT_4O_MINI_2024_07_18,
        GPT_4_TURBO,
        GPT_4_TURBO_2024_04_09,
        GPT_4_0125_PREVIEW,
        GPT_4_TURBO_PREVIEW,
        GPT_4_1106_PREVIEW,
        GPT_4_VISION_PREVIEW,
        GPT_4,
        GPT_4_0314,
        GPT_4_0613,
        GPT_4_32K,
        GPT_4_32K_0314,
        GPT_4_32K_0613,
        GPT_3_5_TURBO,
        GPT_3_5_TURBO_16K,
        GPT_3_5_TURBO_0301,
        GPT_3_5_TURBO_0613,
        GPT_3_5_TURBO_1106,
        GPT_3_5_TURBO_0125,
        GPT_3_5_TURBO_16K_0613,
    }

    /**
     * An enum containing [ChatModel]'s known values, as well as an [_UNKNOWN] member.
     *
     * An instance of [ChatModel] can contain an unknown value in a couple of cases:
     * - It was deserialized from data that doesn't match any known member. For example, if the SDK
     *   is on an older version than the API, then the API may respond with new members that the SDK
     *   is unaware of.
     * - It was constructed with an arbitrary value using the [of] method.
     */
    enum class Value {
        GPT_4_1,
        GPT_4_1_MINI,
        GPT_4_1_NANO,
        GPT_4_1_2025_04_14,
        GPT_4_1_MINI_2025_04_14,
        GPT_4_1_NANO_2025_04_14,
        O4_MINI,
        O4_MINI_2025_04_16,
        O3,
        O3_2025_04_16,
        O3_MINI,
        O3_MINI_2025_01_31,
        O1,
        O1_2024_12_17,
        O1_PREVIEW,
        O1_PREVIEW_2024_09_12,
        O1_MINI,
        O1_MINI_2024_09_12,
        GPT_4O,
        GPT_4O_2024_11_20,
        GPT_4O_2024_08_06,
        GPT_4O_2024_05_13,
        GPT_4O_AUDIO_PREVIEW,
        GPT_4O_AUDIO_PREVIEW_2024_10_01,
        GPT_4O_AUDIO_PREVIEW_2024_12_17,
        GPT_4O_AUDIO_PREVIEW_2025_06_03,
        GPT_4O_MINI_AUDIO_PREVIEW,
        GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17,
        GPT_4O_SEARCH_PREVIEW,
        GPT_4O_MINI_SEARCH_PREVIEW,
        GPT_4O_SEARCH_PREVIEW_2025_03_11,
        GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11,
        CHATGPT_4O_LATEST,
        CODEX_MINI_LATEST,
        GPT_4O_MINI,
        GPT_4O_MINI_2024_07_18,
        GPT_4_TURBO,
        GPT_4_TURBO_2024_04_09,
        GPT_4_0125_PREVIEW,
        GPT_4_TURBO_PREVIEW,
        GPT_4_1106_PREVIEW,
        GPT_4_VISION_PREVIEW,
        GPT_4,
        GPT_4_0314,
        GPT_4_0613,
        GPT_4_32K,
        GPT_4_32K_0314,
        GPT_4_32K_0613,
        GPT_3_5_TURBO,
        GPT_3_5_TURBO_16K,
        GPT_3_5_TURBO_0301,
        GPT_3_5_TURBO_0613,
        GPT_3_5_TURBO_1106,
        GPT_3_5_TURBO_0125,
        GPT_3_5_TURBO_16K_0613,
        /** An enum member indicating that [ChatModel] was instantiated with an unknown value. */
        _UNKNOWN,
    }

    /**
     * Returns an enum member corresponding to this class instance's value, or [Value._UNKNOWN] if
     * the class was instantiated with an unknown value.
     *
     * Use the [known] method instead if you're certain the value is always known or if you want to
     * throw for the unknown case.
     */
    fun value(): Value =
        when (this) {
            GPT_4_1 -> Value.GPT_4_1
            GPT_4_1_MINI -> Value.GPT_4_1_MINI
            GPT_4_1_NANO -> Value.GPT_4_1_NANO
            GPT_4_1_2025_04_14 -> Value.GPT_4_1_2025_04_14
            GPT_4_1_MINI_2025_04_14 -> Value.GPT_4_1_MINI_2025_04_14
            GPT_4_1_NANO_2025_04_14 -> Value.GPT_4_1_NANO_2025_04_14
            O4_MINI -> Value.O4_MINI
            O4_MINI_2025_04_16 -> Value.O4_MINI_2025_04_16
            O3 -> Value.O3
            O3_2025_04_16 -> Value.O3_2025_04_16
            O3_MINI -> Value.O3_MINI
            O3_MINI_2025_01_31 -> Value.O3_MINI_2025_01_31
            O1 -> Value.O1
            O1_2024_12_17 -> Value.O1_2024_12_17
            O1_PREVIEW -> Value.O1_PREVIEW
            O1_PREVIEW_2024_09_12 -> Value.O1_PREVIEW_2024_09_12
            O1_MINI -> Value.O1_MINI
            O1_MINI_2024_09_12 -> Value.O1_MINI_2024_09_12
            GPT_4O -> Value.GPT_4O
            GPT_4O_2024_11_20 -> Value.GPT_4O_2024_11_20
            GPT_4O_2024_08_06 -> Value.GPT_4O_2024_08_06
            GPT_4O_2024_05_13 -> Value.GPT_4O_2024_05_13
            GPT_4O_AUDIO_PREVIEW -> Value.GPT_4O_AUDIO_PREVIEW
            GPT_4O_AUDIO_PREVIEW_2024_10_01 -> Value.GPT_4O_AUDIO_PREVIEW_2024_10_01
            GPT_4O_AUDIO_PREVIEW_2024_12_17 -> Value.GPT_4O_AUDIO_PREVIEW_2024_12_17
            GPT_4O_AUDIO_PREVIEW_2025_06_03 -> Value.GPT_4O_AUDIO_PREVIEW_2025_06_03
            GPT_4O_MINI_AUDIO_PREVIEW -> Value.GPT_4O_MINI_AUDIO_PREVIEW
            GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17 -> Value.GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17
            GPT_4O_SEARCH_PREVIEW -> Value.GPT_4O_SEARCH_PREVIEW
            GPT_4O_MINI_SEARCH_PREVIEW -> Value.GPT_4O_MINI_SEARCH_PREVIEW
            GPT_4O_SEARCH_PREVIEW_2025_03_11 -> Value.GPT_4O_SEARCH_PREVIEW_2025_03_11
            GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11 -> Value.GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11
            CHATGPT_4O_LATEST -> Value.CHATGPT_4O_LATEST
            CODEX_MINI_LATEST -> Value.CODEX_MINI_LATEST
            GPT_4O_MINI -> Value.GPT_4O_MINI
            GPT_4O_MINI_2024_07_18 -> Value.GPT_4O_MINI_2024_07_18
            GPT_4_TURBO -> Value.GPT_4_TURBO
            GPT_4_TURBO_2024_04_09 -> Value.GPT_4_TURBO_2024_04_09
            GPT_4_0125_PREVIEW -> Value.GPT_4_0125_PREVIEW
            GPT_4_TURBO_PREVIEW -> Value.GPT_4_TURBO_PREVIEW
            GPT_4_1106_PREVIEW -> Value.GPT_4_1106_PREVIEW
            GPT_4_VISION_PREVIEW -> Value.GPT_4_VISION_PREVIEW
            GPT_4 -> Value.GPT_4
            GPT_4_0314 -> Value.GPT_4_0314
            GPT_4_0613 -> Value.GPT_4_0613
            GPT_4_32K -> Value.GPT_4_32K
            GPT_4_32K_0314 -> Value.GPT_4_32K_0314
            GPT_4_32K_0613 -> Value.GPT_4_32K_0613
            GPT_3_5_TURBO -> Value.GPT_3_5_TURBO
            GPT_3_5_TURBO_16K -> Value.GPT_3_5_TURBO_16K
            GPT_3_5_TURBO_0301 -> Value.GPT_3_5_TURBO_0301
            GPT_3_5_TURBO_0613 -> Value.GPT_3_5_TURBO_0613
            GPT_3_5_TURBO_1106 -> Value.GPT_3_5_TURBO_1106
            GPT_3_5_TURBO_0125 -> Value.GPT_3_5_TURBO_0125
            GPT_3_5_TURBO_16K_0613 -> Value.GPT_3_5_TURBO_16K_0613
            else -> Value._UNKNOWN
        }

    /**
     * Returns an enum member corresponding to this class instance's value.
     *
     * Use the [value] method instead if you're uncertain the value is always known and don't want
     * to throw for the unknown case.
     *
     * @throws OpenAIInvalidDataException if this class instance's value is a not a known member.
     */
    fun known(): Known =
        when (this) {
            GPT_4_1 -> Known.GPT_4_1
            GPT_4_1_MINI -> Known.GPT_4_1_MINI
            GPT_4_1_NANO -> Known.GPT_4_1_NANO
            GPT_4_1_2025_04_14 -> Known.GPT_4_1_2025_04_14
            GPT_4_1_MINI_2025_04_14 -> Known.GPT_4_1_MINI_2025_04_14
            GPT_4_1_NANO_2025_04_14 -> Known.GPT_4_1_NANO_2025_04_14
            O4_MINI -> Known.O4_MINI
            O4_MINI_2025_04_16 -> Known.O4_MINI_2025_04_16
            O3 -> Known.O3
            O3_2025_04_16 -> Known.O3_2025_04_16
            O3_MINI -> Known.O3_MINI
            O3_MINI_2025_01_31 -> Known.O3_MINI_2025_01_31
            O1 -> Known.O1
            O1_2024_12_17 -> Known.O1_2024_12_17
            O1_PREVIEW -> Known.O1_PREVIEW
            O1_PREVIEW_2024_09_12 -> Known.O1_PREVIEW_2024_09_12
            O1_MINI -> Known.O1_MINI
            O1_MINI_2024_09_12 -> Known.O1_MINI_2024_09_12
            GPT_4O -> Known.GPT_4O
            GPT_4O_2024_11_20 -> Known.GPT_4O_2024_11_20
            GPT_4O_2024_08_06 -> Known.GPT_4O_2024_08_06
            GPT_4O_2024_05_13 -> Known.GPT_4O_2024_05_13
            GPT_4O_AUDIO_PREVIEW -> Known.GPT_4O_AUDIO_PREVIEW
            GPT_4O_AUDIO_PREVIEW_2024_10_01 -> Known.GPT_4O_AUDIO_PREVIEW_2024_10_01
            GPT_4O_AUDIO_PREVIEW_2024_12_17 -> Known.GPT_4O_AUDIO_PREVIEW_2024_12_17
            GPT_4O_AUDIO_PREVIEW_2025_06_03 -> Known.GPT_4O_AUDIO_PREVIEW_2025_06_03
            GPT_4O_MINI_AUDIO_PREVIEW -> Known.GPT_4O_MINI_AUDIO_PREVIEW
            GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17 -> Known.GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17
            GPT_4O_SEARCH_PREVIEW -> Known.GPT_4O_SEARCH_PREVIEW
            GPT_4O_MINI_SEARCH_PREVIEW -> Known.GPT_4O_MINI_SEARCH_PREVIEW
            GPT_4O_SEARCH_PREVIEW_2025_03_11 -> Known.GPT_4O_SEARCH_PREVIEW_2025_03_11
            GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11 -> Known.GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11
            CHATGPT_4O_LATEST -> Known.CHATGPT_4O_LATEST
            CODEX_MINI_LATEST -> Known.CODEX_MINI_LATEST
            GPT_4O_MINI -> Known.GPT_4O_MINI
            GPT_4O_MINI_2024_07_18 -> Known.GPT_4O_MINI_2024_07_18
            GPT_4_TURBO -> Known.GPT_4_TURBO
            GPT_4_TURBO_2024_04_09 -> Known.GPT_4_TURBO_2024_04_09
            GPT_4_0125_PREVIEW -> Known.GPT_4_0125_PREVIEW
            GPT_4_TURBO_PREVIEW -> Known.GPT_4_TURBO_PREVIEW
            GPT_4_1106_PREVIEW -> Known.GPT_4_1106_PREVIEW
            GPT_4_VISION_PREVIEW -> Known.GPT_4_VISION_PREVIEW
            GPT_4 -> Known.GPT_4
            GPT_4_0314 -> Known.GPT_4_0314
            GPT_4_0613 -> Known.GPT_4_0613
            GPT_4_32K -> Known.GPT_4_32K
            GPT_4_32K_0314 -> Known.GPT_4_32K_0314
            GPT_4_32K_0613 -> Known.GPT_4_32K_0613
            GPT_3_5_TURBO -> Known.GPT_3_5_TURBO
            GPT_3_5_TURBO_16K -> Known.GPT_3_5_TURBO_16K
            GPT_3_5_TURBO_0301 -> Known.GPT_3_5_TURBO_0301
            GPT_3_5_TURBO_0613 -> Known.GPT_3_5_TURBO_0613
            GPT_3_5_TURBO_1106 -> Known.GPT_3_5_TURBO_1106
            GPT_3_5_TURBO_0125 -> Known.GPT_3_5_TURBO_0125
            GPT_3_5_TURBO_16K_0613 -> Known.GPT_3_5_TURBO_16K_0613
            else -> throw OpenAIInvalidDataException("Unknown ChatModel: $value")
        }

    /**
     * Returns this class instance's primitive wire representation.
     *
     * This differs from the [toString] method because that method is primarily for debugging and
     * generally doesn't throw.
     *
     * @throws OpenAIInvalidDataException if this class instance's value does not have the expected
     *   primitive type.
     */
    fun asString(): String =
        _value().asString().orElseThrow { OpenAIInvalidDataException("Value is not a String") }

    private var validated: Boolean = false

    fun validate(): ChatModel = apply {
        if (validated) {
            return@apply
        }

        known()
        validated = true
    }

    fun isValid(): Boolean =
        try {
            validate()
            true
        } catch (e: OpenAIInvalidDataException) {
            false
        }

    /**
     * Returns a score indicating how many valid values are contained in this object recursively.
     *
     * Used for best match union deserialization.
     */
    @JvmSynthetic internal fun validity(): Int = if (value() == Value._UNKNOWN) 0 else 1

    override fun equals(other: Any?): Boolean {
        if (this === other) {
            return true
        }

        return /* spotless:off */ other is ChatModel && value == other.value /* spotless:on */
    }

    override fun hashCode() = value.hashCode()

    override fun toString() = value.toString()
}
