From 3384ee93d7791d97ce99fabb01bc8704c7f4beb4 Mon Sep 17 00:00:00 2001 From: Agbonze Osazuwa Date: Fri, 17 Nov 2023 08:07:59 +0100 Subject: [PATCH 1/2] docs: fix typo & update statements - interactions was misspelt in a couple places - update statement grammar - update comment explaining `complete` parameter on transcript history --- core/transcripts.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/core/transcripts.mdx b/core/transcripts.mdx index 66a5f34..899f3c3 100644 --- a/core/transcripts.mdx +++ b/core/transcripts.mdx @@ -5,13 +5,13 @@ description: "Transcripts provide interactions logs" Transcripts are a way to provide a detailed log of the interaction between the AI and the user. This is useful for debugging, post processing and for auditing purposes. -To access the intractions transcript history you can fetch a interaction session. +To access the interactions transcript history you can fetch an interaction session. See the [Get Session API](/api/sessions/get-session) for more information. -An Interaction transcript history would something look like this: +Below is a snapshot of an Interaction transcript: ```json [ @@ -60,7 +60,7 @@ That should log the transcript to the console as it is being generated, which wo "timestamp": "2020-10-20T18:00:00.000Z", "role": "assistant", "content": "Hello, how can I help you?", - "complete": true // indicates that this is the full transcript + "complete": true // indicates transcript contains complete statement } ``` From e7538f434c46b7c6579bfc71cda44790a72b91bb Mon Sep 17 00:00:00 2001 From: Agbonze Osazuwa Date: Fri, 17 Nov 2023 08:22:06 +0100 Subject: [PATCH 2/2] docs: statement composition balance & improvement --- advanced/mode.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/advanced/mode.mdx b/advanced/mode.mdx index f9ac38b..db5cf54 100644 --- a/advanced/mode.mdx +++ b/advanced/mode.mdx @@ -7,7 +7,7 @@ We have two conversation modes **Hands-free** and **Hands-on**. By default interactions are initiated in **Hands-free** mode, In this mode users just talk to the AI and we automatically process the response, timing and manage the conversation responsiveness in the background. -While Hands-on mode, allows users to manually determine when to send their full response to the AI. +Hands-on mode allows users to manually determine when to send their full response to the AI. You can try out the Hands-on mode in the [Playground](https://app.diarupt.ai/) by changing the **Interaction Mode** control to `hands-on` in the `Advanced Controls` section. @@ -114,4 +114,4 @@ To send user's response. ## Conclusion -You're all set to use Hands-on mode. Now you control your user's conversational experience as you wish while still enjoying the benefit of our realtime video conversation AI. \ No newline at end of file +You're all set to use Hands-on mode which grants more conversational control to users and allows for more personalized interactive flow while still enjoying the benefit of our realtime video conversation AI.