create_index
Create a new index in your deepset workspace by providing a unique name and YAML configuration. Returns an object ID for later use.
Instructions
Creates a new index within your deepset platform workspace. :param index_name: Unique name of the index to create. :param yaml_configuration: YAML configuration to use for the index. :param description: Description of the index to create.
All parameters accept object references in the form @obj_id or @obj_id.path.to.value.
Examples::
# Direct call with values
create_index(data={'key': 'value'}, threshold=10)
# Call with references
create_index(data='@obj_123', threshold='@obj_456.config.threshold')
# Mixed call
create_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 |
|---|---|---|---|
| index_name | Yes | ||
| yaml_configuration | Yes | ||
| description | No |