Safe Haskell	None
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

FromJSON Thread Source #

Instance details

Defined in OpenAI.V1.Threads

Methods

parseJSON :: Value -> Parser Thread #

parseJSONList :: Value -> Parser [Thread] #

omittedField :: Maybe Thread #

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

Instance details

Defined in OpenAI.V1.Threads

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

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

FromJSON ModifyThread Source #

Instance details

Defined in OpenAI.V1.Threads

Methods

parseJSON :: Value -> Parser ModifyThread #

parseJSONList :: Value -> Parser [ModifyThread] #

omittedField :: Maybe ModifyThread #

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

Instance details

Defined in OpenAI.V1.Threads

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

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