sttp.openai.requests.assistants.AssistantsResponseData.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core_3 Show documentation
core
There is a newer version: 0.2.6
package sttp.openai.requests.assistants

import sttp.openai.json.SnakePickle
import sttp.openai.requests.completions.chat.message.Tool

object AssistantsResponseData {

  /** Represents an assistant that can call the model and use tools.
    * @param id
    *   The identifier, which can be referenced in API endpoints.
    *
    * @param object
    *   The object type, which is always assistant.
    *
    * @param createdAt
    *   The Unix timestamp (in seconds) for when the assistant was created.
    *
    * @param name
    *   The name of the assistant. The maximum length is 256 characters.
    *
    * @param description
    *   The description of the assistant. The maximum length is 512 characters.
    *
    * @param 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.
    *
    * @param instructions
    *   The system instructions that the assistant uses. The maximum length is 32768 characters.
    *
    * @param 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.
    *
    * @param 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.
    *
    * @param 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]]
    */
  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]
  )

  object AssistantData {
    implicit val assistantDataR: SnakePickle.Reader[AssistantData] = SnakePickle.macroR[AssistantData]
  }

  /** @param id
    *   The identifier, which can be referenced in API endpoints.
    *
    * @param object
    *   The object type, which is always assistant.file.
    *
    * @param createdAt
    *   The Unix timestamp (in seconds) for when the assistant file was created.
    *
    * @param 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]]
    */

  case class AssistantFileData(
      id: String,
      `object`: String,
      createdAt: Int,
      assistantId: String
  )

  object AssistantFileData {
    implicit val assistantFileDataR: SnakePickle.Reader[AssistantFileData] = SnakePickle.macroR[AssistantFileData]
  }

  /** @param object
    *   Always "list"
    * @param data
    *   A list of assistant objects.
    * @param firstId
    * @param lastId
    * @param hasMore
    *   }
    */
  case class ListAssistantsResponse(
      `object`: String = "list",
      data: Seq[AssistantData],
      firstId: String,
      lastId: String,
      hasMore: Boolean
  )
  object ListAssistantsResponse {
    implicit val listAssistantsResponseR: SnakePickle.Reader[ListAssistantsResponse] = SnakePickle.macroR[ListAssistantsResponse]
  }

  /** @param object
    *   Always "list"
    * @param data
    *   A list of assistant objects.
    * @param firstId
    * @param lastId
    * @param hasMore
    *   }
    */
  case class ListAssistantFilesResponse(
      `object`: String = "list",
      data: Seq[AssistantFileData],
      firstId: String,
      lastId: String,
      hasMore: Boolean
  )
  object ListAssistantFilesResponse {
    implicit val listAssistantFilesResponseR: SnakePickle.Reader[ListAssistantFilesResponse] =
      SnakePickle.macroR[ListAssistantFilesResponse]
  }

  /** @param id
    * @param `object`
    *   assistant.deleted
    * @param deleted
    *
    * For more information please visit: [[https://platform.openai.com/docs/api-reference/assistants/deleteAssistant]]
    */
  case class DeleteAssistantResponse(
      id: String,
      `object`: String,
      deleted: Boolean
  )

  object DeleteAssistantResponse {
    implicit val deleteAssistantResponseReadWriter: SnakePickle.ReadWriter[DeleteAssistantResponse] =
      SnakePickle.macroRW[DeleteAssistantResponse]
  }

  /** @param id
    * @param `object`
    *   assistant.file.deleted
    * @param deleted
    *
    * For more information please visit: [[https://platform.openai.com/docs/api-reference/assistants/deleteAssistantFile]]
    */
  case class DeleteAssistantFileResponse(
      id: String,
      `object`: String,
      deleted: Boolean
  )

  object DeleteAssistantFileResponse {
    implicit val deleteAssistantFileResponseReadWriter: SnakePickle.ReadWriter[DeleteAssistantFileResponse] =
      SnakePickle.macroRW[DeleteAssistantFileResponse]
  }
}