Media collections

When should I use this?

When you want your bot to be able to send multimedia files to users.

Currently supported file types

Documents .txt, .pdf, .doc, .docx, .xls, .xlsx, .csv

Images .jpg, .jpeg, .png, .gif, .bmp, .webp, .svg

Video .mp4, .mov, .avi

Audio .mp3, .wav

Once a collection is linked, your bot will be able to send one or more files from it to users—either as a download link or directly—depending on the specific channel’s support for the file type and file size.

How does it work?

How does the bot know when to attach a file?

When you create a collection and upload files to it, you'll be prompted to add a summary for each file. These summaries are included in the system prompt when you link a collection to your bot. This allows the bot to accurately determine when a particular file is relevant to a conversation.

Additionally, OCS automatically provides the bot with a tool that enables it to attach files to its responses.

The location in the prompt where these summaries are included is defined by the {media} prompt variable.

Here’s an example of how file details appear in the system prompt:

You are a friendly assistant. Here's some files that you can attach to your responses when you think the user will benefit from it:
{media}

becomes

You are a friendly assitant. Here's some files that you can attach to your responses when you think the user will benefit from it:
* File (id=22, content_type=image/png): This is an image of a border collie
* File (id=23, content_type=application/pdf): This file contains information about the behaviours of border collies