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 AssistantId(id: String) extends AnyVal

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class AnyVal
trait Matchable
class Any
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
sealed trait AssistantTool

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AssistantTool

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
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
final case class AssistantToolOutput(tool_call_id: String, output: Option[String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class AssistantToolResource(codeInterpreter: Option[CodeInterpreterResources], fileSearch: Option[FileSearchResources])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object AssistantToolResource

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Attachment(fileId: Option[FileId], tools: Seq[MessageAttachmentTool])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Attachment

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait BaseMessage

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Batch

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Batch.type
sealed trait ChatCompletionTool

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 trait ChunkingStrategy

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ChunkingStrategy

Attributes

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

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
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: Option[String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class FileCounts(inProgress: Int, completed: Int, cancelled: Int, failed: Int, total: Int)

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
object FineTune

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
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 ImageURLContent(url: String) extends Content

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Content
class Object
trait Matchable
class Any
sealed trait JsonSchema

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Array
class Boolean
class Null
class Number
class Object
class String
object JsonSchema

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object JsonType

Attributes

Companion:
class
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed abstract class JsonType(value: String) extends NamedEnumValue

Attributes

Companion:
object
Graph
Supertypes
class NamedEnumValue
trait EnumValue
class Object
trait Matchable
class Any
Known subtypes
object Array.type
object Boolean.type
object Null.type
object Number.type
object Object.type
object String.type
case class LastError(code: LastErrorCode, message: String)

Attributes

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

Attributes

Companion:
object
Graph
Supertypes
trait EnumValue
class Object
trait Matchable
class Any
Known subtypes
object RateLimitExceeded.type
object ServerError.type
object LastErrorCode

Attributes

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

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object FileSearchSpec.type
object MessageAttachmentTool

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
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
object NonOpenAIModelId

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
final case class Pagination(limit: Option[Int], after: Option[String], before: Option[String])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Pagination

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ProviderSettings(coreUrl: String, apiKeyEnvVariable: String)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class RequiredAction(`type`: String, submit_tool_outputs: SubmitToolOutputs)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class Run(id: String, `object`: String, created_at: Date, thread_id: String, assistant_id: String, status: RunStatus, required_action: Option[RequiredAction], last_error: Option[LastError], expires_at: Option[Date], started_at: Option[Date], cancelled_at: Option[Date], failed_at: Option[Date], completed_at: Option[Date], incomplete_details: Option[Reason], model: String, instructions: Option[String], tools: Seq[AssistantTool], usage: Option[UsageInfo])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Run

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Run.type
sealed trait RunStatus extends SnakeCaseEnumValue

Attributes

Companion:
object
Graph
Supertypes
trait SnakeCaseEnumValue
trait EnumValue
class Object
trait Matchable
class Any
Known subtypes
object Cancelled.type
object Cancelling.type
object Completed.type
object Expired.type
object Failed.type
object InProgress.type
object Incomplete.type
object Queued.type
object RequiresAction.type
object RunStatus

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class RunStep(id: String, `object`: String, createdAt: Date, assistantId: String, threadId: String, runId: String, `type`: String, status: String, stepDetails: Option[StepDetail], lastError: Option[LastError], expiredAt: Option[Date], cancelledAt: Option[Date], failedAt: Option[Date], completedAt: Option[Date], metadata: Option[Map[String, String]], usage: Option[UsageInfo])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object RunStep

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
RunStep.type
sealed trait RunTool

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object FileSearchTool.type
object RunTool

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
RunTool.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
sealed trait StepDetail

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ToolCalls
object StepDetail

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class SubmitToolOutputs(tool_calls: Seq[ToolCall])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
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
trait Content
class Object
trait Matchable
class Any
case class Thread(id: String, created_at: Date, tool_resources: Seq[AssistantToolResourceResponse], metadata: Map[String, String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class ThreadAndRun(messages: Seq[Message], toolResources: Seq[AssistantToolResource], metadata: Map[String, Any])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ThreadAndRun

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait ThreadAndRunRole

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Assistant.type
object User.type
final case class ThreadAndRunToolResource(codeInterpreter: Option[CodeInterpreterResource], fileSearchResources: Option[FileSearchResource])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ThreadAndRunToolResource

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ThreadFullMessage(id: String, created_at: Date, thread_id: String, role: ChatRole, content: Seq[ThreadMessageContent], assistant_id: Option[String], run_id: Option[String], attachments: Seq[Attachment], 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)

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
case class ToolCall(id: String, `type`: String, function: FunctionCallSpec)

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
sealed trait ToolChoice

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Auto.type
object None.type
object Required.type
object ToolChoice

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
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
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
case class VectorStore(id: String, name: String, status: String, usage_bytes: Long, file_counts: FileCounts, metadata: Map[String, String], created_at: Date, last_active_at: Date, expires_after: Option[Date], expires_at: Option[Date])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class VectorStoreFile(id: String, `object`: String, usageBytes: Int, createdAt: Int, vectorStoreId: String, status: VectorStoreFileStatus, lastError: Option[LastError], chunkingStrategy: ChunkingStrategy)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
sealed abstract class VectorStoreFileStatus(value: String) extends NamedEnumValue

Attributes

Companion:
object
Graph
Supertypes
class NamedEnumValue
trait EnumValue
class Object
trait Matchable
class Any
Known subtypes
object Cancelled.type
object Completed.type
object Failed.type
object InProgress.type
object VectorStoreFileStatus

Attributes

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

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. Will be dropped in the next major version.

Deprecation warning: Use typed Message(s), such as SystemMessage, UserMessage, instead. Will be dropped in the next major version.

Attributes

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