Skip to content

Settings

Get settings of an index. For a conceptual overview of index settings, refer to our Index API Reference.

Get index settings

GET /indexes/{index_name}/settings

Path parameters

Name Type Description
index_name String name of the index

Example

curl -XGET http://localhost:8882/indexes/my-first-index/settings
results = mq.index("my-first-index").get_settings()

Response: 200

{
    "index_defaults": {
        "treat_urls_and_pointers_as_images": false,
        "model": "hf/all_datasets_v4_MiniLM-L6",
        "normalize_embeddings": true,
        "text_preprocessing": {
            "split_length": 2,
            "split_overlap": 0,
            "split_method": "sentence"
        },
        "image_preprocessing": {
            "patch_method": null
        },
        "ann_parameters" : {
            "space_type": "cosinesimil",
            "parameters": {
                "ef_construction": 128,
                "m": 16
            }
        }
    },
    "number_of_shards": 5,
    "number_of_replicas": 1
}