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()
For Marqo Cloud, you will need to access the endpoint of your index and replace your_endpoint
with this. To do this, visit Find Your Endpoint. You will also need your API Key. To obtain this key visit Find Your API Key.
curl -XGET your_endpoint/indexes/my-first-index/settings \
-H 'x-api-key: XXXXXXXXXXXXXXX'
results = mq.index("my-first-index").get_settings()
Response: 200
{
"annParameters": {
"parameters": {
"efConstruction": 512,
"m": 16
},
"spaceType": "prenormalized-angular"
},
"filterStringMaxLength": 20,
"imagePreprocessing": {},
"model": "hf/e5-base-v2",
"normalizeEmbeddings": true,
"textPreprocessing": {
"splitLength": 2,
"splitMethod": "sentence",
"splitOverlap": 0
},
"treatUrlsAndPointersAsImages": false,
"type": "unstructured",
"vectorNumericType": "float"
}