Class AtlasProjection

Hierarchy

BaseAtlasClass<components["schemas"]["ProjectionResponse"]>
- AtlasProjection

Index

Constructors

constructor

new AtlasProjection(id, user?, options?): AtlasProjection
Parameters
- id: string
  The UUID of the projection to retrieve.
- Optional user: AtlasViewer | AtlasUser
  The user object to query with.
- options: ProjectionInitializationOptions = {}
  Options for initializing the projection.
Returns AtlasProjection
Overrides BaseAtlasClass< components['schemas']['ProjectionResponse'] >.constructor
- Defined in src/projection.ts:120

Properties

`Protected` _attr

_attr: undefined | {
    embedding_field?: null | string;
    embedding_model?: null | string;
    primary_projection_algorithm: string;
    resources?: {
        dataset_id: string;
        id: string;
        params: {
            [key: string]: unknown;
        };
        status: "COMPLETED" | "FAILED" | "BUILDING" | "WAITING";
        type: string;
    }[];
    topic_model_metadatas: null | {
        [key: string]: unknown;
    }[];
    topic_models: {
        [key: string]: unknown;
    }[];
    total_data_points: null | number;
}

Type declaration

Optional embedding_field?: null | string
Embedding Field

Description
The data field from which the 2d embeddings were derived
Optional embedding_model?: null | string
Embedding Model

Description
The embedding model used to create the embeddings, if they were generated inside the Atlas system
primary_projection_algorithm: string
Primary Projection Algorithm

Description
The primary projection algorithm used for this map.
Optional resources?: {
    dataset_id: string;
    id: string;
    params: {
        [key: string]: unknown;
    };
    status: "COMPLETED" | "FAILED" | "BUILDING" | "WAITING";
    type: string;
}[]
Resources
Description
All resources used to build the associated map

Default
```
[]
```
topic_model_metadatas: null | {
[key: string]: unknown;
}[]
Topic Model Metadatas

Description
list of topic model metadata
topic_models: {
[key: string]: unknown;
}[]
Topic Models

Description
List of topic model geojsons
total_data_points: null | number
Total Data Points

Description
The total number of data points in this map or None if the checkpoint is not yet completed.

`Optional` _index

_index?: AtlasIndex

`Optional` _project

_project?: AtlasProject

A 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_id_promise

_project_id_promise?: Promise<string>

_schema

_schema: null | Uint8Array = null

`Protected` attributePromise

attributePromise: undefined | Promise<{
    embedding_field?: null | string;
    embedding_model?: null | string;
    primary_projection_algorithm: string;
    resources?: {
        dataset_id: string;
        id: string;
        params: {
            [key: string]: unknown;
        };
        status: "COMPLETED" | "FAILED" | "BUILDING" | "WAITING";
        type: string;
    }[];
    topic_model_metadatas: null | {
        [key: string]: unknown;
    }[];
    topic_models: {
        [key: string]: unknown;
    }[];
    total_data_points: null | number;
}>

id

id: string

The UUID of the projection to retrieve.

`Protected` `Optional` project_id

project_id?: string

viewer

viewer: AtlasViewer

Accessors

attr

get attr(): undefined | AttributesType
returns the object's information; this may be undefined

Returns undefined | AttributesType
Inherited from BaseAtlasClass.attr
- Defined in src/user.ts:41

quadtree_root

get quadtree_root(): string
Returns string
the URL for the quadtree root for this projection. 'public' may be be added in fetching.
- Defined in src/projection.ts:357

Methods

apiCall

apiCall(endpoint, method, payload?, headers?): Promise<null | string | any[] | Record<string, any> | Uint8Array | Table<any>>
Parameters
- endpoint: string
- method: "GET" | "POST"
- payload: Payload = null
- headers: null | Record<string, string> = null
Returns Promise<null | string | any[] | Record<string, any> | Uint8Array | Table<any>>
Inherited from BaseAtlasClass.apiCall
- Defined in src/user.ts:99

atomInformation

atomInformation(ids): Promise<any>
Parameters
- ids: string[] | number[] | bigint[]
Returns Promise<any>
- Defined in src/projection.ts:348

createTag

createTag(options): Promise<TagResponse>
Parameters
- options: CreateTagOptions
Returns Promise<TagResponse>
- Defined in src/projection.ts:173

datasetId

datasetId(): Promise<string>
Returns Promise<string>
the UUID of the dataset that this projection belongs to.
- Defined in src/projection.ts:146

deleteTag

deleteTag(options): Promise<void>
Parameters
- options: DeleteTagRequest
Returns Promise<void>
- Defined in src/projection.ts:221

`Protected` endpoint

endpoint(): string
Returns string
Overrides BaseAtlasClass.endpoint
- Defined in src/projection.ts:367

fetchAttributes

fetchAttributes(bustCache?): Promise<{
    embedding_field?: null | string;
    embedding_model?: null | string;
    primary_projection_algorithm: string;
    resources?: {
        dataset_id: string;
        id: string;
        params: {
            [key: string]: unknown;
        };
        status: "COMPLETED" | "FAILED" | "BUILDING" | "WAITING";
        type: string;
    }[];
    topic_model_metadatas: null | {
        [key: string]: unknown;
    }[];
    topic_models: {
        [key: string]: unknown;
    }[];
    total_data_points: null | number;
}>
Fetches 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.
Parameters
- bustCache: boolean = false
  Whether to refetch the relevant information
Returns Promise<{
    embedding_field?: null | string;
    embedding_model?: null | string;
    primary_projection_algorithm: string;
    resources?: {
        dataset_id: string;
        id: string;
        params: {
            [key: string]: unknown;
        };
        status: "COMPLETED" | "FAILED" | "BUILDING" | "WAITING";
        type: string;
    }[];
    topic_model_metadatas: null | {
        [key: string]: unknown;
    }[];
    topic_models: {
        [key: string]: unknown;
    }[];
    total_data_points: null | number;
}>
A promise that resolves to the organization info.
Inherited from BaseAtlasClass.fetchAttributes
- Defined in src/user.ts:54

getTagStatus

getTagStatus(options): Promise<TagStatus>
Parameters
- options: TagRequestOptions
Returns Promise<TagStatus>
- Defined in src/projection.ts:246

getTags

getTags(): Promise<TagResponse[]>
Returns Promise<TagResponse[]>
- Defined in src/projection.ts:234

index

index(): Promise<AtlasIndex>
Returns Promise<AtlasIndex>
- Defined in src/projection.ts:332

nearest_neighbors_by_vector

nearest_neighbors_by_vector(param0): Promise<Record<string, any>>
Parameters
- param0: Omit<{
      atlas_index_id: string;
      k?: number;
      queries: string | number[][];
  }, "atlas_index_id">
  an object with keys k (number of numbers) and queries (list of vectors, where each one is the length of the embedding space).
Returns Promise<Record<string, any>>
A list of entries in sorted order, where each entry is a list of neighbors including distances in the _distance field.
- Defined in src/projection.ts:379

project

project(): Promise<AtlasProject>
Returns Promise<AtlasProject>
- Defined in src/projection.ts:324

roboTag

roboTag(options): Promise<void>
Parameters
- options: RoboTagOptions
Returns Promise<void>
- Defined in src/projection.ts:299

schema

schema(): Promise<Uint8Array>
Returns Promise<Uint8Array>
- Defined in src/projection.ts:311

updateTag

updateTag(options): Promise<TagResponse>
Parameters
- options: UpdateTagOptions
Returns Promise<TagResponse>
- Defined in src/projection.ts:201

updateTagMask

updateTagMask(bitmask_bytes, options): Promise<void>
Parameters
- bitmask_bytes: Uint8Array
- options: UpdateTagMaskOptions
Returns Promise<void>
- Defined in src/projection.ts:260

withLoadedAttributes

withLoadedAttributes(bustCache?): Promise<LoadedObject<AtlasProjection, {
    embedding_field?: null | string;
    embedding_model?: null | string;
    primary_projection_algorithm: string;
    resources?: {
        dataset_id: string;
        id: string;
        params: {
            [key: string]: unknown;
        };
        status: "COMPLETED" | "FAILED" | "BUILDING" | "WAITING";
        type: string;
    }[];
    topic_model_metadatas: null | {
        [key: string]: unknown;
    }[];
    topic_models: {
        [key: string]: unknown;
    }[];
    total_data_points: null | number;
}>>
Loads the information associated with the class, removing any existing caches.
Parameters
- bustCache: boolean = false
Returns Promise<LoadedObject<AtlasProjection, {
    embedding_field?: null | string;
    embedding_model?: null | string;
    primary_projection_algorithm: string;
    resources?: {
        dataset_id: string;
        id: string;
        params: {
            [key: string]: unknown;
        };
        status: "COMPLETED" | "FAILED" | "BUILDING" | "WAITING";
        type: string;
    }[];
    topic_model_metadatas: null | {
        [key: string]: unknown;
    }[];
    topic_models: {
        [key: string]: unknown;
    }[];
    total_data_points: null | number;
}>>
a LoadedObject instance of the class that is guaranteed to have its attr slot populated with appropriate information.
Example
```
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
```
Inherited from BaseAtlasClass.withLoadedAttributes
- Defined in src/user.ts:92

Class AtlasProjection

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AtlasProjection

Properties

Protected _attr

Type declaration

Optional embedding_field?: null | string

Description

Optional embedding_model?: null | string

Description

primary_projection_algorithm: string

Description

Optional resources?: { dataset_id: string; id: string; params: { [key: string]: unknown; }; status: "COMPLETED" | "FAILED" | "BUILDING" | "WAITING"; type: string; }[]

Description

Default

topic_model_metadatas: null | { [key: string]: unknown; }[]

Description

topic_models: { [key: string]: unknown; }[]

Description

total_data_points: null | number

Description

Optional _index

Optional _project

Optional _project_id_promise

_schema

Protected attributePromise

id

Protected Optional project_id

viewer

Accessors

attr

Returns undefined | AttributesType

quadtree_root

Returns string

Methods

apiCall

Parameters

Returns Promise<null | string | any[] | Record<string, any> | Uint8Array | Table<any>>

atomInformation

Parameters

Returns Promise<any>

createTag

Parameters

Returns Promise<TagResponse>

datasetId

Returns Promise<string>

deleteTag

Parameters

Returns Promise<void>

Protected endpoint

Returns string

fetchAttributes

Parameters

getTagStatus

Parameters

Returns Promise<TagStatus>

getTags

Returns Promise<TagResponse[]>

index

Returns Promise<AtlasIndex>

nearest_neighbors_by_vector

Parameters

Returns Promise<Record<string, any>>

project

Returns Promise<AtlasProject>

roboTag

Parameters

Returns Promise<void>

schema

Returns Promise<Uint8Array>

updateTag

Parameters

`Protected` _attr

`Optional` embedding_field?: null | string

`Optional` embedding_model?: null | string

`Optional` resources?: {
dataset_id: string;
id: string;
params: {
[key: string]: unknown;
};
status: "COMPLETED" | "FAILED" | "BUILDING" | "WAITING";
type: string;
}[]

topic_model_metadatas: null | {
[key: string]: unknown;
}[]

topic_models: {
[key: string]: unknown;
}[]

`Optional` _index

`Optional` _project

`Optional` _project_id_promise

`Protected` attributePromise

`Protected` `Optional` project_id

`Protected` endpoint