class Live extends Assistants
- Alphabetic
- By Inheritance
- Live
- Assistants
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def createAssistant(body: CreateAssistantRequest): ZIO[Any, OpenAIFailure, AssistantObject]
Create an assistant with a model and instructions.
Create an assistant with a model and instructions.
- Definition Classes
- Live → Assistants
- def createAssistant(model: Model, name: Optional[Name] = Optional.Absent, description: Optional[Description] = Optional.Absent, instructions: Optional[Instructions] = Optional.Absent, tools: Optional[Chunk[ToolsItem]] = Optional.Absent, fileIds: Optional[Chunk[String]] = Optional.Absent, metadata: Optional[Metadata] = Optional.Absent): ZIO[Any, OpenAIFailure, AssistantObject]
Create an assistant with a model and instructions.
Create an assistant with a model and instructions.
- model
ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.
- name
The name of the assistant. The maximum length is 256 characters.
- description
The description of the assistant. The maximum length is 512 characters.
- instructions
The system instructions that the assistant uses. The maximum length is 32768 characters.
- 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, orfunction.- fileIds
A list of [file](/docs/api-reference/files) 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.
- 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.
- Definition Classes
- Assistants
- def createAssistantFile(assistant_id: String, body: CreateAssistantFileRequest): ZIO[Any, OpenAIFailure, AssistantFileObject]
Create an assistant file by attaching a [File](/docs/api-reference/files) to an [assistant](/docs/api-reference/assistants).
Create an assistant file by attaching a [File](/docs/api-reference/files) to an [assistant](/docs/api-reference/assistants).
- assistant_id
The ID of the assistant for which to create a File.
- Definition Classes
- Live → Assistants
- def deleteAssistant(assistant_id: String): ZIO[Any, OpenAIFailure, DeleteAssistantResponse]
Delete an assistant.
Delete an assistant.
- assistant_id
The ID of the assistant to delete.
- Definition Classes
- Live → Assistants
- def deleteAssistantFile(assistant_id: String, file_id: String): ZIO[Any, OpenAIFailure, DeleteAssistantFileResponse]
Delete an assistant file.
Delete an assistant file.
- assistant_id
The ID of the assistant that the file belongs to.
- file_id
The ID of the file to delete.
- Definition Classes
- Live → Assistants
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def getAssistant(assistant_id: String): ZIO[Any, OpenAIFailure, AssistantObject]
Retrieves an assistant.
Retrieves an assistant.
- assistant_id
The ID of the assistant to retrieve.
- Definition Classes
- Live → Assistants
- def getAssistantFile(assistant_id: String, file_id: String): ZIO[Any, OpenAIFailure, AssistantFileObject]
Retrieves an AssistantFile.
Retrieves an AssistantFile.
- assistant_id
The ID of the assistant who the file belongs to.
- file_id
The ID of the file we're getting.
- Definition Classes
- Live → Assistants
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def listAssistantFiles(assistant_id: String, limit: Optional[Int] = Optional.Absent, order: Optional[AssistantsListAssistantFilesOrder] = Optional.Absent, after: Optional[String] = Optional.Absent, before: Optional[String] = Optional.Absent): ZIO[Any, OpenAIFailure, ListAssistantFilesResponse]
Returns a list of assistant files.
Returns a list of assistant files.
- assistant_id
The ID of the assistant the file belongs to.
- limit
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
- order
Sort order by the
created_attimestamp of the objects.ascfor ascending order anddescfor descending order.- after
A cursor for use in pagination.
afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.- before
A cursor for use in pagination.
beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
- Definition Classes
- Live → Assistants
- def listAssistants(limit: Optional[Int] = Optional.Absent, order: Optional[AssistantsListAssistantsOrder] = Optional.Absent, after: Optional[String] = Optional.Absent, before: Optional[String] = Optional.Absent): ZIO[Any, OpenAIFailure, ListAssistantsResponse]
Returns a list of assistants.
Returns a list of assistants.
- limit
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
- order
Sort order by the
created_attimestamp of the objects.ascfor ascending order anddescfor descending order.- after
A cursor for use in pagination.
afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.- before
A cursor for use in pagination.
beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
- Definition Classes
- Live → Assistants
- def modifyAssistant(assistant_id: String, body: ModifyAssistantRequest): ZIO[Any, OpenAIFailure, AssistantObject]
Modifies an assistant.
Modifies an assistant.
- assistant_id
The ID of the assistant to modify.
- Definition Classes
- Live → Assistants
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])