Skip to content

Commit 4fb5681

Browse files
committed
Update Realtime Prompting Guide with formatting improvements and execution count adjustments
- Added bullet points for personality and tone descriptions for better readability. - Updated execution counts in code cells for consistency. - Revised audio file paths to ensure correct referencing. - Enhanced clarity in instructional examples and tips throughout the guide.
1 parent 36c71e9 commit 4fb5681

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

examples/Realtime_prompting_guide.ipynb

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -334,10 +334,10 @@
334334
"```\n",
335335
"# Personality & Tone\n",
336336
"## Personality\n",
337-
"Friendly, calm and approachable expert customer service assistant.\n",
337+
"- Friendly, calm and approachable expert customer service assistant.\n",
338338
"\n",
339339
"## Tone\n",
340-
"Warm, concise, confident, never fawning.\n",
340+
"- Warm, concise, confident, never fawning.\n",
341341
"\n",
342342
"## Length\n",
343343
"2–3 sentences per turn.\n",
@@ -362,7 +362,7 @@
362362
},
363363
{
364364
"cell_type": "code",
365-
"execution_count": null,
365+
"execution_count": 3,
366366
"id": "6dce17d5",
367367
"metadata": {},
368368
"outputs": [
@@ -380,13 +380,13 @@
380380
"<IPython.lib.display.Audio object>"
381381
]
382382
},
383-
"execution_count": 4,
383+
"execution_count": 3,
384384
"metadata": {},
385385
"output_type": "execute_result"
386386
}
387387
],
388388
"source": [
389-
"Audio(\"/Users/minh.hoque/work/github/openai-cookbook/examples/data/audio/multi-emotion.wav\")"
389+
"Audio(\"./data/audio/multi-emotion.wav\")"
390390
]
391391
},
392392
{
@@ -419,13 +419,13 @@
419419
"```\n",
420420
"# Personality & Tone\n",
421421
"## Personality\n",
422-
"Friendly, calm and approachable expert customer service assistant.\n",
422+
"- Friendly, calm and approachable expert customer service assistant.\n",
423423
"\n",
424424
"## Tone\n",
425-
"Warm, concise, confident, never fawning.\n",
425+
"- Warm, concise, confident, never fawning.\n",
426426
"\n",
427427
"## Length\n",
428-
"2–3 sentences per turn.\n",
428+
"- 2–3 sentences per turn.\n",
429429
"\n",
430430
"## Pacing\n",
431431
"- Deliver your audio response fast, but do not sound rushed.\n",
@@ -537,13 +537,13 @@
537537
"```\n",
538538
"# Personality & Tone\n",
539539
"## Personality\n",
540-
"Friendly, calm and approachable expert customer service assistant.\n",
540+
"- Friendly, calm and approachable expert customer service assistant.\n",
541541
"\n",
542542
"## Tone\n",
543-
"Warm, concise, confident, never fawning.\n",
543+
"- Warm, concise, confident, never fawning.\n",
544544
"\n",
545545
"## Length\n",
546-
"2–3 sentences per turn.\n",
546+
"- 2–3 sentences per turn.\n",
547547
"\n",
548548
"## Language\n",
549549
"- The conversation will be only in English.\n",
@@ -574,19 +574,19 @@
574574
"### Example (model teaches a language)\n",
575575
"```\n",
576576
"# Role & Objective\n",
577-
"You are a friendly, knowledgeable voice tutor for French learners. \n",
578-
"Your goal is to help the user improve their French speaking and listening skills through engaging conversation and clear explanations. \n",
579-
"Balance immersive French practice with supportive English guidance to ensure understanding and progress.\n",
577+
"- You are a friendly, knowledgeable voice tutor for French learners. \n",
578+
"- Your goal is to help the user improve their French speaking and listening skills through engaging conversation and clear explanations. \n",
579+
"- Balance immersive French practice with supportive English guidance to ensure understanding and progress.\n",
580580
"\n",
581581
"# Personality & Tone\n",
582582
"## Personality\n",
583-
"Friendly, calm and approachable expert voice tutor.\n",
583+
"- Friendly, calm and approachable expert customer service assistant.\n",
584584
"\n",
585585
"## Tone\n",
586-
"Warm, concise, confident, never fawning.\n",
586+
"- Warm, concise, confident, never fawning.\n",
587587
"\n",
588588
"## Length\n",
589-
"2–3 sentences per turn.\n",
589+
"- 2–3 sentences per turn.\n",
590590
"\n",
591591
"## Language\n",
592592
"### Explanations\n",
@@ -635,13 +635,13 @@
635635
"```\n",
636636
"# Personality & Tone\n",
637637
"## Personality\n",
638-
"Friendly, calm and approachable expert customer service assistant.\n",
638+
"- Friendly, calm and approachable expert customer service assistant.\n",
639639
"\n",
640640
"## Tone\n",
641-
"Warm, concise, confident, never fawning.\n",
641+
"- Warm, concise, confident, never fawning.\n",
642642
"\n",
643643
"## Length\n",
644-
"2–3 sentences per turn.\n",
644+
"- 2–3 sentences per turn.\n",
645645
"\n",
646646
"## Language\n",
647647
"- The conversation will be only in English.\n",
@@ -807,7 +807,7 @@
807807
"id": "60708efd",
808808
"metadata": {},
809809
"source": [
810-
"### Example\n",
810+
"### Example (general instruction section)\n",
811811
"```\n",
812812
"# Instructions/Rules\n",
813813
"- When reading numbers or codes, speak each character separately, separated by hyphens (e.g., 4-1-5). \n",
@@ -822,7 +822,7 @@
822822
"source": [
823823
"*Tip: If you are following a conversation flow prompting strategy, you can specify which conversation state needs to apply the alpha-numeric pronunciations instruction.*\n",
824824
"\n",
825-
"### Example \n",
825+
"### Example (instruction in conversation state)\n",
826826
"*(taken from the conversation flow of the prompt of our [openai-realtime-agents](https://github.com/openai/openai-realtime-agents/blob/main/src/app/agentConfigs/customerServiceRetail/authentication.ts))*\n",
827827
"\n",
828828
"```txt\n",
@@ -1214,7 +1214,7 @@
12141214
"id": "30ccc1d9",
12151215
"metadata": {},
12161216
"source": [
1217-
"*Tip: If a tool call can fail unpredictably, add clear failure-handling instructions so the model responds gracefully.*"
1217+
"*Tip: If you notice the model is jumping too quickly to call a tool, try softening the wording. For example, swapping out stronger terms like “proactive” with something gentler can help guide the model to take a calmer, less eager approach.*"
12181218
]
12191219
},
12201220
{
@@ -1269,7 +1269,7 @@
12691269
"id": "24579f54",
12701270
"metadata": {},
12711271
"source": [
1272-
"*Tip: If your tool call can fail in unpredictablr ways, try adding instructions on how to handle tool call outputs failures so taht the model can behave*"
1272+
"*Tip: If a tool call can fail unpredictably, add clear failure-handling instructions so the model responds gracefully.*"
12731273
]
12741274
},
12751275
{

0 commit comments

Comments
 (0)