io.cequence.openaiscala.domain.JsonSchema.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openai-scala-core_3 Show documentation

Core module of OpenAI Scala client

The newest version!

package io.cequence.openaiscala.domain

import io.cequence.wsclient.domain.NamedEnumValue

// Base trait for all JSON Schema elements
sealed trait JsonSchema {
  def `type`: JsonType
}

object JsonSchema {

  import java.lang.{String => JString}

  case class Object(
    properties: Seq[(JString, JsonSchema)],
    required: Seq[JString] = Nil
  ) extends JsonSchema {
    override val `type` = JsonType.Object
  }

  def Object(
    properties: Map[JString, JsonSchema],
    required: Seq[JString] = Nil
  ): Object = Object(properties.toSeq, required)

  case class String(
    description: Option[JString] = None,
    `enum`: Seq[JString] = Nil
  ) extends JsonSchema {
    override val `type` = JsonType.String
  }
  case class Number(
    description: Option[JString] = None
  ) extends JsonSchema {
    override val `type` = JsonType.Number
  }
  case class Boolean(
    description: Option[JString] = None
  ) extends JsonSchema {
    override val `type` = JsonType.Boolean
  }
  case class Null() extends JsonSchema {
    override val `type` = JsonType.Null
  }
  case class Array(
    items: JsonSchema
  ) extends JsonSchema {
    override val `type` = JsonType.Array
  }
}

object JsonType {
  case object Object extends JsonType("object")
  case object String extends JsonType("string")
  case object Number extends JsonType("number")
  case object Boolean extends JsonType("boolean")
  case object Null extends JsonType("null")
  case object Array extends JsonType("array")
}

sealed abstract class JsonType(value: String) extends NamedEnumValue(value)