Object Folders#

The Object Folders screen allows you to group related items by categories.

No.	Interface Element	Description
1.	folder expansion arrow	Allows you to expand or collapse nested folders.
2.	folder selection checkbox	Allows you to select one or more Object Folders for batch actions.
3.	"Create Folder" button	Opens the form to create a new Object Folder.
4.	"Delete Selected" button	Allows you to delete selected Object Folders from the Sherpa AI Server. You can also delete individual Object Folders by clicking the button in the corresponding row of the "Object Folders" table. A confirmation window will appear when deleting a folder.
5.	"Refresh" button	Refreshes the list of Object Folders.
6.	"Name" column	Displays the name of the Object Folder.
7.	"Description" column	Displays the description of the Object Folder, if specified.
8.	"Created" column	Displays the date and time the Object Folder was created.
9.	"Modified" column	Displays the date and time the Object Folder was last modified.
10.	edit button	Allows you to open the selected Object Folder to modify its parameters.
11.	delete button	Allows you to delete a specific Object Folder from the list.

Creating an Object Folder#

To create a new Object Folder, click the "Create Folder" button in the "Object Folders" table and fill out the form that appears in the "Folder" popup window.

Editing an Object Folder#

To view and edit the properties of a specific Object Folder, you need to select it from the list and click the button . After that, a form with the settings of the Object Folder will open, where you can make the necessary changes.

In addition to the fields filled in when creating the Object Folder, the form will display the GUID (unique identifier assigned to the folder after its creation) during editing. This field cannot be edited.

Object Folder GUID in the API#

In the API, object_folder is the Object Folder from the section with the same name in the interface. To use it when uploading a file:

1. Open Object Folders and select the folder. Copy its GUID from the edit form.
2. In Swagger, open POST /api/v1/folders/{folder_guid}/files. Paste the copied Object Folder GUID into object_folder_guid. The folder_guid in the path identifies a folder in Documents; it is a different identifier.
3. To check the list through the API, call GET /api/v1/object_folders. The same GUID is in data[].guid. Use the GUID, not the numeric id.

Using Object Folders on Other Screens#

"Documents" Screen#

When creating and editing a document on the "Documents" screen, you can select the desired Object Folder in the "Object Folders" field.

"Roles" Screen#

When creating a Role, you need to select an Object Folder from the object tree on the screen.

After that, access is restricted to those objects within the server that correspond to the selected Object Folder.

"Assistants" Screen#

When creating and editing an Assistant, you also have the option to select the necessary Object Folders.