update_index
Modify an existing index in a workspace by changing only the fields you provide; update YAML, name, description, batch size, replicas, GPU, traces, and file filters, with optional validation.
Instructions
Updates an index in the specified workspace.
Only the fields you pass are changed; a field left as None is not touched (it is not cleared server-side).
Pass yaml_configuration to replace the index's YAML. When provided, pass the complete,
updated configuration (not just the changed parts); it is validated before being applied.
If validation fails and skip_validation_errors is False, it returns error messages.
All other parameters are index settings that can be updated independently of the YAML:
updated_index_name: rename the index.description: new description.max_allowed_batch_size: cap the number of files indexed per batch (1-500). Lower values reduce the chance that heavy files exceed the queue timeout and get retried.max_index_replica_count: maximum number of index replicas (1-10).gpu_enabled: enable or disable GPU acceleration.capture_traces: record an indexing trace for every file queued for this index.instance_size: pod size used to index files ("small", "medium", "large", or "xl").file_name_prefix_filter: prefix pattern (e.g. "myprefix*") selecting which files are indexed. Can only be updated while the index is not deployed.file_meta_filter: metadata conditions (field/operator/value, AND-combined) selecting which files are indexed. Can only be updated while the index is not deployed. :param index_name: Name of the index to update. :param updated_index_name: Optional new name for the index. :param yaml_configuration: Optional complete, updated YAML configuration for the index. :param description: Optional new description. :param max_allowed_batch_size: Optional per-pipeline cap on files indexed per batch (1-500). :param max_index_replica_count: Optional max number of index replicas (1-10). :param gpu_enabled: Optional toggle for GPU acceleration. :param capture_traces: Optional toggle for recording an indexing trace per queued file. :param instance_size: Optional pod size: "small", "medium", "large", or "xl". :param file_name_prefix_filter: Optional file-name prefix pattern filter. :param file_meta_filter: Optional metadata conditions filtering which files are indexed. :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 | ||
| description | No | ||
| gpu_enabled | No | ||
| instance_size | No | ||
| capture_traces | No | ||
| file_meta_filter | No | ||
| updated_index_name | No | ||
| yaml_configuration | No | ||
| max_allowed_batch_size | No | ||
| skip_validation_errors | No | ||
| file_name_prefix_filter | No | ||
| max_index_replica_count | No |