Add activateGenerativeAi to docs:

structurely · Mar 5, 2024 · 0e63974 · 0e63974
1 parent 0c3d163
commit 0e63974
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 8 deletions.
diff --git a/build/index.html b/build/index.html
@@ -555,6 +555,7 @@ <h2 id='create-conversation'>Create Conversation</h2><div class="highlight"><pre
     </span><span class="nl">"settings"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
         </span><span class="nl">"chatbotName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Aisa"</span><span class="p">,</span><span class="w">
         </span><span class="nl">"timeZone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"America/Chicago"</span><span class="p">,</span><span class="w">
+        </span><span class="nl">"activateGenerativeAi"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
         </span><span class="nl">"liveTransferUrl"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://your-domain/api/structurely-live-transfer-start/leadId"</span><span class="w">
     </span><span class="p">},</span><span class="w">
     </span><span class="nl">"slots"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
@@ -586,7 +587,7 @@ <h4 id='body-parameters'>Body Parameters<a href="#conversation"><sup>[^]</sup></
 </thead><tbody>
 <tr>
 <td>settings</td>
-<td><code>ConversationSettings</code></td>
+<td><code>ConversationSettings</code> <a href="#conversationsettings"><sup>[^]</sup></a></td>
 </tr>
 <tr>
 <td>slots</td>
@@ -1023,7 +1024,7 @@ <h2 id='schemas'>Schemas</h2><h3 id='conversation'>Conversation</h3>
 </tr>
 <tr>
 <td>settings</td>
-<td><code>ConversationSettings</code></td>
+<td><code>ConversationSettings</code> <a href="#conversationsettings"><sup>[^]</sup></a></td>
 <td>The settings for to use for this conversation.</td>
 <td>Yes</td>
 <td>No</td>
@@ -1121,17 +1122,26 @@ <h3 id='conversationsettings'>ConversationSettings</h3>
 <td>If set to true, Structurely drip campaigns will be used for an unresponsive lead.  Only runs if there is no lead message following a system response in the messages list.</td>
 <td>Yes</td>
 <td>No</td>
+<td>No</td>
 <td><code>false</code></td>
-<td></td>
 </tr>
 <tr>
 <td>reDripsEnabled</td>
 <td><code>Boolean</code></td>
 <td>If set to true, Structurely will re-engage leads that have responded but are not responding to the current prompt. Will use the current context to determine outbound re-drips even if a custom response is generated by the third party user.</td>
 <td>Yes</td>
 <td>No</td>
+<td>No</td>
+<td><code>false</code></td>
+</tr>
+<tr>
+<td>activateGenerativeAi</td>
+<td><code>Boolean</code></td>
+<td>If set to <code>true</code>, Structurely will use Generative AI to enhance scripted responses, which results in better conversations and lower carrier filtering.</td>
+<td>Yes</td>
+<td>No</td>
+<td>No</td>
 <td><code>false</code></td>
-<td></td>
 </tr>
 <tr>
 <td>liveTransferUrl</td>

diff --git a/source/includes/_conversations.md b/source/includes/_conversations.md
@@ -20,6 +20,7 @@ curl 'https://api.structurely.com/v1/conversations' \
     "settings": {
         "chatbotName": "Aisa",
         "timeZone": "America/Chicago",
+        "activateGenerativeAi": true,
         "liveTransferUrl": "https://your-domain/api/structurely-live-transfer-start/leadId"
     },
     "slots": [
@@ -50,7 +51,7 @@ This endpoint creates and returns a new conversation object.
 
 Parameter | Type
 --------- | ----
-settings | `ConversationSettings`
+settings | `ConversationSettings` [<sup>[^]</sup>](#conversationsettings)
 slots | `List<ConversationSlot>`
 muted | `Boolean`
 messages | `List<ConversationItem>`
@@ -405,7 +406,7 @@ Be sure to include the header `Content-Type: application/json` with your request
 Field | Type | Description | Readable? | Writable? | Required? | Default
 ----- | ---- | ----------- | --------- | --------- | --------- | -------
 id | `ObjectId` | The ID of the conversation this resource represents. | Yes | No | No
-settings | `ConversationSettings` | The settings for to use for this conversation. | Yes | No | Yes
+settings | `ConversationSettings` [<sup>[^]</sup>](#conversationsettings) | The settings for to use for this conversation. | Yes | No | Yes
 slots | `List<ConversationSlot>` | A list of extracted or pre-filled values relating to the conversation. | Yes | No | Yes
 muted | `Boolean` | A boolean flag to tell whether or not this conversation is muted. Once muted, a conversation can still receive messages but will no longer generate replies. It is not possible to unmute a conversation. | Yes | Yes | No | `false`
 stages | `List<String>` | A list of stages this conversation is currently in. | Yes | No | No
@@ -419,8 +420,9 @@ timeZone | `String` | The time zone the realtor and/or lead. (See [list](https:/
 chatbotName | `String` | The name of conversation AI to use in responses. | Yes | No | No | Aisa
 leadTypes | `List<String>` | The lead types that will be supported in this conversation. Possible values are `buyer`, `seller`, and `renter` | Yes | No | No | `['buyer', 'seller']`
 allowedDomains | `List<String>` | The domains that this conversation can use for conversation flows. Possible values are `real_estate` and `mortgage`. When a lead sets or changes its lead type, the domain determines what scripts to use. | Yes | No | No | `['real_estate']`
-dripCampaignEnabled | `Boolean` | If set to true, Structurely drip campaigns will be used for an unresponsive lead.  Only runs if there is no lead message following a system response in the messages list. | Yes | No | `false`
-reDripsEnabled | `Boolean` | If set to true, Structurely will re-engage leads that have responded but are not responding to the current prompt. Will use the current context to determine outbound re-drips even if a custom response is generated by the third party user. | Yes | No | `false`
+dripCampaignEnabled | `Boolean` | If set to true, Structurely drip campaigns will be used for an unresponsive lead.  Only runs if there is no lead message following a system response in the messages list. | Yes | No | No | `false`
+reDripsEnabled | `Boolean` | If set to true, Structurely will re-engage leads that have responded but are not responding to the current prompt. Will use the current context to determine outbound re-drips even if a custom response is generated by the third party user. | Yes | No | No | `false`
+activateGenerativeAi | `Boolean` | If set to `true`, Structurely will use Generative AI to enhance scripted responses, which results in better conversations and lower carrier filtering. | Yes | No | No | `false`
 liveTransferUrl | `URL` | Enables [Live Transfer](#live-transfer), must be a valid URL using `https://` | Yes | No | No | `undefined`
 liveTransferStatusUpdateUrl | `URL` | Sends [Live Transfer](#live-transfer) status reports, must be a valid URL using `https://` | Yes | No | No | `undefined`