type Rep Input
Instance details Defined in OpenAI.V1.Responses type Rep Input = D1 ('MetaData "Input" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'True) (C1 ('MetaCons "Input" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector InputItem))))

Methods

from :: Input -> Rep Input x #

to :: Rep Input x -> Input #

Show Input Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> Input -> ShowS #

show :: Input -> String #

showList :: [Input] -> ShowS #

type Rep Input Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep Input = D1 ('MetaData "Input" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'True) (C1 ('MetaCons "Input" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector InputItem))))

data InputItem Source #

An input item

Constructors

Item_Input_Message
Fields role :: InputRole content :: Vector InputContent status :: Maybe Text
Item_Input_Function_Call
Fields id :: Maybe Text call_id :: Text name :: Text arguments :: Text status :: Maybe Text
Item_Input_Function_Call_Output
Fields id :: Maybe Text call_id :: Text output :: Text status :: Maybe Text
Item_Input_Reasoning
Fields reasoning_id :: Text reasoning_encrypted_content :: Maybe Text reasoning_summary :: Maybe (Vector SummaryPart) reasoning_content :: Maybe (Vector ReasoningText) reasoning_status :: Maybe Text
Item_Input_Item_Reference
Fields id :: Maybe Text

Instances

Instances details

FromJSON InputItem Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser InputItem #

parseJSONList :: Value -> Parser [InputItem] #

omittedField :: Maybe InputItem #

ToJSON InputItem Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: InputItem -> Value #

toEncoding :: InputItem -> Encoding #

toJSONList :: [InputItem] -> Value #

toEncodingList :: [InputItem] -> Encoding #

omitField :: InputItem -> Bool #

Generic InputItem Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep InputItem

Instance details

Defined in OpenAI.V1.Responses

Methods

from :: InputItem -> Rep InputItem x #

to :: Rep InputItem x -> InputItem #

Show InputItem Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> InputItem -> ShowS #

show :: InputItem -> String #

showList :: [InputItem] -> ShowS #

Eq InputItem Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

(==) :: InputItem -> InputItem -> Bool #

(/=) :: InputItem -> InputItem -> Bool #

type Rep InputItem Source #

Instance details

Defined in OpenAI.V1.Responses

data InputRole Source #

Role of an input message

Constructors

User
System
Developer

Instances

Instances details

FromJSON InputRole Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser InputRole #

parseJSONList :: Value -> Parser [InputRole] #

omittedField :: Maybe InputRole #

ToJSON InputRole Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: InputRole -> Value #

toEncoding :: InputRole -> Encoding #

toJSONList :: [InputRole] -> Value #

toEncodingList :: [InputRole] -> Encoding #

omitField :: InputRole -> Bool #

Generic InputRole Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep InputRole
Instance details Defined in OpenAI.V1.Responses type Rep InputRole = D1 ('MetaData "InputRole" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "User" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "System" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Developer" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: InputRole -> Rep InputRole x #

to :: Rep InputRole x -> InputRole #

Show InputRole Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> InputRole -> ShowS #

show :: InputRole -> String #

showList :: [InputRole] -> ShowS #

Eq InputRole Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

(==) :: InputRole -> InputRole -> Bool #

(/=) :: InputRole -> InputRole -> Bool #

type Rep InputRole Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep InputRole = D1 ('MetaData "InputRole" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "User" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "System" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Developer" 'PrefixI 'False) (U1 :: Type -> Type)))

data InputContent Source #

Content parts for input messages

Constructors

Input_Text
Fields text :: Text
Input_Image
Fields image_url :: Maybe Text file_id :: Maybe Text detail :: Maybe Text
Input_File
Fields file_id :: Maybe Text filename :: Maybe Text file_url :: Maybe Text file_data :: Maybe Text
Input_Audio
Fields input_audio :: Object

Instances

Instances details

FromJSON InputContent Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser InputContent #

parseJSONList :: Value -> Parser [InputContent] #

omittedField :: Maybe InputContent #

ToJSON InputContent Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: InputContent -> Value #

toEncoding :: InputContent -> Encoding #

toJSONList :: [InputContent] -> Value #

toEncodingList :: [InputContent] -> Encoding #

omitField :: InputContent -> Bool #

Generic InputContent Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep InputContent

Instance details

Defined in OpenAI.V1.Responses

type Rep InputContent = D1 ('MetaData "InputContent" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) ((C1 ('MetaCons "Input_Text" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "Input_Image" 'PrefixI 'True) (S1 ('MetaSel ('Just "image_url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "detail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))) :+: (C1 ('MetaCons "Input_File" 'PrefixI 'True) ((S1 ('MetaSel ('Just "file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "filename") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "file_url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "file_data") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :+: C1 ('MetaCons "Input_Audio" 'PrefixI 'True) (S1 ('MetaSel ('Just "input_audio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Object))))

Methods

from :: InputContent -> Rep InputContent x #

to :: Rep InputContent x -> InputContent #

Show InputContent Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> InputContent -> ShowS #

show :: InputContent -> String #

showList :: [InputContent] -> ShowS #

Eq InputContent Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

(==) :: InputContent -> InputContent -> Bool #

(/=) :: InputContent -> InputContent -> Bool #

type Rep InputContent Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep InputContent = D1 ('MetaData "InputContent" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) ((C1 ('MetaCons "Input_Text" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "Input_Image" 'PrefixI 'True) (S1 ('MetaSel ('Just "image_url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "detail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))) :+: (C1 ('MetaCons "Input_File" 'PrefixI 'True) ((S1 ('MetaSel ('Just "file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "filename") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "file_url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "file_data") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :+: C1 ('MetaCons "Input_Audio" 'PrefixI 'True) (S1 ('MetaSel ('Just "input_audio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Object))))

data OutputItem Source #

A generated output item.

Constructors

Item_OutputMessage
Fields message_id :: Text message_role :: Text message_content :: Vector OutputContent message_status :: Text
Item_FunctionToolCall
Fields function_id :: Maybe Text function_call_id :: Text function_name :: Text function_arguments :: Text function_status :: Maybe Text
Item_WebSearchToolCall
Fields web_search_id :: Text web_search_status :: Text web_search_action :: Maybe WebSearchAction
Item_FunctionToolCallOutput
Fields function_output_id :: Maybe Text function_output_call_id :: Text function_output_output :: Text function_output_status :: Maybe Text
Item_FileSearchToolCall
Fields file_search_id :: Text file_search_status :: Text file_search_queries :: Vector Text file_search_results :: Maybe (Vector FileSearchResult)
Item_CodeInterpreterToolCall
Fields code_interpreter_id :: Text code_interpreter_status :: Text code_interpreter_container_id :: Maybe Text code_interpreter_code :: Maybe Text code_interpreter_outputs :: Maybe (Vector CodeInterpreterOutput)
Item_Reasoning
Fields reasoning_id :: Text reasoning_encrypted_content :: Maybe Text reasoning_summary :: Maybe (Vector SummaryPart) reasoning_content :: Maybe (Vector ReasoningText) reasoning_status :: Maybe Text

Instances

Instances details

FromJSON OutputItem Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser OutputItem #

parseJSONList :: Value -> Parser [OutputItem] #

omittedField :: Maybe OutputItem #

ToJSON OutputItem Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: OutputItem -> Value #

toEncoding :: OutputItem -> Encoding #

toJSONList :: [OutputItem] -> Value #

toEncodingList :: [OutputItem] -> Encoding #

omitField :: OutputItem -> Bool #

Generic OutputItem Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep OutputItem

Instance details

Defined in OpenAI.V1.Responses

Methods

from :: OutputItem -> Rep OutputItem x #

to :: Rep OutputItem x -> OutputItem #

Show OutputItem Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> OutputItem -> ShowS #

show :: OutputItem -> String #

showList :: [OutputItem] -> ShowS #

type Rep OutputItem Source #

Instance details

Defined in OpenAI.V1.Responses

data OutputMessage Source #

An output message item

Constructors

OutputMessage
Fields id :: Text role :: Text content :: Vector OutputContent status :: Text

Instances

Instances details

FromJSON OutputMessage Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser OutputMessage #

parseJSONList :: Value -> Parser [OutputMessage] #

omittedField :: Maybe OutputMessage #

ToJSON OutputMessage Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: OutputMessage -> Value #

toEncoding :: OutputMessage -> Encoding #

toJSONList :: [OutputMessage] -> Value #

toEncodingList :: [OutputMessage] -> Encoding #

omitField :: OutputMessage -> Bool #

Generic OutputMessage Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep OutputMessage

Instance details

Defined in OpenAI.V1.Responses

type Rep OutputMessage = D1 ('MetaData "OutputMessage" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "OutputMessage" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "role") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector OutputContent)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

Methods

from :: OutputMessage -> Rep OutputMessage x #

to :: Rep OutputMessage x -> OutputMessage #

Show OutputMessage Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> OutputMessage -> ShowS #

show :: OutputMessage -> String #

showList :: [OutputMessage] -> ShowS #

type Rep OutputMessage Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep OutputMessage = D1 ('MetaData "OutputMessage" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "OutputMessage" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "role") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector OutputContent)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

data OutputContent Source #

Output content from the model

Constructors

Output_Text
Fields text :: Text annotations :: Vector Value logprobs :: Maybe (Vector Value)
Refusal
Fields refusal :: Text

Instances

Instances details

FromJSON OutputContent Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser OutputContent #

parseJSONList :: Value -> Parser [OutputContent] #

omittedField :: Maybe OutputContent #

ToJSON OutputContent Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: OutputContent -> Value #

toEncoding :: OutputContent -> Encoding #

toJSONList :: [OutputContent] -> Value #

toEncodingList :: [OutputContent] -> Encoding #

omitField :: OutputContent -> Bool #

Generic OutputContent Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep OutputContent

Instance details

Defined in OpenAI.V1.Responses

type Rep OutputContent = D1 ('MetaData "OutputContent" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Output_Text" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "annotations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Value)) :*: S1 ('MetaSel ('Just "logprobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Value))))) :+: C1 ('MetaCons "Refusal" 'PrefixI 'True) (S1 ('MetaSel ('Just "refusal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: OutputContent -> Rep OutputContent x #

to :: Rep OutputContent x -> OutputContent #

Show OutputContent Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> OutputContent -> ShowS #

show :: OutputContent -> String #

showList :: [OutputContent] -> ShowS #

type Rep OutputContent Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep OutputContent = D1 ('MetaData "OutputContent" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Output_Text" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "annotations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Value)) :*: S1 ('MetaSel ('Just "logprobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Value))))) :+: C1 ('MetaCons "Refusal" 'PrefixI 'True) (S1 ('MetaSel ('Just "refusal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data FunctionToolCall Source #

Function tool call output item

Constructors

FunctionToolCall
Fields id :: Maybe Text call_id :: Text name :: Text arguments :: Text status :: Maybe Text

Instances

Instances details

FromJSON FunctionToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser FunctionToolCall #

parseJSONList :: Value -> Parser [FunctionToolCall] #

omittedField :: Maybe FunctionToolCall #

ToJSON FunctionToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: FunctionToolCall -> Value #

toEncoding :: FunctionToolCall -> Encoding #

toJSONList :: [FunctionToolCall] -> Value #

toEncodingList :: [FunctionToolCall] -> Encoding #

omitField :: FunctionToolCall -> Bool #

Generic FunctionToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep FunctionToolCall

Instance details

Defined in OpenAI.V1.Responses

type Rep FunctionToolCall = D1 ('MetaData "FunctionToolCall" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "FunctionToolCall" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "call_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "arguments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))

Methods

from :: FunctionToolCall -> Rep FunctionToolCall x #

to :: Rep FunctionToolCall x -> FunctionToolCall #

Show FunctionToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> FunctionToolCall -> ShowS #

show :: FunctionToolCall -> String #

showList :: [FunctionToolCall] -> ShowS #

type Rep FunctionToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep FunctionToolCall = D1 ('MetaData "FunctionToolCall" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "FunctionToolCall" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "call_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "arguments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))

data FunctionToolCallOutput Source #

Function tool call output item

Constructors

FunctionToolCallOutput
Fields id :: Maybe Text call_id :: Text output :: Text status :: Maybe Text

Instances

Instances details

FromJSON FunctionToolCallOutput Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser FunctionToolCallOutput #

parseJSONList :: Value -> Parser [FunctionToolCallOutput] #

omittedField :: Maybe FunctionToolCallOutput #

ToJSON FunctionToolCallOutput Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: FunctionToolCallOutput -> Value #

toEncoding :: FunctionToolCallOutput -> Encoding #

toJSONList :: [FunctionToolCallOutput] -> Value #

toEncodingList :: [FunctionToolCallOutput] -> Encoding #

omitField :: FunctionToolCallOutput -> Bool #

Generic FunctionToolCallOutput Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep FunctionToolCallOutput

Instance details

Defined in OpenAI.V1.Responses

type Rep FunctionToolCallOutput = D1 ('MetaData "FunctionToolCallOutput" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "FunctionToolCallOutput" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "call_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "output") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

Methods

from :: FunctionToolCallOutput -> Rep FunctionToolCallOutput x #

to :: Rep FunctionToolCallOutput x -> FunctionToolCallOutput #

Show FunctionToolCallOutput Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> FunctionToolCallOutput -> ShowS #

show :: FunctionToolCallOutput -> String #

showList :: [FunctionToolCallOutput] -> ShowS #

type Rep FunctionToolCallOutput Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep FunctionToolCallOutput = D1 ('MetaData "FunctionToolCallOutput" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "FunctionToolCallOutput" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "call_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "output") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

data WebSearchToolCall Source #

Web search tool call output item (action is left generic for now)

Constructors

WebSearchToolCall
Fields id :: Text status :: Text action :: Maybe WebSearchAction

Instances

Instances details

FromJSON WebSearchToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser WebSearchToolCall #

parseJSONList :: Value -> Parser [WebSearchToolCall] #

omittedField :: Maybe WebSearchToolCall #

ToJSON WebSearchToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: WebSearchToolCall -> Value #

toEncoding :: WebSearchToolCall -> Encoding #

toJSONList :: [WebSearchToolCall] -> Value #

toEncodingList :: [WebSearchToolCall] -> Encoding #

omitField :: WebSearchToolCall -> Bool #

Generic WebSearchToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep WebSearchToolCall

Instance details

Defined in OpenAI.V1.Responses

type Rep WebSearchToolCall = D1 ('MetaData "WebSearchToolCall" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "WebSearchToolCall" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe WebSearchAction)))))

Methods

from :: WebSearchToolCall -> Rep WebSearchToolCall x #

to :: Rep WebSearchToolCall x -> WebSearchToolCall #

Show WebSearchToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> WebSearchToolCall -> ShowS #

show :: WebSearchToolCall -> String #

showList :: [WebSearchToolCall] -> ShowS #

type Rep WebSearchToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep WebSearchToolCall = D1 ('MetaData "WebSearchToolCall" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "WebSearchToolCall" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe WebSearchAction)))))

data FileSearchToolCall Source #

File search tool call output item

Constructors

FileSearchToolCall
Fields id :: Text status :: Text queries :: Vector Text results :: Maybe (Vector FileSearchResult)

Instances

Instances details

FromJSON FileSearchToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser FileSearchToolCall #

parseJSONList :: Value -> Parser [FileSearchToolCall] #

omittedField :: Maybe FileSearchToolCall #

ToJSON FileSearchToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: FileSearchToolCall -> Value #

toEncoding :: FileSearchToolCall -> Encoding #

toJSONList :: [FileSearchToolCall] -> Value #

toEncodingList :: [FileSearchToolCall] -> Encoding #

omitField :: FileSearchToolCall -> Bool #

Generic FileSearchToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep FileSearchToolCall

Instance details

Defined in OpenAI.V1.Responses

type Rep FileSearchToolCall = D1 ('MetaData "FileSearchToolCall" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "FileSearchToolCall" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "queries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Text)) :*: S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector FileSearchResult))))))

Methods

from :: FileSearchToolCall -> Rep FileSearchToolCall x #

to :: Rep FileSearchToolCall x -> FileSearchToolCall #

Show FileSearchToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> FileSearchToolCall -> ShowS #

show :: FileSearchToolCall -> String #

showList :: [FileSearchToolCall] -> ShowS #

type Rep FileSearchToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep FileSearchToolCall = D1 ('MetaData "FileSearchToolCall" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "FileSearchToolCall" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "queries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Text)) :*: S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector FileSearchResult))))))

data FileSearchResult Source #

File search result entry

Constructors

FileSearchResult
Fields file_id :: Text text :: Text filename :: Text score :: Maybe Double

Instances

Instances details

FromJSON FileSearchResult Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser FileSearchResult #

parseJSONList :: Value -> Parser [FileSearchResult] #

omittedField :: Maybe FileSearchResult #

ToJSON FileSearchResult Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: FileSearchResult -> Value #

toEncoding :: FileSearchResult -> Encoding #

toJSONList :: [FileSearchResult] -> Value #

toEncodingList :: [FileSearchResult] -> Encoding #

omitField :: FileSearchResult -> Bool #

Generic FileSearchResult Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep FileSearchResult

Instance details

Defined in OpenAI.V1.Responses

type Rep FileSearchResult = D1 ('MetaData "FileSearchResult" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "FileSearchResult" 'PrefixI 'True) ((S1 ('MetaSel ('Just "file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "filename") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)))))

Methods

from :: FileSearchResult -> Rep FileSearchResult x #

to :: Rep FileSearchResult x -> FileSearchResult #

Show FileSearchResult Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> FileSearchResult -> ShowS #

show :: FileSearchResult -> String #

showList :: [FileSearchResult] -> ShowS #

type Rep FileSearchResult Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep FileSearchResult = D1 ('MetaData "FileSearchResult" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "FileSearchResult" 'PrefixI 'True) ((S1 ('MetaSel ('Just "file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "filename") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)))))

data CodeInterpreterToolCall Source #

Code interpreter tool call output item

Constructors

CodeInterpreterToolCall
Fields id :: Text status :: Text container_id :: Maybe Text code :: Maybe Text outputs :: Maybe (Vector CodeInterpreterOutput)

Instances

Instances details

FromJSON CodeInterpreterToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser CodeInterpreterToolCall #

parseJSONList :: Value -> Parser [CodeInterpreterToolCall] #

omittedField :: Maybe CodeInterpreterToolCall #

ToJSON CodeInterpreterToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: CodeInterpreterToolCall -> Value #

toEncoding :: CodeInterpreterToolCall -> Encoding #

toJSONList :: [CodeInterpreterToolCall] -> Value #

toEncodingList :: [CodeInterpreterToolCall] -> Encoding #

omitField :: CodeInterpreterToolCall -> Bool #

Generic CodeInterpreterToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep CodeInterpreterToolCall

Instance details

Defined in OpenAI.V1.Responses

type Rep CodeInterpreterToolCall = D1 ('MetaData "CodeInterpreterToolCall" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "CodeInterpreterToolCall" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "container_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector CodeInterpreterOutput)))))))

Methods

from :: CodeInterpreterToolCall -> Rep CodeInterpreterToolCall x #

to :: Rep CodeInterpreterToolCall x -> CodeInterpreterToolCall #

Show CodeInterpreterToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> CodeInterpreterToolCall -> ShowS #

show :: CodeInterpreterToolCall -> String #

showList :: [CodeInterpreterToolCall] -> ShowS #

type Rep CodeInterpreterToolCall Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep CodeInterpreterToolCall = D1 ('MetaData "CodeInterpreterToolCall" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "CodeInterpreterToolCall" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "container_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector CodeInterpreterOutput)))))))

data CodeInterpreterOutput Source #

Code interpreter tool call outputs

Constructors

CodeInterpreterOutput_Logs
Fields logs :: Text
CodeInterpreterOutput_Image
Fields url :: Text

Instances

Instances details

FromJSON CodeInterpreterOutput Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser CodeInterpreterOutput #

parseJSONList :: Value -> Parser [CodeInterpreterOutput] #

omittedField :: Maybe CodeInterpreterOutput #

ToJSON CodeInterpreterOutput Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: CodeInterpreterOutput -> Value #

toEncoding :: CodeInterpreterOutput -> Encoding #

toJSONList :: [CodeInterpreterOutput] -> Value #

toEncodingList :: [CodeInterpreterOutput] -> Encoding #

omitField :: CodeInterpreterOutput -> Bool #

Generic CodeInterpreterOutput Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep CodeInterpreterOutput

Instance details

Defined in OpenAI.V1.Responses

type Rep CodeInterpreterOutput = D1 ('MetaData "CodeInterpreterOutput" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "CodeInterpreterOutput_Logs" 'PrefixI 'True) (S1 ('MetaSel ('Just "logs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "CodeInterpreterOutput_Image" 'PrefixI 'True) (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: CodeInterpreterOutput -> Rep CodeInterpreterOutput x #

to :: Rep CodeInterpreterOutput x -> CodeInterpreterOutput #

Show CodeInterpreterOutput Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> CodeInterpreterOutput -> ShowS #

show :: CodeInterpreterOutput -> String #

showList :: [CodeInterpreterOutput] -> ShowS #

type Rep CodeInterpreterOutput Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep CodeInterpreterOutput = D1 ('MetaData "CodeInterpreterOutput" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "CodeInterpreterOutput_Logs" 'PrefixI 'True) (S1 ('MetaSel ('Just "logs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "CodeInterpreterOutput_Image" 'PrefixI 'True) (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data WebSearchAction Source #

Web search action

Constructors

WebSearchAction_Search
Fields query :: Maybe Text sources :: Maybe (Vector WebSearchSource)
WebSearchAction_Open_Page
Fields url :: Maybe Text
WebSearchAction_Find
Fields url :: Maybe Text pattern :: Maybe Text

Instances

Instances details

FromJSON WebSearchAction Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser WebSearchAction #

parseJSONList :: Value -> Parser [WebSearchAction] #

omittedField :: Maybe WebSearchAction #

ToJSON WebSearchAction Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: WebSearchAction -> Value #

toEncoding :: WebSearchAction -> Encoding #

toJSONList :: [WebSearchAction] -> Value #

toEncodingList :: [WebSearchAction] -> Encoding #

omitField :: WebSearchAction -> Bool #

Generic WebSearchAction Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep WebSearchAction

Instance details

Defined in OpenAI.V1.Responses

type Rep WebSearchAction = D1 ('MetaData "WebSearchAction" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "WebSearchAction_Search" 'PrefixI 'True) (S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector WebSearchSource)))) :+: (C1 ('MetaCons "WebSearchAction_Open_Page" 'PrefixI 'True) (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :+: C1 ('MetaCons "WebSearchAction_Find" 'PrefixI 'True) (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

Methods

from :: WebSearchAction -> Rep WebSearchAction x #

to :: Rep WebSearchAction x -> WebSearchAction #

Show WebSearchAction Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> WebSearchAction -> ShowS #

show :: WebSearchAction -> String #

showList :: [WebSearchAction] -> ShowS #

type Rep WebSearchAction Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep WebSearchAction = D1 ('MetaData "WebSearchAction" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "WebSearchAction_Search" 'PrefixI 'True) (S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector WebSearchSource)))) :+: (C1 ('MetaCons "WebSearchAction_Open_Page" 'PrefixI 'True) (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :+: C1 ('MetaCons "WebSearchAction_Find" 'PrefixI 'True) (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

data WebSearchSource Source #

Web search action sources

Constructors

WebSearchSource_URL
Fields url :: Text

Instances

Instances details

FromJSON WebSearchSource Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser WebSearchSource #

parseJSONList :: Value -> Parser [WebSearchSource] #

omittedField :: Maybe WebSearchSource #

ToJSON WebSearchSource Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: WebSearchSource -> Value #

toEncoding :: WebSearchSource -> Encoding #

toJSONList :: [WebSearchSource] -> Value #

toEncodingList :: [WebSearchSource] -> Encoding #

omitField :: WebSearchSource -> Bool #

Generic WebSearchSource Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

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

Methods

from :: WebSearchSource -> Rep WebSearchSource x #

to :: Rep WebSearchSource x -> WebSearchSource #

Show WebSearchSource Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> WebSearchSource -> ShowS #

show :: WebSearchSource -> String #

showList :: [WebSearchSource] -> ShowS #

type Rep WebSearchSource Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep WebSearchSource = D1 ('MetaData "WebSearchSource" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "WebSearchSource_URL" 'PrefixI 'True) (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Annotation Source #

Output text annotation

Constructors

Annotation_File_Citation
Fields file_id :: Text index :: Natural filename :: Text
Annotation_Url_Citation
Fields url :: Text start_index :: Natural end_index :: Natural title :: Text
Annotation_Container_File_Citation
Fields container_id :: Text file_id :: Text start_index :: Natural end_index :: Natural filename :: Text
Annotation_File_Path
Fields file_id :: Text index :: Natural

Instances

Instances details

FromJSON Annotation Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser Annotation #

parseJSONList :: Value -> Parser [Annotation] #

omittedField :: Maybe Annotation #

ToJSON Annotation Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: Annotation -> Value #

toEncoding :: Annotation -> Encoding #

toJSONList :: [Annotation] -> Value #

toEncodingList :: [Annotation] -> Encoding #

omitField :: Annotation -> Bool #

Generic Annotation Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep Annotation

Instance details

Defined in OpenAI.V1.Responses

Methods

from :: Annotation -> Rep Annotation x #

to :: Rep Annotation x -> Annotation #

Show Annotation Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> Annotation -> ShowS #

show :: Annotation -> String #

showList :: [Annotation] -> ShowS #

type Rep Annotation Source #

Instance details

Defined in OpenAI.V1.Responses

data ReasoningSummary Source #

Reasoning summary verbosity options.

Note: the ReasoningSummary_Concise option is only supported for `computer-use-preview` models.

Constructors

ReasoningSummary_Auto
ReasoningSummary_Concise
ReasoningSummary_Detailed

Instances

Instances details

FromJSON ReasoningSummary Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser ReasoningSummary #

parseJSONList :: Value -> Parser [ReasoningSummary] #

omittedField :: Maybe ReasoningSummary #

ToJSON ReasoningSummary Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: ReasoningSummary -> Value #

toEncoding :: ReasoningSummary -> Encoding #

toJSONList :: [ReasoningSummary] -> Value #

toEncodingList :: [ReasoningSummary] -> Encoding #

omitField :: ReasoningSummary -> Bool #

Generic ReasoningSummary Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep ReasoningSummary

Instance details

Defined in OpenAI.V1.Responses

type Rep ReasoningSummary = D1 ('MetaData "ReasoningSummary" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "ReasoningSummary_Auto" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ReasoningSummary_Concise" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ReasoningSummary_Detailed" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: ReasoningSummary -> Rep ReasoningSummary x #

to :: Rep ReasoningSummary x -> ReasoningSummary #

Show ReasoningSummary Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> ReasoningSummary -> ShowS #

show :: ReasoningSummary -> String #

showList :: [ReasoningSummary] -> ShowS #

Eq ReasoningSummary Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

(==) :: ReasoningSummary -> ReasoningSummary -> Bool #

(/=) :: ReasoningSummary -> ReasoningSummary -> Bool #

type Rep ReasoningSummary Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep ReasoningSummary = D1 ('MetaData "ReasoningSummary" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "ReasoningSummary_Auto" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ReasoningSummary_Concise" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ReasoningSummary_Detailed" 'PrefixI 'False) (U1 :: Type -> Type)))

data Reasoning Source #

Configuration options for reasoning models (`gpt-5` and o-series only).

Constructors

Reasoning

Fields

effort :: Maybe ReasoningEffort
Constrains the amount of effort spent by the model on reasoning.
summary :: Maybe ReasoningSummary
Controls whether the model should produce a reasoning summary (one of auto, concise, or detailed). The concise option is currently limited to `computer-use-preview` models.
generate_summary :: Maybe ReasoningSummary
- *Deprecated:** use summary instead. When present, behaves like summary and accepts auto, concise, or detailed.

Instances

Instances details

FromJSON Reasoning Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser Reasoning #

parseJSONList :: Value -> Parser [Reasoning] #

omittedField :: Maybe Reasoning #

ToJSON Reasoning Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: Reasoning -> Value #

toEncoding :: Reasoning -> Encoding #

toJSONList :: [Reasoning] -> Value #

toEncodingList :: [Reasoning] -> Encoding #

omitField :: Reasoning -> Bool #

Generic Reasoning Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep Reasoning

Instance details

Defined in OpenAI.V1.Responses

type Rep Reasoning = D1 ('MetaData "Reasoning" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Reasoning" 'PrefixI 'True) (S1 ('MetaSel ('Just "effort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ReasoningEffort)) :*: (S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ReasoningSummary)) :*: S1 ('MetaSel ('Just "generate_summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ReasoningSummary)))))

Methods

from :: Reasoning -> Rep Reasoning x #

to :: Rep Reasoning x -> Reasoning #

Show Reasoning Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> Reasoning -> ShowS #

show :: Reasoning -> String #

showList :: [Reasoning] -> ShowS #

Eq Reasoning Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

(==) :: Reasoning -> Reasoning -> Bool #

(/=) :: Reasoning -> Reasoning -> Bool #

type Rep Reasoning Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep Reasoning = D1 ('MetaData "Reasoning" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Reasoning" 'PrefixI 'True) (S1 ('MetaSel ('Just "effort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ReasoningEffort)) :*: (S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ReasoningSummary)) :*: S1 ('MetaSel ('Just "generate_summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ReasoningSummary)))))

_Reasoning :: Reasoning Source #

Default reasoning configuration

data ReasoningItem Source #

Reasoning item produced by reasoning models

Constructors

ReasoningItem
Fields id :: Text encrypted_content :: Maybe Text summary :: Maybe (Vector SummaryPart) content :: Maybe (Vector ReasoningText) status :: Maybe Text

Instances

Instances details

FromJSON ReasoningItem Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser ReasoningItem #

parseJSONList :: Value -> Parser [ReasoningItem] #

omittedField :: Maybe ReasoningItem #

ToJSON ReasoningItem Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: ReasoningItem -> Value #

toEncoding :: ReasoningItem -> Encoding #

toJSONList :: [ReasoningItem] -> Value #

toEncodingList :: [ReasoningItem] -> Encoding #

omitField :: ReasoningItem -> Bool #

Generic ReasoningItem Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep ReasoningItem

Instance details

Defined in OpenAI.V1.Responses

type Rep ReasoningItem = D1 ('MetaData "ReasoningItem" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "ReasoningItem" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "encrypted_content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector SummaryPart))) :*: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector ReasoningText))) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))

Methods

from :: ReasoningItem -> Rep ReasoningItem x #

to :: Rep ReasoningItem x -> ReasoningItem #

Show ReasoningItem Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> ReasoningItem -> ShowS #

show :: ReasoningItem -> String #

showList :: [ReasoningItem] -> ShowS #

Eq ReasoningItem Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

(==) :: ReasoningItem -> ReasoningItem -> Bool #

(/=) :: ReasoningItem -> ReasoningItem -> Bool #

type Rep ReasoningItem Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep ReasoningItem = D1 ('MetaData "ReasoningItem" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "ReasoningItem" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "encrypted_content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector SummaryPart))) :*: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector ReasoningText))) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))

data SummaryPart Source #

Reasoning summary part

Constructors

Summary_Text
Fields text :: Text

Instances

Instances details

FromJSON SummaryPart Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser SummaryPart #

parseJSONList :: Value -> Parser [SummaryPart] #

omittedField :: Maybe SummaryPart #

ToJSON SummaryPart Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: SummaryPart -> Value #

toEncoding :: SummaryPart -> Encoding #

toJSONList :: [SummaryPart] -> Value #

toEncodingList :: [SummaryPart] -> Encoding #

omitField :: SummaryPart -> Bool #

Generic SummaryPart Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

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

Methods

from :: SummaryPart -> Rep SummaryPart x #

to :: Rep SummaryPart x -> SummaryPart #

Show SummaryPart Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> SummaryPart -> ShowS #

show :: SummaryPart -> String #

showList :: [SummaryPart] -> ShowS #

Eq SummaryPart Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

(==) :: SummaryPart -> SummaryPart -> Bool #

(/=) :: SummaryPart -> SummaryPart -> Bool #

type Rep SummaryPart Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep SummaryPart = D1 ('MetaData "SummaryPart" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Summary_Text" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data ReasoningText Source #

Reasoning text part

Constructors

Reasoning_Text
Fields text :: Text

Instances

Instances details

FromJSON ReasoningText Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser ReasoningText #

parseJSONList :: Value -> Parser [ReasoningText] #

omittedField :: Maybe ReasoningText #

ToJSON ReasoningText Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: ReasoningText -> Value #

toEncoding :: ReasoningText -> Encoding #

toJSONList :: [ReasoningText] -> Value #

toEncodingList :: [ReasoningText] -> Encoding #

omitField :: ReasoningText -> Bool #

Generic ReasoningText Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

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

Methods

from :: ReasoningText -> Rep ReasoningText x #

to :: Rep ReasoningText x -> ReasoningText #

Show ReasoningText Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> ReasoningText -> ShowS #

show :: ReasoningText -> String #

showList :: [ReasoningText] -> ShowS #

Eq ReasoningText Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

(==) :: ReasoningText -> ReasoningText -> Bool #

(/=) :: ReasoningText -> ReasoningText -> Bool #

type Rep ReasoningText Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep ReasoningText = D1 ('MetaData "ReasoningText" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Reasoning_Text" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data ReasoningEffort Source #

Constrains effort on reasoning for reasoning models.

Defaults to ReasoningEffort_Medium when omitted. Reducing the effort can result in faster responses with fewer reasoning tokens. The `gpt-5-pro` model currently only supports ReasoningEffort_High.

Constructors

ReasoningEffort_Minimal
ReasoningEffort_Low
ReasoningEffort_Medium
ReasoningEffort_High

Instances

Instances details

FromJSON ReasoningEffort Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser ReasoningEffort #

parseJSONList :: Value -> Parser [ReasoningEffort] #

omittedField :: Maybe ReasoningEffort #

ToJSON ReasoningEffort Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: ReasoningEffort -> Value #

toEncoding :: ReasoningEffort -> Encoding #

toJSONList :: [ReasoningEffort] -> Value #

toEncodingList :: [ReasoningEffort] -> Encoding #

omitField :: ReasoningEffort -> Bool #

Generic ReasoningEffort Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep ReasoningEffort

Instance details

Defined in OpenAI.V1.Responses

type Rep ReasoningEffort = D1 ('MetaData "ReasoningEffort" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) ((C1 ('MetaCons "ReasoningEffort_Minimal" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ReasoningEffort_Low" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ReasoningEffort_Medium" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ReasoningEffort_High" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: ReasoningEffort -> Rep ReasoningEffort x #

to :: Rep ReasoningEffort x -> ReasoningEffort #

Show ReasoningEffort Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> ReasoningEffort -> ShowS #

show :: ReasoningEffort -> String #

showList :: [ReasoningEffort] -> ShowS #

Eq ReasoningEffort Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

(==) :: ReasoningEffort -> ReasoningEffort -> Bool #

(/=) :: ReasoningEffort -> ReasoningEffort -> Bool #

type Rep ReasoningEffort Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep ReasoningEffort = D1 ('MetaData "ReasoningEffort" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) ((C1 ('MetaCons "ReasoningEffort_Minimal" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ReasoningEffort_Low" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ReasoningEffort_Medium" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ReasoningEffort_High" 'PrefixI 'False) (U1 :: Type -> Type)))

type ServiceTier = Text Source #

Specifies the processing tier used for the request

data ResponseStreamEvent Source #

Streaming events for /v1/responses

Constructors

ResponseCreatedEvent
Fields response :: ResponseObject sequence_number :: Natural
ResponseInProgressEvent
Fields response :: ResponseObject sequence_number :: Natural
ResponseCompletedEvent
Fields response :: ResponseObject sequence_number :: Natural
ResponseFailedEvent
Fields response :: ResponseObject sequence_number :: Natural
ResponseOutputItemAddedEvent
Fields output_index :: Natural item :: OutputItem sequence_number :: Natural
ResponseOutputItemDoneEvent
Fields output_index :: Natural sequence_number :: Natural
ResponseContentPartAddedEvent
Fields item_id :: Text output_index :: Natural content_index :: Natural part :: OutputContent sequence_number :: Natural
ResponseContentPartDoneEvent
Fields item_id :: Text output_index :: Natural content_index :: Natural part :: OutputContent sequence_number :: Natural
ResponseTextDeltaEvent
Fields item_id :: Text output_index :: Natural content_index :: Natural delta :: Text sequence_number :: Natural
ResponseTextDoneEvent
Fields item_id :: Text output_index :: Natural content_index :: Natural text :: Text sequence_number :: Natural
ResponseOutputTextAnnotationAddedEvent
Fields item_id :: Text output_index :: Natural content_index :: Natural annotation_index :: Natural annotation :: Annotation sequence_number :: Natural
ResponseWebSearchCallInProgressEvent
Fields output_index :: Natural item_id :: Text sequence_number :: Natural
ResponseWebSearchCallSearchingEvent
Fields output_index :: Natural item_id :: Text sequence_number :: Natural
ResponseWebSearchCallCompletedEvent
Fields output_index :: Natural item_id :: Text sequence_number :: Natural
ResponseFileSearchCallInProgressEvent
Fields output_index :: Natural item_id :: Text sequence_number :: Natural
ResponseFileSearchCallSearchingEvent
Fields output_index :: Natural item_id :: Text sequence_number :: Natural
ResponseFileSearchCallCompletedEvent
Fields output_index :: Natural item_id :: Text sequence_number :: Natural
ResponseCodeInterpreterCallInProgressEvent
Fields output_index :: Natural item_id :: Text sequence_number :: Natural
ResponseCodeInterpreterCallInterpretingEvent
Fields output_index :: Natural item_id :: Text sequence_number :: Natural
ResponseCodeInterpreterCallCompletedEvent
Fields output_index :: Natural item_id :: Text sequence_number :: Natural
ResponseCodeInterpreterCallCodeDeltaEvent
Fields output_index :: Natural item_id :: Text delta :: Text sequence_number :: Natural
ResponseCodeInterpreterCallCodeDoneEvent
Fields output_index :: Natural item_id :: Text code :: Text sequence_number :: Natural
ErrorEvent
Fields error_code :: Maybe Text error_message :: Text error_param :: Maybe Text error_sequence_number :: Natural

Instances

Instances details

FromJSON ResponseStreamEvent Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser ResponseStreamEvent #

parseJSONList :: Value -> Parser [ResponseStreamEvent] #

omittedField :: Maybe ResponseStreamEvent #

ToJSON ResponseStreamEvent Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: ResponseStreamEvent -> Value #

toEncoding :: ResponseStreamEvent -> Encoding #

toJSONList :: [ResponseStreamEvent] -> Value #

toEncodingList :: [ResponseStreamEvent] -> Encoding #

omitField :: ResponseStreamEvent -> Bool #

Generic ResponseStreamEvent Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep ResponseStreamEvent

Instance details

Defined in OpenAI.V1.Responses

Methods

from :: ResponseStreamEvent -> Rep ResponseStreamEvent x #

to :: Rep ResponseStreamEvent x -> ResponseStreamEvent #

Show ResponseStreamEvent Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> ResponseStreamEvent -> ShowS #

show :: ResponseStreamEvent -> String #

showList :: [ResponseStreamEvent] -> ShowS #

type Rep ResponseStreamEvent Source #

Instance details

Defined in OpenAI.V1.Responses

data ResponseObject Source #

Response object

Constructors

ResponseObject

Fields

Instances

Instances details

FromJSON ResponseObject Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser ResponseObject #

parseJSONList :: Value -> Parser [ResponseObject] #

omittedField :: Maybe ResponseObject #

ToJSON ResponseObject Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: ResponseObject -> Value #

toEncoding :: ResponseObject -> Encoding #

toJSONList :: [ResponseObject] -> Value #

toEncodingList :: [ResponseObject] -> Encoding #

omitField :: ResponseObject -> Bool #

Generic ResponseObject Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep ResponseObject

Instance details

Defined in OpenAI.V1.Responses

Methods

from :: ResponseObject -> Rep ResponseObject x #

to :: Rep ResponseObject x -> ResponseObject #

Show ResponseObject Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> ResponseObject -> ShowS #

show :: ResponseObject -> String #

showList :: [ResponseObject] -> ShowS #

type Rep ResponseObject Source #

Instance details

Defined in OpenAI.V1.Responses

data ResponseUsage Source #

Usage statistics for the response request

Constructors

ResponseUsage
Fields input_tokens :: Natural input_tokens_details :: InputTokensDetails output_tokens :: Natural output_tokens_details :: OutputTokensDetails total_tokens :: Natural

Instances

Instances details

FromJSON ResponseUsage Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser ResponseUsage #

parseJSONList :: Value -> Parser [ResponseUsage] #

omittedField :: Maybe ResponseUsage #

ToJSON ResponseUsage Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: ResponseUsage -> Value #

toEncoding :: ResponseUsage -> Encoding #

toJSONList :: [ResponseUsage] -> Value #

toEncodingList :: [ResponseUsage] -> Encoding #

omitField :: ResponseUsage -> Bool #

Generic ResponseUsage Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep ResponseUsage

Instance details

Defined in OpenAI.V1.Responses

type Rep ResponseUsage = D1 ('MetaData "ResponseUsage" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "ResponseUsage" 'PrefixI 'True) ((S1 ('MetaSel ('Just "input_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "input_tokens_details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InputTokensDetails)) :*: (S1 ('MetaSel ('Just "output_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: (S1 ('MetaSel ('Just "output_tokens_details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OutputTokensDetails) :*: S1 ('MetaSel ('Just "total_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))))

Methods

from :: ResponseUsage -> Rep ResponseUsage x #

to :: Rep ResponseUsage x -> ResponseUsage #

Show ResponseUsage Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> ResponseUsage -> ShowS #

show :: ResponseUsage -> String #

showList :: [ResponseUsage] -> ShowS #

type Rep ResponseUsage Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep ResponseUsage = D1 ('MetaData "ResponseUsage" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "ResponseUsage" 'PrefixI 'True) ((S1 ('MetaSel ('Just "input_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "input_tokens_details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InputTokensDetails)) :*: (S1 ('MetaSel ('Just "output_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: (S1 ('MetaSel ('Just "output_tokens_details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OutputTokensDetails) :*: S1 ('MetaSel ('Just "total_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))))

data InputTokensDetails Source #

Constructors

InputTokensDetails
Fields cached_tokens :: Natural

Instances

Instances details

FromJSON InputTokensDetails Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser InputTokensDetails #

parseJSONList :: Value -> Parser [InputTokensDetails] #

omittedField :: Maybe InputTokensDetails #

ToJSON InputTokensDetails Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: InputTokensDetails -> Value #

toEncoding :: InputTokensDetails -> Encoding #

toJSONList :: [InputTokensDetails] -> Value #

toEncodingList :: [InputTokensDetails] -> Encoding #

omitField :: InputTokensDetails -> Bool #

Generic InputTokensDetails Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep InputTokensDetails
Instance details Defined in OpenAI.V1.Responses type Rep InputTokensDetails = D1 ('MetaData "InputTokensDetails" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "InputTokensDetails" 'PrefixI 'True) (S1 ('MetaSel ('Just "cached_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

Methods

from :: InputTokensDetails -> Rep InputTokensDetails x #

to :: Rep InputTokensDetails x -> InputTokensDetails #

Show InputTokensDetails Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

showsPrec :: Int -> InputTokensDetails -> ShowS #

show :: InputTokensDetails -> String #

showList :: [InputTokensDetails] -> ShowS #

type Rep InputTokensDetails Source #

Instance details

Defined in OpenAI.V1.Responses

type Rep InputTokensDetails = D1 ('MetaData "InputTokensDetails" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "InputTokensDetails" 'PrefixI 'True) (S1 ('MetaSel ('Just "cached_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

data OutputTokensDetails Source #

Constructors

OutputTokensDetails
Fields reasoning_tokens :: Natural

Instances

Instances details

FromJSON OutputTokensDetails Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

parseJSON :: Value -> Parser OutputTokensDetails #

parseJSONList :: Value -> Parser [OutputTokensDetails] #

omittedField :: Maybe OutputTokensDetails #

ToJSON OutputTokensDetails Source #

Instance details

Defined in OpenAI.V1.Responses

Methods

toJSON :: OutputTokensDetails -> Value #

toEncoding :: OutputTokensDetails -> Encoding #

toJSONList :: [OutputTokensDetails] -> Value #

toEncodingList :: [OutputTokensDetails] -> Encoding #

omitField :: OutputTokensDetails -> Bool #

Generic OutputTokensDetails Source #

Instance details

Defined in OpenAI.V1.Responses

Associated Types

type Rep OutputTokensDetails
Instance details Defined in OpenAI.V1.Responses type Rep OutputTokensDetails = D1 ('MetaData "OutputTokensDetails" "OpenAI.V1.Responses" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "OutputTokensDetails" 'PrefixI 'True) (S1 ('MetaSel ('Just "reasoning_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))