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

io.cequence.openaiscala.domain.response

package io.cequence.openaiscala.domain.response

Members list

Concise view

Type members

Classlikes

final case class Assistant(id: String, created_at: Date, name: Option[String], description: Option[String], model: String, instructions: Option[String], tools: Seq[AssistantTool], tool_resources: Seq[AssistantToolResourceResponse], metadata: Map[String, String], temperature: Option[Double], top_p: Option[Double], response_format: ResponseFormat)

Attributes

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

Attributes

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

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait BaseChatCompletionChoiceInfo[M <: BaseMessage]

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
sealed trait BaseChatCompletionResponse[M <: BaseMessage, C <: BaseChatCompletionChoiceInfo[M]]()

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class BatchError(code: String, message: String)

Represents an error in a batch request.

Represents an error in a batch request.

Attributes

code

A machine-readable error code.

message

A human-readable error message.

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

Represents the response of a batch request.

Represents the response of a batch request.

Attributes

body

The JSON body of the response.

request_id

An unique identifier for the OpenAI API request. Please include this request ID when contacting support.

status_code

The HTTP status code of the response.

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class ChatCompletionBatchResponse(status_code: Int, request_id: String, body: ChatCompletionResponse) extends BatchResponse

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ChatCompletionChoiceChunkInfo(delta: ChunkMessageSpec, index: Int, finish_reason: Option[String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ChatCompletionChoiceInfo(message: AssistantMessage, index: Int, finish_reason: Option[String], logprobs: Option[Logprobs]) extends BaseChatCompletionChoiceInfo[AssistantMessage]

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ChatCompletionChunkResponse(id: String, created: Date, model: String, system_fingerprint: Option[String], choices: Seq[ChatCompletionChoiceChunkInfo], usage: Option[UsageInfo])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ChatCompletionResponse(id: String, created: Date, model: String, system_fingerprint: Option[String], choices: Seq[ChatCompletionChoiceInfo], usage: Option[UsageInfo], originalResponse: Option[Any]) extends BaseChatCompletionResponse[AssistantMessage, ChatCompletionChoiceInfo]

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ChatFunCompletionChoiceInfo(message: AssistantFunMessage, index: Int, finish_reason: Option[String]) extends BaseChatCompletionChoiceInfo[AssistantFunMessage]

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ChatFunCompletionResponse(id: String, created: Date, model: String, system_fingerprint: Option[String], choices: Seq[ChatFunCompletionChoiceInfo], usage: Option[UsageInfo]) extends BaseChatCompletionResponse[AssistantFunMessage, ChatFunCompletionChoiceInfo]

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ChatToolCompletionChoiceInfo(message: AssistantToolMessage, index: Int, finish_reason: Option[String]) extends BaseChatCompletionChoiceInfo[AssistantToolMessage]

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ChatToolCompletionResponse(id: String, created: Date, model: String, system_fingerprint: Option[String], choices: Seq[ChatToolCompletionChoiceInfo], usage: Option[UsageInfo]) extends BaseChatCompletionResponse[AssistantToolMessage, ChatToolCompletionChoiceInfo]

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ChatWebSearchCompletionChoiceInfo(message: AssistantWebSearchMessage, index: Int, finish_reason: Option[String], logprobs: Option[Logprobs]) extends BaseChatCompletionChoiceInfo[AssistantWebSearchMessage]

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ChatWebSearchCompletionResponse(id: String, created: Date, model: String, system_fingerprint: Option[String], choices: Seq[ChatWebSearchCompletionChoiceInfo], usage: Option[UsageInfo]) extends BaseChatCompletionResponse[AssistantWebSearchMessage, ChatWebSearchCompletionChoiceInfo]

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ChunkMessageSpec(role: Option[ChatRole], content: Option[String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class CompletionTokenDetails(reasoning_tokens: Int, accepted_prediction_tokens: Option[Int], rejected_prediction_tokens: Option[Int])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class CreateBatchResponse(id: String, custom_id: String, response: BatchResponse, error: Option[BatchError])

Represents the output of a batch request.

Represents the output of a batch request.

Attributes

custom_id

A developer-provided per-request id that will be used to match outputs to inputs.

error

The error object, which can be null. For requests that failed with a non-HTTP error, this will contain more information on the cause of the failure. It contains a machine-readable error code and a human-readable error message. OpenAI API Reference

id

The unique identifier for the batch request.

response

The response object, which can be null. It contains the HTTP status code, request id, and the JSON body of the response.

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class CreateBatchResponses(responses: Seq[CreateBatchResponse])

Attributes

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

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Deleted.type
object NotDeleted.type
object NotFound.type
object DeleteResponse

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class EmbeddingBatchResponse(status_code: Int, request_id: String, body: EmbeddingResponse) extends BatchResponse

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class EmbeddingInfo(embedding: Seq[Double], index: Int)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class EmbeddingResponse(data: Seq[EmbeddingInfo], model: String, usage: EmbeddingUsageInfo)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class EmbeddingUsageInfo(prompt_tokens: Int, total_tokens: Int)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class FileInfo(id: String, bytes: Long, created_at: Date, updated_at: Option[Date], filename: String, purpose: String, status: String, status_details: Option[String], statistics: Option[FileStatistics])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class FileStatistics(examples: Int, tokens: Int)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class FineTuneCheckpoint(id: String, created_at: Date, fine_tuned_model_checkpoint: String, step_number: Long, metrics: Metrics, fine_tuning_job_id: String)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class FineTuneError(code: String, message: String, param: Option[String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class FineTuneEvent(id: String, created_at: Date, level: String, message: String, data: Option[Map[String, Any]])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class FineTuneHyperparams(batch_size: Option[Either[Int, String]], learning_rate_multiplier: Option[Either[Int, String]], n_epochs: Either[Int, String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class FineTuneJob(id: String, model: String, created_at: Date, finished_at: Option[Date], fine_tuned_model: Option[String], organization_id: String, status: String, training_file: String, validation_file: Option[String], result_files: Seq[String], trained_tokens: Option[Int], error: Option[FineTuneError], hyperparameters: FineTuneHyperparams, integrations: Option[Seq[Integration]], seed: Int)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ImageInfo(created: Date, data: Seq[Map[String, String]])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class LogprobInfo(token: String, logprob: Double, bytes: Seq[Byte], top_logprobs: Seq[TopLogprobInfo])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class Logprobs(content: Seq[LogprobInfo])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class LogprobsInfo(tokens: Seq[String], token_logprobs: Seq[Double], top_logprobs: Seq[Map[String, Double]], text_offset: Seq[Int])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
final case class Metrics(step: Long, train_loss: Double, train_mean_token_accuracy: Double, valid_loss: Double, valid_mean_token_accuracy: Double, full_valid_loss: Double, full_valid_mean_token_accuracy: Double)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ModelInfo(id: String, created: Date, owned_by: String, @Deprecated root: Option[String], @Deprecated parent: Option[String], @Deprecated permission: Seq[Permission])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ModerationCategories(hate: Boolean, hate_threatening: Boolean, self_harm: Boolean, sexual: Boolean, sexual_minors: Boolean, violence: Boolean, violence_graphic: Boolean)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ModerationCategoryScores(hate: Double, hate_threatening: Double, self_harm: Double, sexual: Double, sexual_minors: Double, violence: Double, violence_graphic: Double)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ModerationResponse(id: String, model: String, results: Seq[ModerationResult])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ModerationResult(categories: ModerationCategories, category_scores: ModerationCategoryScores, flagged: Boolean)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class Permission(id: String, created: Date, allow_create_engine: Boolean, allow_sampling: Boolean, allow_logprobs: Boolean, allow_search_indices: Boolean, allow_view: Boolean, allow_fine_tuning: Boolean, organization: String, group: Option[String], is_blocking: Boolean)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class PromptTokensDetails(cached_tokens: Int, audio_tokens: Option[Int])

Attributes

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

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object JsonObjectResponse.type
object StringResponse.type
object TextResponse.type
object ResponseFormat

Attributes

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

Used only for debugging... can be removed later on

Used only for debugging... can be removed later on

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
case class RunResponse(run: Run)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class TextCompletionChoiceInfo(text: String, index: Int, logprobs: Option[LogprobsInfo], finish_reason: Option[String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class TextCompletionResponse(id: String, created: Date, model: String, system_fingerprint: Option[String], choices: Seq[TextCompletionChoiceInfo], usage: Option[UsageInfo])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class TextEditChoiceInfo(text: String, index: Int, logprobs: Option[LogprobsInfo])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class TextEditResponse(created: Date, choices: Seq[TextEditChoiceInfo], usage: UsageInfo)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class TopLogprobInfo(token: String, logprob: Double, bytes: Seq[Short])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class TranscriptResponse(text: String, verboseJson: Option[String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class UsageInfo(prompt_tokens: Int, total_tokens: Int, completion_tokens: Option[Int], prompt_tokens_details: Option[PromptTokensDetails], completion_tokens_details: Option[CompletionTokenDetails])

Attributes

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