Safe Haskell	None
Language	Haskell2010

OpenAI.V1.Tool

Contents

Types
Constants
Helpers

Description

The Tool type

Synopsis

data Tool
- = Tool_Code_Interpreter {
  - container :: Maybe CodeInterpreterContainer
  }
- | Tool_File_Search {
  - file_search :: FileSearch
  }
- | Tool_Function {
  - function :: Function
  }
- | Tool_Web_Search
data RankingOptions = RankingOptions {
- ranker :: Maybe Text
- score_threshold :: Double
}
data FileSearch = FileSearch {
- max_num_results :: Maybe Natural
- ranking_options :: Maybe RankingOptions
}
data Function = Function {
- description :: Maybe Text
- name :: Text
- parameters :: Maybe Value
- strict :: Maybe Bool
}
data ToolChoice
- = ToolChoiceNone
- | ToolChoiceAuto
- | ToolChoiceRequired
- | ToolChoiceTool Tool
data CodeInterpreterContainer
- = CodeInterpreterContainer_Auto {
  - file_ids :: Maybe (Vector Text)
  }
- | CodeInterpreterContainer_ID {
  - container_id :: Text
  }
toolChoiceNoneText :: Text
toolChoiceAutoText :: Text
toolChoiceRequiredText :: Text
codeInterpreter :: Tool
codeInterpreterAuto :: Tool
codeInterpreterWithFiles :: [Text] -> Tool
toolToResponsesValue :: Tool -> Value
parseResponsesToolValue :: Value -> Parser Tool
toolChoiceToResponsesValue :: ToolChoice -> Value
parseResponsesToolChoiceValue :: Value -> Parser ToolChoice
flattenToolValue :: Value -> Value
unflattenToolValue :: Value -> Value

Types

data Tool Source #

A tool enabled on the assistant

Constructors

Tool_Code_Interpreter
Fields container :: Maybe CodeInterpreterContainer
Tool_File_Search
Fields file_search :: FileSearch
Tool_Function
Fields function :: Function
Tool_Web_Search

Instances

Instances details

FromJSON Tool Source #

Instance details

Defined in OpenAI.V1.Tool

Methods

parseJSON :: Value -> Parser Tool #

parseJSONList :: Value -> Parser [Tool] #

omittedField :: Maybe Tool #

ToJSON Tool Source #

Instance details

Defined in OpenAI.V1.Tool

Methods

toJSON :: Tool -> Value #

toEncoding :: Tool -> Encoding #

toJSONList :: [Tool] -> Value #

toEncodingList :: [Tool] -> Encoding #

omitField :: Tool -> Bool #

Generic Tool Source #

Instance details

Defined in OpenAI.V1.Tool

Associated Types

type Rep Tool

Instance details

Defined in OpenAI.V1.Tool

type Rep Tool = D1 ('MetaData "Tool" "OpenAI.V1.Tool" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) ((C1 ('MetaCons "Tool_Code_Interpreter" 'PrefixI 'True) (S1 ('MetaSel ('Just "container") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe CodeInterpreterContainer))) :+: C1 ('MetaCons "Tool_File_Search" 'PrefixI 'True) (S1 ('MetaSel ('Just "file_search") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileSearch))) :+: (C1 ('MetaCons "Tool_Function" 'PrefixI 'True) (S1 ('MetaSel ('Just "function") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Function)) :+: C1 ('MetaCons "Tool_Web_Search" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: Tool -> Rep Tool x #

to :: Rep Tool x -> Tool #

Show Tool Source #

Instance details

Defined in OpenAI.V1.Tool

Methods

showsPrec :: Int -> Tool -> ShowS #

show :: Tool -> String #

showList :: [Tool] -> ShowS #

type Rep Tool Source #

Instance details

Defined in OpenAI.V1.Tool

type Rep Tool = D1 ('MetaData "Tool" "OpenAI.V1.Tool" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) ((C1 ('MetaCons "Tool_Code_Interpreter" 'PrefixI 'True) (S1 ('MetaSel ('Just "container") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe CodeInterpreterContainer))) :+: C1 ('MetaCons "Tool_File_Search" 'PrefixI 'True) (S1 ('MetaSel ('Just "file_search") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileSearch))) :+: (C1 ('MetaCons "Tool_Function" 'PrefixI 'True) (S1 ('MetaSel ('Just "function") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Function)) :+: C1 ('MetaCons "Tool_Web_Search" 'PrefixI 'False) (U1 :: Type -> Type)))

data RankingOptions Source #

The ranking options for the file search

Constructors

RankingOptions
Fields ranker :: Maybe Text score_threshold :: Double

Instances

Instances details

FromJSON RankingOptions Source #

Instance details

Defined in OpenAI.V1.Tool

Methods

parseJSON :: Value -> Parser RankingOptions #

parseJSONList :: Value -> Parser [RankingOptions] #

omittedField :: Maybe RankingOptions #

ToJSON RankingOptions Source #

Instance details

Defined in OpenAI.V1.Tool

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.Tool

Associated Types

type Rep RankingOptions

Instance details

Defined in OpenAI.V1.Tool

type Rep RankingOptions = D1 ('MetaData "RankingOptions" "OpenAI.V1.Tool" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "RankingOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "ranker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe 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.Tool

Methods

showsPrec :: Int -> RankingOptions -> ShowS #

show :: RankingOptions -> String #

showList :: [RankingOptions] -> ShowS #

type Rep RankingOptions Source #

Instance details

Defined in OpenAI.V1.Tool

type Rep RankingOptions = D1 ('MetaData "RankingOptions" "OpenAI.V1.Tool" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "RankingOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "ranker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "score_threshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))

data FileSearch Source #

Overrides for the file search tool

Constructors

FileSearch
Fields max_num_results :: Maybe Natural ranking_options :: Maybe RankingOptions

Instances

Instances details

FromJSON FileSearch Source #

Instance details

Defined in OpenAI.V1.Tool

Methods

parseJSON :: Value -> Parser FileSearch #

parseJSONList :: Value -> Parser [FileSearch] #

omittedField :: Maybe FileSearch #

ToJSON FileSearch Source #

Instance details

Defined in OpenAI.V1.Tool

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.Tool

Associated Types

type Rep FileSearch

Instance details

Defined in OpenAI.V1.Tool

type Rep FileSearch = D1 ('MetaData "FileSearch" "OpenAI.V1.Tool" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "FileSearch" 'PrefixI 'True) (S1 ('MetaSel ('Just "max_num_results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "ranking_options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe RankingOptions))))

Methods

from :: FileSearch -> Rep FileSearch x #

to :: Rep FileSearch x -> FileSearch #

Show FileSearch Source #

Instance details

Defined in OpenAI.V1.Tool

Methods

showsPrec :: Int -> FileSearch -> ShowS #

show :: FileSearch -> String #

showList :: [FileSearch] -> ShowS #

type Rep FileSearch Source #

Instance details

Defined in OpenAI.V1.Tool

type Rep FileSearch = D1 ('MetaData "FileSearch" "OpenAI.V1.Tool" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "FileSearch" 'PrefixI 'True) (S1 ('MetaSel ('Just "max_num_results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "ranking_options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe RankingOptions))))

data Function Source #

The Function tool

Constructors

Function
Fields description :: Maybe Text name :: Text parameters :: Maybe Value strict :: Maybe Bool

Instances

Instances details

FromJSON Function Source #

Instance details

Defined in OpenAI.V1.Tool

Methods

parseJSON :: Value -> Parser Function #

parseJSONList :: Value -> Parser [Function] #

omittedField :: Maybe Function #

ToJSON Function Source #

Instance details

Defined in OpenAI.V1.Tool

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.Tool

Associated Types

type Rep Function

Instance details

Defined in OpenAI.V1.Tool

type Rep Function = D1 ('MetaData "Function" "OpenAI.V1.Tool" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Function" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "strict") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

Methods

from :: Function -> Rep Function x #

to :: Rep Function x -> Function #

Show Function Source #

Instance details

Defined in OpenAI.V1.Tool

Methods

showsPrec :: Int -> Function -> ShowS #

show :: Function -> String #

showList :: [Function] -> ShowS #

type Rep Function Source #

Instance details

Defined in OpenAI.V1.Tool

type Rep Function = D1 ('MetaData "Function" "OpenAI.V1.Tool" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Function" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "strict") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

data ToolChoice Source #

Controls which (if any) tool is called by the model

Constructors

ToolChoiceNone
ToolChoiceAuto
ToolChoiceRequired
ToolChoiceTool Tool

Instances

Instances details

FromJSON ToolChoice Source #

Instance details

Defined in OpenAI.V1.Tool

Methods

parseJSON :: Value -> Parser ToolChoice #

parseJSONList :: Value -> Parser [ToolChoice] #

omittedField :: Maybe ToolChoice #

ToJSON ToolChoice Source #

Instance details

Defined in OpenAI.V1.Tool

Methods

toJSON :: ToolChoice -> Value #

toEncoding :: ToolChoice -> Encoding #

toJSONList :: [ToolChoice] -> Value #

toEncodingList :: [ToolChoice] -> Encoding #

omitField :: ToolChoice -> Bool #

Generic ToolChoice Source #

Instance details

Defined in OpenAI.V1.Tool

Associated Types

type Rep ToolChoice

Instance details

Defined in OpenAI.V1.Tool

type Rep ToolChoice = D1 ('MetaData "ToolChoice" "OpenAI.V1.Tool" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) ((C1 ('MetaCons "ToolChoiceNone" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ToolChoiceAuto" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ToolChoiceRequired" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ToolChoiceTool" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Tool))))

Methods

from :: ToolChoice -> Rep ToolChoice x #

to :: Rep ToolChoice x -> ToolChoice #

Show ToolChoice Source #

Instance details

Defined in OpenAI.V1.Tool

Methods

showsPrec :: Int -> ToolChoice -> ShowS #

show :: ToolChoice -> String #

showList :: [ToolChoice] -> ShowS #

type Rep ToolChoice Source #

Instance details

Defined in OpenAI.V1.Tool

type Rep ToolChoice = D1 ('MetaData "ToolChoice" "OpenAI.V1.Tool" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) ((C1 ('MetaCons "ToolChoiceNone" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ToolChoiceAuto" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ToolChoiceRequired" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ToolChoiceTool" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Tool))))

data CodeInterpreterContainer Source #

Code Interpreter container reference

Constructors

CodeInterpreterContainer_Auto
Fields file_ids :: Maybe (Vector Text)
CodeInterpreterContainer_ID
Fields container_id :: Text

Instances

Instances details

FromJSON CodeInterpreterContainer Source #

Instance details

Defined in OpenAI.V1.Tool

Methods

parseJSON :: Value -> Parser CodeInterpreterContainer #

parseJSONList :: Value -> Parser [CodeInterpreterContainer] #

omittedField :: Maybe CodeInterpreterContainer #

ToJSON CodeInterpreterContainer Source #

Instance details

Defined in OpenAI.V1.Tool

Methods

toJSON :: CodeInterpreterContainer -> Value #

toEncoding :: CodeInterpreterContainer -> Encoding #

toJSONList :: [CodeInterpreterContainer] -> Value #

toEncodingList :: [CodeInterpreterContainer] -> Encoding #

omitField :: CodeInterpreterContainer -> Bool #

Generic CodeInterpreterContainer Source #

Instance details

Defined in OpenAI.V1.Tool

Associated Types

type Rep CodeInterpreterContainer

Instance details

Defined in OpenAI.V1.Tool

type Rep CodeInterpreterContainer = D1 ('MetaData "CodeInterpreterContainer" "OpenAI.V1.Tool" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "CodeInterpreterContainer_Auto" 'PrefixI 'True) (S1 ('MetaSel ('Just "file_ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Text)))) :+: C1 ('MetaCons "CodeInterpreterContainer_ID" 'PrefixI 'True) (S1 ('MetaSel ('Just "container_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: CodeInterpreterContainer -> Rep CodeInterpreterContainer x #

to :: Rep CodeInterpreterContainer x -> CodeInterpreterContainer #

Show CodeInterpreterContainer Source #

Instance details

Defined in OpenAI.V1.Tool

Methods

showsPrec :: Int -> CodeInterpreterContainer -> ShowS #

show :: CodeInterpreterContainer -> String #

showList :: [CodeInterpreterContainer] -> ShowS #

type Rep CodeInterpreterContainer Source #

Instance details

Defined in OpenAI.V1.Tool

type Rep CodeInterpreterContainer = D1 ('MetaData "CodeInterpreterContainer" "OpenAI.V1.Tool" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "CodeInterpreterContainer_Auto" 'PrefixI 'True) (S1 ('MetaSel ('Just "file_ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Text)))) :+: C1 ('MetaCons "CodeInterpreterContainer_ID" 'PrefixI 'True) (S1 ('MetaSel ('Just "container_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Constants

toolChoiceNoneText :: Text Source #

Tool choice string constants

toolChoiceAutoText :: Text Source #

Tool choice string constants

toolChoiceRequiredText :: Text Source #

Tool choice string constants

Helpers

codeInterpreter :: Tool Source #

Convenience: Code Interpreter without an explicit container (for Assistants API)

codeInterpreterAuto :: Tool Source #

Convenience: Code Interpreter with automatic new container and no files

codeInterpreterWithFiles :: [Text] -> Tool Source #

Convenience: Code Interpreter with automatic new container seeded with files

toolToResponsesValue :: Tool -> Value Source #

parseResponsesToolValue :: Value -> Parser Tool Source #

toolChoiceToResponsesValue :: ToolChoice -> Value Source #

parseResponsesToolChoiceValue :: Value -> Parser ToolChoice Source #

flattenToolValue :: Value -> Value Source #

unflattenToolValue :: Value -> Value Source #