Box Collection

A Box Collection connects SearchBlox to your Box account so that files and folders stored in Box can be indexed and searched through SearchBlox.
Once set up, users can search Box content directly from your SearchBlox search interface — without switching to Box separately.

Before You Begin:

• You will need a Box application with a Client ID and Client Secret. Create one at developer.box.com.
• Have your Access Token and Refresh Token ready from your Box application's OAuth 2.0 settings.
• If you want to index only a specific folder, find the Folder ID in Box (visible in the URL when you open the folder: https://app.box.com/folder/FOLDER_ID).
• For Box enterprise accounts, have your Enterprise IDready.

Creating a Box Collection

You can create a Box Collection by following these steps:

• Log in to the Admin Console, go to the Collections tab, and click Create or the “+” icon.

• Select Box Collection as the collection type.

• Enter a unique name for the collection. The name must contain 3–36 alphanumeric characters, and only underscores (_) are allowed.

• Enable or disable RAG (Retrieval Augmented Generation) depending on your requirement. Enable it if the collection will be used for AI-powered search or chatbot responses.

• Enable Knowledge Graph if you want SearchBlox to extract entities and relationships from the documents in the collection.

• Choose whether the collection should be Private or Public. Enable Private Collection Access to restrict the collection to authenticated users only.

• Configure Collection Encryption if you want to encrypt document content or specific metadata fields.

• Select the Collection Language based on the language used in the documents. The default language is English.

• Click Create to create the Box Collection.

• After the collection is created, you will be redirected to the Box Settings / Authentication section to configure the connection and access details.

Box Settings

The Box Settings section allows you to configure the connection between SearchBlox and your Box account. By providing the required authentication credentials, SearchBlox can securely access your Box storage and crawl files and folders for indexing.

Once configured, SearchBlox will retrieve documents from the specified Box folders and make them searchable within the platform. You can optionally specify a root folder to control where the crawler begins indexing content.

Configuring Box Settings

To configure Box for your collection, follow these steps:

1. Go to the Box Settings tab within the collection.

2. Enter the Client ID.
   This is the client ID of your Box application used for authentication.

3. Enter the Client Secret.
   Provide the client secret associated with your Box application.

4. Enter the Access Token.
   This is the OAuth 2.0 access token used to authorize requests to the Box API.

5. Enter the Refresh Token.
   The refresh token is used to generate a new access token when the existing access token expires.

6. Enter the Enterprise ID (Optional).
   Provide the enterprise ID if you are using a Box enterprise account.

7. Enter the Root Folder ID (Optional).
   Specify the Box folder ID from which the crawler should start indexing content.
   If not specified, the crawler will start from the root folder (0).

8. Click Save to store the configuration and enable SearchBlox to access and crawl your Box content.

Collection Settings

Generate Using LLM

• Enable Title to automatically generate concise and relevant titles for the documents using LLM while indexing.
• Enable Description to generate relevant descriptions for the documents using LLM while indexing.
• Enable Topics to generate relevant topics for the documents using LLM while indexing.

Process Images Using LLM

• Enable Generate Description to extract images from documents and generate descriptions using LLM while indexing.
• Enable Enable OCR to extract text from images and scanned documents using the vision model while indexing.

Relevance

• Auto Relevance — Enable to use Hybrid Search for automatic relevance ranking. Compare Keyword Search with Hybrid to evaluate the difference before enabling.

RAG

• Enable RAG — Turn ON to build a retrieval index (vector embeddings) for this collection so it can be used for RAG, Hybrid Search, and AI Answers. This setting applies at the next index — re-index the collection to build or rebuild the RAG index.

RAG Chunking

• Chunking Strategy — Determines how documents are split for the RAG vector index. Default (recursive) suits most content.

• Size Unit — Measure chunk size and overlap using one of three modes:

  • Global Default — Inherits the system-wide default chunking configuration.
  • Tokens — Measure chunk size and overlap in tokens.
  • Characters — Measure chunk size and overlap in characters.

• Chunk Size — Leave blank to inherit the global default (300 tokens).

• Overlap — Overlap between adjacent chunks; must be less than the chunk size. Leave blank to inherit the global default (30).

Note: Chunking applies at indexing — set it before the first index. Changing it later requires re-indexing the collection.

Click Save to apply the RAG Chunking configuration, or click Cancel/Save at the bottom of the page to discard or store all Collection Settings.

Synonyms

Synonyms help the search show relevant documents even when the exact search word is not used.
For example, if someone searches for “global,” the results can also include documents that use “world” or “international.”
We have an option to load Synonyms from the existing documents.

Stopwords

Stopwords are common, high-frequency words that carry minimal semantic value and are typically excluded during text processing, indexing, or search operations. Examples include articles (a, an, the), conjunctions (and, but, or), prepositions (in, on, about), and auxiliary verbs (is, was, would, had).

Purpose:

Reduce noise in search indexing and text analysis
Improve processing efficiency by excluding low-value tokens
Enhance search relevance by prioritizing meaningful keywords

Schedule and Index

Sets the frequency and the start date/time for indexing a collection. Schedule Frequency supported in SearchBlox is as follows:

• Once
• Hourly
• Daily
• Every 48 Hours
• Every 96 Hours
• Weekly
• Monthly

The following operation can be performed in box collections

Manage Documents Tab

• Using Manage Documents tab we can do the following operations:

  1. Filter
  2. View content
  3. View metadata
  4. Refresh
  5. Delete

• To delete a file from your collection, enter the file path and click "Delete".

• To see the status of an indexed file, click "View Metadata".

Data Fields

• Using Data Fields tab we can create custom fields for search and we can see the Default Data Fields with non-encrypted collection. SearchBlox supports 4 types of Data Fields as listed below:

Note: Once the Data fields are configured, collection must be cleared and re-indexed to take effect.

• To know more about Data Fields please refer to Data Fields Tab

Prompts

• When LLM/RAG is enabled, you can edit AI-based prompts for Title, Description, Topic, Image Description, and Smart FAQs.
• You can customize these prompts anytime, and use Restore Default to reset them back to the original SearchBlox settings.

Box Collection Models

The Models page allows you to configure and override AI models used for embeddings, reranking, and LLM-based features within the collection.

Embedding

• Provider specifies the embedding provider used to generate vector representations of documents.
• Model defines the embedding model used to convert document content into vectors for semantic search.

Reranker

• Provider specifies the reranker provider used for improving search result relevance.
• Model defines the reranker model used to re-score and reorder search results based on relevance.

LLM

• Provider specifies the Large Language Model provider used for AI-powered features.

• Model defines the LLM used for tasks such as document enrichment, summaries, and SmartFAQs.

• These settings override global configurations and apply only to the current collection.

Knowledge Graph

• Enable Knowledge Graph — Turn ON to extract entities and relationships from this collection into a Knowledge Graph. This setting applies at the next index — re-index the collection to build or rebuild the graph.

Permission Webhook

The Permission Webhook allows Box to notify SearchBlox in real time when document-level permissions change, keeping secure search access in sync without waiting for the next scheduled index.

• Box Webhook URL — A unique, auto-generated URL for this collection. Register this URL in Box to push permission changes for this collection.
  Example: https://13.221.53.99:8443/rest/v2/api/permissions/webhook/box/1
  Click the copy icon to copy the URL to your clipboard.

• Set signature key — Paste your Box signature key here — Box signs each request with it, allowing SearchBlox to verify that incoming webhook requests genuinely originate from Box.

• Click How to configure for step-by-step guidance on registering the webhook URL and signature key in Box.

• Click Save Secret Key to store the signature key.

Note: Both the Webhook URL and the signature key must be configured in Box's webhook settings for permission changes to sync automatically with this collection.