validate_index
Ensure your YAML configuration is correct by validating it against the deepset API, then receive a formatted preview or an error message for quick fixes.
Instructions
Validates the provided index YAML configuration against the deepset API. :param yaml_configuration: The YAML configuration to validate. :returns: Validation result with original YAML or error message.
All parameters accept object references in the form @obj_id or @obj_id.path.to.value.
Examples::
# Direct call with values
validate_index(data={'key': 'value'}, threshold=10)
# Call with references
validate_index(data='@obj_123', threshold='@obj_456.config.threshold')
# Mixed call
validate_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
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| yaml_configuration | Yes |