OpenAI.V1.ToolResources

The ToolResources type

Main types

data ToolResources

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

Constructors

ToolResources

Fields

• code_interpreter :: Maybe CodeInterpreterResources
• file_search :: Maybe FileSearchResources

Instances

FromJSON ToolResources

Defined in OpenAI.V1.ToolResources

Methods

parseJSON :: Value -> Parser ToolResources

parseJSONList :: Value -> Parser [ToolResources]

omittedField :: Maybe ToolResources

ToJSON ToolResources

Defined in OpenAI.V1.ToolResources

Methods

toJSON :: ToolResources -> Value

toEncoding :: ToolResources -> Encoding

toJSONList :: [ToolResources] -> Value

toEncodingList :: [ToolResources] -> Encoding

omitField :: ToolResources -> Bool

Generic ToolResources

Defined in OpenAI.V1.ToolResources

Associated Types

type Rep ToolResources :: Type -> Type

Methods

from :: ToolResources -> Rep ToolResources x

to :: Rep ToolResources x -> ToolResources

Show ToolResources

Defined in OpenAI.V1.ToolResources

Methods

showsPrec :: Int -> ToolResources -> ShowS

show :: ToolResources -> String

showList :: [ToolResources] -> ShowS

type Rep ToolResources

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

Other types

data CodeInterpreterResources

Resources for the code search tool

Constructors

CodeInterpreterResources

Fields

• file_ids :: Maybe (Vector FileID)

Instances

FromJSON CodeInterpreterResources

Defined in OpenAI.V1.ToolResources

Methods

parseJSON :: Value -> Parser CodeInterpreterResources

parseJSONList :: Value -> Parser [CodeInterpreterResources]

omittedField :: Maybe CodeInterpreterResources

ToJSON CodeInterpreterResources

Defined in OpenAI.V1.ToolResources

Methods

toJSON :: CodeInterpreterResources -> Value

toEncoding :: CodeInterpreterResources -> Encoding

toJSONList :: [CodeInterpreterResources] -> Value

toEncodingList :: [CodeInterpreterResources] -> Encoding

omitField :: CodeInterpreterResources -> Bool

Generic CodeInterpreterResources

Defined in OpenAI.V1.ToolResources

Associated Types

type Rep CodeInterpreterResources :: Type -> Type

Methods

from :: CodeInterpreterResources -> Rep CodeInterpreterResources x

to :: Rep CodeInterpreterResources x -> CodeInterpreterResources

Show CodeInterpreterResources

Defined in OpenAI.V1.ToolResources

Methods

showsPrec :: Int -> CodeInterpreterResources -> ShowS

show :: CodeInterpreterResources -> String

showList :: [CodeInterpreterResources] -> ShowS

type Rep CodeInterpreterResources

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 Static

Static chunking strategy

Constructors

Static

Fields

• max_chunk_size_tokens :: Natural
• chunk_overlap_tokens :: Natural

Instances

FromJSON Static

Defined in OpenAI.V1.ChunkingStrategy

Methods

parseJSON :: Value -> Parser Static

parseJSONList :: Value -> Parser [Static]

omittedField :: Maybe Static

ToJSON Static

Defined in OpenAI.V1.ChunkingStrategy

Methods

toJSON :: Static -> Value

toEncoding :: Static -> Encoding

toJSONList :: [Static] -> Value

toEncodingList :: [Static] -> Encoding

omitField :: Static -> Bool

Generic Static

Defined in OpenAI.V1.ChunkingStrategy

Associated Types

type Rep Static :: Type -> Type

Methods

from :: Static -> Rep Static x

to :: Rep Static x -> Static

Show Static

Defined in OpenAI.V1.ChunkingStrategy

Methods

showsPrec :: Int -> Static -> ShowS

show :: Static -> String

showList :: [Static] -> ShowS

type Rep Static

Defined in OpenAI.V1.ChunkingStrategy

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

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

Constructors

VectorStore

Fields

• file_ids :: Maybe (Vector FileID)
• chunking_strategy :: Maybe (AutoOr ChunkingStrategy)

Instances

FromJSON VectorStore

Defined in OpenAI.V1.ToolResources

Methods

parseJSON :: Value -> Parser VectorStore

parseJSONList :: Value -> Parser [VectorStore]

omittedField :: Maybe VectorStore

ToJSON VectorStore

Defined in OpenAI.V1.ToolResources

Methods

toJSON :: VectorStore -> Value

toEncoding :: VectorStore -> Encoding

toJSONList :: [VectorStore] -> Value

toEncodingList :: [VectorStore] -> Encoding

omitField :: VectorStore -> Bool

Generic VectorStore

Defined in OpenAI.V1.ToolResources

Associated Types

type Rep VectorStore :: Type -> Type

Methods

from :: VectorStore -> Rep VectorStore x

to :: Rep VectorStore x -> VectorStore

Show VectorStore

Defined in OpenAI.V1.ToolResources

Methods

showsPrec :: Int -> VectorStore -> ShowS

show :: VectorStore -> String

showList :: [VectorStore] -> ShowS

type Rep VectorStore

Defined in OpenAI.V1.ToolResources

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

Resources for the file search tool

Constructors

FileSearchResources

Fields

• vector_store_ids :: Maybe (Vector FileID)
• vector_stores :: Maybe (Vector VectorStore)

Instances

FromJSON FileSearchResources

Defined in OpenAI.V1.ToolResources

Methods

parseJSON :: Value -> Parser FileSearchResources

parseJSONList :: Value -> Parser [FileSearchResources]

omittedField :: Maybe FileSearchResources

ToJSON FileSearchResources

Defined in OpenAI.V1.ToolResources

Methods

toJSON :: FileSearchResources -> Value

toEncoding :: FileSearchResources -> Encoding

toJSONList :: [FileSearchResources] -> Value

toEncodingList :: [FileSearchResources] -> Encoding

omitField :: FileSearchResources -> Bool

Generic FileSearchResources

Defined in OpenAI.V1.ToolResources

Associated Types

type Rep FileSearchResources :: Type -> Type

Methods

from :: FileSearchResources -> Rep FileSearchResources x

to :: Rep FileSearchResources x -> FileSearchResources

Show FileSearchResources

Defined in OpenAI.V1.ToolResources

Methods

showsPrec :: Int -> FileSearchResources -> ShowS

show :: FileSearchResources -> String

showList :: [FileSearchResources] -> ShowS

type Rep FileSearchResources

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