Configurations
Access to Configurations at: https://sandbox.heify.com/sandbox/configurations
Configuration object and all its attributes, please see the Configuration Object Reference.
You can create up to 20 configurations. Each configuration is reusable across unlimited transcriptions.
Configuration List
On this page, you can see the list of your configurations. Each configuration shows its main features. You can filter and search for Configurations. You can also view the details of each one and delete the Configuration.Creating a New Configuration
Click ”+ New Configuration” to open the configuration builder.Configuration Builder Interface
The central panel contains all the settings to define your transcription and analysis workflow.1. Configuration Details
These fields define the basic identification and functionality of your configuration.| Field | Required | Description |
|---|---|---|
| Identification Tag | Yes | A descriptive name for the configuration (max 255 characters). |
| Summary | No | Enable to have the AI automatically generate a summary (default: false). |
| Summary Language | No | The language for the summary (default: auto-detect). See Supported Languages. |
| Analytics Language | No | Language for the Executive and Qualitative Analysis Report (default: auto-detect). See Supported Languages. |
2. Custom Vocabulary
Improve transcription accuracy by adding an array of domain-specific words, phrases, or technical terms. Examples:- Product names: “Kubernetes”, “OAuth2”, “PostgreSQL”
- Industry jargon: “blockchain”, “NFT”, “API Gateway”
- Company terms: “Heify”, “TranscriptionBot”, “CloudSync”
- Acronyms: “GDPR”, “SaaS”, “B2B”
A well-defined vocabulary significantly reduces transcription errors for terms that are key to your business.
3. Webhook Notifications
Configure URLs to receive real-time notifications about transcription status. Both fields are optional.| Field | Description |
|---|---|
| Success URL | Receives a POST request when transcription completes successfully. |
| Error URL | Receives a POST request if transcription fails. |
4. Extraction Fields
Define structured data fields you want the AI to extract from your transcriptions. Learn more about Best Practices for Data Extraction for improve the quality of the extracted data. How to add fields:- Click “Create My First Field” or “Add Field”.
- Fill in the field definition form:
- Name: A unique identifier for the field (e.g.,
customer_id,sentiment). - Type: The data type:
string,number,boolean, orarray. - Description: Detailed instructions for the AI.
- Name: A unique identifier for the field (e.g.,
You can add a maximum of 20 extraction fields per configuration.
Best Practices for Data Extraction
To ensure accurate and consistent results, follow these guidelines when writing your field descriptions. 1. Use Bounded Responses Define a specific, limited set of possible values. This guides the AI and standardizes the output, making the data easier to process.- Good description:
- Poor description:
- Good description:
- Poor description:
Once created, a configuration cannot be edited. To make changes, you must create a new configuration with the desired settings and delete the old one if needed.
General Best Practices
Reuse Configurations
Reuse Configurations
Create configurations for common use cases and reuse them across many transcriptions and create a new one when the extraction needs are different.
Start Simple, Then Iterate
Start Simple, Then Iterate
Begin with 1-2 key extraction fields. Verify the quality of the results and refine their descriptions. Once you are satisfied, progressively add more fields to build complexity.
Troubleshooting
Extraction Fields Not Working
Extraction Fields Not Working
- Issue: Fields consistently return
nullor incorrect values. - Common Causes & Fixes:
- Vague Description: Make your instructions more explicit. Instead of “Get the name,” use “Extract the customer’s full name as mentioned in the conversation.”
- No Examples: Add concrete examples of the format you expect in the field’s description.
- Wrong Data Type: Ensure the selected data type (
string,number,boolean,array) matches the information you are trying to extract.
- Overly Complex Field: If you are trying to extract multiple pieces of information in one field, break it down into several simpler fields.