openai-2.2.1: Servant bindings to OpenAI
Safe HaskellNone
LanguageHaskell2010

OpenAI.V1.ToolResources

Description

The ToolResources type

Synopsis

Main types

data ToolResources Source #

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

Constructors

ToolResources 

Fields

Instances

Instances details
FromJSON ToolResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Methods

parseJSON :: Value -> Parser ToolResources #

parseJSONList :: Value -> Parser [ToolResources] #

omittedField :: Maybe ToolResources #

ToJSON ToolResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Methods

toJSON :: ToolResources -> Value #

toEncoding :: ToolResources -> Encoding #

toJSONList :: [ToolResources] -> Value #

toEncodingList :: [ToolResources] -> Encoding #

omitField :: ToolResources -> Bool #

Generic ToolResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Associated Types

type Rep ToolResources 
Instance details

Defined in OpenAI.V1.ToolResources

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

Methods

from :: ToolResources -> Rep ToolResources x #

to :: Rep ToolResources x -> ToolResources #

Show ToolResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Methods

showsPrec :: Int -> ToolResources -> ShowS #

show :: ToolResources -> String #

showList :: [ToolResources] -> ShowS #

type Rep ToolResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

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

Other types

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

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)))))

Methods

from :: CodeInterpreterResources -> Rep CodeInterpreterResources x #

to :: Rep CodeInterpreterResources x -> CodeInterpreterResources #

Show CodeInterpreterResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Methods

showsPrec :: Int -> CodeInterpreterResources -> ShowS #

show :: CodeInterpreterResources -> String #

showList :: [CodeInterpreterResources] -> ShowS #

type Rep CodeInterpreterResources Source # 
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)))))

data Static Source #

Static chunking strategy

Constructors

Static 

Fields

Instances

Instances details
FromJSON Static Source # 
Instance details

Defined in OpenAI.V1.ChunkingStrategy

Methods

parseJSON :: Value -> Parser Static #

parseJSONList :: Value -> Parser [Static] #

omittedField :: Maybe Static #

ToJSON Static Source # 
Instance details

Defined in OpenAI.V1.ChunkingStrategy

Methods

toJSON :: Static -> Value #

toEncoding :: Static -> Encoding #

toJSONList :: [Static] -> Value #

toEncodingList :: [Static] -> Encoding #

omitField :: Static -> Bool #

Generic Static Source # 
Instance details

Defined in OpenAI.V1.ChunkingStrategy

Associated Types

type Rep Static 
Instance details

Defined in OpenAI.V1.ChunkingStrategy

type Rep Static = D1 ('MetaData "Static" "OpenAI.V1.ChunkingStrategy" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Static" 'PrefixI 'True) (S1 ('MetaSel ('Just "max_chunk_size_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "chunk_overlap_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

Methods

from :: Static -> Rep Static x #

to :: Rep Static x -> Static #

Show Static Source # 
Instance details

Defined in OpenAI.V1.ChunkingStrategy

Methods

showsPrec :: Int -> Static -> ShowS #

show :: Static -> String #

showList :: [Static] -> ShowS #

type Rep Static Source # 
Instance details

Defined in OpenAI.V1.ChunkingStrategy

type Rep Static = D1 ('MetaData "Static" "OpenAI.V1.ChunkingStrategy" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Static" 'PrefixI 'True) (S1 ('MetaSel ('Just "max_chunk_size_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "chunk_overlap_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

data VectorStore Source #

A helper to create a vector store with file_ids and attach it to this assistant

Constructors

VectorStore 

Fields

Instances

Instances details
FromJSON VectorStore Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Methods

parseJSON :: Value -> Parser VectorStore #

parseJSONList :: Value -> Parser [VectorStore] #

omittedField :: Maybe VectorStore #

ToJSON VectorStore Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Methods

toJSON :: VectorStore -> Value #

toEncoding :: VectorStore -> Encoding #

toJSONList :: [VectorStore] -> Value #

toEncodingList :: [VectorStore] -> Encoding #

omitField :: VectorStore -> Bool #

Generic VectorStore Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Associated Types

type Rep VectorStore 
Instance details

Defined in OpenAI.V1.ToolResources

type Rep VectorStore = D1 ('MetaData "VectorStore" "OpenAI.V1.ToolResources" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "VectorStore" 'PrefixI 'True) (S1 ('MetaSel ('Just "file_ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector FileID))) :*: S1 ('MetaSel ('Just "chunking_strategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (AutoOr ChunkingStrategy)))))

Methods

from :: VectorStore -> Rep VectorStore x #

to :: Rep VectorStore x -> VectorStore #

Show VectorStore Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Methods

showsPrec :: Int -> VectorStore -> ShowS #

show :: VectorStore -> String #

showList :: [VectorStore] -> ShowS #

type Rep VectorStore Source # 
Instance details

Defined in OpenAI.V1.ToolResources

type Rep VectorStore = D1 ('MetaData "VectorStore" "OpenAI.V1.ToolResources" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "VectorStore" 'PrefixI 'True) (S1 ('MetaSel ('Just "file_ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector FileID))) :*: S1 ('MetaSel ('Just "chunking_strategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (AutoOr ChunkingStrategy)))))

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

Methods

parseJSON :: Value -> Parser FileSearchResources #

parseJSONList :: Value -> Parser [FileSearchResources] #

omittedField :: Maybe FileSearchResources #

ToJSON FileSearchResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Methods

toJSON :: FileSearchResources -> Value #

toEncoding :: FileSearchResources -> Encoding #

toJSONList :: [FileSearchResources] -> Value #

toEncodingList :: [FileSearchResources] -> Encoding #

omitField :: FileSearchResources -> Bool #

Generic FileSearchResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Associated Types

type Rep FileSearchResources 
Instance details

Defined in OpenAI.V1.ToolResources

type Rep FileSearchResources = D1 ('MetaData "FileSearchResources" "OpenAI.V1.ToolResources" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" '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)))))

Methods

from :: FileSearchResources -> Rep FileSearchResources x #

to :: Rep FileSearchResources x -> FileSearchResources #

Show FileSearchResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

Methods

showsPrec :: Int -> FileSearchResources -> ShowS #

show :: FileSearchResources -> String #

showList :: [FileSearchResources] -> ShowS #

type Rep FileSearchResources Source # 
Instance details

Defined in OpenAI.V1.ToolResources

type Rep FileSearchResources = D1 ('MetaData "FileSearchResources" "OpenAI.V1.ToolResources" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" '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)))))