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

ToJSON RunStepObject Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Methods

toJSON :: RunStepObject -> Value #

toEncoding :: RunStepObject -> Encoding #

toJSONList :: [RunStepObject] -> Value #

toEncodingList :: [RunStepObject] -> Encoding #

omitField :: RunStepObject -> Bool #

Generic RunStepObject Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Associated Types

type Rep RunStepObject

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

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

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 #

ToJSON Status Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

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.Runs.Steps

Associated Types

type Rep Status

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

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

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

ToJSON Image Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Methods

toJSON :: Image -> Value #

toEncoding :: Image -> Encoding #

toJSONList :: [Image] -> Value #

toEncodingList :: [Image] -> Encoding #

omitField :: Image -> Bool #

Generic Image Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Associated Types

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

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

ToJSON Output Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Methods

toJSON :: Output -> Value #

toEncoding :: Output -> Encoding #

toJSONList :: [Output] -> Value #

toEncodingList :: [Output] -> Encoding #

omitField :: Output -> Bool #

Generic Output Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Associated Types

type Rep Output

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

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

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

ToJSON CodeInterpreter Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Methods

toJSON :: CodeInterpreter -> Value #

toEncoding :: CodeInterpreter -> Encoding #

toJSONList :: [CodeInterpreter] -> Value #

toEncodingList :: [CodeInterpreter] -> Encoding #

omitField :: CodeInterpreter -> Bool #

Generic CodeInterpreter Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Associated Types

type Rep CodeInterpreter

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

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

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

ToJSON RankingOptions Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Methods

toJSON :: RankingOptions -> Value #

toEncoding :: RankingOptions -> Encoding #

toJSONList :: [RankingOptions] -> Value #

toEncodingList :: [RankingOptions] -> Encoding #

omitField :: RankingOptions -> Bool #

Generic RankingOptions Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Associated Types

type Rep RankingOptions

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

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

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

ToJSON Content Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Methods

toJSON :: Content -> Value #

toEncoding :: Content -> Encoding #

toJSONList :: [Content] -> Value #

toEncodingList :: [Content] -> Encoding #

omitField :: Content -> Bool #

Generic Content Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Associated Types

type Rep Content

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

type Rep Content = D1 ('MetaData "Content" "OpenAI.V1.Threads.Runs.Steps" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Content" 'PrefixI 'True) (S1 ('MetaSel ('Just "type_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

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

ToJSON Result Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Methods

toJSON :: Result -> Value #

toEncoding :: Result -> Encoding #

toJSONList :: [Result] -> Value #

toEncodingList :: [Result] -> Encoding #

omitField :: Result -> Bool #

Generic Result Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Associated Types

type Rep Result

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

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

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

ToJSON FileSearch Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Methods

toJSON :: FileSearch -> Value #

toEncoding :: FileSearch -> Encoding #

toJSONList :: [FileSearch] -> Value #

toEncodingList :: [FileSearch] -> Encoding #

omitField :: FileSearch -> Bool #

Generic FileSearch Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Associated Types

type Rep FileSearch

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

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

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

ToJSON Function Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Methods

toJSON :: Function -> Value #

toEncoding :: Function -> Encoding #

toJSONList :: [Function] -> Value #

toEncodingList :: [Function] -> Encoding #

omitField :: Function -> Bool #

Generic Function Source #

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

Associated Types

type Rep Function

Instance details

Defined in OpenAI.V1.Threads.Runs.Steps

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

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