Safe Haskell	Safe-Inferred
Language	Haskell2010

OpenAI.V1.Threads.Runs.Steps

Contents

Main types
Other types
Servant

Description

/v1/threads/:thread_id/runs/:run_id/steps

Synopsis

newtype StepID = StepID {
- text :: Text
}
data RunStepObject = RunStepObject {
- id :: StepID
- object :: Text
- created_at :: POSIXTime
- assistant_id :: AssistantID
- thread_id :: ThreadID
- run_id :: RunID
- status :: Status
- step_details :: StepDetails
- last_error :: Maybe Error
- expired_at :: Maybe POSIXTime
- cancelled_at :: Maybe POSIXTime
- failed_at :: Maybe POSIXTime
- completed_at :: Maybe POSIXTime
- metadata :: Map Text Text
- usage :: Maybe (Usage CompletionTokensDetails PromptTokensDetails)
}
data Status
- = In_Progress
- | Cancelled
- | Failed
- | Completed
- | Expired
data Image = Image {
- file_id :: FileID
}
data Output
- = Output_Logs {
  - logs :: Text
  }
- | Output_Image {
  - image :: Image
  }
data CodeInterpreter = CodeInterpreter {
- input :: Text
- outputs :: Vector Output
}
data RankingOptions = RankingOptions {
- ranker :: Text
- score_threshold :: Double
}
data Content = Content {
- type_ :: Text
- text :: Text
}
data Result = Result {
- file_id :: FileID
- file_name :: Text
- score :: Double
- content :: Vector Content
}
data FileSearch = FileSearch {
- ranking_options :: RankingOptions
- results :: Vector Result
}
data Function = Function {
- name :: Text
- arguments :: Text
- output :: Maybe Text
}
data ToolCall
- = ToolCall_Code_Interpreter {
  - id :: Text
  - code_interpreter :: CodeInterpreter
  }
- | ToolCall_File_Search {
  - id :: Text
  - file_search :: Map Text FileSearch
  }
- | ToolCall_Function {
  - id :: Text
  - function :: Function
  }
data StepDetails
- = Message_Creation {
  - message_id :: MessageID
  }
- | Tool_Calls {
  - tool_calls :: Vector ToolCall
  }
type API = "threads" :> (Header' '[Required, Strict] "OpenAI-Beta" Text :> ((Capture "thread_id" ThreadID :> ("runs" :> (Capture "run_id" RunID :> ("steps" :> (QueryParam "limit" Natural :> (QueryParam "order" Order :> (QueryParam "after" Text :> (QueryParam "before" Text :> (QueryParam "include[]" Text :> Get '[JSON] (ListOf RunStepObject)))))))))) :<|> (Capture "thread_id" ThreadID :> ("runs" :> (Capture "run_id" RunID :> ("steps" :> (Capture "step_id" StepID :> (QueryParam "include[]" Text :> Get '[JSON] RunStepObject))))))))

Main types

newtype StepID Source #

Step ID

Constructors

StepID
Fields text :: Text

Instances

Instances details

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

data RunStepObject Source #

Represents a step in execution of a run.

Constructors

RunStepObject

Fields

id :: StepID
object :: Text
created_at :: POSIXTime
assistant_id :: AssistantID
thread_id :: ThreadID
run_id :: RunID
status :: Status
step_details :: StepDetails
last_error :: Maybe Error
expired_at :: Maybe POSIXTime
cancelled_at :: Maybe POSIXTime
failed_at :: Maybe POSIXTime
completed_at :: Maybe POSIXTime
metadata :: Map Text Text
usage :: Maybe (Usage CompletionTokensDetails PromptTokensDetails)

Instances

Instances details

FromJSON RunStepObject Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods parseJSON :: Value -> Parser RunStepObject # parseJSONList :: Value -> Parser [RunStepObject] # omittedField :: Maybe RunStepObject #
Generic RunStepObject Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Associated Types type Rep RunStepObject :: Type -> Type # Methods from :: RunStepObject -> Rep RunStepObject x # to :: Rep RunStepObject x -> RunStepObject #
Show RunStepObject Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods showsPrec :: Int -> RunStepObject -> ShowS # show :: RunStepObject -> String # showList :: [RunStepObject] -> ShowS #
type Rep RunStepObject Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps type Rep RunStepObject = D1 ('MetaData "RunStepObject" "OpenAI.V1.Threads.Runs.Steps" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "RunStepObject" 'PrefixI 'True) (((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 StepID) :: (S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "created_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime))) :: ((S1 ('MetaSel ('Just "assistant_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AssistantID) :: S1 ('MetaSel ('Just "thread_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ThreadID)) :: (S1 ('MetaSel ('Just "run_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RunID) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status)))) :: (((S1 ('MetaSel ('Just "step_details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 StepDetails) :: S1 ('MetaSel ('Just "last_error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Error))) :: (S1 ('MetaSel ('Just "expired_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime)) :: S1 ('MetaSel ('Just "cancelled_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime)))) :: ((S1 ('MetaSel ('Just "failed_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime)) :: S1 ('MetaSel ('Just "completed_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime))) :: (S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Text)) :: S1 ('MetaSel ('Just "usage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Usage CompletionTokensDetails PromptTokensDetails))))))))

Other types

data Status Source #

The status of the run step

Constructors

In_Progress
Cancelled
Failed
Completed
Expired

Instances

Instances details

FromJSON Status Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods parseJSON :: Value -> Parser Status # parseJSONList :: Value -> Parser [Status] # omittedField :: Maybe Status #
Generic Status Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Associated Types type Rep Status :: Type -> Type # Methods from :: Status -> Rep Status x # to :: Rep Status x -> Status #
Show Status Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods showsPrec :: Int -> Status -> ShowS # show :: Status -> String # showList :: [Status] -> ShowS #
type Rep Status Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps type Rep Status = D1 ('MetaData "Status" "OpenAI.V1.Threads.Runs.Steps" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) ((C1 ('MetaCons "In_Progress" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Cancelled" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Failed" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Completed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Expired" 'PrefixI 'False) (U1 :: Type -> Type))))

data Image Source #

Code Interpreter image output

Constructors

Image
Fields file_id :: FileID

Instances

Instances details

FromJSON Image Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods parseJSON :: Value -> Parser Image # parseJSONList :: Value -> Parser [Image] # omittedField :: Maybe Image #
Generic Image Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Associated Types type Rep Image :: Type -> Type # Methods from :: Image -> Rep Image x # to :: Rep Image x -> Image #
Show Image Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods showsPrec :: Int -> Image -> ShowS # show :: Image -> String # showList :: [Image] -> ShowS #
type Rep Image Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps type Rep Image = D1 ('MetaData "Image" "OpenAI.V1.Threads.Runs.Steps" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Image" 'PrefixI 'True) (S1 ('MetaSel ('Just "file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileID)))

data Output Source #

An output from the Code Interpreter tool call

Constructors

Output_Logs
Fields logs :: Text
Output_Image
Fields image :: Image

Instances

Instances details

FromJSON Output Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods parseJSON :: Value -> Parser Output # parseJSONList :: Value -> Parser [Output] # omittedField :: Maybe Output #
Generic Output Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Associated Types type Rep Output :: Type -> Type # Methods from :: Output -> Rep Output x # to :: Rep Output x -> Output #
Show Output Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods showsPrec :: Int -> Output -> ShowS # show :: Output -> String # showList :: [Output] -> ShowS #
type Rep Output Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps type Rep Output = D1 ('MetaData "Output" "OpenAI.V1.Threads.Runs.Steps" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Output_Logs" 'PrefixI 'True) (S1 ('MetaSel ('Just "logs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "Output_Image" 'PrefixI 'True) (S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Image)))

data CodeInterpreter Source #

A Code Interpreter tool call

Constructors

CodeInterpreter
Fields input :: Text outputs :: Vector Output

Instances

Instances details

FromJSON CodeInterpreter Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods parseJSON :: Value -> Parser CodeInterpreter # parseJSONList :: Value -> Parser [CodeInterpreter] # omittedField :: Maybe CodeInterpreter #
Generic CodeInterpreter Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Associated Types type Rep CodeInterpreter :: Type -> Type # Methods from :: CodeInterpreter -> Rep CodeInterpreter x # to :: Rep CodeInterpreter x -> CodeInterpreter #
Show CodeInterpreter Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods showsPrec :: Int -> CodeInterpreter -> ShowS # show :: CodeInterpreter -> String # showList :: [CodeInterpreter] -> ShowS #
type Rep CodeInterpreter Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps type Rep CodeInterpreter = D1 ('MetaData "CodeInterpreter" "OpenAI.V1.Threads.Runs.Steps" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "CodeInterpreter" 'PrefixI 'True) (S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Output))))

data RankingOptions Source #

The ranking options for the file search.

Constructors

RankingOptions
Fields ranker :: Text score_threshold :: Double

Instances

Instances details

FromJSON RankingOptions Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods parseJSON :: Value -> Parser RankingOptions # parseJSONList :: Value -> Parser [RankingOptions] # omittedField :: Maybe RankingOptions #
Generic RankingOptions Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Associated Types type Rep RankingOptions :: Type -> Type # Methods from :: RankingOptions -> Rep RankingOptions x # to :: Rep RankingOptions x -> RankingOptions #
Show RankingOptions Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods showsPrec :: Int -> RankingOptions -> ShowS # show :: RankingOptions -> String # showList :: [RankingOptions] -> ShowS #
type Rep RankingOptions Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps type Rep RankingOptions = D1 ('MetaData "RankingOptions" "OpenAI.V1.Threads.Runs.Steps" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "RankingOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "ranker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "score_threshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))

data Content Source #

The content of the result that was found

Constructors

Content
Fields type_ :: Text text :: Text

Instances

Instances details

FromJSON Content Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods parseJSON :: Value -> Parser Content # parseJSONList :: Value -> Parser [Content] # omittedField :: Maybe Content #
Generic Content Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Associated Types type Rep Content :: Type -> Type # Methods from :: Content -> Rep Content x # to :: Rep Content x -> Content #
Show Content Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods showsPrec :: Int -> Content -> ShowS # show :: Content -> String # showList :: [Content] -> ShowS #
type Rep Content Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps type Rep Content = D1 ('MetaData "Content" "OpenAI.V1.Threads.Runs.Steps" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Content" 'PrefixI 'True) (S1 ('MetaSel ('Just "type_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Result Source #

Result of the file search

Constructors

Result
Fields file_id :: FileID file_name :: Text score :: Double content :: Vector Content

Instances

Instances details

FromJSON Result Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods parseJSON :: Value -> Parser Result # parseJSONList :: Value -> Parser [Result] # omittedField :: Maybe Result #
Generic Result Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Associated Types type Rep Result :: Type -> Type # Methods from :: Result -> Rep Result x # to :: Rep Result x -> Result #
Show Result Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods showsPrec :: Int -> Result -> ShowS # show :: Result -> String # showList :: [Result] -> ShowS #
type Rep Result Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps type Rep Result = D1 ('MetaData "Result" "OpenAI.V1.Threads.Runs.Steps" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Result" 'PrefixI 'True) ((S1 ('MetaSel ('Just "file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileID) :: S1 ('MetaSel ('Just "file_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Content)))))

data FileSearch Source #

A File Search tool call

Constructors

FileSearch
Fields ranking_options :: RankingOptions results :: Vector Result

Instances

Instances details

FromJSON FileSearch Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods parseJSON :: Value -> Parser FileSearch # parseJSONList :: Value -> Parser [FileSearch] # omittedField :: Maybe FileSearch #
Generic FileSearch Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Associated Types type Rep FileSearch :: Type -> Type # Methods from :: FileSearch -> Rep FileSearch x # to :: Rep FileSearch x -> FileSearch #
Show FileSearch Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods showsPrec :: Int -> FileSearch -> ShowS # show :: FileSearch -> String # showList :: [FileSearch] -> ShowS #
type Rep FileSearch Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps type Rep FileSearch = D1 ('MetaData "FileSearch" "OpenAI.V1.Threads.Runs.Steps" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "FileSearch" 'PrefixI 'True) (S1 ('MetaSel ('Just "ranking_options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RankingOptions) :*: S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Result))))

data Function Source #

The definition of the function that was called

Constructors

Function
Fields name :: Text arguments :: Text output :: Maybe Text

Instances

Instances details

FromJSON Function Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods parseJSON :: Value -> Parser Function # parseJSONList :: Value -> Parser [Function] # omittedField :: Maybe Function #
Generic Function Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Associated Types type Rep Function :: Type -> Type # Methods from :: Function -> Rep Function x # to :: Rep Function x -> Function #
Show Function Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods showsPrec :: Int -> Function -> ShowS # show :: Function -> String # showList :: [Function] -> ShowS #
type Rep Function Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps type Rep Function = D1 ('MetaData "Function" "OpenAI.V1.Threads.Runs.Steps" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Function" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "arguments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "output") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

data ToolCall Source #

A tool call the run step was involved in

Constructors

ToolCall_Code_Interpreter
Fields id :: Text code_interpreter :: CodeInterpreter
ToolCall_File_Search
Fields id :: Text file_search :: Map Text FileSearch
ToolCall_Function
Fields id :: Text function :: Function

Instances

Instances details

FromJSON ToolCall Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods parseJSON :: Value -> Parser ToolCall # parseJSONList :: Value -> Parser [ToolCall] # omittedField :: Maybe ToolCall #
Generic ToolCall Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Associated Types type Rep ToolCall :: Type -> Type # Methods from :: ToolCall -> Rep ToolCall x # to :: Rep ToolCall x -> ToolCall #
Show ToolCall Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods showsPrec :: Int -> ToolCall -> ShowS # show :: ToolCall -> String # showList :: [ToolCall] -> ShowS #
type Rep ToolCall Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps type Rep ToolCall = D1 ('MetaData "ToolCall" "OpenAI.V1.Threads.Runs.Steps" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "ToolCall_Code_Interpreter" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "code_interpreter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CodeInterpreter)) :+: (C1 ('MetaCons "ToolCall_File_Search" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "file_search") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text FileSearch))) :+: C1 ('MetaCons "ToolCall_Function" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "function") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Function))))

data StepDetails Source #

The details of the run step

Constructors

Message_Creation
Fields message_id :: MessageID
Tool_Calls
Fields tool_calls :: Vector ToolCall

Instances

Instances details

FromJSON StepDetails Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods parseJSON :: Value -> Parser StepDetails # parseJSONList :: Value -> Parser [StepDetails] # omittedField :: Maybe StepDetails #
Generic StepDetails Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Associated Types type Rep StepDetails :: Type -> Type # Methods from :: StepDetails -> Rep StepDetails x # to :: Rep StepDetails x -> StepDetails #
Show StepDetails Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps Methods showsPrec :: Int -> StepDetails -> ShowS # show :: StepDetails -> String # showList :: [StepDetails] -> ShowS #
type Rep StepDetails Source #
Instance details Defined in OpenAI.V1.Threads.Runs.Steps type Rep StepDetails = D1 ('MetaData "StepDetails" "OpenAI.V1.Threads.Runs.Steps" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Message_Creation" 'PrefixI 'True) (S1 ('MetaSel ('Just "message_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageID)) :+: C1 ('MetaCons "Tool_Calls" 'PrefixI 'True) (S1 ('MetaSel ('Just "tool_calls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector ToolCall))))

Servant

type API = "threads" :> (Header' '[Required, Strict] "OpenAI-Beta" Text :> ((Capture "thread_id" ThreadID :> ("runs" :> (Capture "run_id" RunID :> ("steps" :> (QueryParam "limit" Natural :> (QueryParam "order" Order :> (QueryParam "after" Text :> (QueryParam "before" Text :> (QueryParam "include[]" Text :> Get '[JSON] (ListOf RunStepObject)))))))))) :<|> (Capture "thread_id" ThreadID :> ("runs" :> (Capture "run_id" RunID :> ("steps" :> (Capture "step_id" StepID :> (QueryParam "include[]" Text :> Get '[JSON] RunStepObject)))))))) Source #

Servant API