Skip to content

Commit dbabfe2

Browse files
committed
more instructions
1 parent 8076e56 commit dbabfe2

File tree

1 file changed

+27
-8
lines changed

1 file changed

+27
-8
lines changed

fern/customization/speech-configuration.mdx

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -244,16 +244,10 @@ This enhanced explanation provides concrete examples and clear descriptions of t
244244
- **Elderly or Speech-Impaired Users**: The endpointing rules can be customized to accommodate slower speech patterns or frequent pauses, ensuring the assistant doesn't interrupt prematurely.
245245

246246

247-
AssistantCustomEndpointingRule
248-
CustomerCustomEndpointingRule
249-
BothCustomEndpointingRule
250-
TranscriptionEndpointingPlan
251247

252248
#### AssistantCustomEndpointing Rule
253-
254-
This rule allows customization of when the assistant should start speaking based on its own speech patterns. It's part of the startSpeakingPlan configuration.
255-
256-
AssistantCustomEndpointingRule is a JSON object that defines a rule for setting an endpointing timeout based on the last assistant message before the customer starts speaking. Here's a breakdown of its properties:
249+
This rule allows customization of when the assistant should start speaking based on its own speech patterns. It's part of the startSpeakingPlan configuration.
250+
AssistantCustomEndpointingRule is a JSON object that defines a rule for setting an endpointing timeout based on the last assistant message before the customer starts speaking. Here's a breakdown of its properties:
257251
- **type**: A string that must be "assistant". It indicates that the rule is based on the last assistant message.
258252
- **regex**: A string representing a regular expression pattern to match against the assistant's message.
259253
- **regexOptions**: An array of options for the regex match. Defaults to an empty array.
@@ -318,6 +312,31 @@ The `BothCustomEndpointingRule` is a JSON object that defines a rule for setting
318312

319313
#### TranscriptionEndpointing Plan
320314

315+
316+
{
317+
"TranscriptionEndpointingPlan": {
318+
"type": "object",
319+
"properties": {
320+
"rules": {
321+
"type": "array",
322+
"items": {
323+
"oneOf": [
324+
{ "$ref": "#/components/schemas/AssistantCustomEndpointingRule" },
325+
{ "$ref": "#/components/schemas/CustomerCustomEndpointingRule" },
326+
{ "$ref": "#/components/schemas/BothCustomEndpointingRule" }
327+
]
328+
}
329+
}
330+
}
331+
}
332+
}
333+
334+
Properties
335+
- **rules**: An array of endpointing rules. Each rule can be one of the following types:
336+
- AssistantCustomEndpointingRule
337+
- CustomerCustomEndpointingRule
338+
- BothCustomEndpointingRule
339+
321340
This plan provides detailed control over how the transcription affects the assistant's speaking behavior. It includes parameters such as:
322341
- **onPunctuationSeconds**: Wait time after detecting punctuation in the transcription.
323342
- **onNoPunctuationSeconds**: Wait time when no punctuation is detected.

0 commit comments

Comments
 (0)