openai-scala-core
API
Generated with
openai-scala-core/io.cequence.openaiscala.domain

io.cequence.openaiscala.domain

package io.cequence.openaiscala.domain

Members list

Concise view

Type members

Classlikes

final case class AssistantMessage(content: String, name: Option[String]) extends BaseMessage

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class AssistantToolMessage(content: Option[String], name: Option[String], tool_calls: Seq[(String, ToolCallSpec)]) extends BaseMessage

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
sealed trait BaseMessage

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
sealed trait ChatRole extends EnumValue

Attributes

Companion:
object
Graph
Supertypes
trait EnumValue
class Object
trait Matchable
class Any
Known subtypes
object Assistant.type
object Function.type
object System.type
object Tool.type
object User.type
object ChatRole

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed class Content

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait EnumValue

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait ChatRole
object Assistant.type
object Function.type
object System.type
object Tool.type
object User.type
object file_citation.type
object file_path.type
object Large.type
object LargeLandscape.type
object LargePortrait.type
object Medium.type
object Small.type
trait SortOrder
object asc.type
object desc.type
object image_file.type
object text.type
object json_object.type
object text.type
object base64.type
object float.type
object hd.type
object standard.type
object b64_json.type
object url.type
object natural.type
object vivid.type
object aac.type
object flac.type
object mp3.type
object opus.type
object json.type
object srt.type
object text.type
object verbose_json.type
object vtt.type
trait VoiceType
object alloy.type
object echo.type
object fable.type
object nova.type
object onyx.type
object shimmer.type
case class FileAnnotation(`type`: FileAnnotationType, file_citation: Option[FileCitation], file_path: Option[FileId], text: String, start_index: Int, end_index: Int)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
sealed trait FileAnnotationType extends EnumValue

Attributes

Companion:
object
Graph
Supertypes
trait EnumValue
class Object
trait Matchable
class Any
Known subtypes
object file_citation.type
object file_path.type
object FileAnnotationType

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class FileCitation(file_id: String, quote: String)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class FileId(file_id: String)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class FunctionCallSpec(name: String, arguments: String) extends ToolCallSpec

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class FunctionSpec(name: String, description: Option[String], parameters: Map[String, Any]) extends ToolSpec

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait ToolSpec
class Object
trait Matchable
class Any
case class ImageURLContent(url: String) extends Content

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Content
class Object
trait Matchable
class Any
object ModelId

OpenAI models available as of 2023-12-05.

OpenAI models available as of 2023-12-05.

Attributes

Since:

Jan 2023

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
ModelId.type
abstract class NamedEnumValue(val value: String) extends EnumValue

Attributes

Graph
Supertypes
trait EnumValue
class Object
trait Matchable
class Any
Known subtypes
object Large.type
object LargeLandscape.type
object LargePortrait.type
object Medium.type
object Small.type
sealed trait SortOrder extends EnumValue

Attributes

Companion:
object
Graph
Supertypes
trait EnumValue
class Object
trait Matchable
class Any
Known subtypes
object asc.type
object desc.type
object SortOrder

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class SystemMessage(content: String, name: Option[String]) extends BaseMessage

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class TextContent(text: String) extends Content

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Content
class Object
trait Matchable
class Any
case class Thread(id: String, created_at: Date, metadata: Map[String, String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ThreadFullMessage(id: String, created_at: Date, thread_id: String, role: ChatRole, content: Seq[ThreadMessageContent], assistant_id: Option[String], run_id: Option[String], file_ids: Seq[String], metadata: Map[String, String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ThreadMessage(content: String, role: ChatRole, file_ids: Seq[String], metadata: Map[String, String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ThreadMessageContent(`type`: ThreadMessageContentType, image_file: Option[FileId], text: Option[ThreadMessageText])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
sealed trait ThreadMessageContentType extends EnumValue

Attributes

Companion:
object
Graph
Supertypes
trait EnumValue
class Object
trait Matchable
class Any
Known subtypes
object image_file.type
object text.type
object ThreadMessageContentType

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ThreadMessageFile(id: String, created_at: Date, message_id: String)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ThreadMessageText(value: String, annotations: Seq[FileAnnotation])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
sealed trait ToolCallSpec

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
final case class ToolMessage(content: Option[String], tool_call_id: String, name: String) extends BaseMessage

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
sealed trait ToolSpec

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
final case class UserMessage(content: String, name: Option[String]) extends BaseMessage

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class UserSeqMessage(content: Seq[Content], name: Option[String]) extends BaseMessage

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Deprecated classlikes

@Deprecated
final case class AssistantFunMessage(content: Option[String], name: Option[String], function_call: Option[FunctionCallSpec]) extends BaseMessage

Attributes

Deprecated
true
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
@Deprecated
final case class FunMessage(content: String, name: String) extends BaseMessage

Attributes

Deprecated
true
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
@Deprecated
final case class MessageSpec(role: ChatRole, content: String, name: Option[String]) extends BaseMessage

Deprecation warning: Use typed Message(s), such as SystemMessage, UserMessage, instead.

Deprecation warning: Use typed Message(s), such as SystemMessage, UserMessage, instead.

Attributes

Deprecated
true
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Generated with