Node SDK
Visit the GitHub Repo
You’ll need to Create an API Key to
Authentication with Metal.
Installation
Retrieval
You’ll need to Create an API Key to
Authenticate with Metal.
App Setup
addApp()
Parameters
getApp()
Parameters
getApps()
updateApp()
Parameters
addIndex()
Parameters
Filters
getIndex()
Parameters
index()
Add a single embedding to an index. When invoked, we will generate an embedding with one of the below embedding params and store it into a vector db.
You can only pass one of the following fields:
text, imageUrl, or
embedding. We only embed one field in a single request.id and metadata object to be stored with the embedding. Eg.
Parameters
indexMany()
Bulk add multiple embedding documents to an index. When invoked, we will generate an embedding with one of the below “Embed” params and store it in a vector index.
You can only pass one of the following fields:
text, imageUrl, or
embedding. We only embed one field in a single request.Parameters
search()
Parameters
Filter Object
Filter Item
getOne()
Retrieve a single embedding document.
Parameters
getMany()
Parameters
getQueries()
Parameters
deleteOne()
Delete a single embedding document.
Parameters
deleteMany()
Deletes multiple documents in an index based on their IDs.
Parameters
Memory (Motorhead)
App Setup
addMemory()
getMemory()
deleteMemory()
Datasources
addDatasource()
Add a new Datasource to your Metal instance.
Parameters
Metadata Fields
updateDatasource()
Parameters
getDatasource()
Parameters
getAllDatasources()
Parameters
deleteDatasource()
Parameters
Data Entities
addDataEntity()
Parameters
Example
getDataEntity()
Parameters
getAllDataEntities()
Parameters
deleteDataEntity()
Parameters
Example
Checkout the code on Github