Best Practices
Follow these best practices to get the most out of Secberus AI.
Document Preparation
Supported Formats
- plaintext - the default format is none is specified. The text is passed to the mapping algorithm as-is.
- json - the text will be passed to a JSON parser to remove the JSON structural elements prior to mapping for more accurate results.
- markdown - the text will be passed through a filter to remove the Markdown formatting symbols prior to mapping for more accurate results.
Document Quality
- For best results, keep document text concise. Remove any boilerplate, or other text that is not germaine to a regulatory control.
API Usage
Set your API Key as an environment variable.
export SECBERUS_API_KEY=YOUR_API_KEY
Caching Results
Cache the framework IDs to avoid redundant API calls:
- Call the
/v1/frameworksendpoint once and store the results for subsequent calls to/v1/map. - The algorithm behind the
/v1/mapendpoint is deterministic within a version, which means, the output will be the same for any input.
Security
- Never log or store full API keys
- Use environment variables for configuration