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 viewer: AtlasViewerProtected _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.
-Optional viewer: AtlasViewerAn AtlasDataset object.
Protected _attrAccess Role
+>.constructorProtected _attrAccess Role
Access role of user for this project
Atlas Indices
All Atlas Indices built overtop of this project.
@@ -87,22 +88,29 @@example_projec
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. +
Optional _schemaProtected attributereturns the object's information; this may be undefined
+Private clearPrefer createIndexRaw, which has better syncing of types
+This should be preferred over createIndex, as it uses the actual +up-to-date types. Note that it is definitely possible to pass a +malformed but type-compliant object. (E.g., specifying no embedding field +but also specifying a model.)
+See types for options.
+an AtlasIndex object based on the new arguments.
+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 list of projection summaries, sorted so that the first is +
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
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.
-Optional _project_Protected attributeThe UUID of the projection to retrieve.
-Protected Optional project_returns the object's information; this may be undefined
-the URL for the quadtree root for this projection. +
Optional _project_Protected attributeThe UUID of the projection to retrieve.
+Protected Optional project_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
Rest ...args: [params: AnonViewerLogin] | [AtlasViewer]Protected _attrOptional default_Default Organization +>.constructor
Protected _attrOptional default_Default Organization Format: uuid
The users default organization.
auth0Description
Whether or not the user is wait-listed for Atlas access
Default
false
-Protected attributereturns the object's information; this may be undefined
-Protected endpointFetches basic information about the object. +
Protected 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
-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
+