Safe Haskell	None
Language	Haskell2010

OpenAI.V1.Assistants

Contents

Main types
Other types
Servant

Description

/v1/assistants

Synopsis

newtype AssistantID = AssistantID {
- text :: Text
}
data CreateAssistant = CreateAssistant {
- model :: Model
- name :: Maybe Text
- description :: Maybe Text
- instructions :: Maybe Text
- tools :: Maybe (Vector Tool)
- tool_resources :: Maybe ToolResources
- metadata :: Maybe (Map Text Text)
- temperature :: Maybe Double
- top_p :: Maybe Double
- response_format :: Maybe (AutoOr ResponseFormat)
}
_CreateAssistant :: CreateAssistant
data ModifyAssistant = ModifyAssistant {
- model :: Model
- name :: Maybe Text
- description :: Maybe Text
- instructions :: Maybe Text
- tools :: Maybe (Vector Tool)
- tool_resources :: Maybe ToolResources
- metadata :: Maybe (Map Text Text)
- temperature :: Maybe Double
- top_p :: Maybe Double
- response_format :: Maybe (AutoOr ResponseFormat)
}
_ModifyAssistant :: ModifyAssistant
data AssistantObject = AssistantObject {
- id :: AssistantID
- object :: Text
- created_at :: POSIXTime
- name :: Maybe Text
- description :: Maybe Text
- model :: Model
- instructions :: Maybe Text
- tools :: Maybe (Vector Tool)
- tool_resources :: Maybe ToolResources
- metadata :: Map Text Text
- temperature :: Maybe Double
- top_p :: Maybe Double
- response_format :: AutoOr ResponseFormat
}
data RankingOptions
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 Tool
- = Tool_Code_Interpreter {
  - container :: Maybe CodeInterpreterContainer
  }
- | Tool_File_Search {
  - file_search :: FileSearch
  }
- | Tool_Function {
  - function :: Function
  }
- | Tool_Web_Search
data CodeInterpreterResources = CodeInterpreterResources {
- file_ids :: Maybe (Vector FileID)
}
data FileSearchResources = FileSearchResources {
- vector_store_ids :: Maybe (Vector FileID)
- vector_stores :: Maybe (Vector VectorStore)
}
data ToolResources = ToolResources {
- code_interpreter :: Maybe CodeInterpreterResources
- file_search :: Maybe FileSearchResources
}
type API = Header' '[Required, Strict] "OpenAI-Beta" Text :> ("assistants" :> ((ReqBody '[JSON] CreateAssistant :> Post '[JSON] AssistantObject) :<|> ((QueryParam "limit" Natural :> (QueryParam "order" Order :> (QueryParam "after" Text :> (QueryParam "before" Text :> Get '[JSON] (ListOf AssistantObject))))) :<|> ((Capture "assistant_id" AssistantID :> Get '[JSON] AssistantObject) :<|> ((Capture "assistant_id" AssistantID :> (ReqBody '[JSON] ModifyAssistant :> Post '[JSON] AssistantObject)) :<|> (Capture "assistant_id" AssistantID :> Delete '[JSON] DeletionStatus))))))

Main types

newtype AssistantID Source #

AssistantID

Constructors

AssistantID
Fields text :: Text

Instances

Instances details

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

data CreateAssistant Source #

Request body for /v1/assistants

Constructors

CreateAssistant
Fields model :: Model name :: Maybe Text description :: Maybe Text instructions :: Maybe Text tools :: Maybe (Vector Tool) tool_resources :: Maybe ToolResources metadata :: Maybe (Map Text Text) temperature :: Maybe Double top_p :: Maybe Double response_format :: Maybe (AutoOr ResponseFormat)

Instances

Instances details

FromJSON CreateAssistant Source #

Instance details

Defined in OpenAI.V1.Assistants

Methods

parseJSON :: Value -> Parser CreateAssistant #

parseJSONList :: Value -> Parser [CreateAssistant] #

omittedField :: Maybe CreateAssistant #

ToJSON CreateAssistant Source #

Instance details

Defined in OpenAI.V1.Assistants

Methods

toJSON :: CreateAssistant -> Value #

toEncoding :: CreateAssistant -> Encoding #

toJSONList :: [CreateAssistant] -> Value #

toEncodingList :: [CreateAssistant] -> Encoding #

omitField :: CreateAssistant -> Bool #

Generic CreateAssistant Source #

Instance details

Defined in OpenAI.V1.Assistants

Associated Types

type Rep CreateAssistant

Instance details

Defined in OpenAI.V1.Assistants

Methods

from :: CreateAssistant -> Rep CreateAssistant x #

to :: Rep CreateAssistant x -> CreateAssistant #

Show CreateAssistant Source #

Instance details

Defined in OpenAI.V1.Assistants

Methods

showsPrec :: Int -> CreateAssistant -> ShowS #

show :: CreateAssistant -> String #

showList :: [CreateAssistant] -> ShowS #

type Rep CreateAssistant Source #

Instance details

Defined in OpenAI.V1.Assistants

_CreateAssistant :: CreateAssistant Source #

Default CreateAssistant

data ModifyAssistant Source #

Request body for /v1/assistants/:assistant_id

Constructors

ModifyAssistant
Fields model :: Model name :: Maybe Text description :: Maybe Text instructions :: Maybe Text tools :: Maybe (Vector Tool) tool_resources :: Maybe ToolResources metadata :: Maybe (Map Text Text) temperature :: Maybe Double top_p :: Maybe Double response_format :: Maybe (AutoOr ResponseFormat)

Instances

Instances details

FromJSON ModifyAssistant Source #

Instance details

Defined in OpenAI.V1.Assistants

Methods

parseJSON :: Value -> Parser ModifyAssistant #

parseJSONList :: Value -> Parser [ModifyAssistant] #

omittedField :: Maybe ModifyAssistant #

ToJSON ModifyAssistant Source #

Instance details

Defined in OpenAI.V1.Assistants

Methods

toJSON :: ModifyAssistant -> Value #

toEncoding :: ModifyAssistant -> Encoding #

toJSONList :: [ModifyAssistant] -> Value #

toEncodingList :: [ModifyAssistant] -> Encoding #

omitField :: ModifyAssistant -> Bool #

Generic ModifyAssistant Source #

Instance details

Defined in OpenAI.V1.Assistants

Associated Types

type Rep ModifyAssistant

Instance details

Defined in OpenAI.V1.Assistants

Methods

from :: ModifyAssistant -> Rep ModifyAssistant x #

to :: Rep ModifyAssistant x -> ModifyAssistant #

Show ModifyAssistant Source #

Instance details

Defined in OpenAI.V1.Assistants

Methods

showsPrec :: Int -> ModifyAssistant -> ShowS #

show :: ModifyAssistant -> String #

showList :: [ModifyAssistant] -> ShowS #

type Rep ModifyAssistant Source #

Instance details

Defined in OpenAI.V1.Assistants

_ModifyAssistant :: ModifyAssistant Source #

Default ModifyAssistant

data AssistantObject Source #

Represents an assistant that can call the model and use tools.

Constructors

AssistantObject
Fields id :: AssistantID object :: Text created_at :: POSIXTime name :: Maybe Text description :: Maybe Text model :: Model instructions :: Maybe Text tools :: Maybe (Vector Tool) tool_resources :: Maybe ToolResources metadata :: Map Text Text temperature :: Maybe Double top_p :: Maybe Double response_format :: AutoOr ResponseFormat

Instances

Instances details

FromJSON AssistantObject Source #

Instance details

Defined in OpenAI.V1.Assistants

Methods

parseJSON :: Value -> Parser AssistantObject #

parseJSONList :: Value -> Parser [AssistantObject] #

omittedField :: Maybe AssistantObject #

ToJSON AssistantObject Source #

Instance details

Defined in OpenAI.V1.Assistants

Methods

toJSON :: AssistantObject -> Value #

toEncoding :: AssistantObject -> Encoding #

toJSONList :: [AssistantObject] -> Value #

toEncodingList :: [AssistantObject] -> Encoding #

omitField :: AssistantObject -> Bool #

Generic AssistantObject Source #

Instance details

Defined in OpenAI.V1.Assistants

Associated Types

type Rep AssistantObject

Instance details

Defined in OpenAI.V1.Assistants

Methods

from :: AssistantObject -> Rep AssistantObject x #

to :: Rep AssistantObject x -> AssistantObject #

Show AssistantObject Source #

Instance details

Defined in OpenAI.V1.Assistants

Methods

showsPrec :: Int -> AssistantObject -> ShowS #

show :: AssistantObject -> String #

showList :: [AssistantObject] -> ShowS #

type Rep AssistantObject Source #

Instance details

Defined in OpenAI.V1.Assistants

Other types

data RankingOptions Source #

The ranking options for the file search

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 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 CodeInterpreterResources Source #

Resources for the code search tool

Constructors

CodeInterpreterResources
Fields file_ids :: Maybe (Vector FileID)

Instances

Instances details

FromJSON CodeInterpreterResources Source #

Instance details

Defined in OpenAI.V1.ToolResources

Methods

parseJSON :: Value -> Parser CodeInterpreterResources #

parseJSONList :: Value -> Parser [CodeInterpreterResources] #

omittedField :: Maybe CodeInterpreterResources #

ToJSON CodeInterpreterResources Source #

Instance details

Defined in OpenAI.V1.ToolResources

Methods

toJSON :: CodeInterpreterResources -> Value #

toEncoding :: CodeInterpreterResources -> Encoding #

toJSONList :: [CodeInterpreterResources] -> Value #

toEncodingList :: [CodeInterpreterResources] -> Encoding #

omitField :: CodeInterpreterResources -> Bool #

Generic CodeInterpreterResources Source #

Instance details

Defined in OpenAI.V1.ToolResources

Associated Types

type Rep CodeInterpreterResources
Instance details Defined in OpenAI.V1.ToolResources type Rep CodeInterpreterResources = D1 ('MetaData "CodeInterpreterResources" "OpenAI.V1.ToolResources" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "CodeInterpreterResources" 'PrefixI 'True) (S1 ('MetaSel ('Just "file_ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector FileID)))))