| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Pinecone
Description
Main entrypoint to the API
Synopsis
- getClientEnv :: Host -> IO ClientEnv
- makeControlMethods :: ClientEnv -> Text -> ControlMethods
- data ControlMethods = ControlMethods {
- listIndexes :: IO (Vector IndexModel)
- createIndex :: CreateIndex -> IO IndexModel
- createIndexWithEmbedding :: CreateIndexWithEmbedding -> IO IndexModel
- describeIndex :: Index -> IO IndexModel
- deleteIndex :: Index -> IO ()
- configureIndex :: Index -> ConfigureIndex -> IO IndexModel
- listCollections :: IO (Vector CollectionModel)
- createCollection :: CreateCollection -> IO CollectionModel
- describeCollection :: Collection -> IO CollectionModel
- deleteCollection :: Collection -> IO ()
- generateVectors :: GenerateVectors -> IO Embeddings
- rerankResults :: RerankResults -> IO Documents
- makeDataMethods :: ClientEnv -> Text -> DataMethods
- data DataMethods = DataMethods {
- getIndexStats :: GetIndexStats -> IO IndexStats
- upsertVectors :: UpsertVectors -> IO UpsertStats
- upsertText :: Namespace -> Record -> IO ()
- fetchVectors :: Vector Text -> Maybe Namespace -> IO Vectors
- updateVector :: UpdateVector -> IO ()
- deleteVectors :: DeleteVectors -> IO ()
- listVectorIDs :: Maybe Text -> Maybe Natural -> Maybe Text -> Maybe Namespace -> IO VectorIDs
- searchWithVector :: SearchWithVector -> IO Matches
- searchWithText :: Namespace -> SearchWithText -> IO Hits
- startImport :: StartImport -> IO Import
- listImports :: Maybe Natural -> Maybe Text -> IO Imports
- describeImport :: Import -> IO ImportModel
- cancelImport :: Import -> IO ()
- type ControlAPI = Header' [Required, Strict] "Api-Key" Text :> (Header' [Required, Strict] "X-Pinecone-API-Version" Text :> (ControlAPI :<|> (API :<|> (API :<|> API))))
- type DataAPI = Header' [Required, Strict] "Api-Key" Text :> (Header' [Required, Strict] "X-Pinecone-API-Version" Text :> (DataAPI :<|> (API :<|> (API :<|> API))))
Methods
Arguments
| :: Host | Base URL for API CAREFULLY NOTE: This should be |
| -> IO ClientEnv |
Convenient utility to get a ClientEnv for the most common use case
Arguments
| :: ClientEnv | |
| -> Text | API token |
| -> ControlMethods |
Get a record of control API methods after providing an API token
data ControlMethods Source #
Control plane methods
Constructors
| ControlMethods | |
Fields
| |
Arguments
| :: ClientEnv | |
| -> Text | API token |
| -> DataMethods |
Get a record of control API methods after providing an API token
data DataMethods Source #
Data plane methods
Constructors
| DataMethods | |
Fields
| |