From 9b2819f800d57d5c3f7477ac8121f26a5e272c53 Mon Sep 17 00:00:00 2001 From: bmschmidt Date: Fri, 8 Nov 2024 14:11:37 +0000 Subject: [PATCH] deploy: 5a24a9684c8a9aad6b9da6701642ff2e184be47c --- classes/APIError.html | 4 ++-- classes/AtlasIndex.html | 18 +++++++++--------- classes/AtlasOrganization.html | 10 +++++----- classes/AtlasProject.html | 22 +++++++++++----------- classes/AtlasProjection.html | 22 +++++++++++----------- classes/AtlasUser.html | 16 ++++++++-------- classes/AtlasViewer.html | 6 +++--- classes/Embedder.html | 10 +++++----- functions/embed.html | 2 +- 9 files changed, 55 insertions(+), 55 deletions(-) diff --git a/classes/APIError.html b/classes/APIError.html index ce93a02..5db2c44 100644 --- a/classes/APIError.html +++ b/classes/APIError.html @@ -1,4 +1,4 @@ -APIError | @nomic-ai/atlas

Class APIError

Hierarchy

  • Error
    • APIError

Constructors

constructor +APIError | @nomic-ai/atlas

Class APIError

Hierarchy

  • Error
    • APIError

Constructors

constructor

Properties

headers message name @@ -9,7 +9,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

  • new APIError(status, statusText, headers, responseBody?): APIError

  • Parameters

    • status: number
    • statusText: string
    • headers: any
    • Optional responseBody: string

    Returns APIError

Properties

headers

headers: any

message

message: string

name

name: string

responseBody

responseBody: null | string

Optional stack

stack?: string

status

status: number

statusText

statusText: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

  • new APIError(status, statusText, headers, responseBody?): APIError

  • Parameters

    • status: number
    • statusText: string
    • headers: any
    • Optional responseBody: string

    Returns APIError

Properties

headers

headers: any

message

message: string

name

name: string

responseBody

responseBody: null | string

Optional stack

stack?: string

status

status: number

statusText

statusText: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorheadersmessagenameresponseBodystackstatusstatusTextprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/AtlasIndex.html b/classes/AtlasIndex.html index 1de28bf..be584db 100644 --- a/classes/AtlasIndex.html +++ b/classes/AtlasIndex.html @@ -1,4 +1,4 @@ -AtlasIndex | @nomic-ai/atlas

Class AtlasIndex

Hierarchy

  • BaseAtlasClass<{}>
    • AtlasIndex

Constructors

constructor +AtlasIndex | @nomic-ai/atlas

Class AtlasIndex

Hierarchy

  • BaseAtlasClass<{}>
    • AtlasIndex

Constructors

constructor

Properties

_attr _projections? attributePromise @@ -14,24 +14,24 @@ nearest_neighbors_by_vector projections withLoadedAttributes -

Constructors

constructor

Properties

Protected _attr

_attr: undefined | {}

Type declaration

    Optional _projections

    _projections?: AtlasProjection[] = undefined

    Protected attributePromise

    attributePromise: undefined | Promise<{}>

    id

    id: string

    project

    project: AtlasProject

    viewer

    viewer: AtlasViewer

    Accessors

    attr

    • get attr(): undefined | AttributesType

    • returns the object's information; this may be undefined

      -

      Returns undefined | AttributesType

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

    atomInformation

    • atomInformation(ids): Promise<any>

    • Parameters

      • ids: string[] | number[] | bigint[]

        a list of ids (atom_ids, which are scoped to the index level) to fetch. If passing +

    Constructors

    constructor

    Properties

    Protected _attr

    _attr: undefined | {}

    Type declaration

      Optional _projections

      _projections?: AtlasProjection[] = undefined

      Protected attributePromise

      attributePromise: undefined | Promise<{}>

      id

      id: string

      project

      project: AtlasProject

      viewer

      viewer: AtlasViewer

      Accessors

      attr

      • get attr(): undefined | AttributesType

      • returns the object's information; this may be undefined

        +

        Returns undefined | AttributesType

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

      atomInformation

      • atomInformation(ids): Promise<any>

      • Parameters

        • ids: string[] | number[] | bigint[]

          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.

        Returns Promise<any>

        a list of Records containing metadata for each atom.

        -

      Protected endpoint

      • endpoint(): string

      • Returns string

      fetchAttributes

      • fetchAttributes(bustCache?): Promise<{}>

      • Fetches basic information about the object. +

      Protected endpoint

      • endpoint(): string

      • Returns string

      fetchAttributes

      • fetchAttributes(bustCache?): Promise<{}>

      • 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<{}>

        A promise that resolves to the organization info.

        -

      nearest_neighbors

      • nearest_neighbors(nn_options): Promise<Table<any>>

      • Parameters

        • nn_options: NNOptions

        Returns Promise<Table<any>>

        A table containing the nearest neighbors for each atom.

        -

      nearest_neighbors_by_vector

      • nearest_neighbors_by_vector(param0): Promise<{
            distances: number[][];
            neighbors: string[][];
        }>

      • Parameters

        • param0: Omit<{
              atlas_index_id: string;
              k?: number;
              queries: string | number[][];
          }, "atlas_index_id">

          A keyed dictionary including k (the number of neighbors to return) +

      nearest_neighbors

      • nearest_neighbors(nn_options): Promise<Table<any>>

      • Parameters

        • nn_options: NNOptions

        Returns Promise<Table<any>>

        A table containing the nearest neighbors for each atom.

        +

      nearest_neighbors_by_vector

      • nearest_neighbors_by_vector(param0): Promise<{
            distances: number[][];
            neighbors: string[][];
        }>

      • Parameters

        • param0: Omit<{
              atlas_index_id: string;
              k?: number;
              queries: string | number[][];
          }, "atlas_index_id">

          A keyed dictionary including k (the number of neighbors to return) and queries (a list of vectors to search for).

          -

        Returns Promise<{
            distances: number[][];
            neighbors: string[][];
        }>

      projections

      withLoadedAttributes

      • withLoadedAttributes(): Promise<LoadedObject<AtlasIndex, {}>>

      • Loads the information associated with the class, removing any +

      Returns Promise<{
          distances: number[][];
          neighbors: string[][];
      }>

      projections

      withLoadedAttributes

      • withLoadedAttributes(): Promise<LoadedObject<AtlasIndex, {}>>

      • Loads the information associated with the class, removing any existing caches.

        Returns Promise<LoadedObject<AtlasIndex, {}>>

        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
        -

      Settings

      Member Visibility

      Theme

      On This Page

      constructor_attr_projectionsattributePromiseidprojectviewerattrapiCallatomInformationendpointfetchAttributesnearest_neighborsnearest_neighbors_by_vectorprojectionswithLoadedAttributes
      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      constructor_attr_projectionsattributePromiseidprojectviewerattrapiCallatomInformationendpointfetchAttributesnearest_neighborsnearest_neighbors_by_vectorprojectionswithLoadedAttributes
      \ No newline at end of file diff --git a/classes/AtlasOrganization.html b/classes/AtlasOrganization.html index aec3ea7..ad9984f 100644 --- a/classes/AtlasOrganization.html +++ b/classes/AtlasOrganization.html @@ -1,4 +1,4 @@ -AtlasOrganization | @nomic-ai/atlas

      Class AtlasOrganization

      Hierarchy

      • BaseAtlasClass<OrganizationInfo>
        • AtlasOrganization

      Constructors

      constructor +AtlasOrganization | @nomic-ai/atlas

      Class AtlasOrganization

      Hierarchy

      • BaseAtlasClass<OrganizationInfo>
        • AtlasOrganization

      Constructors

      constructor

      Properties

      _attr attributePromise id @@ -10,17 +10,17 @@ fetchAttributes projects withLoadedAttributes -

      Constructors

      constructor

      Properties

      Protected _attr

      _attr: undefined | OrganizationInfo

      Protected attributePromise

      attributePromise: undefined | Promise<OrganizationInfo>

      id

      id: string

      viewer

      viewer: AtlasViewer

      Accessors

      attr

      • get attr(): undefined | AttributesType

      • returns the object's information; this may be undefined

        -

        Returns undefined | AttributesType

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

      create_project

      Protected endpoint

      fetchAttributes

      • fetchAttributes(bustCache?): Promise<OrganizationInfo>

      • Fetches basic information about the object. +

      Constructors

      constructor

      Properties

      Protected _attr

      _attr: undefined | OrganizationInfo

      Protected attributePromise

      attributePromise: undefined | Promise<OrganizationInfo>

      id

      id: string

      viewer

      viewer: AtlasViewer

      Accessors

      attr

      • get attr(): undefined | AttributesType

      • returns the object's information; this may be undefined

        +

        Returns undefined | AttributesType

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

      create_project

      Protected endpoint

      fetchAttributes

      • fetchAttributes(bustCache?): Promise<OrganizationInfo>

      • 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<OrganizationInfo>

        A promise that resolves to the organization info.

        -

      projects

      • projects(): Promise<{
            created_timestamp: string;
            creator: string;
            creator_nickname: string;
            creator_picture: string;
            description: string;
            id: string;
            is_public: boolean;
            is_public_to_org: boolean;
            modality?: string;
            nickname: string;
            organization_name: string;
            organization_slug: string;
            owner: string;
            project_fields: string[];
            project_name: string;
            slug: string;
            thumbnail: string;
            total_datums_in_project: number;
            unique_id_field: string;
        }[]>

      • Returns Promise<{
            created_timestamp: string;
            creator: string;
            creator_nickname: string;
            creator_picture: string;
            description: string;
            id: string;
            is_public: boolean;
            is_public_to_org: boolean;
            modality?: string;
            nickname: string;
            organization_name: string;
            organization_slug: string;
            owner: string;
            project_fields: string[];
            project_name: string;
            slug: string;
            thumbnail: string;
            total_datums_in_project: number;
            unique_id_field: string;
        }[]>

      withLoadedAttributes

      • withLoadedAttributes(): Promise<LoadedObject<AtlasOrganization, OrganizationInfo>>

      • Loads the information associated with the class, removing any +

      projects

      • projects(): Promise<{
            created_timestamp: string;
            creator: string;
            creator_nickname: string;
            creator_picture: string;
            description: string;
            id: string;
            is_public: boolean;
            is_public_to_org: boolean;
            modality?: string;
            nickname: string;
            organization_name: string;
            organization_slug: string;
            owner: string;
            project_fields: string[];
            project_name: string;
            slug: string;
            thumbnail: string;
            total_datums_in_project: number;
            unique_id_field: string;
        }[]>

      • Returns Promise<{
            created_timestamp: string;
            creator: string;
            creator_nickname: string;
            creator_picture: string;
            description: string;
            id: string;
            is_public: boolean;
            is_public_to_org: boolean;
            modality?: string;
            nickname: string;
            organization_name: string;
            organization_slug: string;
            owner: string;
            project_fields: string[];
            project_name: string;
            slug: string;
            thumbnail: string;
            total_datums_in_project: number;
            unique_id_field: string;
        }[]>

      withLoadedAttributes

      • withLoadedAttributes(): Promise<LoadedObject<AtlasOrganization, OrganizationInfo>>

      • Loads the information associated with the class, removing any existing caches.

        Returns Promise<LoadedObject<AtlasOrganization, OrganizationInfo>>

        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
        -

      Settings

      Member Visibility

      Theme

      On This Page

      constructor_attrattributePromiseidviewerattrapiCallcreate_projectendpointfetchAttributesprojectswithLoadedAttributes
      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      constructor_attrattributePromiseidviewerattrapiCallcreate_projectendpointfetchAttributesprojectswithLoadedAttributes
      \ No newline at end of file diff --git a/classes/AtlasProject.html b/classes/AtlasProject.html index 79d4a0c..f217d88 100644 --- a/classes/AtlasProject.html +++ b/classes/AtlasProject.html @@ -1,7 +1,7 @@ AtlasProject | @nomic-ai/atlas

      Class AtlasProject

      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.

      -

      Hierarchy

      • BaseAtlasClass<components["schemas"]["Project"]>
        • AtlasProject

      Constructors

      constructor +

      Hierarchy

      • BaseAtlasClass<components["schemas"]["Project"]>
        • AtlasProject

      Constructors

      constructor

      Properties

      _attr _indices _schema? @@ -33,7 +33,7 @@
    • Optional viewer: AtlasViewer

      • Returns AtlasProject

      An AtlasDataset object.

      Properties

      Protected _attr

      _attr: undefined | {
          access_role: string;
          atlas_indices: {
              atoms: string[];
              colorable_fields: string[];
              created_timestamp: string;
              embedders: {
                  atlas_index_id: string;
                  hyperparameters: Record<string, unknown>;
                  id: string;
                  model_name: string;
                  ready: boolean;
              }[];
              id: string;
              index_name: string;
              indexed_field: string;
              nearest_neighbor_indices: {
                  atom_strategies: string[];
                  hyperparameters: Record<string, unknown>;
                  id: string;
                  index_name: string;
                  ready: boolean;
              }[];
              project_id: string;
              projections: {
                  atom_strategies: string[];
                  created_timestamp: string;
                  hyperparameters: Record<string, unknown>;
                  id: string;
                  og_image?: string;
                  projection_name: string;
                  ready: boolean;
                  thumbnail?: string;
                  updated_timestamp: string;
              }[];
              updated_timestamp: string;
          }[];
          created_timestamp: string;
          creator: string;
          creator_nickname: string;
          creator_picture: string;
          description: string;
          id: string;
          insert_update_delete_lock: boolean;
          is_public: boolean;
          is_public_to_org: boolean;
          modality?: string;
          og_image: string;
          organization_name: string;
          organization_slug: string;
          owner: string;
          permissions: {
              [key: string]: boolean;
          };
          project_fields: string[];
          project_name: string;
          schema?: string;
          slug: string;
          total_datums_in_project: number;
          unique_id_field: string;
      }

      Type declaration

      Properties

      Protected _attr

      _attr: undefined | {
          access_role: string;
          atlas_indices: {
              atoms: string[];
              colorable_fields: string[];
              created_timestamp: string;
              embedders: {
                  atlas_index_id: string;
                  hyperparameters: Record<string, unknown>;
                  id: string;
                  model_name: string;
                  ready: boolean;
              }[];
              id: string;
              index_name: string;
              indexed_field: string;
              nearest_neighbor_indices: {
                  atom_strategies: string[];
                  hyperparameters: Record<string, unknown>;
                  id: string;
                  index_name: string;
                  ready: boolean;
              }[];
              project_id: string;
              projections: {
                  atom_strategies: string[];
                  created_timestamp: string;
                  hyperparameters: Record<string, unknown>;
                  id: string;
                  og_image?: string;
                  projection_name: string;
                  ready: boolean;
                  thumbnail?: string;
                  updated_timestamp: string;
              }[];
              updated_timestamp: string;
          }[];
          created_timestamp: string;
          creator: string;
          creator_nickname: string;
          creator_picture: string;
          description: string;
          id: string;
          insert_update_delete_lock: boolean;
          is_public: boolean;
          is_public_to_org: boolean;
          modality?: string;
          og_image: string;
          organization_name: string;
          organization_slug: string;
          owner: string;
          permissions: {
              [key: string]: boolean;
          };
          project_fields: string[];
          project_name: string;
          schema?: string;
          slug: string;
          total_datums_in_project: number;
          unique_id_field: string;
      }

      Type declaration

      • access_role: string

        Access Role

        Description

        Access role of user for this project

      • atlas_indices: {
            atoms: string[];
            colorable_fields: string[];
            created_timestamp: string;
            embedders: {
                atlas_index_id: string;
                hyperparameters: Record<string, unknown>;
                id: string;
                model_name: string;
                ready: boolean;
            }[];
            id: string;
            index_name: string;
            indexed_field: string;
            nearest_neighbor_indices: {
                atom_strategies: string[];
                hyperparameters: Record<string, unknown>;
                id: string;
                index_name: string;
                ready: boolean;
            }[];
            project_id: string;
            projections: {
                atom_strategies: string[];
                created_timestamp: string;
                hyperparameters: Record<string, unknown>;
                id: string;
                og_image?: string;
                projection_name: string;
                ready: boolean;
                thumbnail?: string;
                updated_timestamp: string;
            }[];
            updated_timestamp: string;
        }[]

        Atlas Indices

        Description

        All Atlas Indices built overtop of this project.

        @@ -88,29 +88,29 @@

        Example

        example_projec

        Description

        Total datums in project.

      • unique_id_field: string

        Unique Id Field

        Description

        The field that contains a unique id for each document.

        -

      _indices

      _indices: AtlasIndex[] = []

      Optional _schema

      _schema?: null | Schema<any>

      Protected attributePromise

      attributePromise: undefined | Promise<{
          access_role: string;
          atlas_indices: {
              atoms: string[];
              colorable_fields: string[];
              created_timestamp: string;
              embedders: {
                  atlas_index_id: string;
                  hyperparameters: Record<string, unknown>;
                  id: string;
                  model_name: string;
                  ready: boolean;
              }[];
              id: string;
              index_name: string;
              indexed_field: string;
              nearest_neighbor_indices: {
                  atom_strategies: string[];
                  hyperparameters: Record<string, unknown>;
                  id: string;
                  index_name: string;
                  ready: boolean;
              }[];
              project_id: string;
              projections: {
                  atom_strategies: string[];
                  created_timestamp: string;
                  hyperparameters: Record<string, unknown>;
                  id: string;
                  og_image?: string;
                  projection_name: string;
                  ready: boolean;
                  thumbnail?: string;
                  updated_timestamp: string;
              }[];
              updated_timestamp: string;
          }[];
          created_timestamp: string;
          creator: string;
          creator_nickname: string;
          creator_picture: string;
          description: string;
          id: string;
          insert_update_delete_lock: boolean;
          is_public: boolean;
          is_public_to_org: boolean;
          modality?: string;
          og_image: string;
          organization_name: string;
          organization_slug: string;
          owner: string;
          permissions: {
              [key: string]: boolean;
          };
          project_fields: string[];
          project_name: string;
          schema?: string;
          slug: string;
          total_datums_in_project: number;
          unique_id_field: string;
      }>

      id

      id: string

      viewer

      viewer: AtlasViewer

      Accessors

      attr

      • get attr(): undefined | AttributesType

      • returns the object's information; this may be undefined

        -

        Returns undefined | AttributesType

      schema

      • get schema(): undefined | null | Schema<any>

      • Returns undefined | null | Schema<any>

      Methods

      add_embeddings

      add_text

      • add_text(records): Promise<void>

      • Parameters

        • records: Record<string, string>[]

        Returns Promise<void>

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

      Private clear

      createIndex

      • createIndex(options): Promise<AtlasIndex>

      • Prefer createIndexRaw, which has better syncing of types

        -

        Parameters

        • options: Omit<IndexCreateOptions, "project_id">

        Returns Promise<AtlasIndex>

        Deprecated

      createIndexRaw

      • createIndexRaw(options): Promise<AtlasIndex>

      • This should be preferred over createIndex, as it uses the actual +

      _indices

      _indices: AtlasIndex[] = []

      Optional _schema

      _schema?: null | Schema<any>

      Protected attributePromise

      attributePromise: undefined | Promise<{
          access_role: string;
          atlas_indices: {
              atoms: string[];
              colorable_fields: string[];
              created_timestamp: string;
              embedders: {
                  atlas_index_id: string;
                  hyperparameters: Record<string, unknown>;
                  id: string;
                  model_name: string;
                  ready: boolean;
              }[];
              id: string;
              index_name: string;
              indexed_field: string;
              nearest_neighbor_indices: {
                  atom_strategies: string[];
                  hyperparameters: Record<string, unknown>;
                  id: string;
                  index_name: string;
                  ready: boolean;
              }[];
              project_id: string;
              projections: {
                  atom_strategies: string[];
                  created_timestamp: string;
                  hyperparameters: Record<string, unknown>;
                  id: string;
                  og_image?: string;
                  projection_name: string;
                  ready: boolean;
                  thumbnail?: string;
                  updated_timestamp: string;
              }[];
              updated_timestamp: string;
          }[];
          created_timestamp: string;
          creator: string;
          creator_nickname: string;
          creator_picture: string;
          description: string;
          id: string;
          insert_update_delete_lock: boolean;
          is_public: boolean;
          is_public_to_org: boolean;
          modality?: string;
          og_image: string;
          organization_name: string;
          organization_slug: string;
          owner: string;
          permissions: {
              [key: string]: boolean;
          };
          project_fields: string[];
          project_name: string;
          schema?: string;
          slug: string;
          total_datums_in_project: number;
          unique_id_field: string;
      }>

      id

      id: string

      viewer

      viewer: AtlasViewer

      Accessors

      attr

      • get attr(): undefined | AttributesType

      • returns the object's information; this may be undefined

        +

        Returns undefined | AttributesType

      schema

      • get schema(): undefined | null | Schema<any>

      • Returns undefined | null | Schema<any>

      Methods

      add_embeddings

      add_text

      • add_text(records): Promise<void>

      • Parameters

        • records: Record<string, string>[]

        Returns Promise<void>

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

      Private clear

      createIndex

      • createIndex(options): Promise<AtlasIndex>

      • Prefer createIndexRaw, which has better syncing of types

        +

        Parameters

        • options: Omit<IndexCreateOptions, "project_id">

        Returns Promise<AtlasIndex>

        Deprecated

      createIndexRaw

      • createIndexRaw(options): Promise<AtlasIndex>

      • 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.)

        Parameters

        • options: Partial<{
              atomizer_strategies?: string[];
              colorable_fields?: string[];
              duplicate_detection_hyperparameters?: string;
              geometry_strategies?: string[][];
              index_name?: string;
              indexed_field: string;
              modality?: string;
              model: string;
              model_hyperparameters: string;
              nearest_neighbor_index: string;
              nearest_neighbor_index_hyperparameters: string;
              project_id: string;
              projection: string;
              projection_hyperparameters: string;
              reuse_atoms_and_embeddings_from?: string;
              topic_model_hyperparameters?: string;
          }> & {
              indexed_field: string;
          }

          See types for options.

        Returns Promise<AtlasIndex>

        an AtlasIndex object based on the new arguments.

        -

      delete

      • delete(): Promise<null | string | any[] | Record<string, any> | Uint8Array | Table<any>>

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

      delete_data

      • delete_data(ids): Promise<void>

      • Parameters

        • ids: string[]

        Returns Promise<void>

      Protected endpoint

      • endpoint(): string

      • Returns string

      fetchAttributes

      • fetchAttributes(bustCache?): Promise<{
            access_role: string;
            atlas_indices: {
                atoms: string[];
                colorable_fields: string[];
                created_timestamp: string;
                embedders: {
                    atlas_index_id: string;
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    model_name: string;
                    ready: boolean;
                }[];
                id: string;
                index_name: string;
                indexed_field: string;
                nearest_neighbor_indices: {
                    atom_strategies: string[];
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    index_name: string;
                    ready: boolean;
                }[];
                project_id: string;
                projections: {
                    atom_strategies: string[];
                    created_timestamp: string;
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    og_image?: string;
                    projection_name: string;
                    ready: boolean;
                    thumbnail?: string;
                    updated_timestamp: string;
                }[];
                updated_timestamp: string;
            }[];
            created_timestamp: string;
            creator: string;
            creator_nickname: string;
            creator_picture: string;
            description: string;
            id: string;
            insert_update_delete_lock: boolean;
            is_public: boolean;
            is_public_to_org: boolean;
            modality?: string;
            og_image: string;
            organization_name: string;
            organization_slug: string;
            owner: string;
            permissions: {
                [key: string]: boolean;
            };
            project_fields: string[];
            project_name: string;
            schema?: string;
            slug: string;
            total_datums_in_project: number;
            unique_id_field: string;
        }>

      • Fetches basic information about the object. +

      delete

      • delete(): Promise<null | string | any[] | Record<string, any> | Uint8Array | Table<any>>

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

      delete_data

      • delete_data(ids): Promise<void>

      • Parameters

        • ids: string[]

        Returns Promise<void>

      Protected endpoint

      • endpoint(): string

      • Returns string

      fetchAttributes

      • fetchAttributes(bustCache?): Promise<{
            access_role: string;
            atlas_indices: {
                atoms: string[];
                colorable_fields: string[];
                created_timestamp: string;
                embedders: {
                    atlas_index_id: string;
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    model_name: string;
                    ready: boolean;
                }[];
                id: string;
                index_name: string;
                indexed_field: string;
                nearest_neighbor_indices: {
                    atom_strategies: string[];
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    index_name: string;
                    ready: boolean;
                }[];
                project_id: string;
                projections: {
                    atom_strategies: string[];
                    created_timestamp: string;
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    og_image?: string;
                    projection_name: string;
                    ready: boolean;
                    thumbnail?: string;
                    updated_timestamp: string;
                }[];
                updated_timestamp: string;
            }[];
            created_timestamp: string;
            creator: string;
            creator_nickname: string;
            creator_picture: string;
            description: string;
            id: string;
            insert_update_delete_lock: boolean;
            is_public: boolean;
            is_public_to_org: boolean;
            modality?: string;
            og_image: string;
            organization_name: string;
            organization_slug: string;
            owner: string;
            permissions: {
                [key: string]: boolean;
            };
            project_fields: string[];
            project_name: string;
            schema?: string;
            slug: string;
            total_datums_in_project: number;
            unique_id_field: string;
        }>

      • 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<{
            access_role: string;
            atlas_indices: {
                atoms: string[];
                colorable_fields: string[];
                created_timestamp: string;
                embedders: {
                    atlas_index_id: string;
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    model_name: string;
                    ready: boolean;
                }[];
                id: string;
                index_name: string;
                indexed_field: string;
                nearest_neighbor_indices: {
                    atom_strategies: string[];
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    index_name: string;
                    ready: boolean;
                }[];
                project_id: string;
                projections: {
                    atom_strategies: string[];
                    created_timestamp: string;
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    og_image?: string;
                    projection_name: string;
                    ready: boolean;
                    thumbnail?: string;
                    updated_timestamp: string;
                }[];
                updated_timestamp: string;
            }[];
            created_timestamp: string;
            creator: string;
            creator_nickname: string;
            creator_picture: string;
            description: string;
            id: string;
            insert_update_delete_lock: boolean;
            is_public: boolean;
            is_public_to_org: boolean;
            modality?: string;
            og_image: string;
            organization_name: string;
            organization_slug: string;
            owner: string;
            permissions: {
                [key: string]: boolean;
            };
            project_fields: string[];
            project_name: string;
            schema?: string;
            slug: string;
            total_datums_in_project: number;
            unique_id_field: string;
        }>

        A promise that resolves to the organization info.

        -

      fetch_ids

      • fetch_ids(ids?): Promise<Record<string, Record<string, any>>>

      • Parameters

        • Optional ids: string[]

          A list of identifiers to fetch from the server.

          -

        Returns Promise<Record<string, Record<string, any>>>

      indices

      projectionSummaries

      • projectionSummaries(): Promise<{
            atom_strategies: string[];
            created_timestamp: string;
            hyperparameters: Record<string, unknown>;
            id: string;
            og_image?: string;
            projection_name: string;
            ready: boolean;
            thumbnail?: string;
            updated_timestamp: string;
        }[]>

      • Returns Promise<{
            atom_strategies: string[];
            created_timestamp: string;
            hyperparameters: Record<string, unknown>;
            id: string;
            og_image?: string;
            projection_name: string;
            ready: boolean;
            thumbnail?: string;
            updated_timestamp: string;
        }[]>

        A list of projection summaries, sorted so that the first is +

      fetch_ids

      • fetch_ids(ids?): Promise<Record<string, Record<string, any>>>

      • Parameters

        • Optional ids: string[]

          A list of identifiers to fetch from the server.

          +

        Returns Promise<Record<string, Record<string, any>>>

      indices

      projectionSummaries

      • projectionSummaries(): Promise<{
            atom_strategies: string[];
            created_timestamp: string;
            hyperparameters: Record<string, unknown>;
            id: string;
            og_image?: string;
            projection_name: string;
            ready: boolean;
            thumbnail?: string;
            updated_timestamp: string;
        }[]>

      • Returns Promise<{
            atom_strategies: string[];
            created_timestamp: string;
            hyperparameters: Record<string, unknown>;
            id: string;
            og_image?: string;
            projection_name: string;
            ready: boolean;
            thumbnail?: string;
            updated_timestamp: string;
        }[]>

        A list of projection summaries, sorted so that the first is the most useable (defined as ready and newest)

        -

      update_indices

      • update_indices(rebuild_topic_models?): Promise<void>

      • Updates all indices associated with a project.

        +

      update_indices

      • update_indices(rebuild_topic_models?): Promise<void>

      • Updates all indices associated with a project.

        Parameters

        • rebuild_topic_models: boolean = false

          If true, rebuilds topic models for all indices.

          -

        Returns Promise<void>

      uploadArrow

      • uploadArrow(table): Promise<void>

      • Parameters

        • table: Uint8Array | Table<any>

        Returns Promise<void>

      validate_metadata

      wait_for_lock

      withLoadedAttributes

      • withLoadedAttributes(): Promise<LoadedObject<AtlasProject, {
            access_role: string;
            atlas_indices: {
                atoms: string[];
                colorable_fields: string[];
                created_timestamp: string;
                embedders: {
                    atlas_index_id: string;
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    model_name: string;
                    ready: boolean;
                }[];
                id: string;
                index_name: string;
                indexed_field: string;
                nearest_neighbor_indices: {
                    atom_strategies: string[];
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    index_name: string;
                    ready: boolean;
                }[];
                project_id: string;
                projections: {
                    atom_strategies: string[];
                    created_timestamp: string;
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    og_image?: string;
                    projection_name: string;
                    ready: boolean;
                    thumbnail?: string;
                    updated_timestamp: string;
                }[];
                updated_timestamp: string;
            }[];
            created_timestamp: string;
            creator: string;
            creator_nickname: string;
            creator_picture: string;
            description: string;
            id: string;
            insert_update_delete_lock: boolean;
            is_public: boolean;
            is_public_to_org: boolean;
            modality?: string;
            og_image: string;
            organization_name: string;
            organization_slug: string;
            owner: string;
            permissions: {
                [key: string]: boolean;
            };
            project_fields: string[];
            project_name: string;
            schema?: string;
            slug: string;
            total_datums_in_project: number;
            unique_id_field: string;
        }>>

      • Loads the information associated with the class, removing any +

      Returns Promise<void>

      uploadArrow

      • uploadArrow(table): Promise<void>

      • Parameters

        • table: Uint8Array | Table<any>

        Returns Promise<void>

      validate_metadata

      wait_for_lock

      withLoadedAttributes

      • withLoadedAttributes(): Promise<LoadedObject<AtlasProject, {
            access_role: string;
            atlas_indices: {
                atoms: string[];
                colorable_fields: string[];
                created_timestamp: string;
                embedders: {
                    atlas_index_id: string;
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    model_name: string;
                    ready: boolean;
                }[];
                id: string;
                index_name: string;
                indexed_field: string;
                nearest_neighbor_indices: {
                    atom_strategies: string[];
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    index_name: string;
                    ready: boolean;
                }[];
                project_id: string;
                projections: {
                    atom_strategies: string[];
                    created_timestamp: string;
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    og_image?: string;
                    projection_name: string;
                    ready: boolean;
                    thumbnail?: string;
                    updated_timestamp: string;
                }[];
                updated_timestamp: string;
            }[];
            created_timestamp: string;
            creator: string;
            creator_nickname: string;
            creator_picture: string;
            description: string;
            id: string;
            insert_update_delete_lock: boolean;
            is_public: boolean;
            is_public_to_org: boolean;
            modality?: string;
            og_image: string;
            organization_name: string;
            organization_slug: string;
            owner: string;
            permissions: {
                [key: string]: boolean;
            };
            project_fields: string[];
            project_name: string;
            schema?: string;
            slug: string;
            total_datums_in_project: number;
            unique_id_field: string;
        }>>

      • Loads the information associated with the class, removing any existing caches.

        Returns Promise<LoadedObject<AtlasProject, {
            access_role: string;
            atlas_indices: {
                atoms: string[];
                colorable_fields: string[];
                created_timestamp: string;
                embedders: {
                    atlas_index_id: string;
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    model_name: string;
                    ready: boolean;
                }[];
                id: string;
                index_name: string;
                indexed_field: string;
                nearest_neighbor_indices: {
                    atom_strategies: string[];
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    index_name: string;
                    ready: boolean;
                }[];
                project_id: string;
                projections: {
                    atom_strategies: string[];
                    created_timestamp: string;
                    hyperparameters: Record<string, unknown>;
                    id: string;
                    og_image?: string;
                    projection_name: string;
                    ready: boolean;
                    thumbnail?: string;
                    updated_timestamp: string;
                }[];
                updated_timestamp: string;
            }[];
            created_timestamp: string;
            creator: string;
            creator_nickname: string;
            creator_picture: string;
            description: string;
            id: string;
            insert_update_delete_lock: boolean;
            is_public: boolean;
            is_public_to_org: boolean;
            modality?: string;
            og_image: string;
            organization_name: string;
            organization_slug: string;
            owner: string;
            permissions: {
                [key: string]: boolean;
            };
            project_fields: string[];
            project_name: string;
            schema?: string;
            slug: string;
            total_datums_in_project: number;
            unique_id_field: string;
        }>>

        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
        -

      Settings

      Member Visibility

      Theme

      On This Page

      constructor_attr_indices_schemaattributePromiseidviewerattrschemaadd_embeddingsadd_textapiCallclearcreateIndexcreateIndexRawdeletedelete_dataendpointfetchAttributesfetch_idsindicesprojectionSummariesupdate_indicesuploadArrowvalidate_metadatawait_for_lockwithLoadedAttributes
      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      constructor_attr_indices_schemaattributePromiseidviewerattrschemaadd_embeddingsadd_textapiCallclearcreateIndexcreateIndexRawdeletedelete_dataendpointfetchAttributesfetch_idsindicesprojectionSummariesupdate_indicesuploadArrowvalidate_metadatawait_for_lockwithLoadedAttributes
      \ No newline at end of file diff --git a/classes/AtlasProjection.html b/classes/AtlasProjection.html index f041bc2..94c43e0 100644 --- a/classes/AtlasProjection.html +++ b/classes/AtlasProjection.html @@ -1,4 +1,4 @@ -AtlasProjection | @nomic-ai/atlas

      Class AtlasProjection

      Hierarchy

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

      Constructors

      constructor +AtlasProjection | @nomic-ai/atlas

      Class AtlasProjection

      Hierarchy

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

      Constructors

      constructor

      Properties

      _attr _index? _project? @@ -32,29 +32,29 @@
    • options: ProjectionInitializationOptions = {}

      Options for initializing the projection.

      • Returns AtlasProjection

      Properties

      Protected _attr

      _attr: undefined | {
          topic_model_metadatas: Record<string, unknown>[];
          topic_models: {
              bbox?: [number, number, number, number] | [number, number, number, number, number, number];
              features: {
                  bbox?: [number, number, number, number] | [number, number, number, number, number, number];
                  geometry?: {
                      coordinates: [number, number] | [number, number, number];
                      type?: "Point";
                  } | {
                      coordinates: ([(...), (...)] | [(...), (...), (...)])[];
                      type?: "MultiPoint";
                  } | {
                      coordinates: ([(...), (...)] | [(...), (...), (...)])[];
                      type?: "LineString";
                  } | {
                      coordinates: ((...) | (...))[][];
                      type?: "MultiLineString";
                  } | {
                      coordinates: ((...) | (...))[][];
                      type?: "Polygon";
                  } | {
                      coordinates: (...)[][][];
                      type?: "MultiPolygon";
                  } | {
                      geometries: ({
                          coordinates: ...;
                          type?: ...;
                      } | {
                          coordinates: ...;
                          type?: ...;
                      } | {
                          coordinates: ...;
                          type?: ...;
                      } | {
                          coordinates: ...;
                          type?: ...;
                      } | {
                          coordinates: ...;
                          type?: ...;
                      } | {
                          coordinates: ...;
                          type?: ...;
                      })[];
                      type?: "GeometryCollection";
                  };
                  id?: string;
                  properties?: Record<string, unknown>;
                  type?: "Feature";
              }[];
              type?: "FeatureCollection";
          }[];
      }

      Type declaration

      • topic_model_metadatas: Record<string, unknown>[]

        Topic Model Metadatas

        +>.constructor

      Properties

      Protected _attr

      _attr: undefined | {
          topic_model_metadatas: Record<string, unknown>[];
          topic_models: {
              bbox?: [number, number, number, number] | [number, number, number, number, number, number];
              features: {
                  bbox?: [number, number, number, number] | [number, number, number, number, number, number];
                  geometry?: {
                      coordinates: [number, number] | [number, number, number];
                      type?: "Point";
                  } | {
                      coordinates: ([(...), (...)] | [(...), (...), (...)])[];
                      type?: "MultiPoint";
                  } | {
                      coordinates: ([(...), (...)] | [(...), (...), (...)])[];
                      type?: "LineString";
                  } | {
                      coordinates: ((...) | (...))[][];
                      type?: "MultiLineString";
                  } | {
                      coordinates: ((...) | (...))[][];
                      type?: "Polygon";
                  } | {
                      coordinates: (...)[][][];
                      type?: "MultiPolygon";
                  } | {
                      geometries: ({
                          coordinates: ...;
                          type?: ...;
                      } | {
                          coordinates: ...;
                          type?: ...;
                      } | {
                          coordinates: ...;
                          type?: ...;
                      } | {
                          coordinates: ...;
                          type?: ...;
                      } | {
                          coordinates: ...;
                          type?: ...;
                      } | {
                          coordinates: ...;
                          type?: ...;
                      })[];
                      type?: "GeometryCollection";
                  };
                  id?: string;
                  properties?: Record<string, unknown>;
                  type?: "Feature";
              }[];
              type?: "FeatureCollection";
          }[];
      }

      Type declaration

      • topic_model_metadatas: Record<string, unknown>[]

        Topic Model Metadatas

        Description

        list of topic model metadata

      • topic_models: {
            bbox?: [number, number, number, number] | [number, number, number, number, number, number];
            features: {
                bbox?: [number, number, number, number] | [number, number, number, number, number, number];
                geometry?: {
                    coordinates: [number, number] | [number, number, number];
                    type?: "Point";
                } | {
                    coordinates: ([(...), (...)] | [(...), (...), (...)])[];
                    type?: "MultiPoint";
                } | {
                    coordinates: ([(...), (...)] | [(...), (...), (...)])[];
                    type?: "LineString";
                } | {
                    coordinates: ((...) | (...))[][];
                    type?: "MultiLineString";
                } | {
                    coordinates: ((...) | (...))[][];
                    type?: "Polygon";
                } | {
                    coordinates: (...)[][][];
                    type?: "MultiPolygon";
                } | {
                    geometries: ({
                        coordinates: ...;
                        type?: ...;
                    } | {
                        coordinates: ...;
                        type?: ...;
                    } | {
                        coordinates: ...;
                        type?: ...;
                    } | {
                        coordinates: ...;
                        type?: ...;
                    } | {
                        coordinates: ...;
                        type?: ...;
                    } | {
                        coordinates: ...;
                        type?: ...;
                    })[];
                    type?: "GeometryCollection";
                };
                id?: string;
                properties?: Record<string, unknown>;
                type?: "Feature";
            }[];
            type?: "FeatureCollection";
        }[]

        Topic Models

        Description

        List of topic model geojsons

        -

      Optional _index

      _index?: AtlasIndex

      Optional _project

      _project?: AtlasProject

      A projection is a map in Atlas; it represents a snapshot 2d view of a dataset +

      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<{
          topic_model_metadatas: Record<string, unknown>[];
          topic_models: {
              bbox?: [number, number, number, number] | [number, number, number, number, number, number];
              features: {
                  bbox?: [number, number, number, number] | [number, number, number, number, number, number];
                  geometry?: {
                      coordinates: [(...), (...)] | [(...), (...), (...)];
                      type?: "Point";
                  } | {
                      coordinates: ((...) | (...))[];
                      type?: "MultiPoint";
                  } | {
                      coordinates: ((...) | (...))[];
                      type?: "LineString";
                  } | {
                      coordinates: (...)[][];
                      type?: "MultiLineString";
                  } | {
                      coordinates: (...)[][];
                      type?: "Polygon";
                  } | {
                      coordinates: (...)[][];
                      type?: "MultiPolygon";
                  } | {
                      geometries: ((...) | (...) | (...) | (...) | (...) | (...))[];
                      type?: "GeometryCollection";
                  };
                  id?: string;
                  properties?: Record<string, unknown>;
                  type?: "Feature";
              }[];
              type?: "FeatureCollection";
          }[];
      }>

      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

      quadtree_root

      • get quadtree_root(): string

      • Returns string

        the URL for the quadtree root for this projection. +

      Optional _project_id_promise

      _project_id_promise?: Promise<string>

      _schema

      _schema: null | Uint8Array = null

      Protected attributePromise

      attributePromise: undefined | Promise<{
          topic_model_metadatas: Record<string, unknown>[];
          topic_models: {
              bbox?: [number, number, number, number] | [number, number, number, number, number, number];
              features: {
                  bbox?: [number, number, number, number] | [number, number, number, number, number, number];
                  geometry?: {
                      coordinates: [(...), (...)] | [(...), (...), (...)];
                      type?: "Point";
                  } | {
                      coordinates: ((...) | (...))[];
                      type?: "MultiPoint";
                  } | {
                      coordinates: ((...) | (...))[];
                      type?: "LineString";
                  } | {
                      coordinates: (...)[][];
                      type?: "MultiLineString";
                  } | {
                      coordinates: (...)[][];
                      type?: "Polygon";
                  } | {
                      coordinates: (...)[][];
                      type?: "MultiPolygon";
                  } | {
                      geometries: ((...) | (...) | (...) | (...) | (...) | (...))[];
                      type?: "GeometryCollection";
                  };
                  id?: string;
                  properties?: Record<string, unknown>;
                  type?: "Feature";
              }[];
              type?: "FeatureCollection";
          }[];
      }>

      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

      quadtree_root

      • get quadtree_root(): string

      • Returns string

        the URL for the quadtree root for this projection. 'public' may be be added in fetching.

        -

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

      atomInformation

      • atomInformation(ids): Promise<any>

      • Parameters

        • ids: string[] | number[] | bigint[]

        Returns Promise<any>

      createTag

      • createTag(options): Promise<TagResponse>

      • Parameters

        • options: CreateTagOptions

        Returns Promise<TagResponse>

      datasetId

      • datasetId(): Promise<string>

      • Returns Promise<string>

        the UUID of the dataset that this projection belongs to.

        -

      deleteTag

      • deleteTag(options): Promise<void>

      • Parameters

        • options: DeleteTagRequest

        Returns Promise<void>

      Protected endpoint

      fetchAttributes

      • fetchAttributes(bustCache?): Promise<{
            topic_model_metadatas: Record<string, unknown>[];
            topic_models: {
                bbox?: [number, number, number, number] | [number, number, number, number, number, number];
                features: {
                    bbox?: [number, number, number, number] | [number, number, number, number, number, number];
                    geometry?: {
                        coordinates: [number, number] | [number, number, number];
                        type?: "Point";
                    } | {
                        coordinates: ([(...), (...)] | [(...), (...), (...)])[];
                        type?: "MultiPoint";
                    } | {
                        coordinates: ([(...), (...)] | [(...), (...), (...)])[];
                        type?: "LineString";
                    } | {
                        coordinates: ((...) | (...))[][];
                        type?: "MultiLineString";
                    } | {
                        coordinates: ((...) | (...))[][];
                        type?: "Polygon";
                    } | {
                        coordinates: (...)[][][];
                        type?: "MultiPolygon";
                    } | {
                        geometries: ({
                            coordinates: ...;
                            type?: ...;
                        } | {
                            coordinates: ...;
                            type?: ...;
                        } | {
                            coordinates: ...;
                            type?: ...;
                        } | {
                            coordinates: ...;
                            type?: ...;
                        } | {
                            coordinates: ...;
                            type?: ...;
                        } | {
                            coordinates: ...;
                            type?: ...;
                        })[];
                        type?: "GeometryCollection";
                    };
                    id?: string;
                    properties?: Record<string, unknown>;
                    type?: "Feature";
                }[];
                type?: "FeatureCollection";
            }[];
        }>

      • Fetches basic information about the object. +

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

      atomInformation

      • atomInformation(ids): Promise<any>

      • Parameters

        • ids: string[] | number[] | bigint[]

        Returns Promise<any>

      createTag

      • createTag(options): Promise<TagResponse>

      • Parameters

        • options: CreateTagOptions

        Returns Promise<TagResponse>

      datasetId

      • datasetId(): Promise<string>

      • Returns Promise<string>

        the UUID of the dataset that this projection belongs to.

        +

      deleteTag

      • deleteTag(options): Promise<void>

      • Parameters

        • options: DeleteTagRequest

        Returns Promise<void>

      Protected endpoint

      fetchAttributes

      • fetchAttributes(bustCache?): Promise<{
            topic_model_metadatas: Record<string, unknown>[];
            topic_models: {
                bbox?: [number, number, number, number] | [number, number, number, number, number, number];
                features: {
                    bbox?: [number, number, number, number] | [number, number, number, number, number, number];
                    geometry?: {
                        coordinates: [number, number] | [number, number, number];
                        type?: "Point";
                    } | {
                        coordinates: ([(...), (...)] | [(...), (...), (...)])[];
                        type?: "MultiPoint";
                    } | {
                        coordinates: ([(...), (...)] | [(...), (...), (...)])[];
                        type?: "LineString";
                    } | {
                        coordinates: ((...) | (...))[][];
                        type?: "MultiLineString";
                    } | {
                        coordinates: ((...) | (...))[][];
                        type?: "Polygon";
                    } | {
                        coordinates: (...)[][][];
                        type?: "MultiPolygon";
                    } | {
                        geometries: ({
                            coordinates: ...;
                            type?: ...;
                        } | {
                            coordinates: ...;
                            type?: ...;
                        } | {
                            coordinates: ...;
                            type?: ...;
                        } | {
                            coordinates: ...;
                            type?: ...;
                        } | {
                            coordinates: ...;
                            type?: ...;
                        } | {
                            coordinates: ...;
                            type?: ...;
                        })[];
                        type?: "GeometryCollection";
                    };
                    id?: string;
                    properties?: Record<string, unknown>;
                    type?: "Feature";
                }[];
                type?: "FeatureCollection";
            }[];
        }>

      • 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<{
            topic_model_metadatas: Record<string, unknown>[];
            topic_models: {
                bbox?: [number, number, number, number] | [number, number, number, number, number, number];
                features: {
                    bbox?: [number, number, number, number] | [number, number, number, number, number, number];
                    geometry?: {
                        coordinates: [number, number] | [number, number, number];
                        type?: "Point";
                    } | {
                        coordinates: ([(...), (...)] | [(...), (...), (...)])[];
                        type?: "MultiPoint";
                    } | {
                        coordinates: ([(...), (...)] | [(...), (...), (...)])[];
                        type?: "LineString";
                    } | {
                        coordinates: ((...) | (...))[][];
                        type?: "MultiLineString";
                    } | {
                        coordinates: ((...) | (...))[][];
                        type?: "Polygon";
                    } | {
                        coordinates: (...)[][][];
                        type?: "MultiPolygon";
                    } | {
                        geometries: ({
                            coordinates: ...;
                            type?: ...;
                        } | {
                            coordinates: ...;
                            type?: ...;
                        } | {
                            coordinates: ...;
                            type?: ...;
                        } | {
                            coordinates: ...;
                            type?: ...;
                        } | {
                            coordinates: ...;
                            type?: ...;
                        } | {
                            coordinates: ...;
                            type?: ...;
                        })[];
                        type?: "GeometryCollection";
                    };
                    id?: string;
                    properties?: Record<string, unknown>;
                    type?: "Feature";
                }[];
                type?: "FeatureCollection";
            }[];
        }>

        A promise that resolves to the organization info.

        -

      getTagStatus

      • getTagStatus(options): Promise<TagStatus>

      • Parameters

        • options: TagRequestOptions

        Returns Promise<TagStatus>

      getTags

      index

      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).

          +

      getTagStatus

      • getTagStatus(options): Promise<TagStatus>

      • Parameters

        • options: TagRequestOptions

        Returns Promise<TagStatus>

      getTags

      index

      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.

        -

      project

      roboTag

      • roboTag(options): Promise<void>

      • Parameters

        • options: RoboTagOptions

        Returns Promise<void>

      schema

      updateTag

      • updateTag(options): Promise<TagResponse>

      • Parameters

        • options: UpdateTagOptions

        Returns Promise<TagResponse>

      updateTagMask

      • updateTagMask(bitmask_bytes, options): Promise<void>

      • Parameters

        • bitmask_bytes: Uint8Array
        • options: UpdateTagMaskOptions

        Returns Promise<void>

      withLoadedAttributes

      • withLoadedAttributes(): Promise<LoadedObject<AtlasProjection, {
            topic_model_metadatas: Record<string, unknown>[];
            topic_models: {
                bbox?: [number, number, number, number] | [number, number, number, number, number, number];
                features: {
                    bbox?: [number, number, number, number] | [number, number, number, number, number, number];
                    geometry?: {
                        coordinates: [(...), (...)] | [(...), (...), (...)];
                        type?: "Point";
                    } | {
                        coordinates: ((...) | (...))[];
                        type?: "MultiPoint";
                    } | {
                        coordinates: ((...) | (...))[];
                        type?: "LineString";
                    } | {
                        coordinates: (...)[][];
                        type?: "MultiLineString";
                    } | {
                        coordinates: (...)[][];
                        type?: "Polygon";
                    } | {
                        coordinates: (...)[][];
                        type?: "MultiPolygon";
                    } | {
                        geometries: ((...) | (...) | (...) | (...) | (...) | (...))[];
                        type?: "GeometryCollection";
                    };
                    id?: string;
                    properties?: Record<string, unknown>;
                    type?: "Feature";
                }[];
                type?: "FeatureCollection";
            }[];
        }>>

      • Loads the information associated with the class, removing any +

      project

      roboTag

      • roboTag(options): Promise<void>

      • Parameters

        • options: RoboTagOptions

        Returns Promise<void>

      schema

      updateTag

      • updateTag(options): Promise<TagResponse>

      • Parameters

        • options: UpdateTagOptions

        Returns Promise<TagResponse>

      updateTagMask

      • updateTagMask(bitmask_bytes, options): Promise<void>

      • Parameters

        • bitmask_bytes: Uint8Array
        • options: UpdateTagMaskOptions

        Returns Promise<void>

      withLoadedAttributes

      • withLoadedAttributes(): Promise<LoadedObject<AtlasProjection, {
            topic_model_metadatas: Record<string, unknown>[];
            topic_models: {
                bbox?: [number, number, number, number] | [number, number, number, number, number, number];
                features: {
                    bbox?: [number, number, number, number] | [number, number, number, number, number, number];
                    geometry?: {
                        coordinates: [(...), (...)] | [(...), (...), (...)];
                        type?: "Point";
                    } | {
                        coordinates: ((...) | (...))[];
                        type?: "MultiPoint";
                    } | {
                        coordinates: ((...) | (...))[];
                        type?: "LineString";
                    } | {
                        coordinates: (...)[][];
                        type?: "MultiLineString";
                    } | {
                        coordinates: (...)[][];
                        type?: "Polygon";
                    } | {
                        coordinates: (...)[][];
                        type?: "MultiPolygon";
                    } | {
                        geometries: ((...) | (...) | (...) | (...) | (...) | (...))[];
                        type?: "GeometryCollection";
                    };
                    id?: string;
                    properties?: Record<string, unknown>;
                    type?: "Feature";
                }[];
                type?: "FeatureCollection";
            }[];
        }>>

      • Loads the information associated with the class, removing any existing caches.

        Returns Promise<LoadedObject<AtlasProjection, {
            topic_model_metadatas: Record<string, unknown>[];
            topic_models: {
                bbox?: [number, number, number, number] | [number, number, number, number, number, number];
                features: {
                    bbox?: [number, number, number, number] | [number, number, number, number, number, number];
                    geometry?: {
                        coordinates: [(...), (...)] | [(...), (...), (...)];
                        type?: "Point";
                    } | {
                        coordinates: ((...) | (...))[];
                        type?: "MultiPoint";
                    } | {
                        coordinates: ((...) | (...))[];
                        type?: "LineString";
                    } | {
                        coordinates: (...)[][];
                        type?: "MultiLineString";
                    } | {
                        coordinates: (...)[][];
                        type?: "Polygon";
                    } | {
                        coordinates: (...)[][];
                        type?: "MultiPolygon";
                    } | {
                        geometries: ((...) | (...) | (...) | (...) | (...) | (...))[];
                        type?: "GeometryCollection";
                    };
                    id?: string;
                    properties?: Record<string, unknown>;
                    type?: "Feature";
                }[];
                type?: "FeatureCollection";
            }[];
        }>>

        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
        -

      Settings

      Member Visibility

      Theme

      On This Page

      constructor_attr_index_project_project_id_promise_schemaattributePromiseidproject_idviewerattrquadtree_rootapiCallatomInformationcreateTagdatasetIddeleteTagendpointfetchAttributesgetTagStatusgetTagsindexnearest_neighbors_by_vectorprojectroboTagschemaupdateTagupdateTagMaskwithLoadedAttributes
      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      constructor_attr_index_project_project_id_promise_schemaattributePromiseidproject_idviewerattrquadtree_rootapiCallatomInformationcreateTagdatasetIddeleteTagendpointfetchAttributesgetTagStatusgetTagsindexnearest_neighbors_by_vectorprojectroboTagschemaupdateTagupdateTagMaskwithLoadedAttributes
      \ No newline at end of file diff --git a/classes/AtlasUser.html b/classes/AtlasUser.html index 3372687..d4f4f34 100644 --- a/classes/AtlasUser.html +++ b/classes/AtlasUser.html @@ -1,4 +1,4 @@ -AtlasUser | @nomic-ai/atlas

      Class AtlasUser

      Hierarchy

      • BaseAtlasClass<components["schemas"]["PrivateUser"]>
        • AtlasUser

      Constructors

      constructor +AtlasUser | @nomic-ai/atlas

      Class AtlasUser

      Hierarchy

      • BaseAtlasClass<components["schemas"]["PrivateUser"]>
        • AtlasUser

      Constructors

      constructor

      Properties

      _attr attributePromise viewer @@ -13,7 +13,7 @@ withLoadedAttributes

      Constructors

      constructor

      Properties

      Protected _attr

      _attr: undefined | {
          default_organization?: string;
          email: string;
          name: string;
          nickname: string;
          organizations?: {
              access_role: string;
              nickname: string;
              organization_id: string;
              permissions: {
                  [key: string]: boolean;
              };
              plan_type: "atlas_demo" | "atlas_enterprise" | "atlas_research" | "atlas_starter" | "atlas_startup" | "atlas_pro" | "mock" | "free_test_user" | "pro" | "enterprise" | "free" | "research";
              slug: string;
              user_id: string;
          }[];
          picture?: string;
          stripe_customer_id?: string;
          sub: string;
          updated_at: string;
          waitlisted?: boolean;
      }

      Type declaration

      • Optional default_organization?: string

        Default Organization +>.constructor

      Properties

      Protected _attr

      _attr: undefined | {
          default_organization?: string;
          email: string;
          name: string;
          nickname: string;
          organizations?: {
              access_role: string;
              nickname: string;
              organization_id: string;
              permissions: {
                  [key: string]: boolean;
              };
              plan_type: "atlas_demo" | "atlas_enterprise" | "atlas_research" | "atlas_starter" | "atlas_startup" | "atlas_pro" | "mock" | "free_test_user" | "pro" | "enterprise" | "free" | "research";
              slug: string;
              user_id: string;
          }[];
          picture?: string;
          stripe_customer_id?: string;
          sub: string;
          updated_at: string;
          waitlisted?: boolean;
      }

      Type declaration

      • Optional default_organization?: string

        Default Organization Format: uuid

        Description

        The users default organization.

      • email: string

        Email

        @@ -45,20 +45,20 @@

        Example

        auth0
        Description
        Whether or not the user is wait-listed for Atlas access
        
 
        Default
        false
 
        
-

      Protected attributePromise

      attributePromise: undefined | Promise<{
          default_organization?: string;
          email: string;
          name: string;
          nickname: string;
          organizations?: {
              access_role: string;
              nickname: string;
              organization_id: string;
              permissions: {
                  [key: string]: boolean;
              };
              plan_type: "atlas_demo" | "atlas_enterprise" | "atlas_research" | "atlas_starter" | "atlas_startup" | "atlas_pro" | "mock" | "free_test_user" | "pro" | "enterprise" | "free" | "research";
              slug: string;
              user_id: string;
          }[];
          picture?: string;
          stripe_customer_id?: string;
          sub: string;
          updated_at: string;
          waitlisted?: boolean;
      }>

      viewer

      viewer: AtlasViewer

      Accessors

      anonymous

      apiLocation

      attr

      • get attr(): undefined | AttributesType

      • returns the object's information; this may be undefined

        -

        Returns undefined | AttributesType

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

      Protected endpoint

      • endpoint(): string

      • Returns string

      fetchAttributes

      • fetchAttributes(bustCache?): Promise<{
            default_organization?: string;
            email: string;
            name: string;
            nickname: string;
            organizations?: {
                access_role: string;
                nickname: string;
                organization_id: string;
                permissions: {
                    [key: string]: boolean;
                };
                plan_type: "atlas_demo" | "atlas_enterprise" | "atlas_research" | "atlas_starter" | "atlas_startup" | "atlas_pro" | "mock" | "free_test_user" | "pro" | "enterprise" | "free" | "research";
                slug: string;
                user_id: string;
            }[];
            picture?: string;
            stripe_customer_id?: string;
            sub: string;
            updated_at: string;
            waitlisted?: boolean;
        }>

      • Fetches basic information about the object. +

      Protected attributePromise

      attributePromise: undefined | Promise<{
          default_organization?: string;
          email: string;
          name: string;
          nickname: string;
          organizations?: {
              access_role: string;
              nickname: string;
              organization_id: string;
              permissions: {
                  [key: string]: boolean;
              };
              plan_type: "atlas_demo" | "atlas_enterprise" | "atlas_research" | "atlas_starter" | "atlas_startup" | "atlas_pro" | "mock" | "free_test_user" | "pro" | "enterprise" | "free" | "research";
              slug: string;
              user_id: string;
          }[];
          picture?: string;
          stripe_customer_id?: string;
          sub: string;
          updated_at: string;
          waitlisted?: boolean;
      }>

      viewer

      viewer: AtlasViewer

      Accessors

      anonymous

      apiLocation

      attr

      • get attr(): undefined | AttributesType

      • returns the object's information; this may be undefined

        +

        Returns undefined | AttributesType

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

      Protected endpoint

      • endpoint(): string

      • Returns string

      fetchAttributes

      • fetchAttributes(bustCache?): Promise<{
            default_organization?: string;
            email: string;
            name: string;
            nickname: string;
            organizations?: {
                access_role: string;
                nickname: string;
                organization_id: string;
                permissions: {
                    [key: string]: boolean;
                };
                plan_type: "atlas_demo" | "atlas_enterprise" | "atlas_research" | "atlas_starter" | "atlas_startup" | "atlas_pro" | "mock" | "free_test_user" | "pro" | "enterprise" | "free" | "research";
                slug: string;
                user_id: string;
            }[];
            picture?: string;
            stripe_customer_id?: string;
            sub: string;
            updated_at: string;
            waitlisted?: boolean;
        }>

      • 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<{
            default_organization?: string;
            email: string;
            name: string;
            nickname: string;
            organizations?: {
                access_role: string;
                nickname: string;
                organization_id: string;
                permissions: {
                    [key: string]: boolean;
                };
                plan_type: "atlas_demo" | "atlas_enterprise" | "atlas_research" | "atlas_starter" | "atlas_startup" | "atlas_pro" | "mock" | "free_test_user" | "pro" | "enterprise" | "free" | "research";
                slug: string;
                user_id: string;
            }[];
            picture?: string;
            stripe_customer_id?: string;
            sub: string;
            updated_at: string;
            waitlisted?: boolean;
        }>

        A promise that resolves to the organization info.

        -

      organizations

      • organizations(role?): Promise<AtlasOrganization[]>

      • Parameters

        • role: null | "OWNER" | "MEMBER" = null

          return only organizations where the user has this role (default: null, return all organizations)

          +

      organizations

      • organizations(role?): Promise<AtlasOrganization[]>

      • Parameters

        • role: null | "OWNER" | "MEMBER" = null

          return only organizations where the user has this role (default: null, return all organizations)

        Returns Promise<AtlasOrganization[]>

        A list of organizations where the user has the specified role

        -

      projects

      • projects(): Promise<{
            created_timestamp: string;
            creator: string;
            creator_nickname: string;
            creator_picture: string;
            description: string;
            id: string;
            is_public: boolean;
            is_public_to_org: boolean;
            modality?: string;
            nickname: string;
            organization_name: string;
            organization_slug: string;
            owner: string;
            project_fields: string[];
            project_name: string;
            slug: string;
            thumbnail: string;
            total_datums_in_project: number;
            unique_id_field: string;
        }[]>

      • Returns Promise<{
            created_timestamp: string;
            creator: string;
            creator_nickname: string;
            creator_picture: string;
            description: string;
            id: string;
            is_public: boolean;
            is_public_to_org: boolean;
            modality?: string;
            nickname: string;
            organization_name: string;
            organization_slug: string;
            owner: string;
            project_fields: string[];
            project_name: string;
            slug: string;
            thumbnail: string;
            total_datums_in_project: number;
            unique_id_field: string;
        }[]>

        All projects that the user has access to.

        -

      withLoadedAttributes

      • withLoadedAttributes(): Promise<LoadedObject<AtlasUser, {
            default_organization?: string;
            email: string;
            name: string;
            nickname: string;
            organizations?: {
                access_role: string;
                nickname: string;
                organization_id: string;
                permissions: {
                    [key: string]: boolean;
                };
                plan_type: "atlas_demo" | "atlas_enterprise" | "atlas_research" | "atlas_starter" | "atlas_startup" | "atlas_pro" | "mock" | "free_test_user" | "pro" | "enterprise" | "free" | "research";
                slug: string;
                user_id: string;
            }[];
            picture?: string;
            stripe_customer_id?: string;
            sub: string;
            updated_at: string;
            waitlisted?: boolean;
        }>>

      • Loads the information associated with the class, removing any +

      projects

      • projects(): Promise<{
            created_timestamp: string;
            creator: string;
            creator_nickname: string;
            creator_picture: string;
            description: string;
            id: string;
            is_public: boolean;
            is_public_to_org: boolean;
            modality?: string;
            nickname: string;
            organization_name: string;
            organization_slug: string;
            owner: string;
            project_fields: string[];
            project_name: string;
            slug: string;
            thumbnail: string;
            total_datums_in_project: number;
            unique_id_field: string;
        }[]>

      • Returns Promise<{
            created_timestamp: string;
            creator: string;
            creator_nickname: string;
            creator_picture: string;
            description: string;
            id: string;
            is_public: boolean;
            is_public_to_org: boolean;
            modality?: string;
            nickname: string;
            organization_name: string;
            organization_slug: string;
            owner: string;
            project_fields: string[];
            project_name: string;
            slug: string;
            thumbnail: string;
            total_datums_in_project: number;
            unique_id_field: string;
        }[]>

        All projects that the user has access to.

        +

      withLoadedAttributes

      • withLoadedAttributes(): Promise<LoadedObject<AtlasUser, {
            default_organization?: string;
            email: string;
            name: string;
            nickname: string;
            organizations?: {
                access_role: string;
                nickname: string;
                organization_id: string;
                permissions: {
                    [key: string]: boolean;
                };
                plan_type: "atlas_demo" | "atlas_enterprise" | "atlas_research" | "atlas_starter" | "atlas_startup" | "atlas_pro" | "mock" | "free_test_user" | "pro" | "enterprise" | "free" | "research";
                slug: string;
                user_id: string;
            }[];
            picture?: string;
            stripe_customer_id?: string;
            sub: string;
            updated_at: string;
            waitlisted?: boolean;
        }>>

      • Loads the information associated with the class, removing any existing caches.

        Returns Promise<LoadedObject<AtlasUser, {
            default_organization?: string;
            email: string;
            name: string;
            nickname: string;
            organizations?: {
                access_role: string;
                nickname: string;
                organization_id: string;
                permissions: {
                    [key: string]: boolean;
                };
                plan_type: "atlas_demo" | "atlas_enterprise" | "atlas_research" | "atlas_starter" | "atlas_startup" | "atlas_pro" | "mock" | "free_test_user" | "pro" | "enterprise" | "free" | "research";
                slug: string;
                user_id: string;
            }[];
            picture?: string;
            stripe_customer_id?: string;
            sub: string;
            updated_at: string;
            waitlisted?: boolean;
        }>>

        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
        -

      Settings

      Member Visibility

      Theme

      On This Page

      constructor_attrattributePromisevieweranonymousapiLocationattrapiCallendpointfetchAttributesorganizationsprojectswithLoadedAttributes
      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      constructor_attrattributePromisevieweranonymousapiLocationattrapiCallendpointfetchAttributesorganizationsprojectswithLoadedAttributes
      \ No newline at end of file diff --git a/classes/AtlasViewer.html b/classes/AtlasViewer.html index 234e477..cb959ca 100644 --- a/classes/AtlasViewer.html +++ b/classes/AtlasViewer.html @@ -1,4 +1,4 @@ -AtlasViewer | @nomic-ai/atlas

      Class AtlasViewer

      Constructors

      constructor +AtlasViewer | @nomic-ai/atlas

      Class AtlasViewer

      Constructors

      constructor

      Properties

      anonymous apiLocation credentials @@ -11,10 +11,10 @@ TokenLogin: Uses a bearer token or Nomic API key. must have token: string AnonUser: No credentials, used for anonymous Viewer

      -

      Parameters

      • params: Envlogin

      Returns AtlasViewer

    • new AtlasViewer(params): AtlasViewer

    • Parameters

      • params: ApiKeyLogin

      Returns AtlasViewer

    • new AtlasViewer(params): AtlasViewer

    • Parameters

      • params: BearerTokenLogin

      Returns AtlasViewer

    • new AtlasViewer(params): AtlasViewer

    • Parameters

      • params: AnonViewerLogin

      Returns AtlasViewer

      • Properties

      anonymous

      anonymous: boolean = false

      apiLocation

      apiLocation: string

      Private credentials

      credentials: Promise<null | Credentials>

      Methods

      apiCall

      Properties

      anonymous

      anonymous: boolean = false

      apiLocation

      apiLocation: string

      Private credentials

      credentials: Promise<null | Credentials>

      Methods

      apiCall

      • apiCall(endpoint, method?, payload?, headers?, options?): Promise<null | string | any[] | Record<string, any> | Uint8Array | Table<any>>

      • Call the API and return the results as deserialized JSON or Arrow.

        Parameters

        • endpoint: string

          The nomic API endpoint to call. If it doesn't begin with a slash, it will be added.

        • method: "GET" | "POST" = 'GET'

          POST or GET

        • payload: Payload = null

          The binary or JSON payload sent with the request.

        • headers: null | Record<string, string> = null

          Additional headers to send with the request

          -
        • options: ApiCallOptions = ...

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

      Settings

      Member Visibility

      Theme

      On This Page

      constructoranonymousapiLocationcredentialsapiCall
      \ No newline at end of file +
    • options: ApiCallOptions = ...

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

      Settings

      Member Visibility

      Theme

      On This Page

      constructoranonymousapiLocationcredentialsapiCall
      \ No newline at end of file diff --git a/classes/Embedder.html b/classes/Embedder.html index 369c4ae..29403c1 100644 --- a/classes/Embedder.html +++ b/classes/Embedder.html @@ -14,7 +14,7 @@

      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);
      }
      -

      Hierarchy

      • BaseAtlasClass<{}>
        • Embedder

      Constructors

      constructor +

      Hierarchy

      • BaseAtlasClass<{}>
        • Embedder

      Constructors

      constructor

      Properties

      _attr attributePromise backoff @@ -35,17 +35,17 @@ periodicallyFlushCache withLoadedAttributes

      Constructors

      constructor

      Properties

      Protected _attr

      _attr: undefined | {}

      Type declaration

        Protected attributePromise

        attributePromise: undefined | Promise<{}>

        Private backoff

        backoff: null | number = null

        Private embedQueue

        embedQueue: [string, ((embedding) => void), ((error) => void)][] = []

        Private Optional epitaph

        epitaph?: Error

        model

        model: EmbeddingModel

        Private nextScheduledFlush

        nextScheduledFlush: unknown = null

        taskType

        taskType: TaskType

        tokensUsed

        tokensUsed: number = 0

        viewer

        viewer: AtlasViewer

        Accessors

        attr

        • get attr(): undefined | AttributesType

        • returns the object's information; this may be undefined

          -

          Returns undefined | AttributesType

        Methods

        Private _embed

        • _embed(values): Promise<NomicEmbedResponse>

        • Parameters

          • values: string[]

          Returns Promise<NomicEmbedResponse>

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

        embed

        • embed(value): Promise<Embedding>

        • Parameters

          • value: string

          Returns Promise<Embedding>

        • embed(value): Promise<Embedding[]>

        • Parameters

          • value: string[]

          Returns Promise<Embedding[]>

        Protected endpoint

        fetchAttributes

        • fetchAttributes(bustCache?): Promise<{}>

        • Fetches basic information about the object. +

        • options: EmbedderOptions

        Returns Embedder

      • new Embedder(user, options): Embedder

      • Parameters

        Returns Embedder

      • new Embedder(viewer, options): Embedder

      • Parameters

        Returns Embedder

        • Properties

        Protected _attr

        _attr: undefined | {}

        Type declaration

          Protected attributePromise

          attributePromise: undefined | Promise<{}>

          Private backoff

          backoff: null | number = null

          Private embedQueue

          embedQueue: [string, ((embedding) => void), ((error) => void)][] = []

          Private Optional epitaph

          epitaph?: Error

          model

          model: EmbeddingModel

          Private nextScheduledFlush

          nextScheduledFlush: unknown = null

          taskType

          taskType: TaskType

          tokensUsed

          tokensUsed: number = 0

          viewer

          viewer: AtlasViewer

          Accessors

          attr

          • get attr(): undefined | AttributesType

          • returns the object's information; this may be undefined

            +

            Returns undefined | AttributesType

          Methods

          Private _embed

          • _embed(values): Promise<NomicEmbedResponse>

          • Parameters

            • values: string[]

            Returns Promise<NomicEmbedResponse>

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

          embed

          • embed(value): Promise<Embedding>

          • Parameters

            • value: string

            Returns Promise<Embedding>

          • embed(value): Promise<Embedding[]>

          • Parameters

            • value: string[]

            Returns Promise<Embedding[]>

          Protected endpoint

          fetchAttributes

          • fetchAttributes(bustCache?): Promise<{}>

          • 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<{}>

            A promise that resolves to the organization info.

            -

          Private flushDeferredEmbeddings

          Private periodicallyFlushCache

          withLoadedAttributes

          • withLoadedAttributes(): Promise<LoadedObject<Embedder, {}>>

          • Loads the information associated with the class, removing any +

          Private flushDeferredEmbeddings

          Private periodicallyFlushCache

          withLoadedAttributes

          • withLoadedAttributes(): Promise<LoadedObject<Embedder, {}>>

          • Loads the information associated with the class, removing any existing caches.

            Returns Promise<LoadedObject<Embedder, {}>>

            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
            -

          Settings

          Member Visibility

          Theme

          On This Page

          constructor_attrattributePromisebackoffembedQueueepitaphmodelnextScheduledFlushtaskTypetokensUsedviewerattr_embedapiCallembedendpointfetchAttributesflushDeferredEmbeddingsperiodicallyFlushCachewithLoadedAttributes
          \ No newline at end of file +

          Settings

          Member Visibility

          Theme

          On This Page

          constructor_attrattributePromisebackoffembedQueueepitaphmodelnextScheduledFlushtaskTypetokensUsedviewerattr_embedapiCallembedendpointfetchAttributesflushDeferredEmbeddingsperiodicallyFlushCachewithLoadedAttributes
          \ No newline at end of file diff --git a/functions/embed.html b/functions/embed.html index ffa53f7..cbfe55c 100644 --- a/functions/embed.html +++ b/functions/embed.html @@ -1 +1 @@ -embed | @nomic-ai/atlas

          Function embed

          • embed(value, options, apiKey): Promise<Embedding>

          • Parameters

            • value: string
            • options: EmbedderOptions
            • apiKey: undefined | string

            Returns Promise<Embedding>

          • embed(values, options, apiKey): Promise<Embedding[]>

          • Parameters

            • values: string[]
            • options: EmbedderOptions
            • apiKey: undefined | string

            Returns Promise<Embedding[]>

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +embed | @nomic-ai/atlas

          Function embed

          • embed(value, options, apiKey): Promise<Embedding>

          • Parameters

            • value: string
            • options: EmbedderOptions
            • apiKey: undefined | string

            Returns Promise<Embedding>

          • embed(values, options, apiKey): Promise<Embedding[]>

          • Parameters

            • values: string[]
            • options: EmbedderOptions
            • apiKey: undefined | string

            Returns Promise<Embedding[]>

          Settings

          Member Visibility

          Theme

          \ No newline at end of file