openai-1.0.0: Servant bindings to OpenAI
Safe HaskellSafe-Inferred
LanguageHaskell2010

OpenAI.V1.Assistants

Description

/v1/assistants
Synopsis

Main types

data CreateAssistant Source #

Request body for /v1/assistants

Instances

Instances details
ToJSON CreateAssistant Source # 
Instance details

Defined in OpenAI.V1.Assistants

Generic CreateAssistant Source # 
Instance details

Defined in OpenAI.V1.Assistants

Associated Types

type Rep CreateAssistant :: Type -> Type #

Show CreateAssistant Source # 
Instance details

Defined in OpenAI.V1.Assistants

type Rep CreateAssistant Source # 
Instance details

Defined in OpenAI.V1.Assistants

data ModifyAssistant Source #

Request body for /v1/assistants/:assistant_id

Instances

Instances details
ToJSON ModifyAssistant Source # 
Instance details

Defined in OpenAI.V1.Assistants

Generic ModifyAssistant Source # 
Instance details

Defined in OpenAI.V1.Assistants

Associated Types

type Rep ModifyAssistant :: Type -> Type #

Show ModifyAssistant Source # 
Instance details

Defined in OpenAI.V1.Assistants

type Rep ModifyAssistant Source # 
Instance details

Defined in OpenAI.V1.Assistants

data AssistantObject Source #

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

Instances

Instances details
FromJSON AssistantObject Source # 
Instance details

Defined in OpenAI.V1.Assistants

Generic AssistantObject Source # 
Instance details

Defined in OpenAI.V1.Assistants

Associated Types

type Rep AssistantObject :: Type -> Type #

Show AssistantObject Source # 
Instance details

Defined in OpenAI.V1.Assistants

type Rep AssistantObject Source # 
Instance details

Defined in OpenAI.V1.Assistants

type Rep AssistantObject = D1 ('MetaData "AssistantObject" "OpenAI.V1.Assistants" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "AssistantObject" 'PrefixI 'True) (((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AssistantID) :*: (S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "created_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Model)))) :*: ((S1 ('MetaSel ('Just "instructions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Tool))) :*: S1 ('MetaSel ('Just "tool_resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ToolResources)))) :*: ((S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Text)) :*: S1 ('MetaSel ('Just "temperature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "top_p") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "response_format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (AutoOr ResponseFormat)))))))

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

ToJSON RankingOptions Source # 
Instance details

Defined in OpenAI.V1.Tool

Generic RankingOptions Source # 
Instance details

Defined in OpenAI.V1.Tool

Associated Types

type Rep RankingOptions :: Type -> Type #

Show RankingOptions Source # 
Instance details

Defined in OpenAI.V1.Tool

type Rep RankingOptions Source # 
Instance details

Defined in OpenAI.V1.Tool

type Rep RankingOptions = D1 ('MetaData "RankingOptions" "OpenAI.V1.Tool" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" '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

Instances

Instances details
FromJSON FileSearch Source # 
Instance details

Defined in OpenAI.V1.Tool

ToJSON FileSearch Source # 
Instance details

Defined in OpenAI.V1.Tool

Generic FileSearch Source # 
Instance details

Defined in OpenAI.V1.Tool

Associated Types

type Rep FileSearch :: Type -> Type #

Show FileSearch Source # 
Instance details

Defined in OpenAI.V1.Tool

type Rep FileSearch Source # 
Instance details

Defined in OpenAI.V1.Tool

type Rep FileSearch = D1 ('MetaData "FileSearch" "OpenAI.V1.Tool" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" '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

Instances

Instances details
FromJSON Function Source # 
Instance details

Defined in OpenAI.V1.Tool

ToJSON Function Source # 
Instance details

Defined in OpenAI.V1.Tool

Generic Function Source # 
Instance details

Defined in OpenAI.V1.Tool

Associated Types

type Rep Function :: Type -> Type #

Methods

from :: Function -> Rep Function x #

to :: Rep Function x -> Function #

Show Function Source # 
Instance details

Defined in OpenAI.V1.Tool

type Rep Function Source # 
Instance details

Defined in OpenAI.V1.Tool

type Rep Function = D1 ('MetaData "Function" "OpenAI.V1.Tool" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" '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

Instances

Instances details
FromJSON Tool Source # 
Instance details

Defined in OpenAI.V1.Tool

ToJSON Tool Source # 
Instance details

Defined in OpenAI.V1.Tool

Generic Tool Source # 
Instance details

Defined in OpenAI.V1.Tool

Associated Types

type Rep Tool :: 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-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Tool_Code_Interpreter" 'PrefixI 'False) (U1 :: Type -> Type) :+: (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))))

data CodeInterpreterResources Source #

Resources for the code search tool

Constructors

CodeInterpreterResources 

Fields

Instances

Instances details
FromJSON CodeInterpreterResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

ToJSON CodeInterpreterResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Generic CodeInterpreterResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Associated Types

type Rep CodeInterpreterResources :: Type -> Type #

Show CodeInterpreterResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

type Rep CodeInterpreterResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

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

data FileSearchResources Source #

Resources for the file search tool

Constructors

FileSearchResources 

Fields

Instances

Instances details
FromJSON FileSearchResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

ToJSON FileSearchResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Generic FileSearchResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Associated Types

type Rep FileSearchResources :: Type -> Type #

Show FileSearchResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

type Rep FileSearchResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

type Rep FileSearchResources = D1 ('MetaData "FileSearchResources" "OpenAI.V1.ToolResources" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "FileSearchResources" 'PrefixI 'True) (S1 ('MetaSel ('Just "vector_store_ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector FileID))) :*: S1 ('MetaSel ('Just "vector_stores") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector VectorStore)))))

data ToolResources Source #

A set of resources that are used by the assistant's tools

Instances

Instances details
FromJSON ToolResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

ToJSON ToolResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Generic ToolResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Associated Types

type Rep ToolResources :: Type -> Type #

Show ToolResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

type Rep ToolResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

type Rep ToolResources = D1 ('MetaData "ToolResources" "OpenAI.V1.ToolResources" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "ToolResources" 'PrefixI 'True) (S1 ('MetaSel ('Just "code_interpreter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe CodeInterpreterResources)) :*: S1 ('MetaSel ('Just "file_search") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FileSearchResources))))

Servant