core
API
Generated with
core/sttp.openai/sttp.openai.requests/sttp.openai.requests.threads/sttp.openai.requests.threads.messages/ThreadMessagesResponseData

ThreadMessagesResponseData

sttp.openai.requests.threads.messages.ThreadMessagesResponseData
object ThreadMessagesResponseData

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

sealed trait Annotation

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Content

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Content.type
trait Content

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class TextContent
case class FileCitation(fileId: String, quote: String)

Value parameters

fileId

The ID of the specific File the citation is from.

quote

The specific quote in the file.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class FileCitationAnnotation(`type`: String, text: String, fileCitation: FileCitation, startIndex: Int, endIndex: Int) extends Annotation

A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "retrieval" tool to search files.

A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "retrieval" tool to search files.

Value parameters

text

The text in the message content that needs to be replaced.

type

Always file_citation.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Annotation
class Object
trait Matchable
class Any
Show all
case class FilePath(fileId: String)

Value parameters

fileId

The ID of the file that was generated.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class FilePathAnnotation(`type`: String, text: String, filePath: FilePath, startIndex: Int, endIndex: Int) extends Annotation

URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.

URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.

Value parameters

text

The text in the message content that needs to be replaced.

type

Always "file_path".

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Annotation
class Object
trait Matchable
class Any
Show all
case class ListMessageFilesResponse(`object`: String, data: Seq[MessageFileData], firstId: String, lastId: String, hasMore: Boolean)

Value parameters

data

A list of message file objects.

hasMore

}

object

Always "list"

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ListMessageFilesResponse

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ListMessagesResponse(`object`: String, data: Seq[MessageData], firstId: String, lastId: String, hasMore: Boolean)

Value parameters

data

A list of message objects.

hasMore

}

object

Always "list"

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ListMessagesResponse

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class MessageData(id: String, `object`: String, createdAt: Int, threadId: Option[String], role: String, content: Seq[Content], assistantId: Option[String], runId: Option[String], fileIds: Seq[String], metadata: Map[String, String])

Value parameters

assistantId

If applicable, the ID of the assistant that authored this message.

content

The content of the message in array of text and/or images.

createdAt

The Unix timestamp (in seconds) for when the message was created.

fileIds

A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can access files. A maximum of 10 files can be attached to a message.

id

The identifier, which can be referenced in API endpoints.

metadata

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. For more information please visit: https://platform.openai.com/docs/api-reference/messages/object

object

The object type, which is always thread.message.

role

The entity that produced the message. One of user or assistant.

runId

If applicable, the ID of the run associated with the authoring of this message.

threadId

The thread ID that this message belongs to.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MessageData

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class MessageFileData(id: String, `object`: String, createdAt: Int, messageId: String)

Value parameters

createdAt

The Unix timestamp (in seconds) for when the message file was created.

id

The identifier, which can be referenced in API endpoints.

messageId

The ID of the message that the File is attached to. For more information please visit: https://platform.openai.com/docs/api-reference/messages/file-object

object

The object type, which is always thread.message.file.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MessageFileData

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Implicits

Implicits

implicit val annotationR: Reader[Annotation]
implicit val filePathR: Reader[FilePath]
Generated with