Safe Haskell	Safe-Inferred
Language	Haskell2010

OpenAI.V1.Threads

Contents

Other types
Servant

Description

/v1/threads

Synopsis

newtype ThreadID = ThreadID {
- text :: Text
}
data Thread = Thread {
- messages :: Maybe (Vector Message)
- tool_resources :: Maybe ToolResources
- metadata :: Maybe (Map Text Text)
}
_Thread :: Thread
data ModifyThread = ModifyThread {
- tool_resources :: Maybe ToolResources
- metadata :: Maybe (Map Text Text)
}
_ModifyThread :: ModifyThread
data Message
- = User {
  - content :: Vector (Content Text)
  - attachments :: Maybe (Vector Attachment)
  - metadata :: Maybe (Map Text Text)
  }
- | Assistant {
  - content :: Vector (Content Text)
  - attachments :: Maybe (Vector Attachment)
  - metadata :: Maybe (Map Text Text)
  }
data Content text
- = Image_File {
  - image_file :: ImageFile
  }
- | Image_URL {
  - image_url :: ImageURL
  }
- | Text {
  - text :: text
  }
data ThreadObject = ThreadObject {
- id :: ThreadID
- object :: Text
- created_at :: POSIXTime
- tool_resources :: Maybe ToolResources
- metadata :: Maybe (Map Text Text)
}
data ImageURL = ImageURL {
- image_url :: Text
- detail :: Maybe (AutoOr Text)
}
data ImageFile = ImageFile {
- file_id :: FileID
- detail :: Maybe (AutoOr Text)
}
data Attachment = Attachment {
- file_id :: FileID
- tools :: Maybe (Vector Tool)
}
type API = "threads" :> (Header' '[Required, Strict] "OpenAI-Beta" Text :> ((ReqBody '[JSON] Thread :> Post '[JSON] ThreadObject) :<|> ((Capture "thread_id" ThreadID :> Get '[JSON] ThreadObject) :<|> ((Capture "thread_id" ThreadID :> (ReqBody '[JSON] ModifyThread :> Post '[JSON] ThreadObject)) :<|> (Capture "thread_id" ThreadID :> Delete '[JSON] DeletionStatus)))))

Documentation

newtype ThreadID Source #

Thread ID

Constructors

ThreadID
Fields text :: Text

Instances

Instances details

FromJSON ThreadID Source #
Instance details Defined in OpenAI.V1.Threads Methods parseJSON :: Value -> Parser ThreadID # parseJSONList :: Value -> Parser [ThreadID] # omittedField :: Maybe ThreadID #
ToJSON ThreadID Source #
Instance details Defined in OpenAI.V1.Threads Methods toJSON :: ThreadID -> Value # toEncoding :: ThreadID -> Encoding # toJSONList :: [ThreadID] -> Value # toEncodingList :: [ThreadID] -> Encoding # omitField :: ThreadID -> Bool #
IsString ThreadID Source #
Instance details Defined in OpenAI.V1.Threads Methods fromString :: String -> ThreadID #
Show ThreadID Source #
Instance details Defined in OpenAI.V1.Threads Methods showsPrec :: Int -> ThreadID -> ShowS # show :: ThreadID -> String # showList :: [ThreadID] -> ShowS #
ToHttpApiData ThreadID Source #
Instance details Defined in OpenAI.V1.Threads Methods toUrlPiece :: ThreadID -> Text # toEncodedUrlPiece :: ThreadID -> Builder # toHeader :: ThreadID -> ByteString # toQueryParam :: ThreadID -> Text # toEncodedQueryParam :: ThreadID -> Builder #

data Thread Source #

Request body for /v1/threads

Constructors

Thread
Fields messages :: Maybe (Vector Message) tool_resources :: Maybe ToolResources metadata :: Maybe (Map Text Text)

Instances

Instances details

ToJSON Thread Source #
Instance details Defined in OpenAI.V1.Threads Methods toJSON :: Thread -> Value # toEncoding :: Thread -> Encoding # toJSONList :: [Thread] -> Value # toEncodingList :: [Thread] -> Encoding # omitField :: Thread -> Bool #
Generic Thread Source #
Instance details Defined in OpenAI.V1.Threads Associated Types type Rep Thread :: Type -> Type # Methods from :: Thread -> Rep Thread x # to :: Rep Thread x -> Thread #
Show Thread Source #
Instance details Defined in OpenAI.V1.Threads Methods showsPrec :: Int -> Thread -> ShowS # show :: Thread -> String # showList :: [Thread] -> ShowS #
type Rep Thread Source #
Instance details Defined in OpenAI.V1.Threads type Rep Thread = D1 ('MetaData "Thread" "OpenAI.V1.Threads" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Thread" 'PrefixI 'True) (S1 ('MetaSel ('Just "messages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Message))) :: (S1 ('MetaSel ('Just "tool_resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ToolResources)) :: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text))))))

_Thread :: Thread Source #

Default Thread

data ModifyThread Source #

Request body for /v1/threads/:thread_id

Constructors

ModifyThread
Fields tool_resources :: Maybe ToolResources metadata :: Maybe (Map Text Text)

Instances

Instances details

ToJSON ModifyThread Source #
Instance details Defined in OpenAI.V1.Threads Methods toJSON :: ModifyThread -> Value # toEncoding :: ModifyThread -> Encoding # toJSONList :: [ModifyThread] -> Value # toEncodingList :: [ModifyThread] -> Encoding # omitField :: ModifyThread -> Bool #
Generic ModifyThread Source #
Instance details Defined in OpenAI.V1.Threads Associated Types type Rep ModifyThread :: Type -> Type # Methods from :: ModifyThread -> Rep ModifyThread x # to :: Rep ModifyThread x -> ModifyThread #
Show ModifyThread Source #
Instance details Defined in OpenAI.V1.Threads Methods showsPrec :: Int -> ModifyThread -> ShowS # show :: ModifyThread -> String # showList :: [ModifyThread] -> ShowS #
type Rep ModifyThread Source #
Instance details Defined in OpenAI.V1.Threads type Rep ModifyThread = D1 ('MetaData "ModifyThread" "OpenAI.V1.Threads" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "ModifyThread" 'PrefixI 'True) (S1 ('MetaSel ('Just "tool_resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ToolResources)) :*: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text)))))

_ModifyThread :: ModifyThread Source #

Default ModifyThread

data Message Source #

A message

Constructors

User
Fields content :: Vector (Content Text) attachments :: Maybe (Vector Attachment) metadata :: Maybe (Map Text Text)
Assistant
Fields content :: Vector (Content Text) attachments :: Maybe (Vector Attachment) metadata :: Maybe (Map Text Text)

Instances

Instances details

ToJSON Message Source #
Instance details Defined in OpenAI.V1.Message Methods toJSON :: Message -> Value # toEncoding :: Message -> Encoding # toJSONList :: [Message] -> Value # toEncodingList :: [Message] -> Encoding # omitField :: Message -> Bool #
Generic Message Source #
Instance details Defined in OpenAI.V1.Message Associated Types type Rep Message :: Type -> Type # Methods from :: Message -> Rep Message x # to :: Rep Message x -> Message #
Show Message Source #
Instance details Defined in OpenAI.V1.Message Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
type Rep Message Source #
Instance details Defined in OpenAI.V1.Message type Rep Message = D1 ('MetaData "Message" "OpenAI.V1.Message" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "User" 'PrefixI 'True) (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector (Content Text))) :: (S1 ('MetaSel ('Just "attachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Attachment))) :: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text))))) :+: C1 ('MetaCons "Assistant" 'PrefixI 'True) (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector (Content Text))) :: (S1 ('MetaSel ('Just "attachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Attachment))) :: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text))))))

data Content text Source #

Message content

Constructors

Image_File
Fields image_file :: ImageFile
Image_URL
Fields image_url :: ImageURL
Text
Fields text :: text

Instances

Instances details

FromJSON text => FromJSON (Content text) Source #
Instance details Defined in OpenAI.V1.Message Methods parseJSON :: Value -> Parser (Content text) # parseJSONList :: Value -> Parser [Content text] # omittedField :: Maybe (Content text) #
ToJSON text => ToJSON (Content text) Source #
Instance details Defined in OpenAI.V1.Message Methods toJSON :: Content text -> Value # toEncoding :: Content text -> Encoding # toJSONList :: [Content text] -> Value # toEncodingList :: [Content text] -> Encoding # omitField :: Content text -> Bool #
IsString text => IsString (Content text) Source #
Instance details Defined in OpenAI.V1.Message Methods fromString :: String -> Content text #
Generic (Content text) Source #
Instance details Defined in OpenAI.V1.Message Associated Types type Rep (Content text) :: Type -> Type # Methods from :: Content text -> Rep (Content text) x # to :: Rep (Content text) x -> Content text #
Show text => Show (Content text) Source #
Instance details Defined in OpenAI.V1.Message Methods showsPrec :: Int -> Content text -> ShowS # show :: Content text -> String # showList :: [Content text] -> ShowS #
type Rep (Content text) Source #
Instance details Defined in OpenAI.V1.Message type Rep (Content text) = D1 ('MetaData "Content" "OpenAI.V1.Message" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Image_File" 'PrefixI 'True) (S1 ('MetaSel ('Just "image_file") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ImageFile)) :+: (C1 ('MetaCons "Image_URL" 'PrefixI 'True) (S1 ('MetaSel ('Just "image_url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ImageURL)) :+: C1 ('MetaCons "Text" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 text))))

data ThreadObject Source #

Represents a thread that contains messages

Constructors

ThreadObject
Fields id :: ThreadID object :: Text created_at :: POSIXTime tool_resources :: Maybe ToolResources metadata :: Maybe (Map Text Text)

Instances

Instances details

FromJSON ThreadObject Source #
Instance details Defined in OpenAI.V1.Threads Methods parseJSON :: Value -> Parser ThreadObject # parseJSONList :: Value -> Parser [ThreadObject] # omittedField :: Maybe ThreadObject #
Generic ThreadObject Source #
Instance details Defined in OpenAI.V1.Threads Associated Types type Rep ThreadObject :: Type -> Type # Methods from :: ThreadObject -> Rep ThreadObject x # to :: Rep ThreadObject x -> ThreadObject #
Show ThreadObject Source #
Instance details Defined in OpenAI.V1.Threads Methods showsPrec :: Int -> ThreadObject -> ShowS # show :: ThreadObject -> String # showList :: [ThreadObject] -> ShowS #
type Rep ThreadObject Source #
Instance details Defined in OpenAI.V1.Threads type Rep ThreadObject = D1 ('MetaData "ThreadObject" "OpenAI.V1.Threads" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "ThreadObject" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ThreadID) :: S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "created_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime) :: (S1 ('MetaSel ('Just "tool_resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ToolResources)) :: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text)))))))

Other types

data ImageURL Source #

References an image URL in the content of a message

Constructors

ImageURL
Fields image_url :: Text detail :: Maybe (AutoOr Text)

Instances

Instances details

FromJSON ImageURL Source #
Instance details Defined in OpenAI.V1.Message Methods parseJSON :: Value -> Parser ImageURL # parseJSONList :: Value -> Parser [ImageURL] # omittedField :: Maybe ImageURL #
ToJSON ImageURL Source #
Instance details Defined in OpenAI.V1.Message Methods toJSON :: ImageURL -> Value # toEncoding :: ImageURL -> Encoding # toJSONList :: [ImageURL] -> Value # toEncodingList :: [ImageURL] -> Encoding # omitField :: ImageURL -> Bool #
Generic ImageURL Source #
Instance details Defined in OpenAI.V1.Message Associated Types type Rep ImageURL :: Type -> Type # Methods from :: ImageURL -> Rep ImageURL x # to :: Rep ImageURL x -> ImageURL #
Show ImageURL Source #
Instance details Defined in OpenAI.V1.Message Methods showsPrec :: Int -> ImageURL -> ShowS # show :: ImageURL -> String # showList :: [ImageURL] -> ShowS #
type Rep ImageURL Source #
Instance details Defined in OpenAI.V1.Message type Rep ImageURL = D1 ('MetaData "ImageURL" "OpenAI.V1.Message" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "ImageURL" 'PrefixI 'True) (S1 ('MetaSel ('Just "image_url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "detail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (AutoOr Text)))))

data ImageFile Source #

References an image File in the content of a message

Constructors

ImageFile
Fields file_id :: FileID detail :: Maybe (AutoOr Text)

Instances

Instances details

FromJSON ImageFile Source #
Instance details Defined in OpenAI.V1.Message Methods parseJSON :: Value -> Parser ImageFile # parseJSONList :: Value -> Parser [ImageFile] # omittedField :: Maybe ImageFile #
ToJSON ImageFile Source #
Instance details Defined in OpenAI.V1.Message Methods toJSON :: ImageFile -> Value # toEncoding :: ImageFile -> Encoding # toJSONList :: [ImageFile] -> Value # toEncodingList :: [ImageFile] -> Encoding # omitField :: ImageFile -> Bool #
Generic ImageFile Source #
Instance details Defined in OpenAI.V1.Message Associated Types type Rep ImageFile :: Type -> Type # Methods from :: ImageFile -> Rep ImageFile x # to :: Rep ImageFile x -> ImageFile #
Show ImageFile Source #
Instance details Defined in OpenAI.V1.Message Methods showsPrec :: Int -> ImageFile -> ShowS # show :: ImageFile -> String # showList :: [ImageFile] -> ShowS #
type Rep ImageFile Source #
Instance details Defined in OpenAI.V1.Message type Rep ImageFile = D1 ('MetaData "ImageFile" "OpenAI.V1.Message" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "ImageFile" 'PrefixI 'True) (S1 ('MetaSel ('Just "file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileID) :*: S1 ('MetaSel ('Just "detail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (AutoOr Text)))))

data Attachment Source #

A file attached to the message, and the tools it should be added to

Constructors

Attachment
Fields file_id :: FileID tools :: Maybe (Vector Tool)

Instances

Instances details

FromJSON Attachment Source #
Instance details Defined in OpenAI.V1.Message Methods parseJSON :: Value -> Parser Attachment # parseJSONList :: Value -> Parser [Attachment] # omittedField :: Maybe Attachment #
ToJSON Attachment Source #
Instance details Defined in OpenAI.V1.Message Methods toJSON :: Attachment -> Value # toEncoding :: Attachment -> Encoding # toJSONList :: [Attachment] -> Value # toEncodingList :: [Attachment] -> Encoding # omitField :: Attachment -> Bool #
Generic Attachment Source #
Instance details Defined in OpenAI.V1.Message Associated Types type Rep Attachment :: Type -> Type # Methods from :: Attachment -> Rep Attachment x # to :: Rep Attachment x -> Attachment #
Show Attachment Source #
Instance details Defined in OpenAI.V1.Message Methods showsPrec :: Int -> Attachment -> ShowS # show :: Attachment -> String # showList :: [Attachment] -> ShowS #
type Rep Attachment Source #
Instance details Defined in OpenAI.V1.Message type Rep Attachment = D1 ('MetaData "Attachment" "OpenAI.V1.Message" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Attachment" 'PrefixI 'True) (S1 ('MetaSel ('Just "file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileID) :*: S1 ('MetaSel ('Just "tools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Tool)))))

Servant

type API = "threads" :> (Header' '[Required, Strict] "OpenAI-Beta" Text :> ((ReqBody '[JSON] Thread :> Post '[JSON] ThreadObject) :<|> ((Capture "thread_id" ThreadID :> Get '[JSON] ThreadObject) :<|> ((Capture "thread_id" ThreadID :> (ReqBody '[JSON] ModifyThread :> Post '[JSON] ThreadObject)) :<|> (Capture "thread_id" ThreadID :> Delete '[JSON] DeletionStatus))))) Source #

Servant API