File Properties
Last updated
Last updated
File properties will facilitate the user to provide information about the file is an optional step in the process of creating a vector store. If you have specific details about the files you're adding to the knowledge base, you can enter them here. This additional information can help in categorizing and retrieving vectors more efficiently in the future.
There are two easy ways for the user to add file properties during Vector Store creation:
A. The first way is the user may upload their file properties.
You may drag and drop the file into the dropdown area. Our supported formats are as follows: .csv and .json. For JSON files, please find below a sample of our accepted format.
B. The second way for a user to add a file property is to create it from scratch.
Let's take a look at the File properties types available below.
1. Text Field
Text Field allows the user to give information by typing in free-form text, up to a single line at a time.
Users also can add some validation by expanding the Advanced Settings.
You can also allow selecting multiple answers by checking the box to Allow multiple answers.
2. Text Area
Text Area allows the user to give information by typing in free-form text. In contrast to Text Fields, this allows for multiple-line answers.
You can also allow selecting multiple answers by checking the box to Allow multiple answers.
3. Dropdown
Dropdown requires user to give information by picking one of several multiple-choice answers.
If you have a .csv with a pre-set list of answers, you can upload the .csv as an option set.
You can also allow selecting multiple answers by checking the box to Allow multiple answers.
4. Hierarchical Dropdown
Hierarchical dropdown allows the user to give information with hierarchically organized options.
Just like with the Dropdown type, you can also upload an option set once you have created the hierarchical question. The sample format for hierarchical option sets can be found here.
💡Let's break down the components of this file
1. The header
id,label is the header. This will always be the first row in the .csv. The first label will have 1 as the id, as same as the example above.
2. id format
The id format is similar to Microsoft Word's numbering format. In the example above, Characters is a part of Novel name and the id will be 1.1.
Novel name: the root-level.
1: id for the root-level
Characters: the second-level.
1.1: the second-level id.
5. Date
Date allows the user to give information in two ways. The key benefit of selecting Date is that this format validates that a correct date has been filled in.
Typing the date in manually.
Clicking on the calendar symbol, then selecting the date.
If you want to fill date questions with the current timestamp at the time users open the file in knowledge base, you can check the Use current date as default value.
6. Time
Time allows the user to give information in two ways. The key benefit of selecting Time is that this format validates that a correct time has been filled in.
Typing it manually.
Clicking on the clock symbol, then selecting the time.
If you want to fill time questions with the current timestamp at the time the user opens the file in knowledge base, you can check the Use current time as default value.
7. Slider
Slider allows the user to give information by moving the sliding bar (ex: from 1 to 10).
You have the flexibility to personalize the slider color according to your preferences. While the default color for “Start at” and “End to” is blue, we provide 11 alternative default color options for you to select from.
When it comes to colors, you have the choice of using hex codes, color names, or RGB values. If you opt for any of these choices, the dropdown will be labeled as “Custom”.
To get a glimpse of how the color will appear, simply drag the slider thumb on the Preview.
Please note that we only allow numbers as the slider value.
8. Checkbox
Checkbox allows the user to give information by checking it. You can also put a description.
9. URL
URL allows you to put the URL links and apply validation on it.
10. Radio Button
Radio Button allows the user to give information by selecting one answer.
You can also insert a hint to give a description of the Radio Button. Here is an example of using the Radio Button in the labeling process:
11. Grouped Attributes
Grouped Attributes allows the user to combine multiple questions that pertain to a single group.
You can also allow selecting multiple answers by checking the box to Allow multiple answers.
After vector stores creation, the file property will appear on each file on knowledge base. Once you’ve already filled the information on the file properties, just click “Submit answers”.
