cleanup comments

aboutphilippe · aboutphilippe · commit 98b3701c02bf · 2024-08-14T17:16:26.000+02:00
Former-commit-id: 51d33d3 Former-commit-id: 521302095795a2a7533681782d3fa4bf85048f64
diff --git a/examples/voice/src/workflows/agent/agent.ts b/examples/voice/src/workflows/agent/agent.ts
@@ -21,7 +21,7 @@ export async function agentWorkflow({
 
     let openaiChatMessages: any[] = [];
 
-    // Get tools definition and start conversation
+    // Get tools definition and start conversation.
 
     const tools = await step<typeof functions>({
       taskQueue: "erp",
@@ -40,7 +40,7 @@ export async function agentWorkflow({
       openaiChatMessages = initialMessages.messages;
     }
 
-    // Send reply to AI chat with previous messages to continue conversation
+    // On user reply, send it to AI chat with previous messages to continue conversation.
 
     onEvent(replyEvent, async ({ streamSid, text }: Reply) => {
       const replyMessage = await step<typeof functions>({
@@ -60,7 +60,7 @@ export async function agentWorkflow({
       return { text };
     });
 
-    // When AI answer is a tool call, execute function and push results to conversation
+    // When AI answer is a tool call, execute function and push results to conversation.
 
     onEvent(toolCallEvent, async ({ function: toolFunction }: ToolCall) => {
       log.info("toolCallEvent", { toolFunction });
@@ -107,9 +107,10 @@ export async function agentWorkflow({
       return { function: toolFunction };
     });
 
+    // Terminate AI agent workflow.
+
     let ended = false;
     onEvent(agentEnd, async () => {
-      // Terminate AI agent workflow
       log.info(`agentEnd received`);
       ended = true;
     });
diff --git a/examples/voice/src/workflows/stream/stream.ts b/examples/voice/src/workflows/stream/stream.ts
@@ -31,7 +31,7 @@ export async function streamWorkflow() {
     let isSendingAudio = false;
     let childAgentRunId = "";
 
-    // Start long running websocket and send welcome message.
+    // Start long running websocket and stream welcome message to websocket.
     onEvent(streamInfoEvent, async ({ streamSid }: StreamInfo) => {
       log.info(`Workflow update with streamSid: ${streamSid}`);
       step<typeof functions>({
@@ -64,7 +64,7 @@ export async function streamWorkflow() {
       return { streamSid };
     });
 
-    // Transcribe audio and send it to AI agent
+    // Receives audio, transcribe it and send transcription to AI agent.
 
     onEvent(audioInEvent, async ({ streamSid, payload }: AudioIn) => {
       log.info(`Workflow update with streamSid: ${streamSid}`);
@@ -107,7 +107,7 @@ export async function streamWorkflow() {
       return { streamSid };
     });
 
-    // Generate audio from AI answer and send it to websocket
+    // Receives AI answer, generates audio and stream it to websocket.
 
     onEvent(answerEvent, async ({ streamSid, response, isLast }: Answer) => {
       const { audio } = await step<typeof functions>({
@@ -144,7 +144,7 @@ export async function streamWorkflow() {
       return { streamSid };
     });
 
-    // Terminates stream workflow
+    // Terminates stream workflow.
 
     let ended = false;
 
