Skip to main content

Create Index

POST 
/v1/dataset/index/create

Creates an index and returns the job id of the index creation job.

Request​

Body

required

    project_id Project Id (string)required

    Unique project id

    index_name

    object

    The name of the index you are building.

    anyOf

    string

    colorable_fields string[]

    Default value: ``

    The fields that can be colored by.

    modality

    object

    The data modality of the index. DEPRECATED

    anyOf

    string

    reuse_atoms_and_embeddings_from

    object

    If passed, will reuse atoms and embeddings from the specified index

    anyOf

    string

    indexed_field

    object

    required

    The field this index is indexing. Should be set to None for embedding projects.

    anyOf

    string

    atomizer_strategies

    object

    The atomizer strategies to use when building this index. Should be set to None for embedding projects.

    anyOf

  • Array [

    • string

  • ]

    • geometry_strategies

    object

    The sets of geometry strategies to use when building this index. Should be set to None for embedding projects.

    anyOf

  • Array [

    • items string
    type

  • ]

    • model

    object

    required

    The model to encode your data with. Should be set to None for embedding projects.

    anyOf

    string

    model_hyperparameters

    object

    required

    JSON representation of hyperparameters to train the model with. Should be set to None for embedding projects.

    anyOf

    string

    nearest_neighbor_index Nearest Neighbor Index (string)required

    The nearest neighbor index to build.

    nearest_neighbor_index_hyperparameters Nearest Neighbor Index Hyperparameters (string)required

    JSON representation of hyperparameters to train the model with

    projection Projection (string)required

    The projection to build.

    projection_hyperparameters Projection Hyperparameters (string)required

    JSON representation of hyperparameters to train the model with

    topic_model_hyperparameters Topic Model Hyperparameters (string)

    Default value: {"build_topic_model": false}

    JSON representation of hyperparameters to build the topic model with

    duplicate_detection_hyperparameters Duplicate Detection Hyperparameters (string)

    Default value: {"tag_duplicates": false, "duplicate_cutoff": 0.1}

    JSON representation of hyperparameters used for duplicate detection

    build_from_versioned_dataset

    object

    Build index from new storage format (Experimental)

    anyOf

    boolean

    build_map_using_resources

    object

    Build map using resources

    anyOf

    boolean

    upload_checkpoint

    object

    checkpoint indentifier, resolves to the earliest version that has ingested data up to specified point

    anyOf

    integer

    latest_addition_timestamp

    object

    timestamp of the latest addition to the dataset, used to determine the upload checkpoint

    anyOf

    integer

Responses​

Successful Response

Schema

    job_id Job Id (string)required

    The job id of the index creation job.

    projection_id

    object

    The projection id created by a resource-path map.

    anyOf

    string

Loading...