OpenAI.V1.Threads.Messages

/v1/threads:thread_idmessages

Main types

newtype MessageID

Message ID

Constructors

MessageID

Fields

• text :: Text

Instances

FromJSON MessageID

Defined in OpenAI.V1.Threads.Messages

Methods

parseJSON :: Value -> Parser MessageID

parseJSONList :: Value -> Parser [MessageID]

omittedField :: Maybe MessageID

ToJSON MessageID

Defined in OpenAI.V1.Threads.Messages

Methods

toJSON :: MessageID -> Value

toEncoding :: MessageID -> Encoding

toJSONList :: [MessageID] -> Value

toEncodingList :: [MessageID] -> Encoding

omitField :: MessageID -> Bool

IsString MessageID

Defined in OpenAI.V1.Threads.Messages

Methods

fromString :: String -> MessageID

Show MessageID

Defined in OpenAI.V1.Threads.Messages

Methods

showsPrec :: Int -> MessageID -> ShowS

show :: MessageID -> String

showList :: [MessageID] -> ShowS

ToHttpApiData MessageID

Defined in OpenAI.V1.Threads.Messages

Methods

toUrlPiece :: MessageID -> Text

toEncodedUrlPiece :: MessageID -> Builder

toHeader :: MessageID -> ByteString

toQueryParam :: MessageID -> Text

toEncodedQueryParam :: MessageID -> Builder

data Message

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

ToJSON Message

Defined in OpenAI.V1.Message

Methods

toJSON :: Message -> Value

toEncoding :: Message -> Encoding

toJSONList :: [Message] -> Value

toEncodingList :: [Message] -> Encoding

omitField :: Message -> Bool

Generic Message

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

Defined in OpenAI.V1.Message

Methods

showsPrec :: Int -> Message -> ShowS

show :: Message -> String

showList :: [Message] -> ShowS

type Rep Message

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 ModifyMessage

Request body for /v1/threads/:thread_id/messages/:message_id

Constructors

ModifyMessage

Fields

• metadata :: Maybe (Map Text Text)

Instances

ToJSON ModifyMessage

Defined in OpenAI.V1.Threads.Messages

Methods

toJSON :: ModifyMessage -> Value

toEncoding :: ModifyMessage -> Encoding

toJSONList :: [ModifyMessage] -> Value

toEncodingList :: [ModifyMessage] -> Encoding

omitField :: ModifyMessage -> Bool

Generic ModifyMessage

Defined in OpenAI.V1.Threads.Messages

Associated Types

type Rep ModifyMessage :: Type -> Type

Methods

from :: ModifyMessage -> Rep ModifyMessage x

to :: Rep ModifyMessage x -> ModifyMessage

Show ModifyMessage

Defined in OpenAI.V1.Threads.Messages

Methods

showsPrec :: Int -> ModifyMessage -> ShowS

show :: ModifyMessage -> String

showList :: [ModifyMessage] -> ShowS

type Rep ModifyMessage

Defined in OpenAI.V1.Threads.Messages

type Rep ModifyMessage = D1 ('MetaData "ModifyMessage" "OpenAI.V1.Threads.Messages" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "ModifyMessage" 'PrefixI 'True) (S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text)))))

_ModifyMessage :: ModifyMessage

Default ModifyMessage

data MessageObject

Represents a message within a thread.

Constructors

MessageObject

Fields

• id :: MessageID
• object :: Text
• created_at :: POSIXTime
• thread_id :: ThreadID
• status :: Maybe Status
• incomplete_details :: Maybe IncompleteDetails
• completed_at :: Maybe POSIXTime
• incomplete_at :: Maybe POSIXTime
• role :: Text
• content :: Vector (Content TextObject)
• assistant_id :: Maybe AssistantID
• run_id :: Maybe RunID
• attachments :: Maybe (Vector Attachment)
• metadata :: Map Text Text

Instances

FromJSON MessageObject

Defined in OpenAI.V1.Threads.Messages

Methods

parseJSON :: Value -> Parser MessageObject

parseJSONList :: Value -> Parser [MessageObject]

omittedField :: Maybe MessageObject

Generic MessageObject

Defined in OpenAI.V1.Threads.Messages

Associated Types

type Rep MessageObject :: Type -> Type

Methods

from :: MessageObject -> Rep MessageObject x

to :: Rep MessageObject x -> MessageObject

Show MessageObject

Defined in OpenAI.V1.Threads.Messages

Methods

showsPrec :: Int -> MessageObject -> ShowS

show :: MessageObject -> String

showList :: [MessageObject] -> ShowS

type Rep MessageObject

Defined in OpenAI.V1.Threads.Messages

type Rep MessageObject = D1 ('MetaData "MessageObject" "OpenAI.V1.Threads.Messages" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "MessageObject" 'PrefixI 'True) (((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageID) :*: (S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "created_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime))) :*: ((S1 ('MetaSel ('Just "thread_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ThreadID) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Status))) :*: (S1 ('MetaSel ('Just "incomplete_details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe IncompleteDetails)) :*: S1 ('MetaSel ('Just "completed_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime))))) :*: ((S1 ('MetaSel ('Just "incomplete_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime)) :*: (S1 ('MetaSel ('Just "role") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector (Content TextObject))))) :*: ((S1 ('MetaSel ('Just "assistant_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe AssistantID)) :*: S1 ('MetaSel ('Just "run_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe RunID))) :*: (S1 ('MetaSel ('Just "attachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Attachment))) :*: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Text)))))))

Other types

data Status

The status of the message

Constructors

In_Progress

Incomplete

Completed

Instances

FromJSON Status

Defined in OpenAI.V1.Threads.Messages

Methods

parseJSON :: Value -> Parser Status

parseJSONList :: Value -> Parser [Status]

omittedField :: Maybe Status

Generic Status

Defined in OpenAI.V1.Threads.Messages

Associated Types

type Rep Status :: Type -> Type

Methods

from :: Status -> Rep Status x

to :: Rep Status x -> Status

Show Status

Defined in OpenAI.V1.Threads.Messages

Methods

showsPrec :: Int -> Status -> ShowS

show :: Status -> String

showList :: [Status] -> ShowS

type Rep Status

Defined in OpenAI.V1.Threads.Messages

type Rep Status = D1 ('MetaData "Status" "OpenAI.V1.Threads.Messages" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "In_Progress" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Incomplete" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Completed" 'PrefixI 'False) (U1 :: Type -> Type)))

data IncompleteDetails

On an incomplete message, details about why the message is incomplete.

Constructors

IncompleteDetails

Fields

• reason :: Text

Instances

FromJSON IncompleteDetails

Defined in OpenAI.V1.Threads.Messages

Methods

parseJSON :: Value -> Parser IncompleteDetails

parseJSONList :: Value -> Parser [IncompleteDetails]

omittedField :: Maybe IncompleteDetails

Generic IncompleteDetails

Defined in OpenAI.V1.Threads.Messages

Associated Types

type Rep IncompleteDetails :: Type -> Type

Methods

from :: IncompleteDetails -> Rep IncompleteDetails x

to :: Rep IncompleteDetails x -> IncompleteDetails

Show IncompleteDetails

Defined in OpenAI.V1.Threads.Messages

Methods

showsPrec :: Int -> IncompleteDetails -> ShowS

show :: IncompleteDetails -> String

showList :: [IncompleteDetails] -> ShowS

type Rep IncompleteDetails

Defined in OpenAI.V1.Threads.Messages

type Rep IncompleteDetails = D1 ('MetaData "IncompleteDetails" "OpenAI.V1.Threads.Messages" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "IncompleteDetails" 'PrefixI 'True) (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data File

File

Constructors

File

Fields

• file_id :: FileID

Instances

FromJSON File

Defined in OpenAI.V1.Threads.Messages

Methods

parseJSON :: Value -> Parser File

parseJSONList :: Value -> Parser [File]

omittedField :: Maybe File

Generic File

Defined in OpenAI.V1.Threads.Messages

Associated Types

type Rep File :: Type -> Type

Methods

from :: File -> Rep File x

to :: Rep File x -> File

Show File

Defined in OpenAI.V1.Threads.Messages

Methods

showsPrec :: Int -> File -> ShowS

show :: File -> String

showList :: [File] -> ShowS

type Rep File

Defined in OpenAI.V1.Threads.Messages

type Rep File = D1 ('MetaData "File" "OpenAI.V1.Threads.Messages" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "File" 'PrefixI 'True) (S1 ('MetaSel ('Just "file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileID)))

data Annotation

An annotation

Constructors

File_Citation

Fields

• text :: Text
• file_citation :: File
• start_index :: Natural
• end_index :: Natural

File_Path

Fields

• text :: Text
• file_path :: File
• start_index :: Natural
• end_index :: Natural

Instances

FromJSON Annotation

Defined in OpenAI.V1.Threads.Messages

Methods

parseJSON :: Value -> Parser Annotation

parseJSONList :: Value -> Parser [Annotation]

omittedField :: Maybe Annotation

Generic Annotation

Defined in OpenAI.V1.Threads.Messages

Associated Types

type Rep Annotation :: Type -> Type

Methods

from :: Annotation -> Rep Annotation x

to :: Rep Annotation x -> Annotation

Show Annotation

Defined in OpenAI.V1.Threads.Messages

Methods

showsPrec :: Int -> Annotation -> ShowS

show :: Annotation -> String

showList :: [Annotation] -> ShowS

type Rep Annotation

Defined in OpenAI.V1.Threads.Messages

type Rep Annotation = D1 ('MetaData "Annotation" "OpenAI.V1.Threads.Messages" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "File_Citation" 'PrefixI 'True) ((S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "file_citation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 File)) :*: (S1 ('MetaSel ('Just "start_index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "end_index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural))) :+: C1 ('MetaCons "File_Path" 'PrefixI 'True) ((S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "file_path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 File)) :*: (S1 ('MetaSel ('Just "start_index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "end_index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural))))

data TextObject

The text content that is part of a message.

Constructors

TextObject

Fields

• value :: Text
• annotations :: Vector Annotation

Instances

FromJSON TextObject

Defined in OpenAI.V1.Threads.Messages

Methods

parseJSON :: Value -> Parser TextObject

parseJSONList :: Value -> Parser [TextObject]

omittedField :: Maybe TextObject

IsString TextObject

Defined in OpenAI.V1.Threads.Messages

Methods

fromString :: String -> TextObject

Generic TextObject

Defined in OpenAI.V1.Threads.Messages

Associated Types

type Rep TextObject :: Type -> Type

Methods

from :: TextObject -> Rep TextObject x

to :: Rep TextObject x -> TextObject

Show TextObject

Defined in OpenAI.V1.Threads.Messages

Methods

showsPrec :: Int -> TextObject -> ShowS

show :: TextObject -> String

showList :: [TextObject] -> ShowS

type Rep TextObject

Defined in OpenAI.V1.Threads.Messages

type Rep TextObject = D1 ('MetaData "TextObject" "OpenAI.V1.Threads.Messages" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "TextObject" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "annotations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Annotation))))

Servant

type API = Header' '[Required, Strict] "OpenAI-Beta" Text :> ("threads" :> ((Capture "thread_id" ThreadID :> ("messages" :> (ReqBody '[JSON] Message :> Post '[JSON] MessageObject))) :<|> ((Capture "thread_id" ThreadID :> ("messages" :> Get '[JSON] (ListOf MessageObject))) :<|> ((Capture "thread_id" ThreadID :> ("messages" :> (Capture "message_id" MessageID :> Get '[JSON] MessageObject))) :<|> ((Capture "thread_id" ThreadID :> ("messages" :> (Capture "message_id" MessageID :> (ReqBody '[JSON] ModifyMessage :> Post '[JSON] MessageObject)))) :<|> (Capture "thread_id" ThreadID :> ("messages" :> (Capture "message_id" MessageID :> Delete '[JSON] DeletionStatus))))))))

Servant API