Modify index

In Marqo Cloud you can modify the number of inference nodes numberOfInferences, the type of inference node inferenceType, the number of storage shards numberOfShards, the number of replicas numberOfReplicas. Support to update the type of storage class storageClass will be added soon. These are body parameters that are specific to Marqo Cloud only and so this page is specifically for Marqo Cloud.

If you're looking to modify documents in either Marqo Open Source or Marqo Cloud, please see Update Documents.

Marqo Cloud

You can modify the settings of an existing index, such as the number of inference nodes or the type of inference node.

PUT https://api.marqo.ai/api/v2/indexes/{index_name}

Example

cURL

cURL -XPUT 'https://api.marqo.ai/api/v2/indexes/my-first-index' \
-H 'x-api-key: XXXXXXXXXXXXXXX' \
-H 'Content-type:application/json' -d '
{
"numberOfInferences": 1,
"inferenceType": "marqo.CPU.large",
"numberOfShards": 2,
"numberOfReplicas": 1,
"storageClass": "marqo.basic"
}'

Response: 200 OK

{"acknowledged":true}

Path parameters

Name	Type	Description
index_name	String	name of the index

Body Parameters

The settings for the index. The settings are represented as a nested JSON object.

Name	Type	Default value	Description
inferenceType	String	marqo.CPU.small	Type of inference for the index. Options are "marqo.CPU.small"(deprecated), "marqo.CPU.large", "marqo.GPU".
numberOfInferences	Integer	1	Defines the number of inference nodes for the index. The minimum value is 0, and the maximum value is 5 by default, but this is dependent on your account limits.
numberOfShards	Integer	1	Defines the number of shards for the index. The minimum value is equal to the current number of shards for the index, and the maximum value is 5 by default, but this is dependent on your account limits.
numberOfReplicas	Integer	1	Defines the number of replicas for the index. The minimum value is equal to the current number of replicas for the index, and the maximum value is 1 by default, but this is dependent on your account limits.
storageClass	String	marqo.basic	Defines the storage class for the index. Permisible values are marqo.basic, marqo.balanced and marqo.performance. The value must be equal to the current storage class for the index, but support to change this value is coming soon.