File Management in Brightsy AI provides capabilities for storing, organizing, and accessing documents and media.
Features & Capabilities
- Hierarchical Storage: Organize files in folder structures
- Search Functionality: Find files by name, content, or metadata
- Access Control: Permission-based file access
- File Operations: Upload, download, move, rename, and delete files
- File References: Link files in messages, records, and forms
- Format Support: Handle various document and media formats
How to Use
File Operations
Listing Files: Browse directory contents
list_files(path="files")
Creating Folders: Organize files in a logical structure
create_folder(folder_name="project_documents", path="files")
Uploading Files: Add new files to the system
upload_file(file_name="report.pdf", content_base64="...", path="files/project_documents")
Accessing File Content: Retrieve file information or content
get_file_content(file_path="files/project_documents/report.pdf")
Moving or Renaming: Reorganize your file structure
move_file(source_path="files/old_name.pdf", destination_path="files/new_name.pdf", is_folder=false)
Best Practices
- Organization: Create a logical folder hierarchy based on usage patterns
- Naming Conventions: Use consistent, descriptive naming for files and folders
- File Types: Store documents in standard formats (PDF, Office formats, plain text)
- References: Link files in records rather than duplicating information
- Regular Maintenance: Clean up unused files and maintain organized structures
- Security: Place sensitive files in appropriate directories with restricted access
- File Size: Consider file size when uploading; optimize large files when possible