From f950989886ef78582b33b3aba8d5236e606b6bd7 Mon Sep 17 00:00:00 2001 From: Ben Lower Date: Fri, 11 Oct 2024 08:39:26 -0700 Subject: [PATCH 1/5] adding setOutputMedium to SDK page --- docs/src/content/docs/sdk.mdx | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/src/content/docs/sdk.mdx b/docs/src/content/docs/sdk.mdx index 60e6759..3203307 100644 --- a/docs/src/content/docs/sdk.mdx +++ b/docs/src/content/docs/sdk.mdx @@ -82,7 +82,18 @@ Leaves the current call. Returns a promise (with no return value) that resolves ```typescript sendText(text: string): void ``` -Sends a message to the model. Model replies via text transcript. Requires inputting the text message (string). +Sends a text message to the agent. Requires inputting the text message (string). By default, the agent will reply via text transcript. To get a voice reply, use [setOutputMedium](#setoutputmedium). + +#### setOutputMedium() + +```ts +setOutputMedium(medium: Medium): void +``` +Sets the agent's output medium when `sendText()` is used. If the agent is currently speaking, this will take effect at the end of the agent's utterance. Also see [muteSpeaker](#mutespeaker) and [unmuteSpeaker](#unmutespeaker) below. + +| parameter | description | +|-------------- | ------------------------------------------- | +| medium | How replies are communicated. Must be either `'text'` or `'voice'`. If not set, defaults to 'text'. | #### isMicMuted() From cf1e03c6fe66bcaf41e56b2c1d3898fc4a04840d Mon Sep 17 00:00:00 2001 From: Ben Lower Date: Fri, 11 Oct 2024 09:49:53 -0700 Subject: [PATCH 2/5] Update docs/src/content/docs/sdk.mdx Co-authored-by: Mike Depinet --- docs/src/content/docs/sdk.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/content/docs/sdk.mdx b/docs/src/content/docs/sdk.mdx index 3203307..99aed1e 100644 --- a/docs/src/content/docs/sdk.mdx +++ b/docs/src/content/docs/sdk.mdx @@ -82,7 +82,7 @@ Leaves the current call. Returns a promise (with no return value) that resolves ```typescript sendText(text: string): void ``` -Sends a text message to the agent. Requires inputting the text message (string). By default, the agent will reply via text transcript. To get a voice reply, use [setOutputMedium](#setoutputmedium). +Sends a text message to the agent. Requires inputting the text message (string). #### setOutputMedium() From 958b4c045b8d86a88dde45e110e0676cfb0ac2be Mon Sep 17 00:00:00 2001 From: Ben Lower Date: Fri, 11 Oct 2024 09:50:20 -0700 Subject: [PATCH 3/5] Update docs/src/content/docs/sdk.mdx Co-authored-by: Mike Depinet --- docs/src/content/docs/sdk.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/content/docs/sdk.mdx b/docs/src/content/docs/sdk.mdx index 99aed1e..fb9b503 100644 --- a/docs/src/content/docs/sdk.mdx +++ b/docs/src/content/docs/sdk.mdx @@ -93,7 +93,7 @@ Sets the agent's output medium when `sendText()` is used. If the agent is curren | parameter | description | |-------------- | ------------------------------------------- | -| medium | How replies are communicated. Must be either `'text'` or `'voice'`. If not set, defaults to 'text'. | +| medium | How replies are communicated. Must be either `'text'` or `'voice'`. #### isMicMuted() From 612b12b15fb67014b4bf7710e80942f43c557242 Mon Sep 17 00:00:00 2001 From: Ben Lower Date: Fri, 11 Oct 2024 09:51:04 -0700 Subject: [PATCH 4/5] Update docs/src/content/docs/sdk.mdx Co-authored-by: Mike Depinet --- docs/src/content/docs/sdk.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/src/content/docs/sdk.mdx b/docs/src/content/docs/sdk.mdx index fb9b503..44558f9 100644 --- a/docs/src/content/docs/sdk.mdx +++ b/docs/src/content/docs/sdk.mdx @@ -88,8 +88,6 @@ Sends a text message to the agent. Requires inputting the text message (string). ```ts setOutputMedium(medium: Medium): void -``` -Sets the agent's output medium when `sendText()` is used. If the agent is currently speaking, this will take effect at the end of the agent's utterance. Also see [muteSpeaker](#mutespeaker) and [unmuteSpeaker](#unmutespeaker) below. | parameter | description | |-------------- | ------------------------------------------- | From a7fbb8930a945d27b245223ffddf8a8df8550812 Mon Sep 17 00:00:00 2001 From: Ben Lower Date: Fri, 11 Oct 2024 09:52:26 -0700 Subject: [PATCH 5/5] feedback --- docs/src/content/docs/sdk.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/src/content/docs/sdk.mdx b/docs/src/content/docs/sdk.mdx index 44558f9..b7055e5 100644 --- a/docs/src/content/docs/sdk.mdx +++ b/docs/src/content/docs/sdk.mdx @@ -88,6 +88,8 @@ Sends a text message to the agent. Requires inputting the text message (string). ```ts setOutputMedium(medium: Medium): void +``` +Sets the agent's output medium for future utterances. If the agent is currently speaking, this will take effect at the end of the agent's utterance. Also see [muteSpeaker](#mutespeaker) and [unmuteSpeaker](#unmutespeaker) below. | parameter | description | |-------------- | ------------------------------------------- |