Fetch Map Information

GET 
/v1/dataset/:project_id/index/projection/:projection_id

Fetches all information about a map such as topics, defaults, etc.

Request

Path Parameters

project_id Project Idrequired
projection_id Projection Idrequired

Responses

200

Successful Response

application/json

Schema

Schema

topic_models object[]required

List of topic model geojsons

topic_model_metadatas

object

required

list of topic model metadata

anyOf

MOD1

Array [

property name* any

]

resources

object[]

All resources used to build the associated map

Array [

type Type (string)required

Resource type.

id Id (string)required

The resource id.

dataset_id Dataset Id (string)required

The dataset id associated with the resource.

status ResourceStatus (string)required

Possible values: [COMPLETED, FAILED, BUILDING, WAITING]

The resource status.

params

object

required

Resource-specific parameters.

property name* any

Resource-specific parameters.

]

embedding_field

object

The data field from which the 2d embeddings were derived

anyOf

MOD1

string

embedding_model

object

The embedding model used to create the embeddings, if they were generated inside the Atlas system

anyOf

MOD1

string

primary_projection_algorithm Primary Projection Algorithm (string)required

The primary projection algorithm used for this map.

total_data_points

object

required

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

anyOf

MOD1

integer

Example (from schema)

{
  "topic_models": [
    {}
  ],
  "topic_model_metadatas": [
    null
  ],
  "resources": [
    {
      "type": "string",
      "id": "string",
      "dataset_id": "string",
      "status": "COMPLETED",
      "params": {}
    }
  ],
  "embedding_field": "string",
  "embedding_model": "string",
  "primary_projection_algorithm": "string",
  "total_data_points": 0
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...