OpenAI.V1.VectorStores.FileBatches

/v1/vector_stores/:vector_store_id/file_batches

Main types

newtype VectorStoreFileBatchID

Vector store file batch ID

Constructors

VectorStoreFileBatchID

Fields

• text :: Text

Instances

FromJSON VectorStoreFileBatchID

Defined in OpenAI.V1.VectorStores.FileBatches

Methods

parseJSON :: Value -> Parser VectorStoreFileBatchID

parseJSONList :: Value -> Parser [VectorStoreFileBatchID]

omittedField :: Maybe VectorStoreFileBatchID

ToJSON VectorStoreFileBatchID

Defined in OpenAI.V1.VectorStores.FileBatches

Methods

toJSON :: VectorStoreFileBatchID -> Value

toEncoding :: VectorStoreFileBatchID -> Encoding

toJSONList :: [VectorStoreFileBatchID] -> Value

toEncodingList :: [VectorStoreFileBatchID] -> Encoding

omitField :: VectorStoreFileBatchID -> Bool

IsString VectorStoreFileBatchID

Defined in OpenAI.V1.VectorStores.FileBatches

Methods

fromString :: String -> VectorStoreFileBatchID

Show VectorStoreFileBatchID

Defined in OpenAI.V1.VectorStores.FileBatches

Methods

showsPrec :: Int -> VectorStoreFileBatchID -> ShowS

show :: VectorStoreFileBatchID -> String

showList :: [VectorStoreFileBatchID] -> ShowS

ToHttpApiData VectorStoreFileBatchID

Defined in OpenAI.V1.VectorStores.FileBatches

Methods

toUrlPiece :: VectorStoreFileBatchID -> Text

toEncodedUrlPiece :: VectorStoreFileBatchID -> Builder

toHeader :: VectorStoreFileBatchID -> ByteString

toQueryParam :: VectorStoreFileBatchID -> Text

toEncodedQueryParam :: VectorStoreFileBatchID -> Builder

data CreateVectorStoreFileBatch

Request body for /v1/vector_stores/:vector_store_id/file_batches

Constructors

CreateVectorStoreFileBatch

Fields

• file_ids :: Vector FileID
• chunking_strategy :: Maybe ChunkingStrategy

Instances

ToJSON CreateVectorStoreFileBatch

Defined in OpenAI.V1.VectorStores.FileBatches

Methods

toJSON :: CreateVectorStoreFileBatch -> Value

toEncoding :: CreateVectorStoreFileBatch -> Encoding

toJSONList :: [CreateVectorStoreFileBatch] -> Value

toEncodingList :: [CreateVectorStoreFileBatch] -> Encoding

omitField :: CreateVectorStoreFileBatch -> Bool

Generic CreateVectorStoreFileBatch

Defined in OpenAI.V1.VectorStores.FileBatches

Associated Types

type Rep CreateVectorStoreFileBatch :: Type -> Type

Methods

from :: CreateVectorStoreFileBatch -> Rep CreateVectorStoreFileBatch x

to :: Rep CreateVectorStoreFileBatch x -> CreateVectorStoreFileBatch

Show CreateVectorStoreFileBatch

Defined in OpenAI.V1.VectorStores.FileBatches

Methods

showsPrec :: Int -> CreateVectorStoreFileBatch -> ShowS

show :: CreateVectorStoreFileBatch -> String

showList :: [CreateVectorStoreFileBatch] -> ShowS

type Rep CreateVectorStoreFileBatch

Defined in OpenAI.V1.VectorStores.FileBatches

type Rep CreateVectorStoreFileBatch = D1 ('MetaData "CreateVectorStoreFileBatch" "OpenAI.V1.VectorStores.FileBatches" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "CreateVectorStoreFileBatch" 'PrefixI 'True) (S1 ('MetaSel ('Just "file_ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector FileID)) :*: S1 ('MetaSel ('Just "chunking_strategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChunkingStrategy))))

_CreateVectorStoreFileBatch :: CreateVectorStoreFileBatch

Default CreateVectorStoreFileBatch

data VectorStoreFilesBatchObject

A batch of files attached to a vector store

Constructors

VectorStoreFilesBatchObject

Fields

• id :: VectorStoreFileBatchID
• object :: Text
• created_at :: POSIXTime
• vector_store_id :: VectorStoreID
• status :: Status
• file_counts :: Maybe FileCounts

Instances

FromJSON VectorStoreFilesBatchObject

Defined in OpenAI.V1.VectorStores.FileBatches

Methods

parseJSON :: Value -> Parser VectorStoreFilesBatchObject

parseJSONList :: Value -> Parser [VectorStoreFilesBatchObject]

omittedField :: Maybe VectorStoreFilesBatchObject

Generic VectorStoreFilesBatchObject

Defined in OpenAI.V1.VectorStores.FileBatches

Associated Types

type Rep VectorStoreFilesBatchObject :: Type -> Type

Methods

from :: VectorStoreFilesBatchObject -> Rep VectorStoreFilesBatchObject x

to :: Rep VectorStoreFilesBatchObject x -> VectorStoreFilesBatchObject

Show VectorStoreFilesBatchObject

Defined in OpenAI.V1.VectorStores.FileBatches

Methods

showsPrec :: Int -> VectorStoreFilesBatchObject -> ShowS

show :: VectorStoreFilesBatchObject -> String

showList :: [VectorStoreFilesBatchObject] -> ShowS

type Rep VectorStoreFilesBatchObject

Defined in OpenAI.V1.VectorStores.FileBatches

type Rep VectorStoreFilesBatchObject = D1 ('MetaData "VectorStoreFilesBatchObject" "OpenAI.V1.VectorStores.FileBatches" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "VectorStoreFilesBatchObject" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VectorStoreFileBatchID) :*: (S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "created_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime))) :*: (S1 ('MetaSel ('Just "vector_store_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VectorStoreID) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status) :*: S1 ('MetaSel ('Just "file_counts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FileCounts))))))

Servant

type API = "vector_stores" :> (Header' '[Required, Strict] "OpenAI-Beta" Text :> ((Capture "vector_store_id" VectorStoreID :> ("file_batches" :> (ReqBody '[JSON] CreateVectorStoreFileBatch :> Post '[JSON] VectorStoreFilesBatchObject))) :<|> ((Capture "vector_store_id" VectorStoreID :> ("file_batches" :> (Capture "batch_id" VectorStoreFileBatchID :> Get '[JSON] VectorStoreFilesBatchObject))) :<|> ((Capture "vector_store_id" VectorStoreID :> ("file_batches" :> (Capture "batch_id" VectorStoreFileBatchID :> ("cancel" :> Post '[JSON] VectorStoreFilesBatchObject)))) :<|> (Capture "vector_store_id" VectorStoreID :> ("file_batches" :> (Capture "batch_id" VectorStoreFileBatchID :> ("files" :> (QueryParam "limit" Natural :> (QueryParam "order" Order :> (QueryParam "after" Text :> (QueryParam "before" Text :> (QueryParam "filter" Status :> Get '[JSON] (ListOf VectorStoreFilesBatchObject))))))))))))))

Servant API