update_index
Modify an index configuration by swapping out a specified snippet with a new one, with validation bypass option.
Instructions
Updates an index configuration in the specified workspace with a replacement configuration snippet.
This function validates the replacement configuration snippet before applying it to the index. If the validation fails and skip_validation_errors is False, it returns error messages. Otherwise, the replacement snippet is used to update the index's configuration. :param index_name: Name of the index to update. :param original_config_snippet: The configuration snippet to replace. :param replacement_config_snippet: The new configuration snippet. :param skip_validation_errors: If True (default), updates the index even if validation fails. If False, stops update when validation fails. :returns: Updated index or error message.
All parameters accept object references in the form @obj_id or @obj_id.path.to.value.
Examples::
# Direct call with values
update_index(data={'key': 'value'}, threshold=10)
# Call with references
update_index(data='@obj_123', threshold='@obj_456.config.threshold')
# Mixed call
update_index(data='@obj_123.items', threshold=10)The output is automatically stored and can be referenced in other functions.
Returns a formatted preview with an object ID (e.g., @obj_123).
Use the object store tools in combination with the object ID to view nested properties of the object.
Use the returned object ID to pass this result to other functions.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| index_name | Yes | ||
| original_config_snippet | Yes | ||
| replacement_config_snippet | Yes | ||
| skip_validation_errors | No |