Safe Haskell	None
Language	Haskell2010

OpenAI.V1.Threads.Messages

Contents

Main types
Other types
Servant

Description

/v1/threads:thread_idmessages

Synopsis

newtype MessageID = MessageID {
- text :: Text
}
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 ModifyMessage = ModifyMessage {
- metadata :: Maybe (Map Text Text)
}
_ModifyMessage :: ModifyMessage
data MessageObject = MessageObject {
- 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
}
data Status
- = In_Progress
- | Incomplete
- | Completed
data IncompleteDetails = IncompleteDetails {
- reason :: Text
}
data File = File {
- file_id :: FileID
}
data Annotation
- = File_Citation {
  - text :: Text
  - file_citation :: File
  - start_index :: Natural
  - end_index :: Natural
  }
- | File_Path {
  - text :: Text
  - file_path :: File
  - start_index :: Natural
  - end_index :: Natural
  }
data TextObject = TextObject {
- value :: Text
- annotations :: Vector Annotation
}
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))))))))

Main types

newtype MessageID Source #

Message ID

Constructors

MessageID
Fields text :: Text

Instances

Instances details

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

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

FromJSON Message Source #

Instance details

Defined in OpenAI.V1.Message

Methods

parseJSON :: Value -> Parser Message #

parseJSONList :: Value -> Parser [Message] #

omittedField :: Maybe Message #

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

Instance details

Defined in OpenAI.V1.Message

type Rep Message = D1 ('MetaData "Message" "OpenAI.V1.Message" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" '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))))))

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-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" '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 Source #

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

Constructors

ModifyMessage
Fields metadata :: Maybe (Map Text Text)

Instances

Instances details

FromJSON ModifyMessage Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Methods

parseJSON :: Value -> Parser ModifyMessage #

parseJSONList :: Value -> Parser [ModifyMessage] #

omittedField :: Maybe ModifyMessage #

ToJSON ModifyMessage Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Methods

toJSON :: ModifyMessage -> Value #

toEncoding :: ModifyMessage -> Encoding #

toJSONList :: [ModifyMessage] -> Value #

toEncodingList :: [ModifyMessage] -> Encoding #

omitField :: ModifyMessage -> Bool #

Generic ModifyMessage Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Associated Types

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

Methods

from :: ModifyMessage -> Rep ModifyMessage x #

to :: Rep ModifyMessage x -> ModifyMessage #

Show ModifyMessage Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Methods

showsPrec :: Int -> ModifyMessage -> ShowS #

show :: ModifyMessage -> String #

showList :: [ModifyMessage] -> ShowS #

type Rep ModifyMessage Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

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

_ModifyMessage :: ModifyMessage Source #

Default ModifyMessage

data MessageObject Source #

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

Instances details

FromJSON MessageObject Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Methods

parseJSON :: Value -> Parser MessageObject #

parseJSONList :: Value -> Parser [MessageObject] #

omittedField :: Maybe MessageObject #

ToJSON MessageObject Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Methods

toJSON :: MessageObject -> Value #

toEncoding :: MessageObject -> Encoding #

toJSONList :: [MessageObject] -> Value #

toEncodingList :: [MessageObject] -> Encoding #

omitField :: MessageObject -> Bool #

Generic MessageObject Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Associated Types

type Rep MessageObject

Instance details

Defined in OpenAI.V1.Threads.Messages

Methods

from :: MessageObject -> Rep MessageObject x #

to :: Rep MessageObject x -> MessageObject #

Show MessageObject Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Methods

showsPrec :: Int -> MessageObject -> ShowS #

show :: MessageObject -> String #

showList :: [MessageObject] -> ShowS #

type Rep MessageObject Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Other types

data Status Source #

The status of the message

Constructors

In_Progress
Incomplete
Completed

Instances

Instances details

FromJSON Status Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Methods

parseJSON :: Value -> Parser Status #

parseJSONList :: Value -> Parser [Status] #

omittedField :: Maybe Status #

ToJSON Status Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Methods

toJSON :: Status -> Value #

toEncoding :: Status -> Encoding #

toJSONList :: [Status] -> Value #

toEncodingList :: [Status] -> Encoding #

omitField :: Status -> Bool #

Generic Status Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Associated Types

type Rep Status
Instance details Defined in OpenAI.V1.Threads.Messages type Rep Status = D1 ('MetaData "Status" "OpenAI.V1.Threads.Messages" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" '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)))

Methods

from :: Status -> Rep Status x #

to :: Rep Status x -> Status #

Show Status Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Methods

showsPrec :: Int -> Status -> ShowS #

show :: Status -> String #

showList :: [Status] -> ShowS #

type Rep Status Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

type Rep Status = D1 ('MetaData "Status" "OpenAI.V1.Threads.Messages" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" '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 Source #

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

Constructors

IncompleteDetails
Fields reason :: Text

Instances

Instances details

FromJSON IncompleteDetails Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Methods

parseJSON :: Value -> Parser IncompleteDetails #

parseJSONList :: Value -> Parser [IncompleteDetails] #

omittedField :: Maybe IncompleteDetails #

ToJSON IncompleteDetails Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Methods

toJSON :: IncompleteDetails -> Value #

toEncoding :: IncompleteDetails -> Encoding #

toJSONList :: [IncompleteDetails] -> Value #

toEncodingList :: [IncompleteDetails] -> Encoding #

omitField :: IncompleteDetails -> Bool #

Generic IncompleteDetails Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Associated Types

type Rep IncompleteDetails
Instance details Defined in OpenAI.V1.Threads.Messages type Rep IncompleteDetails = D1 ('MetaData "IncompleteDetails" "OpenAI.V1.Threads.Messages" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "IncompleteDetails" 'PrefixI 'True) (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: IncompleteDetails -> Rep IncompleteDetails x #

to :: Rep IncompleteDetails x -> IncompleteDetails #

Show IncompleteDetails Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Methods

showsPrec :: Int -> IncompleteDetails -> ShowS #

show :: IncompleteDetails -> String #

showList :: [IncompleteDetails] -> ShowS #

type Rep IncompleteDetails Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

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

data File Source #

File

Constructors

File
Fields file_id :: FileID

Instances

Instances details

FromJSON File Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Methods

parseJSON :: Value -> Parser File #

parseJSONList :: Value -> Parser [File] #

omittedField :: Maybe File #

ToJSON File Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Methods

toJSON :: File -> Value #

toEncoding :: File -> Encoding #

toJSONList :: [File] -> Value #

toEncodingList :: [File] -> Encoding #

omitField :: File -> Bool #

Generic File Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Associated Types

type Rep File
Instance details Defined in OpenAI.V1.Threads.Messages type Rep File = D1 ('MetaData "File" "OpenAI.V1.Threads.Messages" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "File" 'PrefixI 'True) (S1 ('MetaSel ('Just "file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileID)))

Methods

from :: File -> Rep File x #

to :: Rep File x -> File #

Show File Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

Methods

showsPrec :: Int -> File -> ShowS #

show :: File -> String #

showList :: [File] -> ShowS #

type Rep File Source #

Instance details

Defined in OpenAI.V1.Threads.Messages

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

data Annotation Source #

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