AssistantsResponseData

sttp.openai.requests.assistants.AssistantsResponseData

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

case class AssistantData(id: String, `object`: String, createdAt: Int, name: Option[String], description: Option[String], model: String, instructions: Option[String], tools: Seq[Tool], fileIds: Seq[String], metadata: Map[String, String])

Represents an assistant that can call the model and use tools.

Represents an assistant that can call the model and use tools.

Value parameters

createdAt

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

description

The description of the assistant. The maximum length is 512 characters.

fileIds

A list of file IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order.

id

The identifier, which can be referenced in API endpoints.

instructions

The system instructions that the assistant uses. The maximum length is 32768 characters.

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/assistants/object

model

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

name

The name of the assistant. The maximum length is 256 characters.

object

The object type, which is always assistant.

tools

A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, retrieval, or function.

Attributes

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

Attributes

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

Value parameters

assistantId

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

createdAt

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

id

The identifier, which can be referenced in API endpoints.

object

The object type, which is always assistant.file.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class DeleteAssistantFileResponse(id: String, `object`: String, deleted: Boolean)

Value parameters

`object`

assistant.file.deleted

deleted

For more information please visit: https://platform.openai.com/docs/api-reference/assistants/deleteAssistantFile

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class DeleteAssistantResponse(id: String, `object`: String, deleted: Boolean)

Value parameters

`object`

assistant.deleted

deleted

For more information please visit: https://platform.openai.com/docs/api-reference/assistants/deleteAssistant

Attributes

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

Attributes

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

Value parameters

data

A list of assistant objects.

hasMore

}

object

Always "list"

Attributes

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

Attributes

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

Value parameters

data

A list of assistant objects.

hasMore

}

object

Always "list"

Attributes

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

Attributes

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