Optional stackStatic Optional prepareOptional stackStatic Optional prepareOptional override for formatting stack traces
Static stackStatic captureOptional user: AtlasViewer | AtlasUserProtected _attrOptional _projectionsProtected attributereturns the object's information; this may be undefined
-Optional user: AtlasViewer | AtlasUserProtected _attrOptional _projectionsProtected attributereturns the object's information; this may be undefined
+a list of ids (atom_ids, which are scoped to the index level) to fetch. If passing datum_ids, use the project-level fetchIds method. This API is subject to change.
a list of Records containing metadata for each atom.
-Protected endpointFetches basic information about the object. +
Protected endpointFetches basic information about the object.
By default, this caches the call; if you want to
bust the cache, pass true as the first argument.
This immediately.
Whether to refetch the relevant information
A promise that resolves to the organization info.
-A keyed dictionary including k (the number of neighbors to return)
+
A keyed dictionary including k (the number of neighbors to return)
and queries (a list of vectors to search for).
a list of projections for this index.
-Loads the information associated with the class, removing any +
a list of projections for this index.
+Loads the information associated with the class, removing any existing caches.
a LoadedObject instance of the class that is guaranteed to
have its attr slot populated with appropriate information.
const loadedProject = await (new AtlasProject(projectId)).withLoadedAttributes()
// OR, in cases where we want to do stuff immediately with the project and ensure
// that later calls there don't double-fetch information.
const project = new AtlasProject(projectId)
// do stuff right away.
const projection = new AtlasProjection(projectionId, {project: project})
const loadedProjection = await projection.withLoadedAttributes()
// do stuff with loadedProjection
Optional user: AtlasUserProtected _attrProtected attributereturns the object's information; this may be undefined
-Protected endpointOptional viewer: AtlasViewerProtected _attrProtected attributereturns the object's information; this may be undefined
+Protected endpointFetches basic information about the object.
By default, this caches the call; if you want to
bust the cache, pass true as the first argument.
This immediately.
Whether to refetch the relevant information
A promise that resolves to the organization info.
-Loads the information associated with the class, removing any +
Loads the information associated with the class, removing any existing caches.
a LoadedObject instance of the class that is guaranteed to
have its attr slot populated with appropriate information.
const loadedProject = await (new AtlasProject(projectId)).withLoadedAttributes()
// OR, in cases where we want to do stuff immediately with the project and ensure
// that later calls there don't double-fetch information.
const project = new AtlasProject(projectId)
// do stuff right away.
const projection = new AtlasProjection(projectionId, {project: project})
const loadedProjection = await projection.withLoadedAttributes()
// do stuff with loadedProjection
An AtlasDataset represents a single mutable dataset in Atlas. It provides an interfaces to upload, update, and delete data, as well as create and delete indices which handle specific views.
-The project's unique UUID. To create a new project or fetch +
The project's unique UUID. To create a new project or fetch an existing project, use the create_project or load_project functions.
-Optional user: AtlasViewer | AtlasUserAn existing AtlasUser object. If not provided, a new one will be created.
-An AtlasDataset object.
-Protected _attrOptional _schemaProtected attributereturns the object's information; this may be undefined
-Private clearProtected endpointFetches basic information about the object. +
Optional viewer: AtlasViewerAn AtlasDataset object.
+Protected _attrAccess Role
+Access role of user for this project
+Atlas Indices
+All Atlas Indices built overtop of this project.
+Created Timestamp +Format: date-time
+The timestamp this project was created.
+Creator
+The user id who created this project.
+Creator Nickname
+The creator nickname
+Creator Picture
+The creator picture
+Description
+A description for this project.
+Id +Format: uuid
+Project ID
+33adcf85-84ed-4e3a-9519-17c72682f905
+Insert Update Delete Lock
+Whether the project is locked for CRUD operations.
+Is Public
+Is the project viewable without being in the organzation?
+Is Public To Org
+Is the project viewable to the organization?
+Optional modality?: stringModality
+The project modality
+Og Image
+The datasets opengraph image
+Organization Name
+The organization nickname
+Organization Slug
+The organization url-safe slug
+Owner +Format: uuid
+The organization ID that owns this project
+43adcf85-84ed-4e3a-9519-17c72682f905
+Permissions
+Access role of user for this dataset
+Dataset:Administration:Read
+Dataset:Administration:Write
+Dataset:Data:Read
+Dataset:Data:Write
+Dataset:Members:Read
+Dataset:Members:Write
+Dataset:Metadata:Read
+Dataset:Metadata:Write
+Dataset:Tags:Read
+Dataset:Tags:Write
+Project Fields
+The list of fields a datum in the project may contain.
+Project Name
+The name of this project
+example_project
+Optional schema?: stringSchema
+An Arrow schema for the project. Binary data encoded as base64.
+Slug
+The project url-safe slug
+Total Datums In Project
+Total datums in project.
+Unique Id Field
+The field that contains a unique id for each document.
+Optional _schemaProtected attributereturns the object's information; this may be undefined
+Private clearProtected endpointFetches basic information about the object.
By default, this caches the call; if you want to
bust the cache, pass true as the first argument.
This immediately.
Whether to refetch the relevant information
-A promise that resolves to the organization info.
-A promise that resolves to the organization info.
+A list of projection summaries, sorted so that the first is the most useable (defined as ready and newest)
-Updates all indices associated with a project.
+Loads the information associated with the class, removing any +
Loads the information associated with the class, removing any existing caches.
-a LoadedObject instance of the class that is guaranteed to +
a LoadedObject instance of the class that is guaranteed to
have its attr slot populated with appropriate information.
const loadedProject = await (new AtlasProject(projectId)).withLoadedAttributes()
// OR, in cases where we want to do stuff immediately with the project and ensure
// that later calls there don't double-fetch information.
const project = new AtlasProject(projectId)
// do stuff right away.
const projection = new AtlasProjection(projectionId, {project: project})
const loadedProjection = await projection.withLoadedAttributes()
// do stuff with loadedProjection
Options for initializing the projection.
Protected _attrTopic Model Metadatas
+>.constructorProtected _attrTopic Model Metadatas
list of topic model metadata
Topic Models
List of topic model geojsons
-Optional _indexOptional _projectA projection is a map in Atlas; it represents a snapshot 2d view of a dataset +
Optional _indexOptional _projectA projection is a map in Atlas; it represents a snapshot 2d view of a dataset at a point in time. Every projection belongs to a Dataset.
-Protected attributeThe UUID of the projection to retrieve.
-returns the object's information; this may be undefined
-the URL for the quadtree root for this projection. +
Protected attributeThe UUID of the projection to retrieve.
+returns the object's information; this may be undefined
+the URL for the quadtree root for this projection. 'public' may be be added in fetching.
-Protected endpointFetches basic information about the object. +
Protected endpointFetches basic information about the object.
By default, this caches the call; if you want to
bust the cache, pass true as the first argument.
This immediately.
Whether to refetch the relevant information
A promise that resolves to the organization info.
-an object with keys k (number of numbers) and queries (list of vectors, where each one is the length of the embedding space).
+an object with keys k (number of numbers) and queries (list of vectors, where each one is the length of the embedding space).
A list of entries in sorted order, where each entry is a list of neighbors including distances in the _distance field.
Loads the information associated with the class, removing any +
Loads the information associated with the class, removing any existing caches.
a LoadedObject instance of the class that is guaranteed to
have its attr slot populated with appropriate information.
const loadedProject = await (new AtlasProject(projectId)).withLoadedAttributes()
// OR, in cases where we want to do stuff immediately with the project and ensure
// that later calls there don't double-fetch information.
const project = new AtlasProject(projectId)
// do stuff right away.
const projection = new AtlasProjection(projectionId, {project: project})
const loadedProjection = await projection.withLoadedAttributes()
// do stuff with loadedProjection
Protected _attrProtected attributereturns the object's information; this may be undefined
-Protected endpointProtected _attrProtected attributereturns the object's information; this may be undefined
+Protected endpointFetches basic information about the object.
By default, this caches the call; if you want to
bust the cache, pass true as the first argument.
This immediately.
Whether to refetch the relevant information
A promise that resolves to the organization info.
-return only organizations where the user has this role (default: null, return all organizations)
+return only organizations where the user has this role (default: null, return all organizations)
A list of organizations where the user has the specified role
-All projects that the user has access to.
-Loads the information associated with the class, removing any +
All projects that the user has access to.
+Loads the information associated with the class, removing any existing caches.
a LoadedObject instance of the class that is guaranteed to
have its attr slot populated with appropriate information.
const loadedProject = await (new AtlasProject(projectId)).withLoadedAttributes()
// OR, in cases where we want to do stuff immediately with the project and ensure
// that later calls there don't double-fetch information.
const project = new AtlasProject(projectId)
// do stuff right away.
const projection = new AtlasProjection(projectionId, {project: project})
const loadedProjection = await projection.withLoadedAttributes()
// do stuff with loadedProjection
token: string
AnonUser: No credentials, used for anonymous Viewer
-Private credentialsCall the API and return the results as deserialized JSON +
Private credentialsCall the API and return the results as deserialized JSON or Arrow.
The nomic API endpoint to call. If it doesn't begin with a slash, it will be added.
POST or GET
The binary or JSON payload sent with the request.
Additional headers to send with the request
-const documents = ["Once upon a time", "there was a girl named Goldilocks", …, "and they all lived happily ever after"]
const embedder = new Embedder(myApiKey)
const embeddings = await embedder.embed(documents)
GOOD -- Nomic will combine your small requests into several medium-size ones.
-const documents = ["Once upon a time", "there was a girl named Goldilocks", …, "and they all lived happily ever after"]
const embedder = new Embedder(myApiKey)
const promises = []
for (let document of documents) {
promises.push(embedder.embed(document))
}
const embeddings = await Promise.all(promises)
+const documents = ["Once upon a time", "there was a girl named Goldilocks", …, "and they all lived happily ever after"]
const embedder = new Embedder(myApiKey)
const promises = []
for (let document of documents) {
promises.push(embedder.embed(document))
}
const embeddings = await Promise.all(promises)
BAD -- You will generate many small, inefficient requests.
* const documents = ["Once upon a time", "there was a girl named Goldilocks", …, "and they all lived happily ever after"]
const embedder = new Embedder(myApiKey)
const embeddings = []
for (let document of documents) {
const embedding = await embedder.embed(document); // <- premature await.
embeddings.push(embedding);
}
-Your nomic API key, beginning with 'nk'.
-Protected _attrProtected attributePrivate backoffPrivate embedPrivate Optional epitaphPrivate nextreturns the object's information; this may be undefined
-Private _embedProtected endpointProtected _attrProtected attributePrivate backoffPrivate embedPrivate Optional epitaphPrivate nextreturns the object's information; this may be undefined
+Private _embedProtected endpointFetches basic information about the object.
By default, this caches the call; if you want to
bust the cache, pass true as the first argument.
This immediately.
Whether to refetch the relevant information
A promise that resolves to the organization info.
-Private flushPrivate periodicallyLoads the information associated with the class, removing any +
Private flushPrivate periodicallyLoads the information associated with the class, removing any existing caches.
a LoadedObject instance of the class that is guaranteed to
have its attr slot populated with appropriate information.
const loadedProject = await (new AtlasProject(projectId)).withLoadedAttributes()
// OR, in cases where we want to do stuff immediately with the project and ensure
// that later calls there don't double-fetch information.
const project = new AtlasProject(projectId)
// do stuff right away.
const projection = new AtlasProjection(projectionId, {project: project})
const loadedProjection = await projection.withLoadedAttributes()
// do stuff with loadedProjection
Optional override for formatting stack traces
+