Packages

final case class ModifyAssistantRequest(model: Optional[ModifyAssistantRequest.Model] = Optional.Absent, 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) extends Product with Serializable

ModifyAssistantRequest model

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, or function.

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. If a file was previously attached to the list but does not show up in the list, it will be deleted from the assistant.

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.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ModifyAssistantRequest
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ModifyAssistantRequest(model: Optional[ModifyAssistantRequest.Model] = Optional.Absent, 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)

    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, or function.

    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. If a file was previously attached to the list but does not show up in the list, it will be deleted from the assistant.

    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.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. val description: Optional[Description]
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val fileIds: Optional[Chunk[String]]
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. val instructions: Optional[Instructions]
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val metadata: Optional[Metadata]
  13. val model: Optional[ModifyAssistantRequest.Model]
  14. val name: Optional[Name]
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. val tools: Optional[Chunk[ToolsItem]]
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped